import * as outputs from "../types/output"; import * as enums from "../types/enums"; export declare namespace aad { /** * Configuration Diagnostics */ interface ConfigDiagnosticsResponse { /** * Last domain configuration diagnostics DateTime */ lastExecuted?: string; /** * List of Configuration Diagnostics validator results. */ validatorResults?: outputs.aad.ConfigDiagnosticsValidatorResultResponse[]; } /** * Specific issue for a particular config diagnostics validator */ interface ConfigDiagnosticsValidatorResultIssueResponse { /** * List of domain resource property name or values used to compose a rich description. */ descriptionParams?: string[]; /** * Validation issue identifier. */ id?: string; } /** * Config Diagnostics validator result data */ interface ConfigDiagnosticsValidatorResultResponse { /** * List of resource config validation issues. */ issues?: outputs.aad.ConfigDiagnosticsValidatorResultIssueResponse[]; /** * Replica set location and subnet name */ replicaSetSubnetDisplayName?: string; /** * Status for individual validator after running diagnostics. */ status?: string; /** * Validator identifier */ validatorId?: string; } /** * configDiagnosticsValidatorResultResponseProvideDefaults sets the appropriate defaults for ConfigDiagnosticsValidatorResultResponse */ function configDiagnosticsValidatorResultResponseProvideDefaults(val: ConfigDiagnosticsValidatorResultResponse): ConfigDiagnosticsValidatorResultResponse; /** * Container Account Description */ interface ContainerAccountResponse { /** * The account name */ accountName?: string; /** * The account password */ password?: string; /** * The account spn */ spn?: string; } /** * Domain Security Settings */ interface DomainSecuritySettingsResponse { /** * A flag to determine whether or not ChannelBinding is enabled or disabled. */ channelBinding?: string; /** * A flag to determine whether or not KerberosArmoring is enabled or disabled. */ kerberosArmoring?: string; /** * A flag to determine whether or not KerberosRc4Encryption is enabled or disabled. */ kerberosRc4Encryption?: string; /** * A flag to determine whether or not LdapSigning is enabled or disabled. */ ldapSigning?: string; /** * A flag to determine whether or not NtlmV1 is enabled or disabled. */ ntlmV1?: string; /** * A flag to determine whether or not SyncKerberosPasswords is enabled or disabled. */ syncKerberosPasswords?: string; /** * A flag to determine whether or not SyncNtlmPasswords is enabled or disabled. */ syncNtlmPasswords?: string; /** * A flag to determine whether or not SyncOnPremPasswords is enabled or disabled. */ syncOnPremPasswords?: string; /** * A flag to determine whether or not TlsV1 is enabled or disabled. */ tlsV1?: string; } /** * domainSecuritySettingsResponseProvideDefaults sets the appropriate defaults for DomainSecuritySettingsResponse */ function domainSecuritySettingsResponseProvideDefaults(val: DomainSecuritySettingsResponse): DomainSecuritySettingsResponse; /** * Forest Trust Setting */ interface ForestTrustResponse { /** * Friendly Name */ friendlyName?: string; /** * Remote Dns ips */ remoteDnsIps?: string; /** * Trust Direction */ trustDirection?: string; /** * Trust Password */ trustPassword?: string; /** * Trusted Domain FQDN */ trustedDomainFqdn?: string; } /** * Health Alert Description */ interface HealthAlertResponse { /** * Health Alert Id */ id: string; /** * Health Alert Issue */ issue: string; /** * Health Alert Last Detected DateTime */ lastDetected: string; /** * Health Alert Name */ name: string; /** * Health Alert Raised DateTime */ raised: string; /** * Health Alert TSG Link */ resolutionUri: string; /** * Health Alert Severity */ severity: string; } /** * Health Monitor Description */ interface HealthMonitorResponse { /** * Health Monitor Details */ details: string; /** * Health Monitor Id */ id: string; /** * Health Monitor Name */ name: string; } /** * Secure LDAP Settings */ interface LdapsSettingsResponse { /** * NotAfter DateTime of configure ldaps certificate. */ certificateNotAfter: string; /** * Thumbprint of configure ldaps certificate. */ certificateThumbprint: string; /** * A flag to determine whether or not Secure LDAP access over the internet is enabled or disabled. */ externalAccess?: string; /** * A flag to determine whether or not Secure LDAP is enabled or disabled. */ ldaps?: string; /** * The certificate required to configure Secure LDAP. The parameter passed here should be a base64encoded representation of the certificate pfx file. */ pfxCertificate?: string; /** * The password to decrypt the provided Secure LDAP certificate pfx file. */ pfxCertificatePassword?: string; /** * Public certificate used to configure secure ldap. */ publicCertificate: string; } /** * ldapsSettingsResponseProvideDefaults sets the appropriate defaults for LdapsSettingsResponse */ function ldapsSettingsResponseProvideDefaults(val: LdapsSettingsResponse): LdapsSettingsResponse; /** * Migration Progress */ interface MigrationProgressResponse { /** * Completion Percentage */ completionPercentage?: number; /** * Progress Message */ progressMessage?: string; } /** * Migration Properties */ interface MigrationPropertiesResponse { /** * Migration Progress */ migrationProgress: outputs.aad.MigrationProgressResponse; /** * Old Subnet Id */ oldSubnetId: string; /** * Old Vnet Site Id */ oldVnetSiteId: string; } /** * Settings for notification */ interface NotificationSettingsResponse { /** * The list of additional recipients */ additionalRecipients?: string[]; /** * Should domain controller admins be notified */ notifyDcAdmins?: string; /** * Should global admins be notified */ notifyGlobalAdmins?: string; } /** * Replica Set Definition */ interface ReplicaSetResponse { /** * List of Domain Controller IP Address */ domainControllerIpAddress: string[]; /** * External access ip address. */ externalAccessIpAddress: string; /** * List of Domain Health Alerts */ healthAlerts: outputs.aad.HealthAlertResponse[]; /** * Last domain evaluation run DateTime */ healthLastEvaluated: string; /** * List of Domain Health Monitors */ healthMonitors: outputs.aad.HealthMonitorResponse[]; /** * Virtual network location */ location?: string; /** * ReplicaSet Id */ replicaSetId: string; /** * Status of Domain Service instance */ serviceStatus: string; /** * The name of the virtual network that Domain Services will be deployed on. The id of the subnet that Domain Services will be deployed on. /virtualNetwork/vnetName/subnets/subnetName. */ subnetId?: string; /** * Virtual network site id */ vnetSiteId: string; } /** * Settings for Resource Forest */ interface ResourceForestSettingsResponse { /** * Resource Forest */ resourceForest?: string; /** * List of settings for Resource Forest */ settings?: outputs.aad.ForestTrustResponse[]; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace aadiam { /** * Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular log. */ interface LogSettingsResponse { /** * Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. */ category?: string; /** * A value indicating whether this log is enabled. */ enabled: boolean; /** * The retention policy for this log. */ retentionPolicy?: outputs.aadiam.RetentionPolicyResponse; } /** * Specifies the retention policy for the log. */ interface RetentionPolicyResponse { /** * The number of days for the retention in days. A value of 0 will retain the events indefinitely. */ days: number; /** * A value indicating whether the retention policy is enabled. */ enabled: boolean; } } export declare namespace advisor { /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace agfoodplatform { /** * ApiKeyAuthCredentials class for ApiKey based Auth. */ interface ApiKeyAuthCredentialsResponse { /** * Properties of the key vault. */ apiKey: outputs.agfoodplatform.KeyVaultPropertiesResponse; /** * Enum for different types of AuthCredentials supported. * Expected value is 'ApiKeyAuthCredentials'. */ kind: "ApiKeyAuthCredentials"; } /** * Api properties. */ interface ApiPropertiesResponse { /** * Interval in minutes for which the weather data for the api needs to be refreshed. */ apiFreshnessTimeInMinutes?: number; } /** * DataConnector Properties. */ interface DataConnectorPropertiesResponse { /** * AuthCredentials abstract base class for Auth Purpose. */ credentials: outputs.agfoodplatform.ApiKeyAuthCredentialsResponse | outputs.agfoodplatform.OAuthClientCredentialsResponse; } /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.agfoodplatform.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.agfoodplatform.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */ interface ErrorResponseResponse { /** * The error object. */ error?: outputs.agfoodplatform.ErrorDetailResponse; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. The value must be an UUID. */ principalId: string; /** * The tenant ID of resource. The value must be an UUID. */ tenantId: string; /** * The identity type. */ type?: string; } /** * Properties of the key vault. */ interface KeyVaultPropertiesResponse { /** * Name of Key Vault key. */ keyName: string; /** * Uri of the key vault. */ keyVaultUri: string; /** * Version of Key Vault key. */ keyVersion: string; } /** * OAuthClientCredentials for clientId clientSecret auth. */ interface OAuthClientCredentialsResponse { /** * ClientId associated with the provider. */ clientId: string; /** * Properties of the key vault. */ clientSecret: outputs.agfoodplatform.KeyVaultPropertiesResponse; /** * Enum for different types of AuthCredentials supported. * Expected value is 'OAuthClientCredentials'. */ kind: "OAuthClientCredentials"; } /** * The private endpoint connection resource. */ interface PrivateEndpointConnectionResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint resource. */ privateEndpoint?: outputs.agfoodplatform.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.agfoodplatform.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.agfoodplatform.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Sensor integration request model. */ interface SensorIntegrationResponse { /** * Sensor integration enable state. */ enabled?: string; /** * Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */ provisioningInfo?: outputs.agfoodplatform.ErrorResponseResponse; /** * Sensor integration instance provisioning state. */ provisioningState: string; } /** * Solution resource properties. */ interface SolutionPropertiesResponse { /** * SaaS application Marketplace Publisher Id. */ marketplacePublisherId: string; /** * SaaS application Offer Id. */ offerId: string; /** * Partner Id of the Solution. */ partnerId: string; /** * SaaS application Plan Id. */ planId: string; /** * Role Assignment Id. */ roleAssignmentId?: string; /** * SaaS subscriptionId of the installed SaaS application. */ saasSubscriptionId: string; /** * SaaS subscription name of the installed SaaS application. */ saasSubscriptionName: string; /** * SaaS application Term Id. */ termId: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace agricultureplatform { /** * Config of the AgriService resource instance. */ interface AgriServiceConfigResponse { /** * App service resource Id. */ appServiceResourceId: string; /** * Cosmos Db resource Id. */ cosmosDbResourceId: string; /** * Instance URI of the AgriService instance. */ instanceUri: string; /** * Key vault resource Id. */ keyVaultResourceId: string; /** * Redis cache resource Id. */ redisCacheResourceId: string; /** * Storage account resource Id. */ storageAccountResourceId: string; /** * Version of AgriService instance. */ version: string; } /** * Details of the Agriculture AgriDataManager. */ interface AgriServiceResourcePropertiesResponse { /** * Config of the AgriService instance. */ config?: outputs.agricultureplatform.AgriServiceConfigResponse; /** * Data connector credentials of AgriService instance. */ dataConnectorCredentials?: outputs.agricultureplatform.DataConnectorCredentialMapResponse[]; /** * AgriService installed solutions. */ installedSolutions?: outputs.agricultureplatform.InstalledSolutionMapResponse[]; /** * Managed On Behalf Of Configuration. */ managedOnBehalfOfConfiguration: outputs.agricultureplatform.ManagedOnBehalfOfConfigurationResponse; /** * The status of the last operation. */ provisioningState: string; } /** * Mapping of data connector credentials. */ interface DataConnectorCredentialMapResponse { /** * The key representing the credential. */ key: string; /** * The data connector credential value. */ value: outputs.agricultureplatform.DataConnectorCredentialsResponse; } /** * The properties related to an AgriService data connector. */ interface DataConnectorCredentialsResponse { /** * Client Id associated with the provider, if type of credentials is OAuthClientCredentials. */ clientId?: string; /** * Name of the key vault key. */ keyName?: string; /** * Uri of the key vault */ keyVaultUri?: string; /** * Version of the key vault key. */ keyVersion?: string; /** * Type of credential. */ kind?: string; } /** * Data Manager for Agriculture solution. */ interface DataManagerForAgricultureSolutionResponse { /** * Entra application Id used to access azure data manager for agriculture instance. */ accessAzureDataManagerForAgricultureApplicationId: string; /** * Entra application name used to access azure data manager for agriculture instance. */ accessAzureDataManagerForAgricultureApplicationName: string; /** * Data access scopes. */ dataAccessScopes: string[]; /** * Whether solution inference will validate input. */ isValidateInput: boolean; /** * Marketplace offer details. */ marketPlaceOfferDetails: outputs.agricultureplatform.MarketPlaceOfferDetailsResponse; /** * Partner Id. */ partnerId: string; /** * Partner tenant Id. */ partnerTenantId: string; /** * Saas application Id. */ saasApplicationId: string; /** * Solution Id. */ solutionId: string; } /** * Mapping of installed solutions. */ interface InstalledSolutionMapResponse { /** * The key representing the installed solution. */ key: string; /** * The installed solution value. */ value: outputs.agricultureplatform.SolutionResponse; } /** * Configuration of the managed on behalf of resource. */ interface ManagedOnBehalfOfConfigurationResponse { /** * Associated MoboBrokerResources. */ moboBrokerResources: outputs.agricultureplatform.MoboBrokerResourceResponse[]; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.agricultureplatform.UserAssignedIdentityResponse; }; } /** * Marketplace offer details of Agri solution. */ interface MarketPlaceOfferDetailsResponse { /** * Publisher Id. */ publisherId: string; /** * Saas offer Id. */ saasOfferId: string; } /** * MoboBroker resource. */ interface MoboBrokerResourceResponse { /** * The fully qualified resource ID of the MoboBroker resource. * Example: `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}` */ id: string; } /** * The resource model definition representing SKU */ interface SkuResponse { /** * If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. */ capacity?: number; /** * If the service has different generations of hardware, for the same SKU, then that can be captured here. */ family?: string; /** * The name of the SKU. E.g. P3. It is typically a letter+number code */ name: string; /** * The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. */ size?: string; /** * This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. */ tier?: string; } /** * Installed data manager for Agriculture solution detail. */ interface SolutionResponse { /** * Application name of the solution. */ applicationName?: string; /** * Marketplace publisher Id. */ marketPlacePublisherId?: string; /** * Partner Id. */ partnerId?: string; /** * Plan Id. */ planId?: string; /** * Saas subscription Id. */ saasSubscriptionId?: string; /** * Saas subscription name. */ saasSubscriptionName?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace alertsmanagement { /** * Action rule with action group configuration */ interface ActionGroupResponse { /** * Action group to trigger if action rule matches */ actionGroupId: string; /** * conditions on which alerts will be filtered */ conditions?: outputs.alertsmanagement.ConditionsResponse; /** * Creation time of action rule. Date-Time in ISO-8601 format. */ createdAt: string; /** * Created by user name. */ createdBy: string; /** * Description of action rule */ description?: string; /** * Last updated time of action rule. Date-Time in ISO-8601 format. */ lastModifiedAt: string; /** * Last modified by user name. */ lastModifiedBy: string; /** * scope on which action rule will apply */ scope?: outputs.alertsmanagement.ScopeResponse; /** * Indicates if the given action rule is enabled or disabled */ status?: string; /** * Indicates type of action rule * Expected value is 'ActionGroup'. */ type: "ActionGroup"; } /** * The Action Groups information, used by the alert rule. */ interface ActionGroupsInformationResponse { /** * An optional custom email subject to use in email notifications. */ customEmailSubject?: string; /** * An optional custom web-hook payload to use in web-hook notifications. */ customWebhookPayload?: string; /** * The Action Group resource IDs. */ groupIds: string[]; } /** * Add action groups to alert processing rule. */ interface AddActionGroupsResponse { /** * List of action group Ids to add to alert processing rule. */ actionGroupIds: string[]; /** * Action that should be applied. * Expected value is 'AddActionGroups'. */ actionType: "AddActionGroups"; } /** * Alert processing rule properties defining scopes, conditions and scheduling logic for alert processing rule. */ interface AlertProcessingRulePropertiesResponse { /** * Actions to be applied. */ actions: (outputs.alertsmanagement.AddActionGroupsResponse | outputs.alertsmanagement.RemoveAllActionGroupsResponse)[]; /** * Conditions on which alerts will be filtered. */ conditions?: outputs.alertsmanagement.ConditionAlertProcessingRuleByNameResponse[]; /** * Actions to be applied.Description of alert processing rule. */ description?: string; /** * Indicates if the given alert processing rule is enabled or disabled. */ enabled?: boolean; /** * Scheduling for alert processing rule. */ schedule?: outputs.alertsmanagement.ScheduleResponse; /** * Scopes on which alert processing rule will apply. */ scopes: string[]; } /** * alertProcessingRulePropertiesResponseProvideDefaults sets the appropriate defaults for AlertProcessingRulePropertiesResponse */ function alertProcessingRulePropertiesResponseProvideDefaults(val: AlertProcessingRulePropertiesResponse): AlertProcessingRulePropertiesResponse; /** * Condition to trigger an alert processing rule. */ interface ConditionAlertProcessingRuleByNameResponse { /** * Field for a given condition. */ field?: string; /** * Operator for a given condition. */ operator?: string; /** * List of values to match for a given condition. */ values?: string[]; } /** * condition to trigger an action rule */ interface ConditionResponse { /** * operator for a given condition */ operator?: string; /** * list of values to match for a given condition. */ values?: string[]; } /** * Conditions in alert instance to be matched for a given action rule. Default value is all. Multiple values could be provided with comma separation. */ interface ConditionsResponse { /** * filter alerts by alert context (payload) */ alertContext?: outputs.alertsmanagement.ConditionResponse; /** * filter alerts by alert rule id */ alertRuleId?: outputs.alertsmanagement.ConditionResponse; /** * filter alerts by alert rule name */ alertRuleName?: outputs.alertsmanagement.ConditionResponse; /** * filter alerts by alert rule description */ description?: outputs.alertsmanagement.ConditionResponse; /** * filter alerts by monitor condition */ monitorCondition?: outputs.alertsmanagement.ConditionResponse; /** * filter alerts by monitor service */ monitorService?: outputs.alertsmanagement.ConditionResponse; /** * filter alerts by severity */ severity?: outputs.alertsmanagement.ConditionResponse; /** * filter alerts by target resource type */ targetResourceType?: outputs.alertsmanagement.ConditionResponse; } /** * Daily recurrence object. */ interface DailyRecurrenceResponse { /** * End time for recurrence. */ endTime?: string; /** * Specifies when the recurrence should be applied. * Expected value is 'Daily'. */ recurrenceType: "Daily"; /** * Start time for recurrence. */ startTime?: string; } /** * The detector parameter definition. */ interface DetectorParameterDefinitionResponse { /** * The detector parameter description. */ description?: string; /** * The detector parameter display name. */ displayName?: string; /** * A value indicating whether this detector parameter is mandatory. */ isMandatory?: boolean; /** * The detector parameter name. */ name?: string; /** * The detector parameter type. */ type?: string; } /** * The detector information. By default this is not populated, unless it's specified in expandDetector */ interface DetectorResponse { /** * The Smart Detector description. */ description: string; /** * The detector id. */ id: string; /** * The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector */ imagePaths: string[]; /** * The Smart Detector name. */ name: string; /** * The Smart Detector parameters definitions.' */ parameterDefinitions: outputs.alertsmanagement.DetectorParameterDefinitionResponse[]; /** * The detector's parameters.' */ parameters?: { [key: string]: any; }; /** * The Smart Detector supported cadences. */ supportedCadences: number[]; /** * The Smart Detector supported resource types. */ supportedResourceTypes: string[]; } /** * Action rule with diagnostics configuration */ interface DiagnosticsResponse { /** * conditions on which alerts will be filtered */ conditions?: outputs.alertsmanagement.ConditionsResponse; /** * Creation time of action rule. Date-Time in ISO-8601 format. */ createdAt: string; /** * Created by user name. */ createdBy: string; /** * Description of action rule */ description?: string; /** * Last updated time of action rule. Date-Time in ISO-8601 format. */ lastModifiedAt: string; /** * Last modified by user name. */ lastModifiedBy: string; /** * scope on which action rule will apply */ scope?: outputs.alertsmanagement.ScopeResponse; /** * Indicates if the given action rule is enabled or disabled */ status?: string; /** * Indicates type of action rule * Expected value is 'Diagnostics'. */ type: "Diagnostics"; } /** * Details about the execution of the investigation */ interface InvestigationExecutionResponse { /** * The time at which the investigation execution completed (in UTC) */ completedAt: string; /** * The state of the investigation execution */ runState: string; } /** * Properties of the current investigation */ interface InvestigationMetadataResponse { /** * The creation time of the investigation (in UTC) */ createdAt: string; /** * The execution details of the investigation */ execution: outputs.alertsmanagement.InvestigationExecutionResponse; /** * The unique identifier of the investigation */ id: string; /** * The parameters that were used to start the investigation */ runParameters: outputs.alertsmanagement.RunParametersResponse; } /** * A single scope of the investigation */ interface InvestigationScopeResponse { /** * The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID */ id: string; /** * The origin of the scope */ origin: outputs.alertsmanagement.OriginResponse; /** * The relevance of the scope */ relevance?: string; } /** * The issue properties */ interface IssuePropertiesResponse { /** * The issue impact time (in UTC) */ impactTime: string; /** * The list of investigations in the issue */ investigations: outputs.alertsmanagement.InvestigationMetadataResponse[]; /** * The number of investigations in the issue */ investigationsCount: number; /** * The provisioning state of the resource. */ provisioningState: string; /** * The issue severity */ severity: string; /** * The issue status */ status: string; /** * The issue title */ title: string; } /** * Monthly recurrence object. */ interface MonthlyRecurrenceResponse { /** * Specifies the values for monthly recurrence pattern. */ daysOfMonth: number[]; /** * End time for recurrence. */ endTime?: string; /** * Specifies when the recurrence should be applied. * Expected value is 'Monthly'. */ recurrenceType: "Monthly"; /** * Start time for recurrence. */ startTime?: string; } /** * Details about the origin of the entity - the source that added it to the issue */ interface OriginResponse { /** * The ID of the origin - for example, in case of 'Manual', the object ID of the identity, and in case of 'Automatic', the name of the automatic system */ addedBy: string; /** * The source of the origin - Manual or Automatic */ addedByType: string; } /** * An alert action. Only relevant for alerts. */ interface PrometheusRuleGroupActionResponse { /** * The resource id of the action group to use. */ actionGroupId?: string; /** * The properties of an action group object. */ actionProperties?: { [key: string]: string; }; } /** * Specifies the Prometheus alert rule configuration. */ interface PrometheusRuleResolveConfigurationResponse { /** * Enable alert auto-resolution. */ autoResolved?: boolean; /** * Alert auto-resolution timeout. */ timeToResolve?: string; } /** * An Azure Prometheus alerting or recording rule. */ interface PrometheusRuleResponse { /** * Actions that are performed when the alert rule becomes active, and when an alert condition is resolved. */ actions?: outputs.alertsmanagement.PrometheusRuleGroupActionResponse[]; /** * Alert rule name. */ alert?: string; /** * The annotations clause specifies a set of informational labels that can be used to store longer additional information such as alert descriptions or runbook links. The annotation values can be templated. */ annotations?: { [key: string]: string; }; /** * Enable/disable rule. */ enabled?: boolean; /** * The PromQL expression to evaluate. https://prometheus.io/docs/prometheus/latest/querying/basics/. Evaluated periodically as given by 'interval', and the result recorded as a new set of time series with the metric name as given by 'record'. */ expression: string; /** * The amount of time alert must be active before firing. */ for?: string; /** * Labels to add or overwrite before storing the result. */ labels?: { [key: string]: string; }; /** * Recorded metrics name. */ record?: string; /** * Defines the configuration for resolving fired alerts. Only relevant for alerts. */ resolveConfiguration?: outputs.alertsmanagement.PrometheusRuleResolveConfigurationResponse; /** * The severity of the alerts fired by the rule. Must be between 0 and 4. */ severity?: number; } /** * Properties of an alert which is related to the issue */ interface RelatedAlertResponse { /** * The time this relation was added to the issue (in UTC) */ addedAt: string; /** * The alert ID */ id: string; /** * The last update time of this relation (in UTC) */ lastModifiedAt: string; /** * The source that related the alert to the issue */ origin: outputs.alertsmanagement.OriginResponse; /** * The alerts's relevance status */ relevance: string; } /** * Properties of a resource which is related to the issue */ interface RelatedResourceResponse { /** * The time this relation was added to the issue (in UTC) */ addedAt: string; /** * The resource ID */ id: string; /** * The last update time of this relation (in UTC) */ lastModifiedAt: string; /** * The source that related the resource to the issue */ origin: outputs.alertsmanagement.OriginResponse; /** * The resource's relevance status */ relevance: string; } /** * Indicates if all action groups should be removed. */ interface RemoveAllActionGroupsResponse { /** * Action that should be applied. * Expected value is 'RemoveAllActionGroups'. */ actionType: "RemoveAllActionGroups"; } /** * The parameters used to run the investigation */ interface RunParametersResponse { /** * The alerts used to run the investigation */ alerts: outputs.alertsmanagement.InvestigationScopeResponse[]; /** * The impact time to investigate (in UTC) */ impactTime: string; /** * The resources used to run the investigation */ resources: outputs.alertsmanagement.InvestigationScopeResponse[]; } /** * Scheduling configuration for a given alert processing rule. */ interface ScheduleResponse { /** * Scheduling effective from time. Date-Time in ISO-8601 format without timezone suffix. */ effectiveFrom?: string; /** * Scheduling effective until time. Date-Time in ISO-8601 format without timezone suffix. */ effectiveUntil?: string; /** * List of recurrences. */ recurrences?: (outputs.alertsmanagement.DailyRecurrenceResponse | outputs.alertsmanagement.MonthlyRecurrenceResponse | outputs.alertsmanagement.WeeklyRecurrenceResponse)[]; /** * Scheduling time zone. */ timeZone?: string; } /** * Target scope for a given action rule. By default scope will be the subscription. User can also provide list of resource groups or list of resources from the scope subscription as well. */ interface ScopeResponse { /** * type of target scope */ scopeType?: string; /** * list of ARM IDs of the given scope type which will be the target of the given action rule. */ values?: string[]; } /** * Suppression logic for a given action rule */ interface SuppressionConfigResponse { /** * Specifies when the suppression should be applied */ recurrenceType: string; /** * suppression schedule configuration */ schedule?: outputs.alertsmanagement.SuppressionScheduleResponse; } /** * Action rule with suppression configuration */ interface SuppressionResponse { /** * conditions on which alerts will be filtered */ conditions?: outputs.alertsmanagement.ConditionsResponse; /** * Creation time of action rule. Date-Time in ISO-8601 format. */ createdAt: string; /** * Created by user name. */ createdBy: string; /** * Description of action rule */ description?: string; /** * Last updated time of action rule. Date-Time in ISO-8601 format. */ lastModifiedAt: string; /** * Last modified by user name. */ lastModifiedBy: string; /** * scope on which action rule will apply */ scope?: outputs.alertsmanagement.ScopeResponse; /** * Indicates if the given action rule is enabled or disabled */ status?: string; /** * suppression configuration for the action rule */ suppressionConfig: outputs.alertsmanagement.SuppressionConfigResponse; /** * Indicates type of action rule * Expected value is 'Suppression'. */ type: "Suppression"; } /** * Schedule for a given suppression configuration. */ interface SuppressionScheduleResponse { /** * End date for suppression */ endDate?: string; /** * End date for suppression */ endTime?: string; /** * Specifies the values for recurrence pattern */ recurrenceValues?: number[]; /** * Start date for suppression */ startDate?: string; /** * Start time for suppression */ startTime?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Optional throttling information for the alert rule. */ interface ThrottlingInformationResponse { /** * The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes */ duration?: string; } /** * Weekly recurrence object. */ interface WeeklyRecurrenceResponse { /** * Specifies the values for weekly recurrence pattern. */ daysOfWeek: string[]; /** * End time for recurrence. */ endTime?: string; /** * Specifies when the recurrence should be applied. * Expected value is 'Weekly'. */ recurrenceType: "Weekly"; /** * Start time for recurrence. */ startTime?: string; } } export declare namespace analysisservices { /** * The gateway details. */ interface GatewayDetailsResponse { /** * Uri of the DMTS cluster. */ dmtsClusterUri: string; /** * Gateway object id from in the DMTS cluster for the gateway resource. */ gatewayObjectId: string; /** * Gateway resource to be associated with the server. */ gatewayResourceId?: string; } /** * The detail of firewall rule. */ interface IPv4FirewallRuleResponse { /** * The rule name. */ firewallRuleName?: string; /** * The end range of IPv4. */ rangeEnd?: string; /** * The start range of IPv4. */ rangeStart?: string; } /** * An array of firewall rules. */ interface IPv4FirewallSettingsResponse { /** * The indicator of enabling PBI service. */ enablePowerBIService?: boolean; /** * An array of firewall rules. */ firewallRules?: outputs.analysisservices.IPv4FirewallRuleResponse[]; } /** * Represents the SKU name and Azure pricing tier for Analysis Services resource. */ interface ResourceSkuResponse { /** * The number of instances in the read only query pool. */ capacity?: number; /** * Name of the SKU level. */ name: string; /** * The name of the Azure pricing tier to which the SKU applies. */ tier?: string; } /** * resourceSkuResponseProvideDefaults sets the appropriate defaults for ResourceSkuResponse */ function resourceSkuResponseProvideDefaults(val: ResourceSkuResponse): ResourceSkuResponse; /** * An array of administrator user identities. */ interface ServerAdministratorsResponse { /** * An array of administrator user identities. */ members?: string[]; } } export declare namespace apicenter { /** * API specification details. */ interface ApiDefinitionPropertiesSpecificationResponse { /** * Specification name. */ name?: string; /** * Specification version. */ version?: string; } /** * API source configuration for Azure API Management. */ interface AzureApiManagementSourceResponse { /** * The resource ID of the managed identity that has access to the API Management instance. */ msiResourceId?: string; /** * API Management service resource ID. */ resourceId: string; } /** * Contact information */ interface ContactResponse { /** * Email address of the contact. */ email?: string; /** * Name of the contact. */ name?: string; /** * URL for the contact. */ url?: string; } /** * Server */ interface DeploymentServerResponse { /** * Base runtime URLs for this deployment. */ runtimeUri?: string[]; } /** * Server information of the environment. */ interface EnvironmentServerResponse { /** * The location of the management portal */ managementPortalUri?: string[]; /** * Type of the server that represents the environment. */ type?: string; } /** * Additional, external documentation for the API. */ interface ExternalDocumentationResponse { /** * Description of the documentation. */ description?: string; /** * Title of the documentation. */ title?: string; /** * URL pointing to the documentation. */ url: string; } /** * The license information for the API. */ interface LicenseResponse { /** * SPDX license information for the API. The identifier field is mutually * exclusive of the URL field. */ identifier?: string; /** * Name of the license. */ name?: string; /** * URL pointing to the license details. The URL field is mutually exclusive of the * identifier field. */ url?: string; } /** * The link state. */ interface LinkStateResponse { /** * The timestamp of the last update of the link state. */ lastUpdatedOn: string; /** * The state message. */ message?: string; /** * The state of the link. */ state?: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.apicenter.UserAssignedIdentityResponse; }; } /** * Assignment metadata */ interface MetadataAssignmentResponse { /** * Deprecated assignment */ deprecated?: boolean; /** * The entities this metadata schema component gets applied to. */ entity?: string; /** * Required assignment */ required?: boolean; } /** * Onboarding information */ interface OnboardingResponse { /** * The location of the development portal */ developerPortalUri?: string[]; /** * Onboarding guide. */ instructions?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Terms of service for the API. */ interface TermsOfServiceResponse { /** * URL pointing to the terms of service. */ url: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace apimanagement { /** * Description of an additional API Management resource location. */ interface AdditionalLocationResponse { /** * Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location. */ disableGateway?: boolean; /** * Gateway URL of the API Management service in the Region. */ gatewayRegionalUrl: string; /** * The location name of the additional region among Azure Data center regions. */ location: string; /** * Property can be used to enable NAT Gateway for this API Management service. */ natGatewayState?: string; /** * Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available only for Premium SKU on stv2 platform. */ outboundPublicIPAddresses: string[]; /** * Compute Platform Version running the service. */ platformVersion: string; /** * Private Static Load Balanced IP addresses of the API Management service which is deployed in an Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated SKU. */ privateIPAddresses: string[]; /** * Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU. */ publicIPAddresses: string[]; /** * Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in the location. Supported only for Premium SKU being deployed in Virtual Network. */ publicIpAddressId?: string; /** * SKU properties of the API Management service. */ sku: outputs.apimanagement.ApiManagementServiceSkuPropertiesResponse; /** * Virtual network configuration for the location. */ virtualNetworkConfiguration?: outputs.apimanagement.VirtualNetworkConfigurationResponse; /** * A list of availability zones denoting where the resource needs to come from. */ zones?: string[]; } /** * additionalLocationResponseProvideDefaults sets the appropriate defaults for AdditionalLocationResponse */ function additionalLocationResponseProvideDefaults(val: AdditionalLocationResponse): AdditionalLocationResponse; /** * API contact information */ interface ApiContactInformationResponse { /** * The email address of the contact person/organization. MUST be in the format of an email address */ email?: string; /** * The identifying name of the contact person/organization */ name?: string; /** * The URL pointing to the contact information. MUST be in the format of a URL */ url?: string; } /** * API license information */ interface ApiLicenseInformationResponse { /** * The license name used for the API */ name?: string; /** * A URL to the license used for the API. MUST be in the format of a URL */ url?: string; } /** * API Management gateway resource SKU properties. */ interface ApiManagementGatewaySkuPropertiesResponse { /** * Capacity of the SKU (number of deployed units of the SKU) */ capacity?: number; /** * Name of the Sku. */ name: string; } /** * Identity properties of the Api Management service resource. */ interface ApiManagementServiceIdentityResponse { /** * The principal id of the identity. */ principalId: string; /** * The client tenant id of the identity. */ tenantId: string; /** * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. */ type: string; /** * The list of user identities associated with the resource. The user identity * dictionary key references will be ARM resource ids in the form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ * providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.apimanagement.UserIdentityPropertiesResponse; }; } /** * API Management service resource SKU properties. */ interface ApiManagementServiceSkuPropertiesResponse { /** * Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. */ capacity: number; /** * Name of the Sku. */ name: string; } /** * Control Plane Apis version constraint for the API Management service. */ interface ApiVersionConstraintResponse { /** * Limit control plane API calls to API Management service with version equal to or newer than this value. */ minApiVersion?: string; } /** * An API Version Set contains the common configuration for a set of API Versions relating */ interface ApiVersionSetContractDetailsResponse { /** * Description of API Version Set. */ description?: string; /** * Identifier for existing API Version Set. Omit this value to create a new Version Set. */ id?: string; /** * The display Name of the API Version Set. */ name?: string; /** * Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`. */ versionHeaderName?: string; /** * Name of query parameter that indicates the API Version if versioningScheme is set to `query`. */ versionQueryName?: string; /** * An value that determines where the API Version identifier will be located in a HTTP request. */ versioningScheme?: string; } /** * A wrapper for an ARM resource id */ interface ArmIdWrapperResponse { id: string; } /** * API Authentication Settings. */ interface AuthenticationSettingsContractResponse { /** * OAuth2 Authentication settings */ oAuth2?: outputs.apimanagement.OAuth2AuthenticationSettingsContractResponse; /** * Collection of OAuth2 authentication settings included into this API. */ oAuth2AuthenticationSettings?: outputs.apimanagement.OAuth2AuthenticationSettingsContractResponse[]; /** * OpenID Connect Authentication Settings */ openid?: outputs.apimanagement.OpenIdAuthenticationSettingsContractResponse; /** * Collection of Open ID Connect authentication settings included into this API. */ openidAuthenticationSettings?: outputs.apimanagement.OpenIdAuthenticationSettingsContractResponse[]; } /** * Authorization error details. */ interface AuthorizationErrorResponse { /** * Error code */ code?: string; /** * Error message */ message?: string; } /** * Authorization Provider oauth2 grant types settings */ interface AuthorizationProviderOAuth2GrantTypesResponse { /** * OAuth2 authorization code grant parameters */ authorizationCode?: { [key: string]: string; }; /** * OAuth2 client credential grant parameters */ clientCredentials?: { [key: string]: string; }; } /** * OAuth2 settings details */ interface AuthorizationProviderOAuth2SettingsResponse { /** * OAuth2 settings */ grantTypes?: outputs.apimanagement.AuthorizationProviderOAuth2GrantTypesResponse; /** * Redirect URL to be set in the OAuth application. */ redirectUrl?: string; } /** * Authorization header information. */ interface BackendAuthorizationHeaderCredentialsResponse { /** * Authentication Parameter value. */ parameter: string; /** * Authentication Scheme name. */ scheme: string; } interface BackendBaseParametersResponsePool { /** * The list of backend entities belonging to a pool. */ services?: outputs.apimanagement.BackendPoolItemResponse[]; } /** * The configuration of the backend circuit breaker */ interface BackendCircuitBreakerResponse { /** * The rules for tripping the backend. */ rules?: outputs.apimanagement.CircuitBreakerRuleResponse[]; } /** * Information regarding how the gateway should integrate with backend systems. */ interface BackendConfigurationResponse { /** * The default hostname of the data-plane gateway to which requests can be sent. */ subnet?: outputs.apimanagement.BackendSubnetConfigurationResponse; } /** * Details of the Credentials used to connect to Backend. */ interface BackendCredentialsContractResponse { /** * Authorization header authentication */ authorization?: outputs.apimanagement.BackendAuthorizationHeaderCredentialsResponse; /** * List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided. */ certificate?: string[]; /** * List of Client Certificate Ids. */ certificateIds?: string[]; /** * Header Parameter description. */ header?: { [key: string]: string[]; }; /** * Query Parameter description. */ query?: { [key: string]: string[]; }; } /** * Backend pool service information */ interface BackendPoolItemResponse { /** * The unique ARM id of the backend entity. The ARM id should refer to an already existing backend entity. */ id: string; /** * The priority of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified. */ priority?: number; /** * The weight of the backend entity in the backend pool. Must be between 0 and 100. It can be also null if the value not specified. */ weight?: number; } /** * Properties specific to the Backend Type. */ interface BackendPropertiesResponse { /** * Backend Service Fabric Cluster Properties */ serviceFabricCluster?: outputs.apimanagement.BackendServiceFabricClusterPropertiesResponse; } /** * Details of the Backend WebProxy Server to use in the Request to Backend. */ interface BackendProxyContractResponse { /** * Password to connect to the WebProxy Server */ password?: string; /** * WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. */ url: string; /** * Username to connect to the WebProxy server */ username?: string; } /** * Properties of the Service Fabric Type Backend. */ interface BackendServiceFabricClusterPropertiesResponse { /** * The client certificate id for the management endpoint. */ clientCertificateId?: string; /** * The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided */ clientCertificatethumbprint?: string; /** * The cluster management endpoint. */ managementEndpoints: string[]; /** * Maximum number of retries while attempting resolve the partition. */ maxPartitionResolutionRetries?: number; /** * Thumbprints of certificates cluster management service uses for tls communication */ serverCertificateThumbprints?: string[]; /** * Server X509 Certificate Names Collection */ serverX509Names?: outputs.apimanagement.X509CertificateNameResponse[]; } /** * Information regarding how the subnet to which the gateway should be injected. */ interface BackendSubnetConfigurationResponse { /** * The ARM ID of the subnet in which the backend systems are hosted. */ id?: string; } /** * Properties controlling TLS Certificate Validation. */ interface BackendTlsPropertiesResponse { /** * Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host. */ validateCertificateChain?: boolean; /** * Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host. */ validateCertificateName?: boolean; } /** * backendTlsPropertiesResponseProvideDefaults sets the appropriate defaults for BackendTlsPropertiesResponse */ function backendTlsPropertiesResponseProvideDefaults(val: BackendTlsPropertiesResponse): BackendTlsPropertiesResponse; /** * Body logging settings. */ interface BodyDiagnosticSettingsResponse { /** * Number of request body bytes to log. */ bytes?: number; } /** * Certificate configuration which consist of non-trusted intermediates and root certificates. */ interface CertificateConfigurationResponse { /** * Certificate information. */ certificate?: outputs.apimanagement.CertificateInformationResponse; /** * Certificate Password. */ certificatePassword?: string; /** * Base64 Encoded certificate. */ encodedCertificate?: string; /** * The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. */ storeName: string; } /** * SSL certificate information. */ interface CertificateInformationResponse { /** * Expiration date of the certificate. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. */ expiry: string; /** * Subject of the certificate. */ subject: string; /** * Thumbprint of the certificate. */ thumbprint: string; } /** * The trip conditions of the circuit breaker */ interface CircuitBreakerFailureConditionResponse { /** * The threshold for opening the circuit. */ count?: number; /** * The error reasons which are considered as failure. */ errorReasons?: string[]; /** * The interval during which the failures are counted. */ interval?: string; /** * The threshold for opening the circuit. */ percentage?: number; /** * The status code ranges which are considered as failure. */ statusCodeRanges?: outputs.apimanagement.FailureStatusCodeRangeResponse[]; } /** * Rule configuration to trip the backend. */ interface CircuitBreakerRuleResponse { /** * flag to accept Retry-After header from the backend. */ acceptRetryAfter?: boolean; /** * The conditions for tripping the circuit breaker. */ failureCondition?: outputs.apimanagement.CircuitBreakerFailureConditionResponse; /** * The rule name. */ name?: string; /** * The duration for which the circuit will be tripped. */ tripDuration?: string; } /** * Microsoft EntraID client application secrets */ interface ClientApplicationSecretsContractResponseEntra { /** * EntraID client application secret */ clientSecret?: string; /** * EntraID client application secret expiration date. */ expiresAt: string; } /** * Information regarding the Configuration API of the API Management service. */ interface ConfigurationApiResponse { /** * Indication whether or not the legacy Configuration API (v1) should be exposed on the API Management service. Value is optional but must be 'Enabled' or 'Disabled'. If 'Disabled', legacy Configuration API (v1) will not be available for self-hosted gateways. Default value is 'Enabled' */ legacyApi?: string; } /** * configurationApiResponseProvideDefaults sets the appropriate defaults for ConfigurationApiResponse */ function configurationApiResponseProvideDefaults(val: ConfigurationApiResponse): ConfigurationApiResponse; interface DataMaskingEntityResponse { /** * Data masking mode. */ mode?: string; /** * The name of an entity to mask (e.g. a name of a header or a query parameter). */ value?: string; } interface DataMaskingResponse { /** * Masking settings for headers */ headers?: outputs.apimanagement.DataMaskingEntityResponse[]; /** * Masking settings for Url query parameters */ queryParams?: outputs.apimanagement.DataMaskingEntityResponse[]; } /** * Email Template Parameter contract. */ interface EmailTemplateParametersContractPropertiesResponse { /** * Template parameter description. */ description?: string; /** * Template parameter name. */ name?: string; /** * Template parameter title. */ title?: string; } /** * The failure http status code range */ interface FailureStatusCodeRangeResponse { /** * The maximum http status code. */ max?: number; /** * The minimum http status code. */ min?: number; } /** * Information regarding how the gateway should be exposed. */ interface FrontendConfigurationResponse { /** * The default hostname of the data-plane gateway to which requests can be sent. This is only applicable for API gateway with Standard SKU. */ defaultHostname: string; } /** * Information regarding the Configuration API of the API Management gateway. This is only applicable for API gateway with Standard SKU. */ interface GatewayConfigurationApiResponse { /** * Hostname to which the agent connects to propagate configuration to the cloud. */ hostname: string; } interface GatewayHostnameBindingCertificateResponse { /** * The expiration date of the certificate. */ expiry: string; /** * The subject of the certificate. */ subject: string; /** * The thumbprint of the certificate. */ thumbprint: string; } interface GatewayHostnameBindingKeyVaultLastStatusResponse { /** * The last status of the Key Vault certificate fetch process. */ code: string; /** * The last time the Key Vault certificate fetch process was successful. Only when the fetch process has succeeded at least once and current state is failed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. */ lastSuccessTimeStampUtc: string; /** * The last time the Key Vault certificate fetch process was attempted. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. */ timeStampUtc: string; } interface GatewayHostnameBindingKeyVaultResponse { /** * The default hostname of the data-plane gateway. */ identityClientId?: string; /** * The last status of the Key Vault certificate fetch process. */ lastStatus?: outputs.apimanagement.GatewayHostnameBindingKeyVaultLastStatusResponse; /** * The current provisioning state of the API Management gateway hostname binding. */ secretId: string; } /** * Group contract Properties. */ interface GroupContractPropertiesResponse { /** * true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. */ builtIn: boolean; /** * Group description. Can contain HTML formatting tags. */ description?: string; /** * Group name. */ displayName: string; /** * For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory `aad://.onmicrosoft.com/groups/`; otherwise the value is null. */ externalId?: string; /** * Group type. */ type?: string; } /** * Custom hostname configuration. */ interface HostnameConfigurationResponse { /** * Certificate information. */ certificate?: outputs.apimanagement.CertificateInformationResponse; /** * Certificate Password. */ certificatePassword?: string; /** * Certificate Source. */ certificateSource?: string; /** * Certificate Status. */ certificateStatus?: string; /** * Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The setting only applied to gateway Hostname Type. */ defaultSslBinding?: boolean; /** * Base64 Encoded certificate. */ encodedCertificate?: string; /** * Hostname to configure on the Api Management service. */ hostName: string; /** * System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate. */ identityClientId?: string; /** * Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. The secret should be of type *application/x-pkcs12* */ keyVaultId?: string; /** * Specify true to always negotiate client certificate on the hostname. Default Value is false. */ negotiateClientCertificate?: boolean; /** * Hostname type. */ type: string; } /** * hostnameConfigurationResponseProvideDefaults sets the appropriate defaults for HostnameConfigurationResponse */ function hostnameConfigurationResponseProvideDefaults(val: HostnameConfigurationResponse): HostnameConfigurationResponse; /** * Http message diagnostic settings. */ interface HttpMessageDiagnosticResponse { /** * Body logging settings. */ body?: outputs.apimanagement.BodyDiagnosticSettingsResponse; /** * Data masking settings. */ dataMasking?: outputs.apimanagement.DataMaskingResponse; /** * Array of HTTP Headers to log. */ headers?: string[]; } /** * KeyVault contract details. */ interface KeyVaultContractPropertiesResponse { /** * Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret. */ identityClientId?: string; /** * Last time sync and refresh status of secret from key vault. */ lastStatus?: outputs.apimanagement.KeyVaultLastAccessStatusContractPropertiesResponse; /** * Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi */ secretIdentifier?: string; } /** * Issue contract Update Properties. */ interface KeyVaultLastAccessStatusContractPropertiesResponse { /** * Last status code for sync and refresh of secret from key vault. */ code?: string; /** * Details of the error else empty. */ message?: string; /** * Last time secret was accessed. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. */ timeStampUtc?: string; } /** * API OAuth2 Authentication settings details. */ interface OAuth2AuthenticationSettingsContractResponse { /** * OAuth authorization server identifier. */ authorizationServerId?: string; /** * operations scope. */ scope?: string; } /** * API OAuth2 Authentication settings details. */ interface OpenIdAuthenticationSettingsContractResponse { /** * How to send token to the server. */ bearerTokenSendingMethods?: string[]; /** * OAuth authorization server identifier. */ openidProviderId?: string; } /** * Operation parameters details. */ interface ParameterContractResponse { /** * Default parameter value. */ defaultValue?: string; /** * Parameter description. */ description?: string; /** * Exampled defined for the parameter. */ examples?: { [key: string]: outputs.apimanagement.ParameterExampleContractResponse; }; /** * Parameter name. */ name: string; /** * Specifies whether parameter is required or not. */ required?: boolean; /** * Schema identifier. */ schemaId?: string; /** * Parameter type. */ type: string; /** * Type name defined by the schema. */ typeName?: string; /** * Parameter values. */ values?: string[]; } /** * Parameter example. */ interface ParameterExampleContractResponse { /** * Long description for the example */ description?: string; /** * A URL that points to the literal example */ externalValue?: string; /** * Short description for the example */ summary?: string; /** * Example value. May be a primitive value, or an object. */ value?: any; } /** * Diagnostic settings for incoming/outgoing HTTP messages to the Gateway. */ interface PipelineDiagnosticSettingsResponse { /** * Diagnostic settings for request. */ request?: outputs.apimanagement.HttpMessageDiagnosticResponse; /** * Diagnostic settings for response. */ response?: outputs.apimanagement.HttpMessageDiagnosticResponse; } /** * The Private Endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Remote Private Endpoint Connection resource. */ interface RemotePrivateEndpointConnectionWrapperResponse { /** * All the Group ids. */ groupIds: string[]; /** * Private Endpoint connection resource id */ id?: string; /** * Private Endpoint Connection Name */ name?: string; /** * The resource of private end point. */ privateEndpoint?: outputs.apimanagement.ArmIdWrapperResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.apimanagement.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Private Endpoint Connection Resource Type */ type?: string; } /** * Operation request/response representation details. */ interface RepresentationContractResponse { /** * Specifies a registered or custom content type for this representation, e.g. application/xml. */ contentType: string; /** * Exampled defined for the representation. */ examples?: { [key: string]: outputs.apimanagement.ParameterExampleContractResponse; }; /** * Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'.. */ formParameters?: outputs.apimanagement.ParameterContractResponse[]; /** * Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. */ schemaId?: string; /** * Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'. */ typeName?: string; } /** * Operation request details. */ interface RequestContractResponse { /** * Operation request description. */ description?: string; /** * Collection of operation request headers. */ headers?: outputs.apimanagement.ParameterContractResponse[]; /** * Collection of operation request query parameters. */ queryParameters?: outputs.apimanagement.ParameterContractResponse[]; /** * Collection of operation request representations. */ representations?: outputs.apimanagement.RepresentationContractResponse[]; } interface ResourceCollectionResponseValue { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Resource location data properties. */ interface ResourceLocationDataContractResponse { /** * The city or locality where the resource is located. */ city?: string; /** * The country or region where the resource is located. */ countryOrRegion?: string; /** * The district, state, or province where the resource is located. */ district?: string; /** * A canonical name for the geographic or physical location. */ name: string; } /** * Operation response details. */ interface ResponseContractResponse { /** * Operation response description. */ description?: string; /** * Collection of operation response headers. */ headers?: outputs.apimanagement.ParameterContractResponse[]; /** * Collection of operation response representations. */ representations?: outputs.apimanagement.RepresentationContractResponse[]; /** * Operation response HTTP status code. */ statusCode: number; } /** * Sampling settings for Diagnostic. */ interface SamplingSettingsResponse { /** * Rate of sampling for fixed-rate sampling. */ percentage?: number; /** * Sampling type. */ samplingType?: string; } /** * Subscription key parameter names details. */ interface SubscriptionKeyParameterNamesContractResponse { /** * Subscription key header name. */ header?: string; /** * Subscription key query string parameter name. */ query?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * OAuth acquire token request body parameter (www-url-form-encoded). */ interface TokenBodyParameterContractResponse { /** * body parameter name. */ name: string; /** * body parameter value. */ value: string; } /** * User identity details. */ interface UserIdentityContractResponse { /** * Identifier value within provider. */ id?: string; /** * Identity provider name. */ provider?: string; } interface UserIdentityPropertiesResponse { /** * The client id of user assigned identity. */ clientId?: string; /** * The principal id of user assigned identity. */ principalId?: string; } /** * Configuration of a virtual network to which API Management service is deployed. */ interface VirtualNetworkConfigurationResponse { /** * The full resource ID of a subnet in a virtual network to deploy the API Management service in. */ subnetResourceId?: string; /** * The name of the subnet. */ subnetname: string; /** * The virtual network ID. This is typically a GUID. Expect a null GUID by default. */ vnetid: string; } /** * Wiki documentation details. */ interface WikiDocumentationContractResponse { /** * Documentation Identifier */ documentationId?: string; } /** * Properties of server X509Names. */ interface X509CertificateNameResponse { /** * Thumbprint for the Issuer of the Certificate. */ issuerCertificateThumbprint?: string; /** * Common Name of the Certificate. */ name?: string; } } export declare namespace app { /** * Configuration for action */ interface ActionConfigurationResponse { /** * The access level of the action */ accessLevel?: string; /** * The identity used by the action */ identity?: string; /** * The mode of the action */ mode?: string; } /** * Agent Connector Properties */ interface AgentConnectorPropertiesResponse { /** * The type of the data connector */ dataConnectorType?: string; /** * Data source connection string or endpoint */ dataSource?: string; /** * Deployment error message if provisioning failed */ deploymentError: string; /** * Endpoint of the connector */ endpoint?: string; /** * Additional properties for the data connector which can be used to store custom key-value pairs */ extendedProperties?: any; /** * Identity used to access the data source */ identity?: string; /** * Provisioning state of the connector */ provisioningState: string; /** * Source of the data connector - "Agent" when directly stored in agent, "AgentSpace" when inherited */ source: string; } /** * Agent Connector used to connect to data sources */ interface AgentConnectorResponse { /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The resource-specific properties for this resource. */ properties?: outputs.app.AgentConnectorPropertiesResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.app.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Agent identity configuration */ interface AgentIdentityResponse { /** * Client ID (GUID) for the agent identity */ clientId: string; /** * Indicates whether the agent identity is enabled */ enabled: boolean; /** * Initial sponsor group ID (required for agent identity) */ initialSponsorGroupId: string; } /** * Properties of the Agent */ interface AgentPropertiesResponse { /** * Configuration for action */ actionConfiguration?: outputs.app.ActionConfigurationResponse; /** * The endpoint of the Agent */ agentEndpoint: string; /** * Agent identity configuration for accessing resources */ agentIdentity?: outputs.app.AgentIdentityResponse; /** * The agent space ID referenced by the agent */ agentSpaceId?: string; /** * Default AI model configuration for the agent */ defaultModel?: outputs.app.DefaultModelResponse; /** * Incident management configurations */ incidentManagementConfiguration?: outputs.app.IncidentManagementConfigurationResponse; /** * Knowledge graph configuration for agent */ knowledgeGraphConfiguration?: outputs.app.KnowledgeGraphConfigurationResponse; /** * Log configurations */ logConfiguration?: outputs.app.LogConfigurationResponse; /** * The power state of the Agent */ powerState: string; /** * Provisioning state of the Agent */ provisioningState: string; /** * The running state of the Agent */ runningState: string; /** * The upgrade channel of the agent */ upgradeChannel?: string; } /** * Compliance status of the Agent Space */ interface AgentSpaceComplianceStatusResponse { /** * List of compliance issues found in the Agent Space */ complianceIssues: string[]; /** * Indicates whether the Agent Space is compliant */ isCompliant: boolean; /** * Timestamp of the last compliance check */ lastComplianceCheck: string; } /** * Agent Space Connector Properties */ interface AgentSpaceConnectorPropertiesResponse { /** * The type of the data connector */ dataConnectorType?: string; /** * Data source connection string or endpoint */ dataSource?: string; /** * Deployment error message if provisioning failed */ deploymentError: string; /** * Endpoint of the connector */ endpoint?: string; /** * Additional properties for the data connector which can be used to store custom key-value pairs */ extendedProperties?: any; /** * Identity used to access the data source */ identity?: string; /** * Provisioning state of the connector */ provisioningState: string; } /** * Agent Space Connector used to connect to data sources */ interface AgentSpaceConnectorResponse { /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The resource-specific properties for this resource. */ properties?: outputs.app.AgentSpaceConnectorPropertiesResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.app.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Policy configurations for an Agent Space */ interface AgentSpacePoliciesResponse { /** * Configuration for Geneva Actions policy */ genevaActionsConfiguration?: outputs.app.GenevaActionsPolicyResponse; } /** * Agent Space specific properties */ interface AgentSpacePropertiesResponse { /** * Compliance status of the Agent Space */ complianceStatus: outputs.app.AgentSpaceComplianceStatusResponse; /** * Current number of agents in the Agent Space */ currentAgentCount: number; /** * Description of the Agent Space */ description?: string; /** * Timestamp of the last policy propagation to agents in this Agent Space */ lastPolicyPropagation: string; /** * Maximum number of agents allowed in the Agent Space */ maxAgentCount?: number; /** * List of agents referencing the Agent Space */ memberAgents: string[]; /** * Policy configurations for the Agent Space */ policies?: outputs.app.AgentSpacePoliciesResponse; /** * Provisioning state of the Agent Space */ provisioningState: string; /** * Universal unique ID (UUID) of the Service Tree associated with this Agent Space */ serviceTreeId?: string; } /** * The configuration settings of the Allowed Audiences validation flow. */ interface AllowedAudiencesValidationResponse { /** * The configuration settings of the allowed list of audiences from which to validate the JWT token. */ allowedAudiences?: string[]; } /** * The configuration settings of the Azure Active Directory allowed principals. */ interface AllowedPrincipalsResponse { /** * The list of the allowed groups. */ groups?: string[]; /** * The list of the allowed identities. */ identities?: string[]; } /** * Configuration of Application Insights */ interface AppInsightsConfigurationResponse { /** * Application Insights connection string */ connectionString?: string; } /** * Configuration of application logs */ interface AppLogsConfigurationResponse { /** * Logs destination, can be 'log-analytics', 'azure-monitor' or 'none' */ destination?: string; /** * Log Analytics configuration, must only be provided when destination is configured as 'log-analytics' */ logAnalyticsConfiguration?: outputs.app.LogAnalyticsConfigurationResponse; } /** * The configuration settings of the app registration for providers that have app ids and app secrets */ interface AppRegistrationResponse { /** * The App ID of the app used for login. */ appId?: string; /** * The app setting name that contains the app secret. */ appSecretSettingName?: string; } /** * The configuration settings of the registration for the Apple provider */ interface AppleRegistrationResponse { /** * The Client ID of the app used for login. */ clientId?: string; /** * The app setting name that contains the client secret. */ clientSecretSettingName?: string; } /** * The configuration settings of the Apple provider. */ interface AppleResponse { /** * false if the Apple provider should not be enabled despite the set registration; otherwise, true. */ enabled?: boolean; /** * The configuration settings of the login flow. */ login?: outputs.app.LoginScopesResponse; /** * The configuration settings of the Apple registration. */ registration?: outputs.app.AppleRegistrationResponse; } /** * Application Insights Configuration */ interface ApplicationInsightsConfigurationResponse { /** * The Application ID for the Application Insights resource */ appId?: string; /** * The connection string for the Application Insights resource */ connectionString?: string; } /** * The configuration settings of the platform of ContainerApp Service Authentication/Authorization. */ interface AuthPlatformResponse { /** * true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. */ enabled?: boolean; /** * The RuntimeVersion of the Authentication / Authorization feature in use for the current app. * The setting in this value can control the behavior of certain features in the Authentication / Authorization module. */ runtimeVersion?: string; } /** * The configuration settings of the Azure Active Directory login flow. */ interface AzureActiveDirectoryLoginResponse { /** * true if the www-authenticate provider should be omitted from the request; otherwise, false. */ disableWWWAuthenticate?: boolean; /** * Login parameters to send to the OpenID Connect authorization endpoint when * a user logs in. Each parameter must be in the form "key=value". */ loginParameters?: string[]; } /** * The configuration settings of the Azure Active Directory app registration. */ interface AzureActiveDirectoryRegistrationResponse { /** * The Client ID of this relying party application, known as the client_id. * This setting is required for enabling OpenID Connection authentication with Azure Active Directory or * other 3rd party OpenID Connect providers. * More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html */ clientId?: string; /** * An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as * a replacement for the Client Secret Certificate Thumbprint. It is also optional. */ clientSecretCertificateIssuer?: string; /** * An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as * a replacement for the Client Secret Certificate Thumbprint. It is also optional. */ clientSecretCertificateSubjectAlternativeName?: string; /** * An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as * a replacement for the Client Secret. It is also optional. */ clientSecretCertificateThumbprint?: string; /** * The app setting name that contains the client secret of the relying party application. */ clientSecretSettingName?: string; /** * The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. * When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://login.microsoftonline.com/v2.0/{tenant-guid}/. * This URI is a case-sensitive identifier for the token issuer. * More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html */ openIdIssuer?: string; } /** * The configuration settings of the Azure Active directory provider. */ interface AzureActiveDirectoryResponse { /** * false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. */ enabled?: boolean; /** * Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. * This is an internal flag primarily intended to support the Azure Management Portal. Users should not * read or write to this property. */ isAutoProvisioned?: boolean; /** * The configuration settings of the Azure Active Directory login flow. */ login?: outputs.app.AzureActiveDirectoryLoginResponse; /** * The configuration settings of the Azure Active Directory app registration. */ registration?: outputs.app.AzureActiveDirectoryRegistrationResponse; /** * The configuration settings of the Azure Active Directory token validation flow. */ validation?: outputs.app.AzureActiveDirectoryValidationResponse; } /** * The configuration settings of the Azure Active Directory token validation flow. */ interface AzureActiveDirectoryValidationResponse { /** * The list of audiences that can make successful authentication/authorization requests. */ allowedAudiences?: string[]; /** * The configuration settings of the default authorization policy. */ defaultAuthorizationPolicy?: outputs.app.DefaultAuthorizationPolicyResponse; /** * The configuration settings of the checks that should be made while validating the JWT Claims. */ jwtClaimChecks?: outputs.app.JwtClaimChecksResponse; } /** * Container App credentials. */ interface AzureCredentialsResponse { /** * Subscription Id. */ subscriptionId?: string; } /** * Azure File Properties. */ interface AzureFilePropertiesResponse { /** * Access mode for storage */ accessMode?: string; /** * Storage account key for azure file. */ accountKey?: string; /** * Storage account key stored as an Azure Key Vault secret. */ accountKeyVaultProperties?: outputs.app.SecretKeyVaultPropertiesResponse; /** * Storage account name for azure file. */ accountName?: string; /** * Azure file share name. */ shareName?: string; } /** * The configuration settings of the registration for the Azure Static Web Apps provider */ interface AzureStaticWebAppsRegistrationResponse { /** * The Client ID of the app used for login. */ clientId?: string; } /** * The configuration settings of the Azure Static Web Apps provider. */ interface AzureStaticWebAppsResponse { /** * false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. */ enabled?: boolean; /** * The configuration settings of the Azure Static Web Apps registration. */ registration?: outputs.app.AzureStaticWebAppsRegistrationResponse; } /** * The configuration settings of the storage of the tokens if blob storage is used. */ interface BlobStorageTokenStoreResponse { /** * The URI of the blob storage containing the tokens. Should not be used along with sasUrlSettingName. */ blobContainerUri?: string; /** * The Client ID of a User-Assigned Managed Identity. Should not be used along with managedIdentityResourceId. */ clientId?: string; /** * The Resource ID of a User-Assigned Managed Identity. Should not be used along with clientId. */ managedIdentityResourceId?: string; /** * The name of the app secrets containing the SAS URL of the blob storage containing the tokens. Should not be used along with blobContainerUri. */ sasUrlSettingName?: string; } /** * Configuration of the build. */ interface BuildConfigurationResponse { /** * Base OS used to build and run the app. */ baseOs?: string; /** * List of environment variables to be passed to the build, secrets should not be used in environment variable. */ environmentVariables?: outputs.app.EnvironmentVariableResponse[]; /** * Platform to be used to build and run the app. */ platform?: string; /** * Platform version to be used to build and run the app. */ platformVersion?: string; /** * List of steps to perform before the build. */ preBuildSteps?: outputs.app.PreBuildStepResponse[]; } /** * Properties for a certificate stored in a Key Vault. */ interface CertificateKeyVaultPropertiesResponse { /** * Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. */ identity?: string; /** * URL pointing to the Azure Key Vault secret that holds the certificate. */ keyVaultUrl?: string; } /** * Certificate resource specific properties */ interface CertificateResponseProperties { /** * Properties for a certificate stored in a Key Vault. */ certificateKeyVaultProperties?: outputs.app.CertificateKeyVaultPropertiesResponse; /** * The type of the certificate. Allowed values are `ServerSSLCertificate` and `ImagePullTrustedCA` */ certificateType?: string; /** * Any errors that occurred during deployment or deployment validation */ deploymentErrors: string; /** * Certificate expiration date. */ expirationDate: string; /** * Certificate issue Date. */ issueDate: string; /** * Certificate issuer. */ issuer: string; /** * Provisioning state of the certificate. */ provisioningState: string; /** * Public key hash. */ publicKeyHash: string; /** * Subject alternative names the certificate applies to. */ subjectAlternativeNames: string[]; /** * Subject name of the certificate. */ subjectName: string; /** * Certificate thumbprint. */ thumbprint: string; /** * Is the certificate valid?. */ valid: boolean; } /** * Policy that defines circuit breaker conditions */ interface CircuitBreakerPolicyResponse { /** * Number of consecutive errors before the circuit breaker opens */ consecutiveErrors?: number; /** * The time interval, in seconds, between endpoint checks. This can result in opening the circuit breaker if the check fails as well as closing the circuit breaker if the check succeeds. Defaults to 10s. */ intervalInSeconds?: number; /** * Maximum percentage of hosts that will be ejected after failure threshold has been met */ maxEjectionPercent?: number; } /** * The configuration settings of the app registration for providers that have client ids and client secrets */ interface ClientRegistrationResponse { /** * The Client ID of the app used for login. */ clientId?: string; /** * The app setting name that contains the client secret. */ clientSecretSettingName?: string; } /** * Non versioned Container App configuration properties that define the mutable settings of a Container app */ interface ConfigurationResponse { /** * ActiveRevisionsMode controls how active revisions are handled for the Container app: * Single: Only one revision can be active at a time. Traffic weights cannot be used. This is the default.Multiple: Multiple revisions can be active, including optional traffic weights and labels.Labels: Only revisions with labels are active. Traffic weights can be applied to labels. */ activeRevisionsMode?: string; /** * Dapr configuration for the Container App. */ dapr?: outputs.app.DaprResponse; /** * Optional settings for Managed Identities that are assigned to the Container App. If a Managed Identity is not specified here, default settings will be used. */ identitySettings?: outputs.app.IdentitySettingsResponse[]; /** * Ingress configurations. */ ingress?: outputs.app.IngressResponse; /** * Optional. Max inactive revisions a Container App can have. */ maxInactiveRevisions?: number; /** * Collection of private container registry credentials for containers used by the Container app */ registries?: outputs.app.RegistryCredentialsResponse[]; /** * Optional. The percent of the total number of replicas that must be brought up before revision transition occurs. Defaults to 100 when none is given. Value must be greater than 0 and less than or equal to 100. */ revisionTransitionThreshold?: number; /** * App runtime configuration for the Container App. */ runtime?: outputs.app.RuntimeResponse; /** * Collection of secrets used by a Container app */ secrets?: outputs.app.SecretResponse[]; /** * Container App to be a dev Container App Service */ service?: outputs.app.ServiceResponse; /** * Required in labels revisions mode. Label to apply to newly created revision. */ targetLabel?: string; } /** * configurationResponseProvideDefaults sets the appropriate defaults for ConfigurationResponse */ function configurationResponseProvideDefaults(val: ConfigurationResponse): ConfigurationResponse; /** * Storage properties */ interface ConnectedEnvironmentStorageResponseProperties { /** * Azure file properties */ azureFile?: outputs.app.AzureFilePropertiesResponse; /** * Any errors that occurred during deployment or deployment validation */ deploymentErrors: string; /** * Provisioning state of the storage. */ provisioningState: string; /** * SMB storage properties */ smb?: outputs.app.SmbStorageResponse; } /** * Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive traffic. */ interface ContainerAppProbeResponse { /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10. */ failureThreshold?: number; /** * HTTPGet specifies the http request to perform. */ httpGet?: outputs.app.ContainerAppProbeResponseHttpGet; /** * Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10. */ successThreshold?: number; /** * TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. */ tcpSocket?: outputs.app.ContainerAppProbeResponseTcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour) */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. */ timeoutSeconds?: number; /** * The type of probe. */ type?: string; } /** * HTTPGet specifies the http request to perform. */ interface ContainerAppProbeResponseHttpGet { /** * Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** * Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: outputs.app.ContainerAppProbeResponseHttpHeaders[]; /** * Path to access on the HTTP server. */ path?: string; /** * Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number; /** * Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** * HTTPHeader describes a custom header to be used in HTTP probes */ interface ContainerAppProbeResponseHttpHeaders { /** * The header field name */ name: string; /** * The header field value */ value: string; } /** * TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. */ interface ContainerAppProbeResponseTcpSocket { /** * Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number; } /** * Container App auto patch configuration. */ interface ContainerAppResponsePatchingConfiguration { /** * Patching mode for the container app. Null or default in this field will be interpreted as Automatic by RP. Automatic mode will automatically apply available patches. Manual mode will require the user to manually apply patches. Disabled mode will stop patch detection and auto patching. */ patchingMode?: string; } /** * Container App Secret. */ interface ContainerAppSecretResponse { /** * Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. */ identity: string; /** * Azure Key Vault URL pointing to the secret referenced by the container app. */ keyVaultUrl: string; /** * Secret Name. */ name: string; /** * Secret Value. */ value: string; } /** * Model representing a mapping from a container registry to the identity used to connect to it. */ interface ContainerRegistryResponse { /** * Login server of the container registry. */ containerRegistryServer: string; /** * Resource ID of the managed identity. */ identityResourceId: string; } /** * Container registry that the final image will be uploaded to. */ interface ContainerRegistryWithCustomImageResponse { /** * Full name that the final image should be uploaded as, including both image name and tag. */ image?: string; /** * Login server of the container registry that the final image should be uploaded to. Builder resource needs to have this container registry defined along with an identity to use to access it. */ server: string; } /** * Container App container resource requirements. */ interface ContainerResourcesResponse { /** * Required CPU in cores, e.g. 0.5 */ cpu?: number; /** * Ephemeral Storage, e.g. "1Gi" */ ephemeralStorage: string; /** * Required GPU in cores for GPU based app, e.g. 1.0 */ gpu?: number; /** * Required memory, e.g. "250Mb" */ memory?: string; } /** * Container App container definition */ interface ContainerResponse { /** * Container start command arguments. */ args?: string[]; /** * Container start command. */ command?: string[]; /** * Container environment variables. */ env?: outputs.app.EnvironmentVarResponse[]; /** * Container image tag. */ image?: string; /** * The type of the image. Set to CloudBuild to let the system manages the image, where user will not be able to update image through image field. Set to ContainerImage for user provided image. */ imageType?: string; /** * Custom container name. */ name?: string; /** * List of probes for the container. */ probes?: outputs.app.ContainerAppProbeResponse[]; /** * Container resource requirements. */ resources?: outputs.app.ContainerResourcesResponse; /** * Container volume mounts. */ volumeMounts?: outputs.app.VolumeMountResponse[]; } /** * The configuration settings of the session cookie's expiration. */ interface CookieExpirationResponse { /** * The convention used when determining the session cookie's expiration. */ convention?: string; /** * The time after the request is made when the session cookie should expire. */ timeToExpiration?: string; } /** * Cross-Origin-Resource-Sharing policy */ interface CorsPolicyResponse { /** * Specifies whether the resource allows credentials */ allowCredentials?: boolean; /** * Specifies the content for the access-control-allow-headers header */ allowedHeaders?: string[]; /** * Specifies the content for the access-control-allow-methods header */ allowedMethods?: string[]; /** * Specifies the content for the access-control-allow-origins header */ allowedOrigins: string[]; /** * Specifies the content for the access-control-expose-headers header */ exposeHeaders?: string[]; /** * Specifies the content for the access-control-max-age header */ maxAge?: number; } /** * Custom container configuration. */ interface CustomContainerTemplateResponse { /** * List of container definitions for the sessions of the session pool. */ containers?: outputs.app.SessionContainerResponse[]; /** * Session pool ingress configuration. */ ingress?: outputs.app.SessionIngressResponse; /** * Private container registry credentials for containers used by the sessions of the session pool. */ registryCredentials?: outputs.app.SessionRegistryCredentialsResponse; } /** * Configuration properties for apps environment custom domain */ interface CustomDomainConfigurationResponse { /** * Certificate stored in Azure Key Vault. */ certificateKeyVaultProperties?: outputs.app.CertificateKeyVaultPropertiesResponse; /** * Certificate password */ certificatePassword?: string; /** * PFX or PEM blob */ certificateValue?: string; /** * Id used to verify domain name ownership */ customDomainVerificationId: string; /** * Dns suffix for the environment domain */ dnsSuffix?: string; /** * Certificate expiration date. */ expirationDate: string; /** * Subject name of the certificate. */ subjectName: string; /** * Certificate thumbprint. */ thumbprint: string; } /** * Custom Domain of a Container App */ interface CustomDomainResponse { /** * Custom Domain binding type. */ bindingType?: string; /** * Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. */ certificateId?: string; /** * Hostname. */ name: string; } /** * Raw failure information if DNS verification fails. */ interface CustomHostnameAnalysisResultResponseCustomDomainVerificationFailureInfo { /** * Standardized string to programmatically identify the error. */ code: string; /** * Details or the error */ details?: outputs.app.CustomHostnameAnalysisResultResponseDetails[]; /** * Detailed error description and debugging information. */ message: string; /** * Detailed error description and debugging information. */ target: string; } /** * Detailed errors. */ interface CustomHostnameAnalysisResultResponseDetails { /** * Standardized string to programmatically identify the error. */ code: string; /** * Detailed error description and debugging information. */ message: string; /** * Detailed error description and debugging information. */ target: string; } /** * The configuration settings of the custom Open ID Connect provider. */ interface CustomOpenIdConnectProviderResponse { /** * false if the custom Open ID provider provider should not be enabled; otherwise, true. */ enabled?: boolean; /** * The configuration settings of the login flow of the custom Open ID Connect provider. */ login?: outputs.app.OpenIdConnectLoginResponse; /** * The configuration settings of the app registration for the custom Open ID Connect provider. */ registration?: outputs.app.OpenIdConnectRegistrationResponse; } /** * Container App container Custom scaling rule. */ interface CustomScaleRuleResponse { /** * Authentication secrets for the custom scale rule. */ auth?: outputs.app.ScaleRuleAuthResponse[]; /** * The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. */ identity?: string; /** * Metadata properties to describe custom scale rule. */ metadata?: { [key: string]: string; }; /** * Type of the custom scale rule * eg: azure-servicebus, redis etc. */ type?: string; } /** * Dapr Component Resiliency Policy Circuit Breaker Policy Configuration. */ interface DaprComponentResiliencyPolicyCircuitBreakerPolicyConfigurationResponse { /** * The number of consecutive errors before the circuit is opened. */ consecutiveErrors?: number; /** * The optional interval in seconds after which the error count resets to 0. An interval of 0 will never reset. If not specified, the timeoutInSeconds value will be used. */ intervalInSeconds?: number; /** * The interval in seconds until a retry attempt is made after the circuit is opened. */ timeoutInSeconds?: number; } /** * Dapr Component Resiliency Policy Configuration. */ interface DaprComponentResiliencyPolicyConfigurationResponse { /** * The optional circuit breaker policy configuration */ circuitBreakerPolicy?: outputs.app.DaprComponentResiliencyPolicyCircuitBreakerPolicyConfigurationResponse; /** * The optional HTTP retry policy configuration */ httpRetryPolicy?: outputs.app.DaprComponentResiliencyPolicyHttpRetryPolicyConfigurationResponse; /** * The optional timeout policy configuration */ timeoutPolicy?: outputs.app.DaprComponentResiliencyPolicyTimeoutPolicyConfigurationResponse; } /** * Dapr Component Resiliency Policy HTTP Retry Backoff Configuration. */ interface DaprComponentResiliencyPolicyHttpRetryBackOffConfigurationResponse { /** * The optional initial delay in milliseconds before an operation is retried */ initialDelayInMilliseconds?: number; /** * The optional maximum time interval in milliseconds between retry attempts */ maxIntervalInMilliseconds?: number; } /** * Dapr Component Resiliency Policy HTTP Retry Policy Configuration. */ interface DaprComponentResiliencyPolicyHttpRetryPolicyConfigurationResponse { /** * The optional maximum number of retries */ maxRetries?: number; /** * The optional retry backoff configuration */ retryBackOff?: outputs.app.DaprComponentResiliencyPolicyHttpRetryBackOffConfigurationResponse; } /** * Dapr Component Resiliency Policy Timeout Policy Configuration. */ interface DaprComponentResiliencyPolicyTimeoutPolicyConfigurationResponse { /** * The optional response timeout in seconds */ responseTimeoutInSeconds?: number; } /** * Configuration to bind a Dapr Component to a dev ContainerApp Service */ interface DaprComponentServiceBindingResponse { /** * Service bind metadata */ metadata?: outputs.app.DaprServiceBindMetadataResponse; /** * Name of the service bind */ name?: string; /** * Resource id of the target service */ serviceId?: string; } /** * Configuration properties Dapr component */ interface DaprConfigurationResponse { /** * The version of Dapr */ version: string; } /** * Dapr component metadata. */ interface DaprMetadataResponse { /** * Metadata property name. */ name?: string; /** * Name of the Dapr Component secret from which to pull the metadata property value. */ secretRef?: string; /** * Metadata property value. */ value?: string; } /** * Container App Dapr configuration. */ interface DaprResponse { /** * Dapr application health check configuration */ appHealth?: outputs.app.DaprResponseAppHealth; /** * Dapr application identifier */ appId?: string; /** * Tells Dapr which port your application is listening on */ appPort?: number; /** * Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http */ appProtocol?: string; /** * Enables API logging for the Dapr sidecar */ enableApiLogging?: boolean; /** * Boolean indicating if the Dapr side car is enabled */ enabled?: boolean; /** * Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big files. Default is 4 MB. */ httpMaxRequestSize?: number; /** * Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. */ httpReadBufferSize?: number; /** * Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. */ logLevel?: string; /** * Maximum number of concurrent requests, events handled by the Dapr sidecar */ maxConcurrency?: number; } /** * daprResponseProvideDefaults sets the appropriate defaults for DaprResponse */ function daprResponseProvideDefaults(val: DaprResponse): DaprResponse; /** * Dapr application health check configuration */ interface DaprResponseAppHealth { /** * Boolean indicating if the health probe is enabled */ enabled?: boolean; /** * Path for the health probe */ path?: string; /** * Interval for the health probe in seconds */ probeIntervalSeconds?: number; /** * Timeout for the health probe in milliseconds */ probeTimeoutMilliseconds?: number; /** * Threshold for the health probe */ threshold?: number; } /** * Dapr component Secret for ListSecrets Action */ interface DaprSecretResponse { /** * Secret Name. */ name: string; /** * Secret Value. */ value: string; } /** * Dapr component metadata. */ interface DaprServiceBindMetadataResponse { /** * Service bind metadata property name. */ name?: string; /** * Service bind metadata property value. */ value?: string; } /** * Dapr PubSub Bulk Subscription Options. */ interface DaprSubscriptionBulkSubscribeOptionsResponse { /** * Enable bulk subscription */ enabled?: boolean; /** * Maximum duration in milliseconds to wait before a bulk message is sent to the app. */ maxAwaitDurationMs?: number; /** * Maximum number of messages to deliver in a bulk message. */ maxMessagesCount?: number; } /** * daprSubscriptionBulkSubscribeOptionsResponseProvideDefaults sets the appropriate defaults for DaprSubscriptionBulkSubscribeOptionsResponse */ function daprSubscriptionBulkSubscribeOptionsResponseProvideDefaults(val: DaprSubscriptionBulkSubscribeOptionsResponse): DaprSubscriptionBulkSubscribeOptionsResponse; /** * Dapr Pubsub Event Subscription Route Rule is used to specify the condition for sending a message to a specific path. */ interface DaprSubscriptionRouteRuleResponse { /** * The optional CEL expression used to match the event. If the match is not specified, then the route is considered the default. The rules are tested in the order specified, so they should be define from most-to-least specific. The default route should appear last in the list. */ match?: string; /** * The path for events that match this rule */ path?: string; } /** * Dapr PubSub Event Subscription Routes configuration. */ interface DaprSubscriptionRoutesResponse { /** * The default path to deliver events that do not match any of the rules. */ default?: string; /** * The list of Dapr PubSub Event Subscription Route Rules. */ rules?: outputs.app.DaprSubscriptionRouteRuleResponse[]; } /** * Configuration of datadog */ interface DataDogConfigurationResponse { /** * The data dog api key */ key?: string; /** * The data dog site */ site?: string; } /** * The configuration settings of the Azure Active Directory default authorization policy. */ interface DefaultAuthorizationPolicyResponse { /** * The configuration settings of the Azure Active Directory allowed applications. */ allowedApplications?: string[]; /** * The configuration settings of the Azure Active Directory allowed principals. */ allowedPrincipals?: outputs.app.AllowedPrincipalsResponse; } /** * Default AI model configuration */ interface DefaultModelResponse { /** * Model name (e.g., gpt-5, claude-opus-4-5, claude-sonnet-4-5) */ name?: string; /** * AI provider name (e.g., MicrosoftFoundry, Anthropic) */ provider?: string; } /** * Configuration of Open Telemetry destinations */ interface DestinationsConfigurationResponse { /** * Open telemetry datadog destination configuration */ dataDogConfiguration?: outputs.app.DataDogConfigurationResponse; /** * Open telemetry otlp configurations */ otlpConfigurations?: outputs.app.OtlpConfigurationResponse[]; } /** * Configuration properties for disk encryption */ interface DiskEncryptionConfigurationResponse { /** * The Key Vault that contains your key to use for disk encryption. The Key Vault must be in the same region as the Managed Environment. */ keyVaultConfiguration?: outputs.app.DiskEncryptionConfigurationResponseKeyVaultConfiguration; } /** * Configuration properties for the authentication to the Key Vault */ interface DiskEncryptionConfigurationResponseAuth { /** * Resource ID of a user-assigned managed identity to authenticate to the Key Vault. The identity must be assigned to the managed environment, in the same tenant as the Key Vault, and it must have the following key permissions on the Key Vault: wrapkey, unwrapkey, get. */ identity?: string; } /** * The Key Vault that contains your key to use for disk encryption. The Key Vault must be in the same region as the Managed Environment. */ interface DiskEncryptionConfigurationResponseKeyVaultConfiguration { /** * Configuration properties for the authentication to the Key Vault */ auth?: outputs.app.DiskEncryptionConfigurationResponseAuth; /** * Key URL pointing to a key in KeyVault. Version segment of the Url is required. */ keyUrl?: string; } /** * Configuration properties for a .NET Component */ interface DotNetComponentConfigurationPropertyResponse { /** * The name of the property */ propertyName?: string; /** * The value of the property */ value?: string; } /** * Configuration to bind a .NET Component to another .NET Component */ interface DotNetComponentServiceBindResponse { /** * Name of the service bind */ name?: string; /** * Resource id of the target service */ serviceId?: string; } /** * Dynamic pool configuration. */ interface DynamicPoolConfigurationResponse { /** * The lifecycle configuration of a session in the dynamic session pool */ lifecycleConfiguration?: outputs.app.LifecycleConfigurationResponse; } /** * The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service Authentication/Authorization. */ interface EncryptionSettingsResponse { /** * The secret name which is referenced for EncryptionKey. */ containerAppAuthEncryptionSecretName?: string; /** * The secret name which is referenced for SigningKey. */ containerAppAuthSigningSecretName?: string; } /** * Container App container environment variable. */ interface EnvironmentVarResponse { /** * Environment variable name. */ name?: string; /** * Name of the Container App secret from which to pull the environment variable value. */ secretRef?: string; /** * Non-secret environment variable value. */ value?: string; } /** * Model representing an environment variable. */ interface EnvironmentVariableResponse { /** * Environment variable name. */ name: string; /** * Environment variable value. */ value: string; } /** * Body of the error response returned from the API. */ interface ErrorEntityResponse { /** * Basic error code. */ code?: string; /** * Error Details. */ details?: outputs.app.ErrorEntityResponse[]; /** * Type of error. */ extendedCode?: string; /** * Inner errors. */ innerErrors?: outputs.app.ErrorEntityResponse[]; /** * Any details of the error. */ message?: string; /** * Message template. */ messageTemplate?: string; /** * Parameters for the template. */ parameters?: string[]; /** * The error target. */ target?: string; } /** * The complex type of the extended location. */ interface ExtendedLocationResponse { /** * The name of the extended location. */ name?: string; /** * The type of the extended location. */ type?: string; } /** * The configuration settings of the Facebook provider. */ interface FacebookResponse { /** * false if the Facebook provider should not be enabled despite the set registration; otherwise, true. */ enabled?: boolean; /** * The version of the Facebook api to be used while logging in. */ graphApiVersion?: string; /** * The configuration settings of the login flow. */ login?: outputs.app.LoginScopesResponse; /** * The configuration settings of the app registration for the Facebook provider. */ registration?: outputs.app.AppRegistrationResponse; } /** * The configuration settings of a forward proxy used to make the requests. */ interface ForwardProxyResponse { /** * The convention used to determine the url of the request made. */ convention?: string; /** * The name of the header containing the host of the request. */ customHostHeaderName?: string; /** * The name of the header containing the scheme of the request. */ customProtoHeaderName?: string; } /** * Configuration for a Geneva action */ interface GenevaActionConfigResponse { /** * Name of the Geneva action */ actionName?: string; /** * Parameters for the Geneva action */ actionParameters?: outputs.app.GenevaActionParameterResponse[]; /** * Indicates whether approval is required for this action */ approvalRequired?: boolean; /** * Extension associated with the action */ extension?: string; } /** * Parameter for a Geneva action */ interface GenevaActionParameterResponse { /** * Name of the parameter */ name?: string; /** * Type of the parameter */ type?: string; } /** * Geneva Actions policy configuration for Agent Space */ interface GenevaActionsPolicyResponse { /** * ACIS (Azure Container Instance Service) endpoint URL */ acisEndpoint?: string; /** * Collection of allowed Geneva actions */ allowedActions?: outputs.app.GenevaActionConfigResponse[]; /** * Authentication mode for Geneva Actions */ authenticationMode?: string; /** * Subject alternative name of the certificate used for authentication */ certificateSubjectAlternativeName: string; /** * Subject name of the certificate used for authentication */ certificateSubjectName?: string; /** * Client ID for authentication */ clientId?: string; /** * Name of the Geneva extension */ extensionName: string; } /** * The configuration settings of the GitHub provider. */ interface GitHubResponse { /** * false if the GitHub provider should not be enabled despite the set registration; otherwise, true. */ enabled?: boolean; /** * The configuration settings of the login flow. */ login?: outputs.app.LoginScopesResponse; /** * The configuration settings of the app registration for the GitHub provider. */ registration?: outputs.app.ClientRegistrationResponse; } /** * Configuration properties that define the mutable settings of a Container App SourceControl */ interface GithubActionConfigurationResponse { /** * AzureCredentials configurations. */ azureCredentials?: outputs.app.AzureCredentialsResponse; /** * List of environment variables to be passed to the build. */ buildEnvironmentVariables?: outputs.app.EnvironmentVariableResponse[]; /** * Context path */ contextPath?: string; /** * Dockerfile path */ dockerfilePath?: string; /** * Image name */ image?: string; /** * Operation system */ os?: string; /** * Code or Image */ publishType?: string; /** * Registry configurations. */ registryInfo?: outputs.app.RegistryInfoResponse; /** * Runtime stack */ runtimeStack?: string; /** * Runtime version */ runtimeVersion?: string; } /** * The configuration settings that determines the validation flow of users using ContainerApp Service Authentication/Authorization. */ interface GlobalValidationResponse { /** * The paths for which unauthenticated flow would not be redirected to the login page. */ excludedPaths?: string[]; /** * The default authentication provider to use when multiple providers are configured. * This setting is only needed if multiple providers are configured and the unauthenticated client * action is set to "RedirectToLoginPage". */ redirectToProvider?: string; /** * The action to take when an unauthenticated client attempts to access the app. */ unauthenticatedClientAction?: string; } /** * The configuration settings of the Google provider. */ interface GoogleResponse { /** * false if the Google provider should not be enabled despite the set registration; otherwise, true. */ enabled?: boolean; /** * The configuration settings of the login flow. */ login?: outputs.app.LoginScopesResponse; /** * The configuration settings of the app registration for the Google provider. */ registration?: outputs.app.ClientRegistrationResponse; /** * The configuration settings of the Azure Active Directory token validation flow. */ validation?: outputs.app.AllowedAudiencesValidationResponse; } /** * Conditions required to match a header */ interface HeaderMatchResponse { /** * Exact value of the header */ exactMatch?: string; /** * Name of the header */ header?: string; /** * Prefix value of the header */ prefixMatch?: string; /** * Regex value of the header */ regexMatch?: string; /** * Suffix value of the header */ suffixMatch?: string; } /** * Header of otlp configuration */ interface HeaderResponse { /** * The key of otlp configuration header */ key?: string; /** * The value of otlp configuration header */ value?: string; } /** * Defines parameters for http connection pooling */ interface HttpConnectionPoolResponse { /** * Maximum number of pending http1 requests allowed */ http1MaxPendingRequests?: number; /** * Maximum number of http2 requests allowed */ http2MaxRequests?: number; } /** * Model representing a http get request. */ interface HttpGetResponse { /** * Name of the file that the request should be saved to. */ fileName?: string; /** * List of headers to send with the request. */ headers?: string[]; /** * URL to make HTTP GET request against. */ url: string; } /** * Policy that defines http request retry conditions */ interface HttpRetryPolicyResponse { /** * Errors that can trigger a retry */ errors?: string[]; /** * Headers that must be present for a request to be retried */ headers?: outputs.app.HeaderMatchResponse[]; /** * Additional http status codes that can trigger a retry */ httpStatusCodes?: number[]; /** * Initial delay, in milliseconds, before retrying a request */ initialDelayInMilliseconds?: number; /** * Maximum interval, in milliseconds, between retries */ maxIntervalInMilliseconds?: number; /** * Maximum number of times a request will retry */ maxRetries?: number; } /** * Action to perform once matching of routes is done */ interface HttpRouteActionResponse { /** * Rewrite prefix, default is no rewrites */ prefixRewrite?: string; } /** * Http Route Config properties */ interface HttpRouteConfigResponseProperties { /** * Custom domain bindings for http Routes' hostnames. */ customDomains?: outputs.app.CustomDomainResponse[]; /** * FQDN of the route resource. */ fqdn: string; /** * List of errors when trying to reconcile http routes */ provisioningErrors: outputs.app.HttpRouteProvisioningErrorsResponse[]; /** * The provisioning state of the Http Route Config in cluster */ provisioningState: string; /** * Routing Rules for http route resource. */ rules?: outputs.app.HttpRouteRuleResponse[]; } /** * Criteria to match on */ interface HttpRouteMatchResponse { /** * path case sensitive, default is true */ caseSensitive?: boolean; /** * match on exact path */ path?: string; /** * match on all prefix's. Not exact */ pathSeparatedPrefix?: string; /** * match on all prefix's. Not exact */ prefix?: string; } /** * List of provisioning errors for a http route config object */ interface HttpRouteProvisioningErrorsResponse { /** * Description or error message */ message: string; /** * Timestamp error occured at */ timestamp: string; } /** * Http Routes configuration, including paths to match on and whether or not rewrites are to be done. */ interface HttpRouteResponse { /** * Once route is matched, what is the desired action */ action?: outputs.app.HttpRouteActionResponse; /** * Conditions route will match on */ match?: outputs.app.HttpRouteMatchResponse; } /** * Http Route rule. */ interface HttpRouteRuleResponse { /** * Description of rule. Optional. */ description?: string; /** * Routing configuration that will allow matches on specific paths/headers. */ routes?: outputs.app.HttpRouteResponse[]; /** * Targets- container apps, revisions, labels */ targets?: outputs.app.HttpRouteTargetResponse[]; } /** * Targets - Container App Names, Revision Names, Labels. */ interface HttpRouteTargetResponse { /** * Container App Name to route requests to */ containerApp: string; /** * Label/Revision to route requests to */ label?: string; /** * Revision to route requests to */ revision?: string; /** * Weighted routing */ weight?: number; } /** * Container App container Http scaling rule. */ interface HttpScaleRuleResponse { /** * Authentication secrets for the custom scale rule. */ auth?: outputs.app.ScaleRuleAuthResponse[]; /** * The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. */ identity?: string; /** * Metadata properties to describe http scale rule. */ metadata?: { [key: string]: string; }; } /** * The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp Service Authentication/Authorization. */ interface HttpSettingsResponse { /** * The configuration settings of a forward proxy used to make the requests. */ forwardProxy?: outputs.app.ForwardProxyResponse; /** * false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. */ requireHttps?: boolean; /** * The configuration settings of the paths HTTP requests. */ routes?: outputs.app.HttpSettingsRoutesResponse; } /** * The configuration settings of the paths HTTP requests. */ interface HttpSettingsRoutesResponse { /** * The prefix that should precede all the authentication/authorization paths. */ apiPrefix?: string; } /** * The configuration settings of each of the identity providers used to configure ContainerApp Service Authentication/Authorization. */ interface IdentityProvidersResponse { /** * The configuration settings of the Apple provider. */ apple?: outputs.app.AppleResponse; /** * The configuration settings of the Azure Active directory provider. */ azureActiveDirectory?: outputs.app.AzureActiveDirectoryResponse; /** * The configuration settings of the Azure Static Web Apps provider. */ azureStaticWebApps?: outputs.app.AzureStaticWebAppsResponse; /** * The map of the name of the alias of each custom Open ID Connect provider to the * configuration settings of the custom Open ID Connect provider. */ customOpenIdConnectProviders?: { [key: string]: outputs.app.CustomOpenIdConnectProviderResponse; }; /** * The configuration settings of the Facebook provider. */ facebook?: outputs.app.FacebookResponse; /** * The configuration settings of the GitHub provider. */ gitHub?: outputs.app.GitHubResponse; /** * The configuration settings of the Google provider. */ google?: outputs.app.GoogleResponse; /** * The configuration settings of the Twitter provider. */ twitter?: outputs.app.TwitterResponse; } /** * Optional settings for a Managed Identity that is assigned to the Container App. */ interface IdentitySettingsResponse { /** * The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. */ identity: string; /** * Use to select the lifecycle stages of a Container App during which the Managed Identity should be available. */ lifecycle?: string; } /** * identitySettingsResponseProvideDefaults sets the appropriate defaults for IdentitySettingsResponse */ function identitySettingsResponseProvideDefaults(val: IdentitySettingsResponse): IdentitySettingsResponse; /** * Incident Management Configurations */ interface IncidentManagementConfigurationResponse { /** * The key for the connection */ connectionKey?: string; /** * The name of the connection */ connectionName?: string; /** * The URL of the connection */ connectionUrl?: string; /** * The user for the connection */ oboUser?: string; /** * The type of incident management system */ type?: string; } /** * Settings for the ingress component, including workload profile, scaling, and connection handling. */ interface IngressConfigurationResponse { /** * Maximum number of headers per request allowed by the ingress. Must be at least 1. Defaults to 100. */ headerCountLimit?: number; /** * Duration (in minutes) before idle requests are timed out. Must be at least 1 minute. Defaults to 4 minutes. */ requestIdleTimeout?: number; /** * Scaling configuration for the ingress component. Required. */ scale?: outputs.app.IngressConfigurationResponseScale; /** * Time (in seconds) to allow active connections to complete on termination. Must be between 0 and 3600. Defaults to 480 seconds. */ terminationGracePeriodSeconds?: number; /** * Name of the workload profile used by the ingress component. Required. */ workloadProfileName?: string; } /** * Scaling configuration for the ingress component. Required. */ interface IngressConfigurationResponseScale { /** * Maximum number of ingress replicas. Must be greater than or equal to minReplicas. */ maxReplicas?: number; /** * Minimum number of ingress replicas. Must be at least 2. Required. */ minReplicas?: number; } /** * Port mappings of container app ingress */ interface IngressPortMappingResponse { /** * Specifies the exposed port for the target port. If not specified, it defaults to target port */ exposedPort?: number; /** * Specifies whether the app port is accessible outside of the environment */ external: boolean; /** * Specifies the port user's container listens on */ targetPort: number; } /** * Container App Ingress configuration. */ interface IngressResponse { /** * Settings to expose additional ports on container app */ additionalPortMappings?: outputs.app.IngressPortMappingResponse[]; /** * Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections */ allowInsecure?: boolean; /** * Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require indicates server requires a client certificate. */ clientCertificateMode?: string; /** * CORS policy for container app */ corsPolicy?: outputs.app.CorsPolicyResponse; /** * custom domain bindings for Container Apps' hostnames. */ customDomains?: outputs.app.CustomDomainResponse[]; /** * Exposed Port in containers for TCP traffic from ingress */ exposedPort?: number; /** * Bool indicating if app exposes an external http endpoint */ external?: boolean; /** * Hostname. */ fqdn: string; /** * Rules to restrict incoming IP address. */ ipSecurityRestrictions?: outputs.app.IpSecurityRestrictionRuleResponse[]; /** * Sticky Sessions for Single Revision Mode */ stickySessions?: outputs.app.IngressResponseStickySessions; /** * Target Port in containers for traffic from ingress */ targetPort?: number; /** * Whether an http app listens on http or https */ targetPortHttpScheme?: string; /** * Traffic weights for app's revisions */ traffic?: outputs.app.TrafficWeightResponse[]; /** * Ingress transport protocol */ transport?: string; } /** * ingressResponseProvideDefaults sets the appropriate defaults for IngressResponse */ function ingressResponseProvideDefaults(val: IngressResponse): IngressResponse; /** * Sticky Sessions for Single Revision Mode */ interface IngressResponseStickySessions { /** * Sticky Session Affinity */ affinity?: string; } /** * Container App init container definition */ interface InitContainerResponse { /** * Container start command arguments. */ args?: string[]; /** * Container start command. */ command?: string[]; /** * Container environment variables. */ env?: outputs.app.EnvironmentVarResponse[]; /** * Container image tag. */ image?: string; /** * The type of the image. Set to CloudBuild to let the system manages the image, where user will not be able to update image through image field. Set to ContainerImage for user provided image. */ imageType?: string; /** * Custom container name. */ name?: string; /** * Container resource requirements. */ resources?: outputs.app.ContainerResourcesResponse; /** * Container volume mounts. */ volumeMounts?: outputs.app.VolumeMountResponse[]; } /** * Rule to restrict incoming IP address. */ interface IpSecurityRestrictionRuleResponse { /** * Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny */ action: string; /** * Describe the IP restriction rule that is being sent to the container-app. This is an optional field. */ description?: string; /** * CIDR notation to match incoming IP address */ ipAddressRange: string; /** * Name for the IP restriction rule. */ name: string; } /** * Configuration properties for a Java Component */ interface JavaComponentConfigurationPropertyResponse { /** * The name of the property */ propertyName?: string; /** * The value of the property */ value?: string; } /** * Container App Ingress configuration. */ interface JavaComponentIngressResponse { /** * Hostname of the Java Component endpoint */ fqdn: string; } /** * Java component scaling configurations */ interface JavaComponentPropertiesResponseScale { /** * Optional. Maximum number of Java component replicas */ maxReplicas?: number; /** * Optional. Minimum number of Java component replicas. Defaults to 1 if not set */ minReplicas?: number; } /** * Configuration to bind a Java Component to another Java Component */ interface JavaComponentServiceBindResponse { /** * Name of the service bind */ name?: string; /** * Resource id of the target service */ serviceId?: string; } /** * Non versioned Container Apps Job configuration properties */ interface JobConfigurationResponse { /** * Trigger configuration of an event driven job. */ eventTriggerConfig?: outputs.app.JobConfigurationResponseEventTriggerConfig; /** * Optional settings for Managed Identities that are assigned to the Container App Job. If a Managed Identity is not specified here, default settings will be used. */ identitySettings?: outputs.app.IdentitySettingsResponse[]; /** * Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default */ manualTriggerConfig?: outputs.app.JobConfigurationResponseManualTriggerConfig; /** * Collection of private container registry credentials used by a Container apps job */ registries?: outputs.app.RegistryCredentialsResponse[]; /** * Maximum number of retries before failing the job. */ replicaRetryLimit?: number; /** * Maximum number of seconds a replica is allowed to run. */ replicaTimeout: number; /** * Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set to 1 by default */ scheduleTriggerConfig?: outputs.app.JobConfigurationResponseScheduleTriggerConfig; /** * Collection of secrets used by a Container Apps Job */ secrets?: outputs.app.SecretResponse[]; /** * Trigger type of the job */ triggerType: string; } /** * jobConfigurationResponseProvideDefaults sets the appropriate defaults for JobConfigurationResponse */ function jobConfigurationResponseProvideDefaults(val: JobConfigurationResponse): JobConfigurationResponse; /** * Trigger configuration of an event driven job. */ interface JobConfigurationResponseEventTriggerConfig { /** * Number of parallel replicas of a job that can run at a given time. */ parallelism?: number; /** * Minimum number of successful replica completions before overall job completion. */ replicaCompletionCount?: number; /** * Scaling configurations for event driven jobs. */ scale?: outputs.app.JobScaleResponse; } /** * jobConfigurationResponseEventTriggerConfigProvideDefaults sets the appropriate defaults for JobConfigurationResponseEventTriggerConfig */ function jobConfigurationResponseEventTriggerConfigProvideDefaults(val: JobConfigurationResponseEventTriggerConfig): JobConfigurationResponseEventTriggerConfig; /** * Manual trigger configuration for a single execution job. Properties replicaCompletionCount and parallelism would be set to 1 by default */ interface JobConfigurationResponseManualTriggerConfig { /** * Number of parallel replicas of a job that can run at a given time. */ parallelism?: number; /** * Minimum number of successful replica completions before overall job completion. */ replicaCompletionCount?: number; } /** * Cron formatted repeating trigger schedule ("* * * * *") for cronjobs. Properties completions and parallelism would be set to 1 by default */ interface JobConfigurationResponseScheduleTriggerConfig { /** * Cron formatted repeating schedule ("* * * * *") of a Cron Job. */ cronExpression: string; /** * Number of parallel replicas of a job that can run at a given time. */ parallelism?: number; /** * Minimum number of successful replica completions before overall job completion. */ replicaCompletionCount?: number; } /** * Scaling configurations for event driven jobs. */ interface JobScaleResponse { /** * Maximum number of job executions that are created for a trigger, default 100. */ maxExecutions?: number; /** * Minimum number of job executions that are created for a trigger, default 0 */ minExecutions?: number; /** * Interval to check each event source in seconds. Defaults to 30s */ pollingInterval?: number; /** * Scaling rules. */ rules?: outputs.app.JobScaleRuleResponse[]; } /** * jobScaleResponseProvideDefaults sets the appropriate defaults for JobScaleResponse */ function jobScaleResponseProvideDefaults(val: JobScaleResponse): JobScaleResponse; /** * Scaling rule. */ interface JobScaleRuleResponse { /** * Authentication secrets for the scale rule. */ auth?: outputs.app.ScaleRuleAuthResponse[]; /** * The resource ID of a user-assigned managed identity that is assigned to the job, or 'system' for system-assigned identity. */ identity?: string; /** * Metadata properties to describe the scale rule. */ metadata?: any; /** * Scale Rule Name */ name?: string; /** * Type of the scale rule * eg: azure-servicebus, redis etc. */ type?: string; } /** * Container Apps Job versioned application definition. Defines the desired state of an immutable revision. Any changes to this section Will result in a new revision being created */ interface JobTemplateResponse { /** * List of container definitions for the Container App. */ containers?: outputs.app.ContainerResponse[]; /** * List of specialized containers that run before app containers. */ initContainers?: outputs.app.InitContainerResponse[]; /** * List of volume definitions for the Container App. */ volumes?: outputs.app.VolumeResponse[]; } /** * The configuration settings of the checks that should be made while validating the JWT Claims. */ interface JwtClaimChecksResponse { /** * The list of the allowed client applications. */ allowedClientApplications?: string[]; /** * The list of the allowed groups. */ allowedGroups?: string[]; } /** * Configuration properties Keda component */ interface KedaConfigurationResponse { /** * The version of Keda */ version: string; } /** * Knowledge graph configuration for agent */ interface KnowledgeGraphConfigurationResponse { /** * The identity used to access the knowledge graph */ identity?: string; /** * The list of resources managed by agent */ managedResources?: string[]; } /** * The lifecycle configuration properties of a session in the dynamic session pool */ interface LifecycleConfigurationResponse { /** * The cooldown period of a session in seconds when the lifecycle type is 'Timed'. */ cooldownPeriodInSeconds?: number; /** * The lifecycle type of the session pool. */ lifecycleType?: string; /** * The maximum alive period of a session in seconds when the lifecycle type is 'OnContainerExit'. */ maxAlivePeriodInSeconds?: number; } /** * Log Analytics configuration, must only be provided when destination is configured as 'log-analytics' */ interface LogAnalyticsConfigurationResponse { /** * Log analytics customer id */ customerId?: string; /** * Boolean indicating whether to parse json string log into dynamic json columns */ dynamicJsonColumns?: boolean; } /** * Log Configurations */ interface LogConfigurationResponse { /** * Application Insights Configuration */ applicationInsightsConfiguration?: outputs.app.ApplicationInsightsConfigurationResponse; } /** * Logger settings for java workloads. */ interface LoggerSettingResponse { /** * The specified logger's log level. */ level: string; /** * Logger name. */ logger: string; } /** * The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization. */ interface LoginResponse { /** * External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. * This is an advanced setting typically only needed by Windows Store application backends. * Note that URLs within the current domain are always implicitly allowed. */ allowedExternalRedirectUrls?: string[]; /** * The configuration settings of the session cookie's expiration. */ cookieExpiration?: outputs.app.CookieExpirationResponse; /** * The configuration settings of the nonce used in the login flow. */ nonce?: outputs.app.NonceResponse; /** * true if the fragments from the request are preserved after the login request is made; otherwise, false. */ preserveUrlFragmentsForLogins?: boolean; /** * The routes that specify the endpoints used for login and logout requests. */ routes?: outputs.app.LoginRoutesResponse; /** * The configuration settings of the token store. */ tokenStore?: outputs.app.TokenStoreResponse; } /** * The routes that specify the endpoints used for login and logout requests. */ interface LoginRoutesResponse { /** * The endpoint at which a logout request should be made. */ logoutEndpoint?: string; } /** * The configuration settings of the login flow, including the scopes that should be requested. */ interface LoginScopesResponse { /** * A list of the scopes that should be requested while authenticating. */ scopes?: string[]; } /** * Configuration of Open Telemetry logs */ interface LogsConfigurationResponse { /** * Open telemetry logs destinations */ destinations?: string[]; } /** * Certificate resource specific properties */ interface ManagedCertificateResponseProperties { /** * Selected type of domain control validation for managed certificates. */ domainControlValidation?: string; /** * Any error occurred during the certificate provision. */ error: string; /** * Provisioning state of the certificate. */ provisioningState: string; /** * Subject name of the certificate. */ subjectName?: string; /** * A TXT token used for DNS TXT domain control validation when issuing this type of managed certificates. */ validationToken: string; } /** * Peer traffic encryption settings for the Managed Environment */ interface ManagedEnvironmentResponseEncryption { /** * Boolean indicating whether the peer traffic encryption is enabled */ enabled?: boolean; } /** * Peer authentication settings for the Managed Environment */ interface ManagedEnvironmentResponsePeerAuthentication { /** * Mutual TLS authentication settings for the Managed Environment */ mtls?: outputs.app.MtlsResponse; } /** * Peer traffic settings for the Managed Environment */ interface ManagedEnvironmentResponsePeerTrafficConfiguration { /** * Peer traffic encryption settings for the Managed Environment */ encryption?: outputs.app.ManagedEnvironmentResponseEncryption; } /** * Storage properties */ interface ManagedEnvironmentStorageResponseProperties { /** * Azure file properties */ azureFile?: outputs.app.AzureFilePropertiesResponse; /** * NFS Azure file properties */ nfsAzureFile?: outputs.app.NfsAzureFilePropertiesResponse; } /** * Optional settings for a Managed Identity that is assigned to the Session pool. */ interface ManagedIdentitySettingResponse { /** * The resource ID of a user-assigned managed identity that is assigned to the Session Pool, or 'system' for system-assigned identity. */ identity: string; /** * Use to select the lifecycle stages of a Session Pool during which the Managed Identity should be available. */ lifecycle?: string; } /** * managedIdentitySettingResponseProvideDefaults sets the appropriate defaults for ManagedIdentitySettingResponse */ function managedIdentitySettingResponseProvideDefaults(val: ManagedIdentitySettingResponse): ManagedIdentitySettingResponse; /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.app.UserAssignedIdentityResponse; }; } /** * Configuration of Open Telemetry metrics */ interface MetricsConfigurationResponse { /** * Open telemetry metrics destinations */ destinations?: string[]; /** * Boolean indicating if including keda metrics */ includeKeda?: boolean; } /** * Configuration properties for mutual TLS authentication */ interface MtlsResponse { /** * Boolean indicating whether the mutual TLS authentication is enabled */ enabled?: boolean; } /** * Nacos properties. */ interface NacosComponentResponse { /** * Type of the Java Component. * Expected value is 'Nacos'. */ componentType: "Nacos"; /** * List of Java Components configuration properties */ configurations?: outputs.app.JavaComponentConfigurationPropertyResponse[]; /** * Java Component Ingress configurations. */ ingress?: outputs.app.JavaComponentIngressResponse; /** * Provisioning state of the Java Component. */ provisioningState: string; /** * Java component scaling configurations */ scale?: outputs.app.JavaComponentPropertiesResponseScale; /** * List of Java Components that are bound to the Java component */ serviceBinds?: outputs.app.JavaComponentServiceBindResponse[]; } /** * NFS Azure File Properties. */ interface NfsAzureFilePropertiesResponse { /** * Access mode for storage */ accessMode?: string; /** * Server for NFS azure file. */ server?: string; /** * NFS Azure file share name. */ shareName?: string; } /** * The configuration settings of the nonce used in the login flow. */ interface NonceResponse { /** * The time after the request is made when the nonce should expire. */ nonceExpirationInterval?: string; /** * false if the nonce should not be validated while completing the login flow; otherwise, true. */ validateNonce?: boolean; } /** * The authentication client credentials of the custom Open ID Connect provider. */ interface OpenIdConnectClientCredentialResponse { /** * The app setting that contains the client secret for the custom Open ID Connect provider. */ clientSecretSettingName?: string; /** * The method that should be used to authenticate the user. */ method?: string; } /** * The configuration settings of the endpoints used for the custom Open ID Connect provider. */ interface OpenIdConnectConfigResponse { /** * The endpoint to be used to make an authorization request. */ authorizationEndpoint?: string; /** * The endpoint that provides the keys necessary to validate the token. */ certificationUri?: string; /** * The endpoint that issues the token. */ issuer?: string; /** * The endpoint to be used to request a token. */ tokenEndpoint?: string; /** * The endpoint that contains all the configuration endpoints for the provider. */ wellKnownOpenIdConfiguration?: string; } /** * The configuration settings of the login flow of the custom Open ID Connect provider. */ interface OpenIdConnectLoginResponse { /** * The name of the claim that contains the users name. */ nameClaimType?: string; /** * A list of the scopes that should be requested while authenticating. */ scopes?: string[]; } /** * The configuration settings of the app registration for the custom Open ID Connect provider. */ interface OpenIdConnectRegistrationResponse { /** * The authentication credentials of the custom Open ID Connect provider. */ clientCredential?: outputs.app.OpenIdConnectClientCredentialResponse; /** * The client id of the custom Open ID Connect provider. */ clientId?: string; /** * The configuration settings of the endpoints used for the custom Open ID Connect provider. */ openIdConnectConfiguration?: outputs.app.OpenIdConnectConfigResponse; } /** * Configuration of Open Telemetry */ interface OpenTelemetryConfigurationResponse { /** * Open telemetry destinations configuration */ destinationsConfiguration?: outputs.app.DestinationsConfigurationResponse; /** * Open telemetry logs configuration */ logsConfiguration?: outputs.app.LogsConfigurationResponse; /** * Open telemetry metrics configuration */ metricsConfiguration?: outputs.app.MetricsConfigurationResponse; /** * Open telemetry trace configuration */ tracesConfiguration?: outputs.app.TracesConfigurationResponse; } /** * Configuration of otlp */ interface OtlpConfigurationResponse { /** * The endpoint of otlp configuration */ endpoint?: string; /** * Headers of otlp configurations */ headers?: outputs.app.HeaderResponse[]; /** * Boolean indicating if otlp configuration is insecure */ insecure?: boolean; /** * The name of otlp configuration */ name?: string; } /** * Model representing a pre-build step. */ interface PreBuildStepResponse { /** * Description of the pre-build step. */ description?: string; /** * Http get request to send before the build. */ httpGet?: outputs.app.HttpGetResponse; /** * List of custom commands to run. */ scripts?: string[]; } /** * The Private Endpoint Connection resource. */ interface PrivateEndpointConnectionResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The resource of private end point. */ privateEndpoint?: outputs.app.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.app.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.app.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The Private Endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Container App container Azure Queue based scaling rule. */ interface QueueScaleRuleResponse { /** * Storage account name. required if using managed identity to authenticate */ accountName?: string; /** * Authentication secrets for the queue scale rule. */ auth?: outputs.app.ScaleRuleAuthResponse[]; /** * The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. */ identity?: string; /** * Queue length. */ queueLength?: number; /** * Queue name. */ queueName?: string; } /** * Container App Private Registry */ interface RegistryCredentialsResponse { /** * A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system' */ identity?: string; /** * The name of the Secret that contains the registry login password */ passwordSecretRef?: string; /** * Container Registry Server */ server?: string; /** * Container Registry Username */ username?: string; } /** * Container App registry information. */ interface RegistryInfoResponse { /** * registry server Url. */ registryUrl?: string; /** * registry username. */ registryUserName?: string; } /** * Container App Runtime configuration. */ interface RuntimeResponse { /** * .NET app configuration */ dotnet?: outputs.app.RuntimeResponseDotnet; /** * Java app configuration */ java?: outputs.app.RuntimeResponseJava; } /** * .NET app configuration */ interface RuntimeResponseDotnet { /** * Auto configure the ASP.NET Core Data Protection feature */ autoConfigureDataProtection?: boolean; } /** * Java app configuration */ interface RuntimeResponseJava { /** * Enable jmx core metrics for the java app */ enableMetrics?: boolean; /** * Diagnostic capabilities achieved by java agent */ javaAgent?: outputs.app.RuntimeResponseJavaAgent; } /** * Diagnostic capabilities achieved by java agent */ interface RuntimeResponseJavaAgent { /** * Enable java agent injection for the java app. */ enabled?: boolean; /** * Capabilities on the java logging scenario. */ logging?: outputs.app.RuntimeResponseLogging; } /** * Capabilities on the java logging scenario. */ interface RuntimeResponseLogging { /** * Settings of the logger for the java app. */ loggerSettings?: outputs.app.LoggerSettingResponse[]; } /** * Scale configuration. */ interface ScaleConfigurationResponse { /** * The maximum count of sessions at the same time. */ maxConcurrentSessions?: number; /** * The minimum count of ready session instances. */ readySessionInstances?: number; } /** * Container App scaling configurations. */ interface ScaleResponse { /** * Optional. KEDA Cooldown Period. Defaults to 300 seconds if not set. */ cooldownPeriod?: number; /** * Optional. Maximum number of container replicas. Defaults to 10 if not set. */ maxReplicas?: number; /** * Optional. Minimum number of container replicas. */ minReplicas?: number; /** * Optional. KEDA Polling Interval. Defaults to 30 seconds if not set. */ pollingInterval?: number; /** * Scaling rules. */ rules?: outputs.app.ScaleRuleResponse[]; } /** * scaleResponseProvideDefaults sets the appropriate defaults for ScaleResponse */ function scaleResponseProvideDefaults(val: ScaleResponse): ScaleResponse; /** * Auth Secrets for Scale Rule */ interface ScaleRuleAuthResponse { /** * Name of the secret from which to pull the auth params. */ secretRef?: string; /** * Trigger Parameter that uses the secret */ triggerParameter?: string; } /** * Container App container scaling rule. */ interface ScaleRuleResponse { /** * Azure Queue based scaling. */ azureQueue?: outputs.app.QueueScaleRuleResponse; /** * Custom scale rule. */ custom?: outputs.app.CustomScaleRuleResponse; /** * HTTP requests based scaling. */ http?: outputs.app.HttpScaleRuleResponse; /** * Scale Rule Name */ name?: string; /** * Tcp requests based scaling. */ tcp?: outputs.app.TcpScaleRuleResponse; } /** * Spring Cloud Gateway route definition */ interface ScgRouteResponse { /** * Filters of the route */ filters?: string[]; /** * Id of the route */ id: string; /** * Order of the route */ order?: number; /** * Predicates of the route */ predicates?: string[]; /** * Uri of the route */ uri: string; } /** * Maintenance schedule entry for a managed environment. */ interface ScheduledEntryResponse { /** * Length of maintenance window range from 8 to 24 hours. */ durationHours: number; /** * Start hour after which managed environment maintenance can start from 0 to 23 hour. */ startHourUtc: number; /** * Day of the week when a managed environment can be patched. */ weekDay: string; } /** * Properties for a secret stored in a Key Vault. */ interface SecretKeyVaultPropertiesResponse { /** * Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. */ identity?: string; /** * URL pointing to the Azure Key Vault secret. */ keyVaultUrl?: string; } /** * Secret definition. */ interface SecretResponse { /** * Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned identity. */ identity?: string; /** * Azure Key Vault URL pointing to the secret referenced by the container app. */ keyVaultUrl?: string; /** * Secret Name. */ name?: string; } /** * Secret to be added to volume. */ interface SecretVolumeItemResponse { /** * Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. */ path?: string; /** * Name of the Container App secret from which to pull the secret value. */ secretRef?: string; } /** * Configuration to bind a ContainerApp to a dev ContainerApp Service */ interface ServiceBindResponse { /** * Type of the client to be used to connect to the service */ clientType?: string; /** * Customized keys for customizing injected values to the app */ customizedKeys?: { [key: string]: string; }; /** * Name of the service bind */ name?: string; /** * Resource id of the target service */ serviceId?: string; } /** * Container App to be a dev service */ interface ServiceResponse { /** * Dev ContainerApp service type */ type: string; } /** * Container resource requirements for sessions of the session pool. */ interface SessionContainerResourcesResponse { /** * Required CPU in cores, e.g. 0.5 */ cpu?: number; /** * Required memory, e.g. "250Mb" */ memory?: string; } /** * Container definitions for the sessions of the session pool. */ interface SessionContainerResponse { /** * Container start command arguments. */ args?: string[]; /** * Container start command. */ command?: string[]; /** * Container environment variables. */ env?: outputs.app.EnvironmentVarResponse[]; /** * Container image tag. */ image?: string; /** * Custom container name. */ name?: string; /** * List of probes for the container. */ probes?: outputs.app.SessionProbeResponse[]; /** * Container resource requirements. */ resources?: outputs.app.SessionContainerResourcesResponse; } /** * Session pool ingress configuration. */ interface SessionIngressResponse { /** * Target port in containers for traffic from ingress */ targetPort?: number; } /** * Session network configuration. */ interface SessionNetworkConfigurationResponse { /** * Network status for the sessions. */ status?: string; } /** * Secret definition. */ interface SessionPoolSecretResponse { /** * Secret Name. */ name?: string; } /** * Session probe configuration. */ interface SessionProbeResponse { /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10. */ failureThreshold?: number; /** * HTTPGet specifies the http request to perform. */ httpGet?: outputs.app.SessionProbeResponseHttpGet; /** * Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. */ periodSeconds?: number; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10. */ successThreshold?: number; /** * TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. */ tcpSocket?: outputs.app.SessionProbeResponseTcpSocket; /** * Optional duration in seconds the pod needs to terminate gracefully upon probe failure. The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this value overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour) */ terminationGracePeriodSeconds?: number; /** * Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum value is 240. */ timeoutSeconds?: number; /** * Denotes the type of probe. Can be Liveness or Startup, Readiness probe is not supported in sessions. Type must be unique for each probe within the context of a list of probes (SessionProbes). */ type?: string; } /** * HTTPGet specifies the http request to perform. */ interface SessionProbeResponseHttpGet { /** * Host name to connect to, defaults to the pod IP. You probably want to set "Host" in httpHeaders instead. */ host?: string; /** * Custom headers to set in the request. HTTP allows repeated headers. */ httpHeaders?: outputs.app.SessionProbeResponseHttpHeaders[]; /** * Path to access on the HTTP server. */ path?: string; /** * Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number; /** * Scheme to use for connecting to the host. Defaults to HTTP. */ scheme?: string; } /** * HTTPHeader describes a custom header to be used in HTTP probes */ interface SessionProbeResponseHttpHeaders { /** * The header field name */ name: string; /** * The header field value */ value: string; } /** * TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. */ interface SessionProbeResponseTcpSocket { /** * Optional: Host name to connect to, defaults to the pod IP. */ host?: string; /** * Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. */ port: number; } /** * Session pool private registry credentials. */ interface SessionRegistryCredentialsResponse { /** * A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system' */ identity?: string; /** * The name of the secret that contains the registry login password */ passwordSecretRef?: string; /** * Container registry server. */ server?: string; /** * Container registry username. */ username?: string; } /** * SMB storage properties */ interface SmbStorageResponse { /** * Access mode for storage */ accessMode?: string; /** * The domain name for the user. */ domain?: string; /** * The host name or IP address of the SMB server. */ host?: string; /** * The password for the user. */ password?: string; /** * The path to the SMB shared folder. */ shareName?: string; /** * The user to log on to the SMB server. */ username?: string; } /** * Spring Boot Admin properties. */ interface SpringBootAdminComponentResponse { /** * Type of the Java Component. * Expected value is 'SpringBootAdmin'. */ componentType: "SpringBootAdmin"; /** * List of Java Components configuration properties */ configurations?: outputs.app.JavaComponentConfigurationPropertyResponse[]; /** * Java Component Ingress configurations. */ ingress?: outputs.app.JavaComponentIngressResponse; /** * Provisioning state of the Java Component. */ provisioningState: string; /** * Java component scaling configurations */ scale?: outputs.app.JavaComponentPropertiesResponseScale; /** * List of Java Components that are bound to the Java component */ serviceBinds?: outputs.app.JavaComponentServiceBindResponse[]; } /** * Spring Cloud Config properties. */ interface SpringCloudConfigComponentResponse { /** * Type of the Java Component. * Expected value is 'SpringCloudConfig'. */ componentType: "SpringCloudConfig"; /** * List of Java Components configuration properties */ configurations?: outputs.app.JavaComponentConfigurationPropertyResponse[]; /** * Provisioning state of the Java Component. */ provisioningState: string; /** * Java component scaling configurations */ scale?: outputs.app.JavaComponentPropertiesResponseScale; /** * List of Java Components that are bound to the Java component */ serviceBinds?: outputs.app.JavaComponentServiceBindResponse[]; } /** * Spring Cloud Eureka properties. */ interface SpringCloudEurekaComponentResponse { /** * Type of the Java Component. * Expected value is 'SpringCloudEureka'. */ componentType: "SpringCloudEureka"; /** * List of Java Components configuration properties */ configurations?: outputs.app.JavaComponentConfigurationPropertyResponse[]; /** * Java Component Ingress configurations. */ ingress?: outputs.app.JavaComponentIngressResponse; /** * Provisioning state of the Java Component. */ provisioningState: string; /** * Java component scaling configurations */ scale?: outputs.app.JavaComponentPropertiesResponseScale; /** * List of Java Components that are bound to the Java component */ serviceBinds?: outputs.app.JavaComponentServiceBindResponse[]; } /** * Spring Cloud Gateway properties. */ interface SpringCloudGatewayComponentResponse { /** * Type of the Java Component. * Expected value is 'SpringCloudGateway'. */ componentType: "SpringCloudGateway"; /** * List of Java Components configuration properties */ configurations?: outputs.app.JavaComponentConfigurationPropertyResponse[]; /** * Java Component Ingress configurations. */ ingress?: outputs.app.JavaComponentIngressResponse; /** * Provisioning state of the Java Component. */ provisioningState: string; /** * Java component scaling configurations */ scale?: outputs.app.JavaComponentPropertiesResponseScale; /** * List of Java Components that are bound to the Java component */ serviceBinds?: outputs.app.JavaComponentServiceBindResponse[]; /** * Gateway route definition */ springCloudGatewayRoutes?: outputs.app.ScgRouteResponse[]; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Defines parameters for tcp connection pooling */ interface TcpConnectionPoolResponse { /** * Maximum number of tcp connections allowed */ maxConnections?: number; } /** * Policy that defines tcp request retry conditions */ interface TcpRetryPolicyResponse { /** * Maximum number of attempts to connect to the tcp service */ maxConnectAttempts?: number; } /** * Container App container Tcp scaling rule. */ interface TcpScaleRuleResponse { /** * Authentication secrets for the tcp scale rule. */ auth?: outputs.app.ScaleRuleAuthResponse[]; /** * The resource ID of a user-assigned managed identity that is assigned to the Container App, or 'system' for system-assigned identity. */ identity?: string; /** * Metadata properties to describe tcp scale rule. */ metadata?: { [key: string]: string; }; } /** * Container App versioned application definition. * Defines the desired state of an immutable revision. * Any changes to this section Will result in a new revision being created */ interface TemplateResponse { /** * List of container definitions for the Container App. */ containers?: outputs.app.ContainerResponse[]; /** * List of specialized containers that run before app containers. */ initContainers?: outputs.app.InitContainerResponse[]; /** * User friendly suffix that is appended to the revision name */ revisionSuffix?: string; /** * Scaling properties for the Container App. */ scale?: outputs.app.ScaleResponse; /** * List of container app services bound to the app */ serviceBinds?: outputs.app.ServiceBindResponse[]; /** * Optional duration in seconds the Container App Instance needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. Set this value longer than the expected cleanup time for your process. Defaults to 30 seconds. */ terminationGracePeriodSeconds?: number; /** * List of volume definitions for the Container App. */ volumes?: outputs.app.VolumeResponse[]; } /** * templateResponseProvideDefaults sets the appropriate defaults for TemplateResponse */ function templateResponseProvideDefaults(val: TemplateResponse): TemplateResponse; /** * Policy to set request timeouts */ interface TimeoutPolicyResponse { /** * Timeout, in seconds, for a request to initiate a connection */ connectionTimeoutInSeconds?: number; /** * Timeout, in seconds, for a request to respond */ responseTimeoutInSeconds?: number; } /** * The configuration settings of the token store. */ interface TokenStoreResponse { /** * The configuration settings of the storage of the tokens if blob storage is used. */ azureBlobStorage?: outputs.app.BlobStorageTokenStoreResponse; /** * true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. * The default is false. */ enabled?: boolean; /** * The number of hours after session token expiration that a session token can be used to * call the token refresh API. The default is 72 hours. */ tokenRefreshExtensionHours?: number; } /** * Configuration of Open Telemetry traces */ interface TracesConfigurationResponse { /** * Open telemetry traces destinations */ destinations?: string[]; /** * Boolean indicating if including dapr traces */ includeDapr?: boolean; } /** * Traffic weight assigned to a revision */ interface TrafficWeightResponse { /** * Associates a traffic label with a revision */ label?: string; /** * Indicates that the traffic weight belongs to a latest stable revision */ latestRevision?: boolean; /** * Name of a revision */ revisionName?: string; /** * Traffic weight assigned to a revision */ weight?: number; } /** * trafficWeightResponseProvideDefaults sets the appropriate defaults for TrafficWeightResponse */ function trafficWeightResponseProvideDefaults(val: TrafficWeightResponse): TrafficWeightResponse; /** * The configuration settings of the app registration for the Twitter provider. */ interface TwitterRegistrationResponse { /** * The OAuth 1.0a consumer key of the Twitter application used for sign-in. * This setting is required for enabling Twitter Sign-In. * Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in */ consumerKey?: string; /** * The app setting name that contains the OAuth 1.0a consumer secret of the Twitter * application used for sign-in. */ consumerSecretSettingName?: string; } /** * The configuration settings of the Twitter provider. */ interface TwitterResponse { /** * false if the Twitter provider should not be enabled despite the set registration; otherwise, true. */ enabled?: boolean; /** * The configuration settings of the app registration for the Twitter provider. */ registration?: outputs.app.TwitterRegistrationResponse; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Configuration properties for apps environment to join a Virtual Network */ interface VnetConfigurationResponse { /** * CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other provided IP ranges. */ dockerBridgeCidr?: string; /** * Resource ID of a subnet for infrastructure components. Must not overlap with any other provided IP ranges. */ infrastructureSubnetId?: string; /** * Boolean indicating the environment only has an internal load balancer. These environments do not have a public static IP resource. They must provide infrastructureSubnetId if enabling this property */ internal?: boolean; /** * IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must not overlap with any other provided IP ranges. */ platformReservedCidr?: string; /** * An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server. */ platformReservedDnsIP?: string; } /** * Volume mount for the Container App. */ interface VolumeMountResponse { /** * Path within the container at which the volume should be mounted.Must not contain ':'. */ mountPath?: string; /** * Path within the volume from which the container's volume should be mounted. Defaults to "" (volume's root). */ subPath?: string; /** * This must match the Name of a Volume. */ volumeName?: string; } /** * Volume definitions for the Container App. */ interface VolumeResponse { /** * Mount options used while mounting the Azure file share or NFS Azure file share. Must be a comma-separated string. */ mountOptions?: string; /** * Volume name. */ name?: string; /** * List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume. */ secrets?: outputs.app.SecretVolumeItemResponse[]; /** * Name of storage resource. No need to provide for EmptyDir and Secret. */ storageName?: string; /** * Storage type for the volume. If not provided, use EmptyDir. */ storageType?: string; } /** * Additional workflow properties. */ interface WorkflowEnvelopeResponseProperties { /** * Gets or sets the files. */ files?: any; /** * Gets or sets the state of the workflow. */ flowState?: string; /** * Gets or sets workflow health. */ health?: outputs.app.WorkflowHealthResponse; } /** * Represents the workflow health. */ interface WorkflowHealthResponse { /** * Gets or sets the workflow error. */ error?: outputs.app.ErrorEntityResponse; /** * Gets or sets the workflow health state. */ state: string; } /** * Workload profile to scope container app execution. */ interface WorkloadProfileResponse { /** * Whether to use a FIPS-enabled OS. Supported only for dedicated workload profiles. */ enableFips?: boolean; /** * The maximum capacity. */ maximumCount?: number; /** * The minimum capacity. */ minimumCount?: number; /** * Workload profile type for the workloads to run on. */ name: string; /** * Workload profile type for the workloads to run on. */ workloadProfileType: string; } /** * workloadProfileResponseProvideDefaults sets the appropriate defaults for WorkloadProfileResponse */ function workloadProfileResponseProvideDefaults(val: WorkloadProfileResponse): WorkloadProfileResponse; } export declare namespace appcomplianceautomation { /** * A class represent the certification record synchronized from app compliance. */ interface CertSyncRecordResponse { /** * Indicates the status of certification process. */ certificationStatus?: string; /** * The control records list to be synchronized. */ controls?: outputs.appcomplianceautomation.ControlSyncRecordResponse[]; /** * Indicates the status of compliance process. */ ingestionStatus?: string; /** * The offerGuid which mapping to the reports. */ offerGuid?: string; } /** * A class represent the control record synchronized from app compliance. */ interface ControlSyncRecordResponse { /** * The Id of the control. e.g. "Operational_Security_10" */ controlId?: string; /** * Control status synchronized from app compliance. */ controlStatus?: string; } /** * The overview of the compliance result for one report. */ interface OverviewStatusResponse { /** * The count of all failed control. */ failedCount: number; /** * The count of all manual control. */ manualCount: number; /** * The count of all not applicable control. */ notApplicableCount: number; /** * The count of all passed control. */ passedCount: number; /** * The count of all pending for approval control. */ pendingCount: number; } /** * A list which includes all the compliance result for one report. */ interface ReportComplianceStatusResponse { /** * The Microsoft 365 certification name. */ m365: outputs.appcomplianceautomation.OverviewStatusResponse; } /** * Single resource Id's metadata. */ interface ResourceMetadataResponse { /** * Account Id. For example - the AWS account id. */ accountId?: string; /** * Resource Id - e.g. "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1". */ resourceId: string; /** * Resource kind. */ resourceKind?: string; /** * Resource Origin. */ resourceOrigin?: string; /** * Resource type. e.g. "Microsoft.Compute/virtualMachines" */ resourceType?: string; } /** * Scoping answer. */ interface ScopingAnswerResponse { /** * Question answer value list. */ answers: string[]; /** * Question id. */ questionId: string; } /** * The definition of a scoping question. */ interface ScopingQuestionResponse { /** * Input type of the question answer. */ inputType: string; /** * Option id list. */ optionIds: string[]; /** * Question id. */ questionId: string; /** * The rule of the question. */ rules: string[]; /** * The answer value to show the sub questions. */ showSubQuestionsValue: string; /** * Superior question id. */ superiorQuestionId: string; } /** * Single status. */ interface StatusItemResponse { /** * Status name - e.g. "Active", "Failed". */ statusName?: string; /** * Status value. e.g. "100", or "100%". */ statusValue?: string; } /** * The information of 'bring your own storage' account binding to the report */ interface StorageInfoResponse { /** * 'bring your own storage' account name */ accountName?: string; /** * The region of 'bring your own storage' account */ location?: string; /** * The resourceGroup which 'bring your own storage' account belongs to */ resourceGroup?: string; /** * The subscription id which 'bring your own storage' account belongs to */ subscriptionId?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace appconfiguration { /** * An API key used for authenticating with a configuration store endpoint. */ interface ApiKeyResponse { /** * A connection string that can be used by supporting clients for authentication. */ connectionString: string; /** * The key ID. */ id: string; /** * The last time any of the key's properties were modified. */ lastModified: string; /** * A name for the key describing its usage. */ name: string; /** * Whether this key can only be used for read operations. */ readOnly: boolean; /** * The value of the key that is used for authentication purposes. */ value: string; } /** * The data plane proxy settings for a configuration store. */ interface DataPlaneProxyPropertiesResponse { /** * The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. */ authenticationMode?: string; /** * The data plane proxy private link delegation. This property manages if a request from delegated Azure Resource Manager (ARM) private link is allowed when the data plane resource requires private link. */ privateLinkDelegation?: string; } /** * The encryption settings for a configuration store. */ interface EncryptionPropertiesResponse { /** * Key vault properties. */ keyVaultProperties?: outputs.appconfiguration.KeyVaultPropertiesResponse; } /** * Settings concerning key vault encryption for a configuration store. */ interface KeyVaultPropertiesResponse { /** * The client id of the identity which will be used to access key vault. */ identityClientId?: string; /** * The URI of the key vault key used to encrypt data. */ keyIdentifier?: string; } /** * A reference to a related private endpoint connection. */ interface PrivateEndpointConnectionReferenceResponse { /** * The resource ID. */ id: string; /** * The name of the resource. */ name: string; /** * The resource of private endpoint. */ privateEndpoint?: outputs.appconfiguration.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.appconfiguration.PrivateLinkServiceConnectionStateResponse; /** * The provisioning status of the private endpoint connection. */ provisioningState: string; /** * The type of the resource. */ type: string; } /** * Private endpoint which a connection belongs to. */ interface PrivateEndpointResponse { /** * The resource Id for private endpoint */ id?: string; } /** * The state of a private link service connection. */ interface PrivateLinkServiceConnectionStateResponse { /** * Any action that is required beyond basic workflow (approve/ reject/ disconnect) */ actionsRequired: string; /** * The private link service connection description. */ description?: string; /** * The private link service connection status. */ status?: string; } /** * An identity that can be associated with a resource. */ interface ResourceIdentityResponse { /** * The principal id of the identity. This property will only be provided for a system-assigned identity. */ principalId: string; /** * The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity. */ tenantId: string; /** * The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. */ type?: string; /** * The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.appconfiguration.UserIdentityResponse; }; } /** * Describes a configuration store SKU. */ interface SkuResponse { /** * The SKU name of the configuration store. */ name: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * A resource identity that is managed by the user of the service. */ interface UserIdentityResponse { /** * The client ID of the user-assigned identity. */ clientId: string; /** * The principal ID of the user-assigned identity. */ principalId: string; } } export declare namespace applicationinsights { /** * A set of properties that can be defined in the context of a specific item type. Each type may have its own properties. */ interface ApplicationInsightsComponentAnalyticsItemPropertiesResponse { /** * A function alias, used when the type of the item is Function */ functionAlias?: string; } /** * An Application Insights component daily data volume cap */ interface ApplicationInsightsComponentDataVolumeCapResponse { /** * Daily data volume cap in GB. */ cap?: number; /** * Maximum daily data volume cap that the user can set for this component. */ maxHistoryCap: number; /** * Daily data volume cap UTC reset hour. */ resetTime: number; /** * Do not send a notification email when the daily data volume cap is met. */ stopSendNotificationWhenHitCap?: boolean; /** * Reserved, not used for now. */ stopSendNotificationWhenHitThreshold?: boolean; /** * Reserved, not used for now. */ warningThreshold?: number; } /** * Properties that define a ProactiveDetection configuration. */ interface ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesResponse { /** * Custom email addresses for this rule notifications */ customEmails?: string[]; /** * A flag that indicates whether this rule is enabled by the user */ enabled?: boolean; /** * The last time this rule was updated */ lastUpdatedTime: string; /** * The rule name */ name: string; /** * Static definitions of the ProactiveDetection configuration rule (same values for all components). */ ruleDefinitions?: outputs.applicationinsights.ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesResponseRuleDefinitions; /** * A flag that indicated whether notifications on this rule should be sent to subscription owners */ sendEmailsToSubscriptionOwners?: boolean; } /** * Static definitions of the ProactiveDetection configuration rule (same values for all components). */ interface ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesResponseRuleDefinitions { /** * The rule description */ description?: string; /** * The rule name as it is displayed in UI */ displayName?: string; /** * URL which displays additional info about the proactive detection rule */ helpUrl?: string; /** * A flag indicating whether the rule is enabled by default */ isEnabledByDefault?: boolean; /** * A flag indicating whether the rule is hidden (from the UI) */ isHidden?: boolean; /** * A flag indicating whether the rule is in preview */ isInPreview?: boolean; /** * The rule name */ name?: string; /** * A flag indicating whether email notifications are supported for detections for this rule */ supportsEmailNotifications?: boolean; } /** * A header to add to the WebTest. */ interface HeaderFieldResponse { /** * The name of the header. */ headerFieldName?: string; /** * The value of the header. */ headerFieldValue?: string; } /** * Customer Managed Identity */ interface MyWorkbookManagedIdentityResponse { /** * The identity type. */ type?: string; /** * Customer Managed Identity */ userAssignedIdentities?: outputs.applicationinsights.MyWorkbookUserAssignedIdentitiesResponse; } /** * Customer Managed Identity */ interface MyWorkbookUserAssignedIdentitiesResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; } /** * The private link scope resource reference. */ interface PrivateLinkScopedResourceResponse { /** * The full resource Id of the private link scope resource. */ resourceId?: string; /** * The private link scope unique Identifier. */ scopeId?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Geo-physical location to run a WebTest from. You must specify one or more locations for the test to run from. */ interface WebTestGeolocationResponse { /** * Location ID for the WebTest to run from. */ location?: string; } /** * An XML configuration specification for a WebTest. */ interface WebTestPropertiesConfigurationResponse { /** * The XML specification of a WebTest to run against an application. */ webTest?: string; } /** * The collection of request properties */ interface WebTestPropertiesRequestResponse { /** * Follow redirects for this web test. */ followRedirects?: boolean; /** * List of headers and their values to add to the WebTest call. */ headers?: outputs.applicationinsights.HeaderFieldResponse[]; /** * Http verb to use for this web test. */ httpVerb?: string; /** * Parse Dependent request for this WebTest. */ parseDependentRequests?: boolean; /** * Base64 encoded string body to send with this web test. */ requestBody?: string; /** * Url location to test. */ requestUrl?: string; } /** * The collection of content validation properties */ interface WebTestPropertiesValidationRulesContentValidationResponse { /** * Content to look for in the return of the WebTest. Must not be null or empty. */ contentMatch?: string; /** * When set, this value makes the ContentMatch validation case insensitive. */ ignoreCase?: boolean; /** * When true, validation will pass if there is a match for the ContentMatch string. If false, validation will fail if there is a match */ passIfTextFound?: boolean; } /** * The collection of validation rule properties */ interface WebTestPropertiesValidationRulesResponse { /** * The collection of content validation properties */ contentValidation?: outputs.applicationinsights.WebTestPropertiesValidationRulesContentValidationResponse; /** * Validate that the WebTest returns the http status code provided. */ expectedHttpStatusCode?: number; /** * When set, validation will ignore the status code. */ ignoreHttpStatusCode?: boolean; /** * A number of days to check still remain before the the existing SSL cert expires. Value must be positive and the SSLCheck must be set to true. */ sSLCertRemainingLifetimeCheck?: number; /** * Checks to see if the SSL cert is still valid. */ sSLCheck?: boolean; } /** * Identity used for BYOS */ interface WorkbookResourceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.applicationinsights.UserAssignedIdentityResponse; }; } /** * Gallery information for a workbook template. */ interface WorkbookTemplateGalleryResponse { /** * Category for the gallery. */ category?: string; /** * Name of the workbook template in the gallery. */ name?: string; /** * Order of the template within the gallery. */ order?: number; /** * Azure resource type supported by the gallery. */ resourceType?: string; /** * Type of workbook supported by the workbook template. */ type?: string; } /** * Localized template data and gallery information. */ interface WorkbookTemplateLocalizedGalleryResponse { /** * Workbook galleries supported by the template. */ galleries?: outputs.applicationinsights.WorkbookTemplateGalleryResponse[]; /** * Valid JSON object containing workbook template payload. */ templateData?: any; } } export declare namespace applink { /** * AppLink Member properties */ interface AppLinkMemberPropertiesResponse { /** * Cluster type */ clusterType?: string; /** * Connectivity profile. */ connectivityProfile?: outputs.applink.ConnectivityProfileResponse; /** * AppLink Member Metadata */ metadata: outputs.applink.MetadataResponse; /** * Observability profile */ observabilityProfile?: outputs.applink.ObservabilityProfileResponse; /** * Provisioning state */ provisioningState: string; /** * Upgrade profile. */ upgradeProfile?: outputs.applink.UpgradeProfileResponse; } /** * AppLink properties */ interface AppLinkPropertiesResponse { /** * Provisioning state */ provisioningState: string; } /** * AppLinkMember connectivity profile. */ interface ConnectivityProfileResponse { /** * East-West gateway profile. */ eastWestGateway?: outputs.applink.EastWestGatewayProfileResponse; /** * Private connect profile. */ privateConnect?: outputs.applink.PrivateConnectProfileResponse; } /** * AppLinkMember east-west gateway profile. */ interface EastWestGatewayProfileResponse { /** * East-West gateway visibility. */ visibility: string; } /** * AppLinkMember fully managed upgrade profile */ interface FullyManagedUpgradeProfileResponse { /** * Release channel */ releaseChannel: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.applink.UserAssignedIdentityResponse; }; } /** * AppLinkMember metadata */ interface MetadataResponse { /** * Resource ID */ resourceId: string; } /** * AppLinkMember metrics profile */ interface MetricsProfileResponse { /** * Metrics endpoint URL */ metricsEndpoint: string; } /** * AppLinkMember observability profile */ interface ObservabilityProfileResponse { /** * Metrics configuration */ metrics?: outputs.applink.MetricsProfileResponse; } /** * AppLinkMember private connect profile. */ interface PrivateConnectProfileResponse { /** * Delegated Subnet to AppLink. */ subnetResourceId: string; } /** * AppLinkMember self managed upgrade profile */ interface SelfManagedUpgradeProfileResponse { /** * Istio version */ version: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * AppLinkMember upgrade profile. */ interface UpgradeProfileResponse { /** * Fully managed upgrade profile. */ fullyManagedUpgradeProfile?: outputs.applink.FullyManagedUpgradeProfileResponse; /** * Upgrade mode. */ mode: string; /** * Self managed upgrade profile. */ selfManagedUpgradeProfile?: outputs.applink.SelfManagedUpgradeProfileResponse; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace appplatform { /** * Auth setting for basic auth. */ interface AcceleratorBasicAuthSettingResponse { /** * The type of the auth setting. * Expected value is 'BasicAuth'. */ authType: "BasicAuth"; /** * Resource Id of CA certificate for https URL of Git repository. */ caCertResourceId?: string; /** * Username of git repository basic auth. */ username: string; } interface AcceleratorGitRepositoryResponse { /** * Properties of the auth setting payload. */ authSetting: outputs.appplatform.AcceleratorBasicAuthSettingResponse | outputs.appplatform.AcceleratorPublicSettingResponse | outputs.appplatform.AcceleratorSshSettingResponse; /** * Git repository branch to be used. */ branch?: string; /** * Git repository commit to be used. */ commit?: string; /** * Git repository tag to be used. */ gitTag?: string; /** * Interval for checking for updates to Git or image repository. */ intervalInSeconds?: number; /** * Folder path inside the git repository to consider as the root of the accelerator or fragment. */ subPath?: string; /** * Git repository URL for the accelerator. */ url: string; } /** * Auth setting for public url. */ interface AcceleratorPublicSettingResponse { /** * The type of the auth setting. * Expected value is 'Public'. */ authType: "Public"; /** * Resource Id of CA certificate for https URL of Git repository. */ caCertResourceId?: string; } /** * Auth setting for SSH auth. */ interface AcceleratorSshSettingResponse { /** * The type of the auth setting. * Expected value is 'SSH'. */ authType: "SSH"; } /** * The properties of custom domain for API portal */ interface ApiPortalCustomDomainPropertiesResponse { /** * The thumbprint of bound certificate. */ thumbprint?: string; } /** * Collection of instances belong to the API portal */ interface ApiPortalInstanceResponse { /** * Name of the API portal instance */ name: string; /** * Status of the API portal instance */ status: string; } /** * API portal properties payload */ interface ApiPortalPropertiesResponse { /** * Indicates whether the API try-out feature is enabled or disabled. When enabled, users can try out the API by sending requests and viewing responses in API portal. When disabled, users cannot try out the API. */ apiTryOutEnabledState?: string; /** * The array of resource Ids of gateway to integrate with API portal. */ gatewayIds?: string[]; /** * Indicate if only https is allowed. */ httpsOnly?: boolean; /** * Collection of instances belong to API portal. */ instances: outputs.appplatform.ApiPortalInstanceResponse[]; /** * State of the API portal. */ provisioningState: string; /** * Indicates whether the API portal exposes endpoint. */ public?: boolean; /** * The requested resource quantity for required CPU and Memory. */ resourceRequests: outputs.appplatform.ApiPortalResourceRequestsResponse; /** * Collection of OpenAPI source URL locations. */ sourceUrls?: string[]; /** * Single sign-on related configuration */ ssoProperties?: outputs.appplatform.SsoPropertiesResponse; /** * URL of the API portal, exposed when 'public' is true. */ url: string; } /** * apiPortalPropertiesResponseProvideDefaults sets the appropriate defaults for ApiPortalPropertiesResponse */ function apiPortalPropertiesResponseProvideDefaults(val: ApiPortalPropertiesResponse): ApiPortalPropertiesResponse; /** * Resource requests of the API portal */ interface ApiPortalResourceRequestsResponse { /** * Cpu allocated to each API portal instance */ cpu: string; /** * Memory allocated to each API portal instance */ memory: string; } /** * Properties of an APM */ interface ApmPropertiesResponse { /** * Non-sensitive properties for the APM */ properties?: { [key: string]: string; }; /** * State of the APM. */ provisioningState: string; /** * APM Type */ type: string; } /** * A reference to the APM */ interface ApmReferenceResponse { /** * Resource Id of the APM */ resourceId: string; } /** * App resource properties payload */ interface AppResourcePropertiesResponse { /** * Collection of addons */ addonConfigs?: { [key: string]: any; }; /** * List of custom persistent disks */ customPersistentDisks?: outputs.appplatform.CustomPersistentDiskResourceResponse[]; /** * Indicate if end to end TLS is enabled. */ enableEndToEndTLS?: boolean; /** * Fully qualified dns Name. */ fqdn: string; /** * Indicate if only https is allowed. */ httpsOnly?: boolean; /** * App ingress settings payload. */ ingressSettings?: outputs.appplatform.IngressSettingsResponse; /** * Collection of loaded certificates */ loadedCertificates?: outputs.appplatform.LoadedCertificateResponse[]; /** * Persistent disk settings */ persistentDisk?: outputs.appplatform.PersistentDiskResponse; /** * Provisioning state of the App */ provisioningState: string; /** * Indicates whether the App exposes public endpoint */ public?: boolean; /** * Collection of auth secrets */ secrets?: outputs.appplatform.SecretResponse[]; /** * Temporary disk settings */ temporaryDisk?: outputs.appplatform.TemporaryDiskResponse; /** * State of test endpoint auth. */ testEndpointAuthState?: string; /** * URL of the App */ url: string; /** * Additional App settings in vnet injection instance */ vnetAddons?: outputs.appplatform.AppVNetAddonsResponse; /** * The workload profile used for this app. Supported for Consumption + Dedicated plan. */ workloadProfileName?: string; } /** * appResourcePropertiesResponseProvideDefaults sets the appropriate defaults for AppResourcePropertiesResponse */ function appResourcePropertiesResponseProvideDefaults(val: AppResourcePropertiesResponse): AppResourcePropertiesResponse; /** * Additional App settings in vnet injection instance */ interface AppVNetAddonsResponse { /** * Indicates whether the App in vnet injection instance exposes endpoint which could be accessed from internet. */ publicEndpoint?: boolean; /** * URL of the App in vnet injection instance which could be accessed from internet */ publicEndpointUrl: string; } /** * appVNetAddonsResponseProvideDefaults sets the appropriate defaults for AppVNetAddonsResponse */ function appVNetAddonsResponseProvideDefaults(val: AppVNetAddonsResponse): AppVNetAddonsResponse; interface ApplicationAcceleratorComponentResponse { instances: outputs.appplatform.ApplicationAcceleratorInstanceResponse[]; name: string; resourceRequests?: outputs.appplatform.ApplicationAcceleratorResourceRequestsResponse; } interface ApplicationAcceleratorInstanceResponse { /** * Name of the Application Accelerator instance. */ name: string; /** * Status of the Application Accelerator instance. It can be Pending, Running, Succeeded, Failed, Unknown. */ status: string; } /** * Application accelerator properties payload */ interface ApplicationAcceleratorPropertiesResponse { /** * Collection of components belong to application accelerator. */ components: outputs.appplatform.ApplicationAcceleratorComponentResponse[]; /** * State of the application accelerator. */ provisioningState: string; } interface ApplicationAcceleratorResourceRequestsResponse { /** * Cpu allocated to each application accelerator component. 1 core can be represented by 1 or 1000m */ cpu: string; /** * Instance count of the application accelerator component. */ instanceCount: number; /** * Memory allocated to each application accelerator component. 1 GB can be represented by 1Gi or 1024Mi. */ memory: string; } /** * Application Insights agent versions properties payload */ interface ApplicationInsightsAgentVersionsResponse { /** * Indicates the version of application insight java agent */ java: string; } /** * Application Live View properties payload */ interface ApplicationLiveViewComponentResponse { /** * Collection of instances belong to Application Live View. */ instances: outputs.appplatform.ApplicationLiveViewInstanceResponse[]; /** * Name of the component. */ name: any; /** * The requested resource quantity for required CPU and Memory. */ resourceRequests: outputs.appplatform.ApplicationLiveViewResourceRequestsResponse; } /** * Collection of instances belong to the Application Live View */ interface ApplicationLiveViewInstanceResponse { /** * Name of the Application Live View instance. */ name: string; /** * Status of the Application Live View instance. It can be Pending, Running, Succeeded, Failed, Unknown. */ status: string; } /** * Application Live View properties payload */ interface ApplicationLiveViewPropertiesResponse { /** * Component details of Application Live View */ components: outputs.appplatform.ApplicationLiveViewComponentResponse[]; /** * State of the Application Live View. */ provisioningState: string; } /** * The resource quantity for required CPU and Memory of Application Live View component */ interface ApplicationLiveViewResourceRequestsResponse { /** * Cpu quantity allocated to each Application Live View component instance. 1 core can be represented by 1 or 1000m. */ cpu: string; /** * Desired instance count of Application Live View component instance. */ instanceCount: number; /** * Memory quantity allocated to each Application Live View component instance. 1 GB can be represented by 1Gi or 1024Mi. */ memory: string; } /** * The properties of the Azure File volume. Azure File shares are mounted as volumes. */ interface AzureFileVolumeResponse { /** * If set to true, it will create and mount a dedicated directory for every individual app instance. */ enableSubPath?: boolean; /** * These are the mount options for a persistent disk. */ mountOptions?: string[]; /** * The mount path of the persistent disk. */ mountPath: string; /** * Indicates whether the persistent disk is a readOnly one. */ readOnly?: boolean; /** * The share name of the Azure File share. */ shareName?: string; /** * The type of the underlying resource to mount as a persistent disk. * Expected value is 'AzureFileVolume'. */ type: "AzureFileVolume"; } /** * azureFileVolumeResponseProvideDefaults sets the appropriate defaults for AzureFileVolumeResponse */ function azureFileVolumeResponseProvideDefaults(val: AzureFileVolumeResponse): AzureFileVolumeResponse; /** * Binding resource properties payload */ interface BindingResourcePropertiesResponse { /** * Binding parameters of the Binding resource */ bindingParameters?: { [key: string]: string; }; /** * Creation time of the Binding resource */ createdAt: string; /** * The generated Spring Boot property file for this binding. The secret will be deducted. */ generatedProperties: string; /** * The key of the bound resource */ key?: string; /** * The Azure resource id of the bound resource */ resourceId?: string; /** * The name of the bound resource */ resourceName: string; /** * The standard Azure resource type of the bound resource */ resourceType: string; /** * Update time of the Binding resource */ updatedAt: string; } /** * Build resource properties payload */ interface BuildPropertiesResponse { /** * The resource id of agent pool */ agentPool?: string; /** * The APMs for this build */ apms?: outputs.appplatform.ApmReferenceResponse[]; /** * The resource id of builder to build the source code */ builder?: string; /** * The CA Certificates for this build */ certificates?: outputs.appplatform.CertificateReferenceResponse[]; /** * The environment variables for this build */ env?: { [key: string]: string; }; /** * Provisioning state of the KPack build result */ provisioningState: string; /** * The relative path of source code */ relativePath?: string; /** * The customized build resource for this build */ resourceRequests?: outputs.appplatform.BuildResourceRequestsResponse; /** * The build result triggered by this build */ triggeredBuildResult: outputs.appplatform.TriggeredBuildResultResponse; } /** * buildPropertiesResponseProvideDefaults sets the appropriate defaults for BuildPropertiesResponse */ function buildPropertiesResponseProvideDefaults(val: BuildPropertiesResponse): BuildPropertiesResponse; /** * Resource request payload of Build Resource. */ interface BuildResourceRequestsResponse { /** * Optional Cpu allocated to the build resource. 1 core can be represented by 1 or 1000m. * The default value is 1, this should not exceed build service agent pool cpu size. */ cpu?: string; /** * Optional Memory allocated to the build resource. 1 GB can be represented by 1Gi or 1024Mi. * The default value is 2Gi, this should not exceed build service agent pool memory size. */ memory?: string; } /** * buildResourceRequestsResponseProvideDefaults sets the appropriate defaults for BuildResourceRequestsResponse */ function buildResourceRequestsResponseProvideDefaults(val: BuildResourceRequestsResponse): BuildResourceRequestsResponse; /** * Reference to a build result */ interface BuildResultUserSourceInfoResponse { /** * Resource id of an existing succeeded build result under the same Spring instance. */ buildResultId?: string; /** * Type of the source uploaded * Expected value is 'BuildResult'. */ type: "BuildResult"; /** * Version of the source */ version?: string; } /** * Build service agent pool properties */ interface BuildServiceAgentPoolPropertiesResponse { /** * build service agent pool size properties */ poolSize?: outputs.appplatform.BuildServiceAgentPoolSizePropertiesResponse; /** * Provisioning state of the build service agent pool */ provisioningState: string; } /** * Build service agent pool size properties */ interface BuildServiceAgentPoolSizePropertiesResponse { /** * The cpu property of build service agent pool size */ cpu: string; /** * The memory property of build service agent pool size */ memory: string; /** * The name of build service agent pool size */ name?: string; } /** * KPack Builder properties payload */ interface BuilderPropertiesResponse { /** * Builder buildpack groups. */ buildpackGroups?: outputs.appplatform.BuildpacksGroupPropertiesResponse[]; /** * Builder provision status. */ provisioningState: string; /** * Builder cluster stack property. */ stack?: outputs.appplatform.StackPropertiesResponse; } /** * Buildpack Binding Launch Properties */ interface BuildpackBindingLaunchPropertiesResponse { /** * Non-sensitive properties for launchProperties */ properties?: { [key: string]: string; }; /** * Sensitive properties for launchProperties */ secrets?: { [key: string]: string; }; } /** * Properties of a buildpack binding */ interface BuildpackBindingPropertiesResponse { /** * Buildpack Binding Type */ bindingType?: string; /** * The object describes the buildpack binding launch properties */ launchProperties?: outputs.appplatform.BuildpackBindingLaunchPropertiesResponse; /** * State of the Buildpack Binding. */ provisioningState: string; } /** * Buildpack properties payload */ interface BuildpackPropertiesResponse { /** * Id of the buildpack */ id?: string; /** * Version of the buildpack */ version: string; } /** * Buildpack group properties of the Builder */ interface BuildpacksGroupPropertiesResponse { /** * Buildpacks in the buildpack group */ buildpacks?: outputs.appplatform.BuildpackPropertiesResponse[]; /** * Buildpack group name */ name?: string; } /** * A reference to the certificate */ interface CertificateReferenceResponse { /** * Resource Id of the certificate */ resourceId: string; } /** * Service properties payload */ interface ClusterResourcePropertiesResponse { /** * Fully qualified dns name of the service instance */ fqdn: string; /** * The name of the resource group that contains the infrastructure resources */ infraResourceGroup?: string; /** * Additional Service settings for planned maintenance */ maintenanceScheduleConfiguration?: outputs.appplatform.WeeklyMaintenanceScheduleConfigurationResponse; /** * The resource Id of the Managed Environment that the Spring Apps instance builds on */ managedEnvironmentId?: string; /** * Purchasing 3rd party product of the Service resource. */ marketplaceResource?: outputs.appplatform.MarketplaceResourceResponse; /** * Network profile of the Service */ networkProfile?: outputs.appplatform.NetworkProfileResponse; /** * Power state of the Service */ powerState: string; /** * Provisioning state of the Service */ provisioningState: string; /** * ServiceInstanceEntity Id which uniquely identifies a created resource */ serviceId: string; /** * Version of the Service */ version: number; /** * Additional Service settings in vnet injection instance */ vnetAddons?: outputs.appplatform.ServiceVNetAddonsResponse; zoneRedundant?: boolean; } /** * clusterResourcePropertiesResponseProvideDefaults sets the appropriate defaults for ClusterResourcePropertiesResponse */ function clusterResourcePropertiesResponseProvideDefaults(val: ClusterResourcePropertiesResponse): ClusterResourcePropertiesResponse; /** * Property of git. */ interface ConfigServerGitPropertyResponse { /** * Public sshKey of git repository. */ hostKey?: string; /** * SshKey algorithm of git repository. */ hostKeyAlgorithm?: string; /** * Label of the repository */ label?: string; /** * Password of git repository basic auth. */ password?: string; /** * Private sshKey algorithm of git repository. */ privateKey?: string; /** * Repositories of git. */ repositories?: outputs.appplatform.GitPatternRepositoryResponse[]; /** * Searching path of the repository */ searchPaths?: string[]; /** * Strict host key checking or not. */ strictHostKeyChecking?: boolean; /** * URI of the repository */ uri: string; /** * Username of git repository basic auth. */ username?: string; } /** * Config server git properties payload */ interface ConfigServerPropertiesResponse { /** * Settings of config server. */ configServer?: outputs.appplatform.ConfigServerSettingsResponse; /** * Enabled state of the config server. This is only used in Consumption tier. */ enabledState?: string; /** * Error when apply config server settings. */ error?: outputs.appplatform.ErrorResponse; /** * State of the config server. */ provisioningState: string; } /** * The settings of config server. */ interface ConfigServerSettingsResponse { /** * Property of git environment. */ gitProperty?: outputs.appplatform.ConfigServerGitPropertyResponse; } /** * Property of git environment. */ interface ConfigurationServiceGitPropertyResponse { /** * Repositories of Application Configuration Service git property. */ repositories?: outputs.appplatform.ConfigurationServiceGitRepositoryResponse[]; } /** * Git repository property payload for Application Configuration Service */ interface ConfigurationServiceGitRepositoryResponse { /** * Resource Id of CA certificate for https URL of Git repository. */ caCertResourceId?: string; /** * Git libraries used to support various repository providers */ gitImplementation?: string; /** * Public sshKey of git repository. */ hostKey?: string; /** * SshKey algorithm of git repository. */ hostKeyAlgorithm?: string; /** * Label of the repository */ label: string; /** * Name of the repository */ name: string; /** * Password of git repository basic auth. */ password?: string; /** * Collection of patterns of the repository */ patterns: string[]; /** * Private sshKey algorithm of git repository. */ privateKey?: string; /** * Searching path of the repository */ searchPaths?: string[]; /** * Strict host key checking or not. */ strictHostKeyChecking?: boolean; /** * URI of the repository */ uri: string; /** * Username of git repository basic auth. */ username?: string; } /** * Collection of instances belong to the Application Configuration Service */ interface ConfigurationServiceInstanceResponse { /** * Name of the Application Configuration Service instance */ name: string; /** * Status of the Application Configuration Service instance */ status: string; } /** * Application Configuration Service properties payload */ interface ConfigurationServicePropertiesResponse { /** * The generation of the Application Configuration Service. */ generation?: string; /** * Collection of instances belong to Application Configuration Service. */ instances: outputs.appplatform.ConfigurationServiceInstanceResponse[]; /** * State of the Application Configuration Service. */ provisioningState: string; /** * The requested resource quantity for required CPU and Memory. */ resourceRequests: outputs.appplatform.ConfigurationServiceResourceRequestsResponse; /** * The settings of Application Configuration Service. */ settings?: outputs.appplatform.ConfigurationServiceSettingsResponse; } /** * configurationServicePropertiesResponseProvideDefaults sets the appropriate defaults for ConfigurationServicePropertiesResponse */ function configurationServicePropertiesResponseProvideDefaults(val: ConfigurationServicePropertiesResponse): ConfigurationServicePropertiesResponse; /** * Resource request payload of Application Configuration Service */ interface ConfigurationServiceResourceRequestsResponse { /** * Cpu allocated to each Application Configuration Service instance */ cpu: string; /** * Instance count of the Application Configuration Service */ instanceCount: number; /** * Memory allocated to each Application Configuration Service instance */ memory: string; } /** * The settings of Application Configuration Service. */ interface ConfigurationServiceSettingsResponse { /** * Property of git environment. */ gitProperty?: outputs.appplatform.ConfigurationServiceGitPropertyResponse; /** * How often (in seconds) to check repository updates. Minimum value is 0. */ refreshIntervalInSeconds?: number; } /** * Container liveness and readiness probe settings */ interface ContainerProbeSettingsResponse { /** * Indicates whether disable the liveness and readiness probe */ disableProbe?: boolean; } /** * The basic authentication properties for the container registry resource. */ interface ContainerRegistryBasicCredentialsResponse { /** * The login server of the Container Registry. */ server: string; /** * The credential type of the container registry credentials. * Expected value is 'BasicAuth'. */ type: "BasicAuth"; /** * The username of the Container Registry. */ username: string; } /** * Container registry resource payload. */ interface ContainerRegistryPropertiesResponse { /** * The credentials of the container registry resource. */ credentials: outputs.appplatform.ContainerRegistryBasicCredentialsResponse; /** * State of the Container Registry. */ provisioningState: string; } /** * Properties of certificate imported from key vault. */ interface ContentCertificatePropertiesResponse { /** * The activate date of certificate. */ activateDate: string; /** * The domain list of certificate. */ dnsNames: string[]; /** * The expiration date of certificate. */ expirationDate: string; /** * The issue date of certificate. */ issuedDate: string; /** * The issuer of certificate. */ issuer: string; /** * Provisioning state of the Certificate */ provisioningState: string; /** * The subject name of certificate. */ subjectName: string; /** * The thumbprint of certificate. */ thumbprint: string; /** * The type of the certificate source. * Expected value is 'ContentCertificate'. */ type: "ContentCertificate"; } /** * Custom container payload */ interface CustomContainerResponse { /** * Arguments to the entrypoint. The docker image's CMD is used if this is not provided. */ args?: string[]; /** * Entrypoint array. Not executed within a shell. The docker image's ENTRYPOINT is used if this is not provided. */ command?: string[]; /** * Container image of the custom container. This should be in the form of : without the server name of the registry */ containerImage?: string; /** * Credential of the image registry */ imageRegistryCredential?: outputs.appplatform.ImageRegistryCredentialResponse; /** * Language framework of the container image uploaded. Supported values: "springboot", "", null. */ languageFramework?: string; /** * The name of the registry that contains the container image */ server?: string; } /** * Custom container user source info */ interface CustomContainerUserSourceInfoResponse { /** * Custom container payload */ customContainer?: outputs.appplatform.CustomContainerResponse; /** * Type of the source uploaded * Expected value is 'Container'. */ type: "Container"; /** * Version of the source */ version?: string; } /** * Custom domain of app resource payload. */ interface CustomDomainPropertiesResponse { /** * The app name of domain. */ appName: string; /** * The bound certificate name of domain. */ certName?: string; /** * Provisioning state of the Domain */ provisioningState: string; /** * The thumbprint of bound certificate. */ thumbprint?: string; } /** * Custom persistent disk resource payload. */ interface CustomPersistentDiskResourceResponse { /** * Properties of the custom persistent disk resource payload. */ customPersistentDiskProperties?: outputs.appplatform.AzureFileVolumeResponse; /** * The resource id of Azure Spring Apps Storage resource. */ storageId: string; } /** * customPersistentDiskResourceResponseProvideDefaults sets the appropriate defaults for CustomPersistentDiskResourceResponse */ function customPersistentDiskResourceResponseProvideDefaults(val: CustomPersistentDiskResourceResponse): CustomPersistentDiskResourceResponse; /** * Azure Spring Apps App Instance Custom scaling rule. */ interface CustomScaleRuleResponse { /** * Authentication secrets for the custom scale rule. */ auth?: outputs.appplatform.ScaleRuleAuthResponse[]; /** * Metadata properties to describe custom scale rule. */ metadata?: { [key: string]: string; }; /** * Type of the custom scale rule * eg: azure-servicebus, redis etc. */ type?: string; } /** * Customized accelerator properties payload */ interface CustomizedAcceleratorPropertiesResponse { acceleratorTags?: string[]; /** * Type of the customized accelerator. */ acceleratorType?: string; description?: string; displayName?: string; gitRepository: outputs.appplatform.AcceleratorGitRepositoryResponse; iconUrl?: string; /** * Imports references all imports that this accelerator/fragment depends upon. */ imports: string[]; /** * State of the customized accelerator. */ provisioningState: string; } /** * Deployment instance payload */ interface DeploymentInstanceResponse { /** * Discovery status of the deployment instance */ discoveryStatus: string; /** * Name of the deployment instance */ name: string; /** * Failed reason of the deployment instance */ reason: string; /** * Start time of the deployment instance */ startTime: string; /** * Status of the deployment instance */ status: string; /** * Availability zone information of the deployment instance */ zone: string; } /** * Deployment resource properties payload */ interface DeploymentResourcePropertiesResponse { /** * Indicates whether the Deployment is active */ active?: boolean; /** * Deployment settings of the Deployment */ deploymentSettings?: outputs.appplatform.DeploymentSettingsResponse; /** * Collection of instances belong to the Deployment */ instances: outputs.appplatform.DeploymentInstanceResponse[]; /** * Provisioning state of the Deployment */ provisioningState: string; /** * Uploaded source information of the deployment. */ source?: outputs.appplatform.BuildResultUserSourceInfoResponse | outputs.appplatform.CustomContainerUserSourceInfoResponse | outputs.appplatform.JarUploadedUserSourceInfoResponse | outputs.appplatform.NetCoreZipUploadedUserSourceInfoResponse | outputs.appplatform.SourceUploadedUserSourceInfoResponse | outputs.appplatform.UploadedUserSourceInfoResponse | outputs.appplatform.WarUploadedUserSourceInfoResponse; /** * Status of the Deployment */ status: string; } /** * deploymentResourcePropertiesResponseProvideDefaults sets the appropriate defaults for DeploymentResourcePropertiesResponse */ function deploymentResourcePropertiesResponseProvideDefaults(val: DeploymentResourcePropertiesResponse): DeploymentResourcePropertiesResponse; /** * Deployment settings payload */ interface DeploymentSettingsResponse { /** * Collection of addons */ addonConfigs?: { [key: string]: any; }; /** * Collection of ApmReferences */ apms?: outputs.appplatform.ApmReferenceResponse[]; /** * Container liveness and readiness probe settings */ containerProbeSettings?: outputs.appplatform.ContainerProbeSettingsResponse; /** * Collection of environment variables */ environmentVariables?: { [key: string]: string; }; /** * Periodic probe of App Instance liveness. App Instance will be restarted if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */ livenessProbe?: outputs.appplatform.ProbeResponse; /** * Periodic probe of App Instance service readiness. App Instance will be removed from service endpoints if the probe fails. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */ readinessProbe?: outputs.appplatform.ProbeResponse; /** * The requested resource quantity for required CPU and Memory. It is recommended that using this field to represent the required CPU and Memory, the old field cpu and memoryInGB will be deprecated later. */ resourceRequests?: outputs.appplatform.ResourceRequestsResponse; /** * Scaling properties for the Azure Spring Apps App Instance. */ scale?: outputs.appplatform.ScaleResponse; /** * StartupProbe indicates that the App Instance has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a App Instance's lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */ startupProbe?: outputs.appplatform.ProbeResponse; /** * Optional duration in seconds the App Instance needs to terminate gracefully. May be decreased in delete request. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down). If this value is nil, the default grace period will be used instead. The grace period is the duration in seconds after the processes running in the App Instance are sent a termination signal and the time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for your process. Defaults to 90 seconds. */ terminationGracePeriodSeconds?: number; } /** * deploymentSettingsResponseProvideDefaults sets the appropriate defaults for DeploymentSettingsResponse */ function deploymentSettingsResponseProvideDefaults(val: DeploymentSettingsResponse): DeploymentSettingsResponse; interface DevToolPortalComponentResponse { /** * Collection of instances belong to Dev Tool Portal. */ instances: outputs.appplatform.DevToolPortalInstanceResponse[]; name: string; /** * The requested resource quantity for required CPU and Memory. */ resourceRequests: outputs.appplatform.DevToolPortalResourceRequestsResponse; } /** * Detail settings for Dev Tool Portal feature */ interface DevToolPortalFeatureDetailResponse { /** * Route path to visit the plugin */ route: string; /** * State of the plugin */ state?: string; } /** * devToolPortalFeatureDetailResponseProvideDefaults sets the appropriate defaults for DevToolPortalFeatureDetailResponse */ function devToolPortalFeatureDetailResponseProvideDefaults(val: DevToolPortalFeatureDetailResponse): DevToolPortalFeatureDetailResponse; /** * Settings for Dev Tool Portal */ interface DevToolPortalFeatureSettingsResponse { /** * Detail of Accelerator plugin */ applicationAccelerator?: outputs.appplatform.DevToolPortalFeatureDetailResponse; /** * Detail of App Live View plugin */ applicationLiveView?: outputs.appplatform.DevToolPortalFeatureDetailResponse; } /** * devToolPortalFeatureSettingsResponseProvideDefaults sets the appropriate defaults for DevToolPortalFeatureSettingsResponse */ function devToolPortalFeatureSettingsResponseProvideDefaults(val: DevToolPortalFeatureSettingsResponse): DevToolPortalFeatureSettingsResponse; /** * Collection of instances belong to the Dev Tool Portal. */ interface DevToolPortalInstanceResponse { /** * Name of the Dev Tool Portal instance. */ name: string; /** * Status of the Dev Tool Portal instance. It can be Pending, Running, Succeeded, Failed, Unknown. */ status: string; } /** * Dev Tool Portal properties payload */ interface DevToolPortalPropertiesResponse { /** * Collection of components belong to Dev Tool Portal. */ components: outputs.appplatform.DevToolPortalComponentResponse[]; /** * Settings for Dev Tool Portal */ features?: outputs.appplatform.DevToolPortalFeatureSettingsResponse; /** * State of the Dev Tool Portal. */ provisioningState: string; /** * Indicates whether the resource exposes public endpoint */ public?: boolean; /** * Single sign-on related configuration */ ssoProperties?: outputs.appplatform.DevToolPortalSsoPropertiesResponse; /** * URL of the resource, exposed when 'public' is true. */ url: string; } /** * devToolPortalPropertiesResponseProvideDefaults sets the appropriate defaults for DevToolPortalPropertiesResponse */ function devToolPortalPropertiesResponseProvideDefaults(val: DevToolPortalPropertiesResponse): DevToolPortalPropertiesResponse; /** * The resource quantity for required CPU and Memory of Dev Tool Portal */ interface DevToolPortalResourceRequestsResponse { /** * Cpu quantity allocated to each Dev Tool Portal instance. 1 core can be represented by 1 or 1000m */ cpu: string; /** * Desired instance count of Dev Tool Portal. */ instanceCount: number; /** * Memory quantity allocated to each Dev Tool Portal instance. 1 GB can be represented by 1Gi or 1024Mi. */ memory: string; } /** * Single sign-on related configuration */ interface DevToolPortalSsoPropertiesResponse { /** * The public identifier for the application */ clientId?: string; /** * The secret known only to the application and the authorization server */ clientSecret?: string; /** * The URI of a JSON file with generic OIDC provider configuration. */ metadataUrl?: string; /** * It defines the specific actions applications can be allowed to do on a user's behalf */ scopes?: string[]; } /** * Azure Spring Apps components' environment variable. */ interface EnvVarResponse { /** * Environment variable name. */ name?: string; /** * secret environment variable value. */ secretValue?: string; /** * Non-secret environment variable value. */ value?: string; } /** * The error code compose of code and message. */ interface ErrorResponse { /** * The code of error. */ code?: string; /** * The message of error. */ message?: string; } /** * ExecAction describes a "run in container" action. */ interface ExecActionResponse { /** * Command is the command line to execute inside the container, the working directory for the command is root ('/') in the container's filesystem. The command is not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use a shell, you need to explicitly call out to that shell. Exit status of 0 is treated as live/healthy and non-zero is unhealthy. */ command?: string[]; /** * The type of the action to take to perform the health check. * Expected value is 'ExecAction'. */ type: "ExecAction"; } /** * API metadata property for Spring Cloud Gateway */ interface GatewayApiMetadataPropertiesResponse { /** * Detailed description of the APIs available on the Gateway instance (default: `Generated OpenAPI 3 document that describes the API routes configured.`) */ description?: string; /** * Location of additional documentation for the APIs available on the Gateway instance */ documentation?: string; /** * Base URL that API consumers will use to access APIs on the Gateway instance. */ serverUrl?: string; /** * Title describing the context of the APIs available on the Gateway instance (default: `Spring Cloud Gateway for K8S`) */ title?: string; /** * Version of APIs available on this Gateway instance (default: `unspecified`). */ version?: string; } /** * API route config of the Spring Cloud Gateway */ interface GatewayApiRouteResponse { /** * A description, will be applied to methods in the generated OpenAPI documentation. */ description?: string; /** * To modify the request before sending it to the target endpoint, or the received response. */ filters?: string[]; /** * Route processing order. */ order?: number; /** * A number of conditions to evaluate a route for each request. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request. */ predicates?: string[]; /** * Enable sso validation. */ ssoEnabled?: boolean; /** * Classification tags, will be applied to methods in the generated OpenAPI documentation. */ tags?: string[]; /** * A title, will be applied to methods in the generated OpenAPI documentation. */ title?: string; /** * Pass currently-authenticated user's identity token to application service, default is 'false' */ tokenRelay?: boolean; /** * Full uri, will override `appName`. */ uri?: string; } /** * Cross-Origin Resource Sharing property */ interface GatewayCorsPropertiesResponse { /** * Whether user credentials are supported on cross-site requests. Valid values: `true`, `false`. */ allowCredentials?: boolean; /** * Allowed headers in cross-site requests. The special value `*` allows actual requests to send any header. */ allowedHeaders?: string[]; /** * Allowed HTTP methods on cross-site requests. The special value `*` allows all methods. If not set, `GET` and `HEAD` are allowed by default. */ allowedMethods?: string[]; /** * Allowed origin patterns to make cross-site requests. */ allowedOriginPatterns?: string[]; /** * Allowed origins to make cross-site requests. The special value `*` allows all domains. */ allowedOrigins?: string[]; /** * HTTP response headers to expose for cross-site requests. */ exposedHeaders?: string[]; /** * How long, in seconds, the response from a pre-flight request can be cached by clients. */ maxAge?: number; } /** * The properties of custom domain for Spring Cloud Gateway */ interface GatewayCustomDomainPropertiesResponse { /** * The thumbprint of bound certificate. */ thumbprint?: string; } /** * Collection of instances belong to the Spring Cloud Gateway */ interface GatewayInstanceResponse { /** * Name of the Spring Cloud Gateway instance */ name: string; /** * Status of the Spring Cloud Gateway instance */ status: string; } /** * Spring Cloud Gateway local response cache per instance properties. */ interface GatewayLocalResponseCachePerInstancePropertiesResponse { /** * The type of the response cache. * Expected value is 'LocalCachePerInstance'. */ responseCacheType: "LocalCachePerInstance"; /** * Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries */ size?: string; /** * Time before a cached entry is expired (300s, 5m, 1h...) */ timeToLive?: string; } /** * Spring Cloud Gateway local response cache per route properties. */ interface GatewayLocalResponseCachePerRoutePropertiesResponse { /** * The type of the response cache. * Expected value is 'LocalCachePerRoute'. */ responseCacheType: "LocalCachePerRoute"; /** * Maximum size of cache (10MB, 900KB, 1GB...) to determine if the cache needs to evict some entries. */ size?: string; /** * Time before a cached entry is expired (300s, 5m, 1h...) */ timeToLive?: string; } /** * Properties of the Spring Cloud Gateway Operator. */ interface GatewayOperatorPropertiesResponse { /** * Collection of instances belong to Spring Cloud Gateway operator. */ instances: outputs.appplatform.GatewayInstanceResponse[]; /** * The requested resource quantity for required CPU and Memory. */ resourceRequests: outputs.appplatform.GatewayOperatorResourceRequestsResponse; } /** * Properties of the Spring Cloud Gateway Operator. */ interface GatewayOperatorResourceRequestsResponse { /** * Cpu allocated to each Spring Cloud Gateway Operator instance. */ cpu: string; /** * Instance count of the Spring Cloud Gateway Operator. */ instanceCount: number; /** * Memory allocated to each Spring Cloud Gateway Operator instance. */ memory: string; } /** * Spring Cloud Gateway properties payload */ interface GatewayPropertiesResponse { /** * Collection of addons for Spring Cloud Gateway */ addonConfigs?: { [key: string]: any; }; /** * API metadata property for Spring Cloud Gateway */ apiMetadataProperties?: outputs.appplatform.GatewayApiMetadataPropertiesResponse; /** * Collection of APM type used in Spring Cloud Gateway */ apmTypes?: string[]; /** * Collection of ApmReferences in service level */ apms?: outputs.appplatform.ApmReferenceResponse[]; /** * Client-Certification Authentication. */ clientAuth?: outputs.appplatform.GatewayPropertiesResponseClientAuth; /** * Cross-Origin Resource Sharing property */ corsProperties?: outputs.appplatform.GatewayCorsPropertiesResponse; /** * Environment variables of Spring Cloud Gateway */ environmentVariables?: outputs.appplatform.GatewayPropertiesResponseEnvironmentVariables; /** * Indicate if only https is allowed. */ httpsOnly?: boolean; /** * Collection of instances belong to Spring Cloud Gateway. */ instances: outputs.appplatform.GatewayInstanceResponse[]; /** * Properties of the Spring Cloud Gateway Operator. */ operatorProperties: outputs.appplatform.GatewayOperatorPropertiesResponse; /** * State of the Spring Cloud Gateway. */ provisioningState: string; /** * Indicates whether the Spring Cloud Gateway exposes endpoint. */ public?: boolean; /** * The requested resource quantity for required CPU and Memory. */ resourceRequests?: outputs.appplatform.GatewayResourceRequestsResponse; /** * The properties to configure different types of response cache for Spring Cloud Gateway. */ responseCacheProperties?: outputs.appplatform.GatewayLocalResponseCachePerInstancePropertiesResponse | outputs.appplatform.GatewayLocalResponseCachePerRoutePropertiesResponse; /** * Single sign-on related configuration */ ssoProperties?: outputs.appplatform.SsoPropertiesResponse; /** * URL of the Spring Cloud Gateway, exposed when 'public' is true. */ url: string; } /** * gatewayPropertiesResponseProvideDefaults sets the appropriate defaults for GatewayPropertiesResponse */ function gatewayPropertiesResponseProvideDefaults(val: GatewayPropertiesResponse): GatewayPropertiesResponse; /** * Client-Certification Authentication. */ interface GatewayPropertiesResponseClientAuth { /** * Whether to enable certificate verification or not */ certificateVerification?: string; /** * Collection of certificate resource Ids in Azure Spring Apps. */ certificates?: string[]; } /** * gatewayPropertiesResponseClientAuthProvideDefaults sets the appropriate defaults for GatewayPropertiesResponseClientAuth */ function gatewayPropertiesResponseClientAuthProvideDefaults(val: GatewayPropertiesResponseClientAuth): GatewayPropertiesResponseClientAuth; /** * Environment variables of Spring Cloud Gateway */ interface GatewayPropertiesResponseEnvironmentVariables { /** * Non-sensitive properties */ properties?: { [key: string]: string; }; /** * Sensitive properties */ secrets?: { [key: string]: string; }; } /** * Resource request payload of Spring Cloud Gateway. */ interface GatewayResourceRequestsResponse { /** * Cpu allocated to each Spring Cloud Gateway instance. */ cpu?: string; /** * Memory allocated to each Spring Cloud Gateway instance. */ memory?: string; } /** * gatewayResourceRequestsResponseProvideDefaults sets the appropriate defaults for GatewayResourceRequestsResponse */ function gatewayResourceRequestsResponseProvideDefaults(val: GatewayResourceRequestsResponse): GatewayResourceRequestsResponse; /** * OpenAPI properties of Spring Cloud Gateway route config. */ interface GatewayRouteConfigOpenApiPropertiesResponse { /** * The URI of OpenAPI specification. */ uri?: string; } /** * API route config of the Spring Cloud Gateway */ interface GatewayRouteConfigPropertiesResponse { /** * The resource Id of the Azure Spring Apps app, required unless route defines `uri`. */ appResourceId?: string; /** * To modify the request before sending it to the target endpoint, or the received response in app level. */ filters?: string[]; /** * OpenAPI properties of Spring Cloud Gateway route config. */ openApi?: outputs.appplatform.GatewayRouteConfigOpenApiPropertiesResponse; /** * A number of conditions to evaluate a route for each request in app level. Each predicate may be evaluated against request headers and parameter values. All of the predicates associated with a route must evaluate to true for the route to be matched to the request. */ predicates?: string[]; /** * Protocol of routed Azure Spring Apps applications. */ protocol?: string; /** * State of the Spring Cloud Gateway route config. */ provisioningState: string; /** * Array of API routes, each route contains properties such as `title`, `uri`, `ssoEnabled`, `predicates`, `filters`. */ routes?: outputs.appplatform.GatewayApiRouteResponse[]; /** * Enable Single Sign-On in app level. */ ssoEnabled?: boolean; } /** * gatewayRouteConfigPropertiesResponseProvideDefaults sets the appropriate defaults for GatewayRouteConfigPropertiesResponse */ function gatewayRouteConfigPropertiesResponseProvideDefaults(val: GatewayRouteConfigPropertiesResponse): GatewayRouteConfigPropertiesResponse; /** * Git repository property payload for config server */ interface GitPatternRepositoryResponse { /** * Public sshKey of git repository. */ hostKey?: string; /** * SshKey algorithm of git repository. */ hostKeyAlgorithm?: string; /** * Label of the repository */ label?: string; /** * Name of the repository */ name: string; /** * Password of git repository basic auth. */ password?: string; /** * Collection of pattern of the repository */ pattern?: string[]; /** * Private sshKey algorithm of git repository. */ privateKey?: string; /** * Searching path of the repository */ searchPaths?: string[]; /** * Strict host key checking or not. */ strictHostKeyChecking?: boolean; /** * URI of the repository */ uri: string; /** * Username of git repository basic auth. */ username?: string; } /** * HTTPGetAction describes an action based on HTTP Get requests. */ interface HTTPGetActionResponse { /** * Path to access on the HTTP server. */ path?: string; /** * Scheme to use for connecting to the host. Defaults to HTTP. * * Possible enum values: * - `"HTTP"` means that the scheme used will be http:// * - `"HTTPS"` means that the scheme used will be https:// */ scheme?: string; /** * The type of the action to take to perform the health check. * Expected value is 'HTTPGetAction'. */ type: "HTTPGetAction"; } /** * Azure Spring Apps App Instance Http scaling rule. */ interface HttpScaleRuleResponse { /** * Authentication secrets for the custom scale rule. */ auth?: outputs.appplatform.ScaleRuleAuthResponse[]; /** * Metadata properties to describe http scale rule. */ metadata?: { [key: string]: string; }; } /** * Credential of the image registry */ interface ImageRegistryCredentialResponse { /** * The password of the image registry credential */ password?: string; /** * The username of the image registry credential */ username?: string; } /** * Ingress configuration payload for Azure Spring Apps resource. */ interface IngressConfigResponse { /** * Ingress read time out in seconds. */ readTimeoutInSeconds?: number; } /** * App ingress settings payload. */ interface IngressSettingsResponse { /** * How ingress should communicate with this app backend service. */ backendProtocol?: string; /** * Client-Certification Authentication. */ clientAuth?: outputs.appplatform.IngressSettingsResponseClientAuth; /** * Ingress read time out in seconds. */ readTimeoutInSeconds?: number; /** * Ingress send time out in seconds. */ sendTimeoutInSeconds?: number; /** * Type of the affinity, set this to Cookie to enable session affinity. */ sessionAffinity?: string; /** * Time in seconds until the cookie expires. */ sessionCookieMaxAge?: number; } /** * Client-Certification Authentication. */ interface IngressSettingsResponseClientAuth { /** * Collection of certificate resource id. */ certificates?: string[]; } /** * Uploaded Jar binary for a deployment */ interface JarUploadedUserSourceInfoResponse { /** * JVM parameter */ jvmOptions?: string; /** * Relative path of the storage which stores the source */ relativePath?: string; /** * Runtime version of the Jar file */ runtimeVersion?: string; /** * Type of the source uploaded * Expected value is 'Jar'. */ type: "Jar"; /** * Version of the source */ version?: string; } /** * Job's execution template, containing configuration for an execution */ interface JobExecutionTemplateResponse { /** * Arguments for the Job execution. */ args?: string[]; /** * Environment variables of Job execution */ environmentVariables?: outputs.appplatform.EnvVarResponse[]; /** * The requested resource quantity for required CPU and Memory. */ resourceRequests?: outputs.appplatform.JobResourceRequestsResponse; } /** * jobExecutionTemplateResponseProvideDefaults sets the appropriate defaults for JobExecutionTemplateResponse */ function jobExecutionTemplateResponseProvideDefaults(val: JobExecutionTemplateResponse): JobExecutionTemplateResponse; /** * Job resource properties payload */ interface JobResourcePropertiesResponse { /** * Referenced managed components collection */ managedComponentReferences?: outputs.appplatform.ManagedComponentReferenceResponse[]; /** * Provisioning state of the Job */ provisioningState: string; /** * Uploaded source information of the Job. */ source?: outputs.appplatform.BuildResultUserSourceInfoResponse | outputs.appplatform.CustomContainerUserSourceInfoResponse | outputs.appplatform.JarUploadedUserSourceInfoResponse | outputs.appplatform.NetCoreZipUploadedUserSourceInfoResponse | outputs.appplatform.SourceUploadedUserSourceInfoResponse | outputs.appplatform.UploadedUserSourceInfoResponse | outputs.appplatform.WarUploadedUserSourceInfoResponse; /** * The template which is applied for all executions of the Job. */ template?: outputs.appplatform.JobExecutionTemplateResponse; /** * The Job trigger related configuration. */ triggerConfig?: outputs.appplatform.ManualJobTriggerConfigResponse; } /** * jobResourcePropertiesResponseProvideDefaults sets the appropriate defaults for JobResourcePropertiesResponse */ function jobResourcePropertiesResponseProvideDefaults(val: JobResourcePropertiesResponse): JobResourcePropertiesResponse; /** * Job resource request payload */ interface JobResourceRequestsResponse { /** * CPU allocated to each job execution instance. */ cpu?: string; /** * Memory allocated to each job execution instance. */ memory?: string; } /** * jobResourceRequestsResponseProvideDefaults sets the appropriate defaults for JobResourceRequestsResponse */ function jobResourceRequestsResponseProvideDefaults(val: JobResourceRequestsResponse): JobResourceRequestsResponse; /** * Properties of certificate imported from key vault. */ interface KeyVaultCertificatePropertiesResponse { /** * The activate date of certificate. */ activateDate: string; /** * Indicates whether to automatically synchronize certificate from key vault or not. */ autoSync?: string; /** * The certificate version of key vault. */ certVersion?: string; /** * The domain list of certificate. */ dnsNames: string[]; /** * Optional. If set to true, it will not import private key from key vault. */ excludePrivateKey?: boolean; /** * The expiration date of certificate. */ expirationDate: string; /** * The issue date of certificate. */ issuedDate: string; /** * The issuer of certificate. */ issuer: string; /** * The certificate name of key vault. */ keyVaultCertName: string; /** * Provisioning state of the Certificate */ provisioningState: string; /** * The subject name of certificate. */ subjectName: string; /** * The thumbprint of certificate. */ thumbprint: string; /** * The type of the certificate source. * Expected value is 'KeyVaultCertificate'. */ type: "KeyVaultCertificate"; /** * The vault uri of user key vault. */ vaultUri: string; } /** * keyVaultCertificatePropertiesResponseProvideDefaults sets the appropriate defaults for KeyVaultCertificatePropertiesResponse */ function keyVaultCertificatePropertiesResponseProvideDefaults(val: KeyVaultCertificatePropertiesResponse): KeyVaultCertificatePropertiesResponse; /** * Loaded certificate payload */ interface LoadedCertificateResponse { /** * Indicate whether the certificate will be loaded into default trust store, only work for Java runtime. */ loadTrustStore?: boolean; /** * Resource Id of loaded certificate */ resourceId: string; } /** * loadedCertificateResponseProvideDefaults sets the appropriate defaults for LoadedCertificateResponse */ function loadedCertificateResponseProvideDefaults(val: LoadedCertificateResponse): LoadedCertificateResponse; /** * A reference to the managed component like Config Server. */ interface ManagedComponentReferenceResponse { /** * Resource Id of the managed component */ resourceId: string; } /** * Managed identity properties retrieved from ARM request headers. */ interface ManagedIdentityPropertiesResponse { /** * Principal Id of system-assigned managed identity. */ principalId?: string; /** * Tenant Id of system-assigned managed identity. */ tenantId?: string; /** * Type of the managed identity */ type?: string; /** * Properties of user-assigned managed identities */ userAssignedIdentities?: { [key: string]: outputs.appplatform.UserAssignedManagedIdentityResponse; }; } /** * Configuration for manual triggered job */ interface ManualJobTriggerConfigResponse { /** * Number of parallel replicas of a job execution can run. */ parallelism?: number; /** * Maximum number of retries before failing the job. */ retryLimit?: number; /** * Maximum number of seconds an execution is allowed to run. */ timeoutInSeconds?: number; /** * Type of job trigger * Expected value is 'Manual'. */ triggerType: "Manual"; } /** * manualJobTriggerConfigResponseProvideDefaults sets the appropriate defaults for ManualJobTriggerConfigResponse */ function manualJobTriggerConfigResponseProvideDefaults(val: ManualJobTriggerConfigResponse): ManualJobTriggerConfigResponse; /** * Purchasing 3rd Party product for one Azure Spring Apps instance */ interface MarketplaceResourceResponse { /** * The plan id of the 3rd Party Artifact that is being procured. */ plan?: string; /** * The 3rd Party artifact that is being procured. */ product?: string; /** * The publisher id of the 3rd Party Artifact that is being bought. */ publisher?: string; } /** * Monitoring Setting properties payload */ interface MonitoringSettingPropertiesResponse { /** * Indicates the versions of application insight agent */ appInsightsAgentVersions?: outputs.appplatform.ApplicationInsightsAgentVersionsResponse; /** * Target application insight instrumentation key, null or whitespace include empty will disable monitoringSettings */ appInsightsInstrumentationKey?: string; /** * Indicates the sampling rate of application insight agent, should be in range [0.0, 100.0] */ appInsightsSamplingRate?: number; /** * Error when apply Monitoring Setting changes. */ error?: outputs.appplatform.ErrorResponse; /** * State of the Monitoring Setting. */ provisioningState: string; /** * Indicates whether enable the trace functionality, which will be deprecated since api version 2020-11-01-preview. Please leverage appInsightsInstrumentationKey to indicate if monitoringSettings enabled or not */ traceEnabled?: boolean; } /** * Uploaded Jar binary for a deployment */ interface NetCoreZipUploadedUserSourceInfoResponse { /** * The path to the .NET executable relative to zip root */ netCoreMainEntryPath?: string; /** * Relative path of the storage which stores the source */ relativePath?: string; /** * Runtime version of the .Net file */ runtimeVersion?: string; /** * Type of the source uploaded * Expected value is 'NetCoreZip'. */ type: "NetCoreZip"; /** * Version of the source */ version?: string; } /** * Service network profile payload */ interface NetworkProfileResponse { /** * Name of the resource group containing network resources for customer apps in Azure Spring Apps */ appNetworkResourceGroup?: string; /** * Fully qualified resource Id of the subnet to host customer apps in Azure Spring Apps */ appSubnetId?: string; /** * Ingress configuration payload for Azure Spring Apps resource. */ ingressConfig?: outputs.appplatform.IngressConfigResponse; /** * Desired outbound IP resources for Azure Spring Apps resource. */ outboundIPs: outputs.appplatform.NetworkProfileResponseOutboundIPs; /** * The egress traffic type of Azure Spring Apps VNet instances. */ outboundType?: string; /** * Required inbound or outbound traffics for Azure Spring Apps resource. */ requiredTraffics: outputs.appplatform.RequiredTrafficResponse[]; /** * Azure Spring Apps service reserved CIDR */ serviceCidr?: string; /** * Name of the resource group containing network resources of Azure Spring Apps Service Runtime */ serviceRuntimeNetworkResourceGroup?: string; /** * Fully qualified resource Id of the subnet to host Azure Spring Apps Service Runtime */ serviceRuntimeSubnetId?: string; } /** * Desired outbound IP resources for Azure Spring Apps resource. */ interface NetworkProfileResponseOutboundIPs { /** * A list of public IP addresses. */ publicIPs: string[]; } /** * Persistent disk payload */ interface PersistentDiskResponse { /** * Mount path of the persistent disk */ mountPath?: string; /** * Size of the persistent disk in GB */ sizeInGB?: number; /** * Size of the used persistent disk in GB */ usedInGB: number; } /** * Probe describes a health check to be performed against an App Instance to determine whether it is alive or ready to receive traffic. */ interface ProbeResponse { /** * Indicate whether the probe is disabled. */ disableProbe: boolean; /** * Minimum consecutive failures for the probe to be considered failed after having succeeded. Minimum value is 1. */ failureThreshold?: number; /** * Number of seconds after the App Instance has started before probes are initiated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes */ initialDelaySeconds?: number; /** * How often (in seconds) to perform the probe. Minimum value is 1. */ periodSeconds?: number; /** * The action of the probe. */ probeAction?: outputs.appplatform.ExecActionResponse | outputs.appplatform.HTTPGetActionResponse | outputs.appplatform.TCPSocketActionResponse; /** * Minimum consecutive successes for the probe to be considered successful after having failed. Must be 1 for liveness and startup. Minimum value is 1. */ successThreshold?: number; /** * Number of seconds after which the probe times out. Minimum value is 1. */ timeoutSeconds?: number; } /** * probeResponseProvideDefaults sets the appropriate defaults for ProbeResponse */ function probeResponseProvideDefaults(val: ProbeResponse): ProbeResponse; /** * Azure Spring Apps App Instance Azure Queue based scaling rule. */ interface QueueScaleRuleResponse { /** * Authentication secrets for the queue scale rule. */ auth?: outputs.appplatform.ScaleRuleAuthResponse[]; /** * Queue length. */ queueLength?: number; /** * Queue name. */ queueName?: string; } /** * Required inbound or outbound traffic for Azure Spring Apps resource. */ interface RequiredTrafficResponse { /** * The direction of required traffic */ direction: string; /** * The FQDN list of required traffic */ fqdns: string[]; /** * The ip list of required traffic */ ips: string[]; /** * The port of required traffic */ port: number; /** * The protocol of required traffic */ protocol: string; } /** * Deployment resource request payload */ interface ResourceRequestsResponse { /** * Required CPU. 1 core can be represented by 1 or 1000m. This should be 500m or 1 for Basic tier, and {500m, 1, 2, 3, 4} for Standard tier. */ cpu?: string; /** * Required memory. 1 GB can be represented by 1Gi or 1024Mi. This should be {512Mi, 1Gi, 2Gi} for Basic tier, and {512Mi, 1Gi, 2Gi, ..., 8Gi} for Standard tier. */ memory?: string; } /** * Azure Spring Apps scaling configurations. */ interface ScaleResponse { /** * Optional. Maximum number of container replicas. Defaults to 10 if not set. */ maxReplicas?: number; /** * Optional. Minimum number of container replicas. */ minReplicas?: number; /** * Scaling rules. */ rules?: outputs.appplatform.ScaleRuleResponse[]; } /** * scaleResponseProvideDefaults sets the appropriate defaults for ScaleResponse */ function scaleResponseProvideDefaults(val: ScaleResponse): ScaleResponse; /** * Auth Secrets for Azure Spring Apps App Instance Scale Rule */ interface ScaleRuleAuthResponse { /** * Name of the Azure Spring Apps App Instance secret from which to pull the auth params. */ secretRef?: string; /** * Trigger Parameter that uses the secret */ triggerParameter?: string; } /** * Azure Spring Apps App Instance scaling rule. */ interface ScaleRuleResponse { /** * Azure Queue based scaling. */ azureQueue?: outputs.appplatform.QueueScaleRuleResponse; /** * Custom scale rule. */ custom?: outputs.appplatform.CustomScaleRuleResponse; /** * HTTP requests based scaling. */ http?: outputs.appplatform.HttpScaleRuleResponse; /** * Scale Rule Name */ name?: string; /** * Tcp requests based scaling. */ tcp?: outputs.appplatform.TcpScaleRuleResponse; } /** * Secret definition. */ interface SecretResponse { /** * Secret Name. */ name?: string; } /** * Collection of instances belong to the Service Registry */ interface ServiceRegistryInstanceResponse { /** * Name of the Service Registry instance */ name: string; /** * Status of the Service Registry instance */ status: string; } /** * Service Registry properties payload */ interface ServiceRegistryPropertiesResponse { /** * Collection of instances belong to Service Registry. */ instances: outputs.appplatform.ServiceRegistryInstanceResponse[]; /** * State of the Service Registry. */ provisioningState: string; /** * The requested resource quantity for required CPU and Memory. */ resourceRequests: outputs.appplatform.ServiceRegistryResourceRequestsResponse; } /** * Resource request payload of Service Registry */ interface ServiceRegistryResourceRequestsResponse { /** * Cpu allocated to each Service Registry instance */ cpu: string; /** * Instance count of the Service Registry */ instanceCount: number; /** * Memory allocated to each Service Registry instance */ memory: string; } /** * Additional Service settings in vnet injection instance */ interface ServiceVNetAddonsResponse { /** * Indicates whether the data plane components(log stream, app connect, remote debugging) in vnet injection instance could be accessed from internet. */ dataPlanePublicEndpoint?: boolean; /** * Indicates whether the log stream in vnet injection instance could be accessed from internet. */ logStreamPublicEndpoint?: boolean; } /** * serviceVNetAddonsResponseProvideDefaults sets the appropriate defaults for ServiceVNetAddonsResponse */ function serviceVNetAddonsResponseProvideDefaults(val: ServiceVNetAddonsResponse): ServiceVNetAddonsResponse; /** * Sku of Azure Spring Apps */ interface SkuResponse { /** * Current capacity of the target resource */ capacity?: number; /** * Name of the Sku */ name?: string; /** * Tier of the Sku */ tier?: string; } /** * skuResponseProvideDefaults sets the appropriate defaults for SkuResponse */ function skuResponseProvideDefaults(val: SkuResponse): SkuResponse; /** * Uploaded Java source code binary for a deployment */ interface SourceUploadedUserSourceInfoResponse { /** * Selector for the artifact to be used for the deployment for multi-module projects. This should be * the relative path to the target module/project. */ artifactSelector?: string; /** * Relative path of the storage which stores the source */ relativePath?: string; /** * Runtime version of the source file */ runtimeVersion?: string; /** * Type of the source uploaded * Expected value is 'Source'. */ type: "Source"; /** * Version of the source */ version?: string; } /** * Single sign-on related configuration */ interface SsoPropertiesResponse { /** * The public identifier for the application */ clientId?: string; /** * The secret known only to the application and the authorization server */ clientSecret?: string; /** * The URI of Issuer Identifier */ issuerUri?: string; /** * It defines the specific actions applications can be allowed to do on a user's behalf */ scope?: string[]; } /** * KPack ClusterStack properties payload */ interface StackPropertiesResponse { /** * Id of the ClusterStack. */ id?: string; /** * Version of the ClusterStack */ version?: string; } /** * storage resource of type Azure Storage Account. */ interface StorageAccountResponse { /** * The account name of the Azure Storage Account. */ accountName: string; /** * The type of the storage. * Expected value is 'StorageAccount'. */ storageType: "StorageAccount"; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource modification (UTC). */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * TCPSocketAction describes an action based on opening a socket */ interface TCPSocketActionResponse { /** * The type of the action to take to perform the health check. * Expected value is 'TCPSocketAction'. */ type: "TCPSocketAction"; } /** * Azure Spring Apps App Instance Tcp scaling rule. */ interface TcpScaleRuleResponse { /** * Authentication secrets for the tcp scale rule. */ auth?: outputs.appplatform.ScaleRuleAuthResponse[]; /** * Metadata properties to describe tcp scale rule. */ metadata?: { [key: string]: string; }; } /** * Temporary disk payload */ interface TemporaryDiskResponse { /** * Mount path of the temporary disk */ mountPath?: string; /** * Size of the temporary disk in GB */ sizeInGB?: number; } /** * temporaryDiskResponseProvideDefaults sets the appropriate defaults for TemporaryDiskResponse */ function temporaryDiskResponseProvideDefaults(val: TemporaryDiskResponse): TemporaryDiskResponse; /** * The build result triggered by a build */ interface TriggeredBuildResultResponse { /** * The unique build id of this build result */ id?: string; /** * The container image of this build result */ image?: string; /** * The last transition reason of this build result */ lastTransitionReason?: string; /** * The last transition status of this build result */ lastTransitionStatus?: string; /** * The last transition time of this build result */ lastTransitionTime?: string; /** * The provisioning state of this build result */ provisioningState: string; } /** * Source with uploaded location */ interface UploadedUserSourceInfoResponse { /** * Relative path of the storage which stores the source */ relativePath?: string; /** * Type of the source uploaded * Expected value is 'UploadedUserSourceInfo'. */ type: "UploadedUserSourceInfo"; /** * Version of the source */ version?: string; } /** * The details of the user-assigned managed identity assigned to an App. */ interface UserAssignedManagedIdentityResponse { /** * Client Id of user-assigned managed identity. */ clientId: string; /** * Principal Id of user-assigned managed identity. */ principalId: string; } /** * Uploaded War binary for a deployment */ interface WarUploadedUserSourceInfoResponse { /** * JVM parameter */ jvmOptions?: string; /** * Relative path of the storage which stores the source */ relativePath?: string; /** * Runtime version of the war file */ runtimeVersion?: string; /** * Server version, currently only Apache Tomcat is supported */ serverVersion?: string; /** * Type of the source uploaded * Expected value is 'War'. */ type: "War"; /** * Version of the source */ version?: string; } /** * Weekly planned maintenance */ interface WeeklyMaintenanceScheduleConfigurationResponse { /** * The day to run the maintenance job */ day: string; /** * The duration time to run the maintenance job, specified in ISO8601 format, e.g. PT8H */ duration: string; /** * The frequency to run the maintenance job * Expected value is 'Weekly'. */ frequency: "Weekly"; /** * The hour to run the maintenance job */ hour: number; } } export declare namespace attestation { /** * The Private Endpoint Connection resource. */ interface PrivateEndpointConnectionResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * The resource of private end point. */ privateEndpoint?: outputs.attestation.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.attestation.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.attestation.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The Private Endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace authorization { /** * Access Review History Definition Instance. */ interface AccessReviewHistoryInstanceResponse { /** * The display name for the parent history definition. */ displayName?: string; /** * Uri which can be used to retrieve review history data. To generate this Uri, generateDownloadUri() must be called for a specific accessReviewHistoryDefinitionInstance. The link expires after a 24 hour period. Callers can see the expiration date time by looking at the 'se' parameter in the generated uri. */ downloadUri: string; /** * Date time when history data report expires and the associated data is deleted. */ expiration?: string; /** * Date time when the history data report is scheduled to be generated. */ fulfilledDateTime?: string; /** * The access review history definition instance id. */ id: string; /** * The access review history definition instance unique id. */ name: string; /** * Date time used when selecting review data, all reviews included in data end on or before this date. For use only with one-time/non-recurring reports. */ reviewHistoryPeriodEndDateTime?: string; /** * Date time used when selecting review data, all reviews included in data start on or after this date. For use only with one-time/non-recurring reports. */ reviewHistoryPeriodStartDateTime?: string; /** * Date time when the history data report is scheduled to be generated. */ runDateTime?: string; /** * Status of the requested review history instance data. This is either requested, in-progress, done or error. The state transitions are as follows - Requested -> InProgress -> Done -> Expired */ status: string; /** * The resource type. */ type: string; } /** * Access Review Instance. */ interface AccessReviewInstanceResponse { /** * This is the collection of backup reviewers. */ backupReviewers?: outputs.authorization.AccessReviewReviewerResponse[]; /** * The DateTime when the review instance is scheduled to end. */ endDateTime?: string; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * This is the collection of reviewers. */ reviewers?: outputs.authorization.AccessReviewReviewerResponse[]; /** * This field specifies the type of reviewers for a review. Usually for a review, reviewers are explicitly assigned. However, in some cases, the reviewers may not be assigned and instead be chosen dynamically. For example managers review or self review. */ reviewersType: string; /** * The DateTime when the review instance is scheduled to be start. */ startDateTime?: string; /** * This read-only field specifies the status of an access review instance. */ status: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.authorization.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Recurrence Range of an Access Review Schedule Definition. */ interface AccessReviewRecurrenceRangeResponse { /** * The DateTime when the review is scheduled to end. Required if type is endDate */ endDate?: string; /** * The number of times to repeat the access review. Required and must be positive if type is numbered. */ numberOfOccurrences?: number; /** * The DateTime when the review is scheduled to be start. This could be a date in the future. Required on create. */ startDate?: string; /** * The recurrence range type. The possible values are: endDate, noEnd, numbered. */ type?: string; } /** * Descriptor for what needs to be reviewed */ interface AccessReviewReviewerResponse { /** * The id of the reviewer(user/servicePrincipal) */ principalId?: string; /** * The identity type : user/servicePrincipal */ principalType: string; } /** * Descriptor for what needs to be reviewed */ interface AccessReviewScopeResponse { /** * The role assignment state eligible/active to review */ assignmentState: string; /** * This is used to indicate the resource id(s) to exclude */ excludeResourceId?: string; /** * This is used to indicate the role definition id(s) to exclude */ excludeRoleDefinitionId?: string; /** * Flag to indicate whether to expand nested memberships or not. */ expandNestedMemberships?: boolean; /** * Duration users are inactive for. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) */ inactiveDuration?: string; /** * Flag to indicate whether to expand nested memberships or not. */ includeAccessBelowResource?: boolean; /** * Flag to indicate whether to expand nested memberships or not. */ includeInheritedAccess?: boolean; /** * The identity type user/servicePrincipal to review */ principalType: string; /** * ResourceId in which this review is getting created */ resourceId: string; /** * This is used to indicate the role being reviewed */ roleDefinitionId: string; } /** * The approval settings. */ interface ApprovalSettingsResponse { /** * The type of rule */ approvalMode?: string; /** * The approval stages of the request. */ approvalStages?: outputs.authorization.ApprovalStageResponse[]; /** * Determines whether approval is required or not. */ isApprovalRequired?: boolean; /** * Determines whether approval is required for assignment extension. */ isApprovalRequiredForExtension?: boolean; /** * Determine whether requestor justification is required. */ isRequestorJustificationRequired?: boolean; } /** * The approval stage. */ interface ApprovalStageResponse { /** * The time in days when approval request would be timed out */ approvalStageTimeOutInDays?: number; /** * The escalation approver of the request. */ escalationApprovers?: outputs.authorization.UserSetResponse[]; /** * The time in minutes when the approval request would be escalated if the primary approver does not approve */ escalationTimeInMinutes?: number; /** * Determines whether approver need to provide justification for his decision. */ isApproverJustificationRequired?: boolean; /** * The value determine whether escalation feature is enabled. */ isEscalationEnabled?: boolean; /** * The primary approver of the request. */ primaryApprovers?: outputs.authorization.UserSetResponse[]; } /** * Deny assignment permissions. */ interface DenyAssignmentPermissionResponse { /** * Actions to which the deny assignment does not grant access. */ actions?: string[]; /** * The conditions on the Deny assignment permission. This limits the resources it applies to. */ condition?: string; /** * Version of the condition. */ conditionVersion?: string; /** * Data actions to which the deny assignment does not grant access. */ dataActions?: string[]; /** * Actions to exclude from that the deny assignment does not grant access. */ notActions?: string[]; /** * Data actions to exclude from that the deny assignment does not grant access. */ notDataActions?: string[]; } /** * Deny assignment principal. */ interface DenyAssignmentPrincipalResponse { /** * The object ID of the principal. */ id?: string; /** * The type of the principal such as user, group, servicePrincipal, etc. */ type?: string; } /** * Expanded info of resource, role and principal */ interface ExpandedPropertiesResponse { /** * Details of the principal */ principal?: outputs.authorization.ExpandedPropertiesResponsePrincipal; /** * Details of role definition */ roleDefinition?: outputs.authorization.ExpandedPropertiesResponseRoleDefinition; /** * Details of the resource scope */ scope?: outputs.authorization.ExpandedPropertiesResponseScope; } /** * Details of the principal */ interface ExpandedPropertiesResponsePrincipal { /** * Display name of the principal */ displayName?: string; /** * Email id of the principal */ email?: string; /** * Id of the principal */ id?: string; /** * Type of the principal */ type?: string; } /** * Details of role definition */ interface ExpandedPropertiesResponseRoleDefinition { /** * Display name of the role definition */ displayName?: string; /** * Id of the role definition */ id?: string; /** * Type of the role definition */ type?: string; } /** * Details of the resource scope */ interface ExpandedPropertiesResponseScope { /** * Display name of the resource */ displayName?: string; /** * Scope id of the resource */ id?: string; /** * Type of the resource */ type?: string; } /** * Identity for the resource. Policy assignments support a maximum of one identity. That is either a system assigned identity or a single user assigned identity. */ interface IdentityResponse { /** * The principal ID of the resource identity. This property will only be provided for a system assigned identity */ principalId: string; /** * The tenant ID of the resource identity. This property will only be provided for a system assigned identity */ tenantId: string; /** * The identity type. This is the only required field when adding a system or user assigned identity to a resource. */ type?: string; /** * The user identity associated with the policy. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.authorization.IdentityResponseUserAssignedIdentities; }; } interface IdentityResponseUserAssignedIdentities { /** * The client id of user assigned identity. */ clientId: string; /** * The principal id of user assigned identity. */ principalId: string; } /** * Information about a tenant managing the subscription. */ interface ManagedByTenantResponse { /** * The tenant ID of the managing tenant. */ tenantId?: string; } /** * Lock owner properties. */ interface ManagementLockOwnerResponse { /** * The application ID of the lock owner. */ applicationId?: string; } /** * A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. */ interface NonComplianceMessageResponse { /** * A message that describes why a resource is non-compliant with the policy. This is shown in 'deny' error messages and on resource's non-compliant compliance results. */ message: string; /** * The policy definition reference ID within a policy set definition the message is intended for. This is only applicable if the policy assignment assigns a policy set definition. If this is not provided the message applies to all policies assigned by this policy assignment. */ policyDefinitionReferenceId?: string; } /** * The policy property value override. */ interface OverrideResponse { /** * The override kind. */ kind?: string; /** * The list of the selector expressions. */ selectors?: outputs.authorization.SelectorResponse[]; /** * The value to override the policy property. */ value?: string; } /** * The PIM Only Mode settings. */ interface PIMOnlyModeSettingsResponse { /** * The list of excluded assignment types allowed. */ excludedAssignmentTypes?: string[]; /** * The list of excluded entities that the rule does not apply to. */ excludes?: outputs.authorization.UsersOrServicePrincipalSetResponse[]; /** * Determines whether the setting is enabled, disabled or report only. */ mode?: string; } /** * The definition of a parameter that can be provided to the policy. */ interface ParameterDefinitionsValueResponse { /** * The allowed values for the parameter. */ allowedValues?: any[]; /** * The default value for the parameter if no value is provided. */ defaultValue?: any; /** * General metadata for the parameter. */ metadata?: outputs.authorization.ParameterDefinitionsValueResponseMetadata; /** * Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/. */ schema?: any; /** * The data type of the parameter. */ type?: string; } /** * General metadata for the parameter. */ interface ParameterDefinitionsValueResponseMetadata { /** * Set to true to have Azure portal create role assignments on the resource ID or resource scope value of this parameter during policy assignment. This property is useful in case you wish to assign permissions outside the assignment scope. */ assignPermissions?: boolean; /** * The description of the parameter. */ description?: string; /** * The display name for the parameter. */ displayName?: string; /** * Used when assigning the policy definition through the portal. Provides a context aware list of values for the user to choose from. */ strongType?: string; } /** * The value of a parameter. */ interface ParameterValuesValueResponse { /** * The value of the parameter. */ value?: any; } /** * Role definition permissions. */ interface PermissionResponse { /** * Allowed actions. */ actions?: string[]; /** * The conditions on the role definition. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container' */ condition: string; /** * Version of the condition. Currently the only accepted value is '2.0' */ conditionVersion: string; /** * Allowed Data actions. */ dataActions?: string[]; /** * Denied actions. */ notActions?: string[]; /** * Denied Data actions. */ notDataActions?: string[]; } /** * Details of the policy */ interface PolicyAssignmentPropertiesPolicyResponse { /** * Id of the policy */ id?: string; /** * The name of the entity last modified it */ lastModifiedBy: outputs.authorization.PrincipalResponse; /** * The last modified date time. */ lastModifiedDateTime?: string; } /** * Expanded info of resource scope, role definition and policy */ interface PolicyAssignmentPropertiesResponse { /** * Details of the policy */ policy?: outputs.authorization.PolicyAssignmentPropertiesPolicyResponse; /** * Details of role definition */ roleDefinition?: outputs.authorization.PolicyAssignmentPropertiesRoleDefinitionResponse; /** * Details of the resource scope */ scope?: outputs.authorization.PolicyAssignmentPropertiesScopeResponse; } /** * Details of role definition */ interface PolicyAssignmentPropertiesRoleDefinitionResponse { /** * Display name of the role definition */ displayName?: string; /** * Id of the role definition */ id?: string; /** * Type of the role definition */ type?: string; } /** * Details of the resource scope */ interface PolicyAssignmentPropertiesScopeResponse { /** * Display name of the resource */ displayName?: string; /** * Scope id of the resource */ id?: string; /** * Type of the resource */ type?: string; } /** * The policy definition group. */ interface PolicyDefinitionGroupResponse { /** * A resource ID of a resource that contains additional metadata about the group. */ additionalMetadataId?: string; /** * The group's category. */ category?: string; /** * The group's description. */ description?: string; /** * The group's display name. */ displayName?: string; /** * The name of the group. */ name: string; } /** * The policy definition reference. */ interface PolicyDefinitionReferenceResponse { /** * The version of the policy definition to use. */ definitionVersion?: string; /** * The effective version of the policy definition in use. This is only present if requested via the $expand query parameter. */ effectiveDefinitionVersion: string; /** * The name of the groups that this policy definition reference belongs to. */ groupNames?: string[]; /** * The latest version of the policy definition available. This is only present if requested via the $expand query parameter. */ latestDefinitionVersion: string; /** * The parameter values for the referenced policy rule. The keys are the parameter names. */ parameters?: { [key: string]: outputs.authorization.ParameterValuesValueResponse; }; /** * The ID of the policy definition or policy set definition. */ policyDefinitionId: string; /** * A unique id (within the policy set definition) for this policy definition reference. */ policyDefinitionReferenceId?: string; } /** * The ID of the policy definition version. */ interface PolicyDefinitionVersionResponse { /** * The policy definition description. */ description?: string; /** * The display name of the policy definition. */ displayName?: string; /** * The ID of the policy definition version. */ id: string; /** * The policy definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. */ metadata?: any; /** * The policy definition mode. Some examples are All, Indexed, Microsoft.KeyVault.Data. */ mode?: string; /** * The name of the policy definition version. */ name: string; /** * The parameter definitions for parameters used in the policy rule. The keys are the parameter names. */ parameters?: { [key: string]: outputs.authorization.ParameterDefinitionsValueResponse; }; /** * The policy rule. */ policyRule?: any; /** * The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. */ policyType?: string; /** * The system metadata relating to this resource. */ systemData: outputs.authorization.SystemDataResponse; /** * The type of the resource (Microsoft.Authorization/policyDefinitions/versions). */ type: string; /** * The policy definition version in #.#.# format. */ version?: string; } /** * policyDefinitionVersionResponseProvideDefaults sets the appropriate defaults for PolicyDefinitionVersionResponse */ function policyDefinitionVersionResponseProvideDefaults(val: PolicyDefinitionVersionResponse): PolicyDefinitionVersionResponse; /** * Expanded info of resource scope */ interface PolicyPropertiesResponse { /** * Details of the resource scope */ scope: outputs.authorization.PolicyPropertiesScopeResponse; } /** * Details of the resource scope */ interface PolicyPropertiesScopeResponse { /** * Display name of the resource */ displayName?: string; /** * Scope id of the resource */ id?: string; /** * Type of the resource */ type?: string; } /** * The policy set definition version. */ interface PolicySetDefinitionVersionResponse { /** * The policy set definition description. */ description?: string; /** * The display name of the policy set definition. */ displayName?: string; /** * The ID of the policy set definition version. */ id: string; /** * The policy set definition metadata. Metadata is an open ended object and is typically a collection of key value pairs. */ metadata?: any; /** * The name of the policy set definition version. */ name: string; /** * The policy set definition parameters that can be used in policy definition references. */ parameters?: { [key: string]: outputs.authorization.ParameterDefinitionsValueResponse; }; /** * The metadata describing groups of policy definition references within the policy set definition. */ policyDefinitionGroups?: outputs.authorization.PolicyDefinitionGroupResponse[]; /** * An array of policy definition references. */ policyDefinitions: outputs.authorization.PolicyDefinitionReferenceResponse[]; /** * The type of policy definition. Possible values are NotSpecified, BuiltIn, Custom, and Static. */ policyType?: string; /** * The system metadata relating to this resource. */ systemData: outputs.authorization.SystemDataResponse; /** * The type of the resource (Microsoft.Authorization/policySetDefinitions/versions). */ type: string; /** * The policy set definition version in #.#.# format. */ version?: string; } /** * The variable column. */ interface PolicyVariableColumnResponse { /** * The name of this policy variable column. */ columnName: string; } /** * The name value tuple for this variable value column. */ interface PolicyVariableValueColumnValueResponse { /** * Column name for the variable value */ columnName: string; /** * Column value for the variable value; this can be an integer, double, boolean, null or a string. */ columnValue: any; } /** * The name of the entity last modified it */ interface PrincipalResponse { /** * The name of the principal made changes */ displayName?: string; /** * Email of principal */ email?: string; /** * The id of the principal made changes */ id?: string; /** * Type of principal such as user , group etc */ type?: string; } /** * Private Link Association Properties. */ interface PrivateLinkAssociationPropertiesExpandedResponse { /** * The rmpl Resource ID. */ privateLink?: string; publicNetworkAccess?: string; /** * The scope of the private link association. */ scope?: string; /** * The TenantID. */ tenantID?: string; } interface ResourceManagementPrivateLinkEndpointConnectionsResponse { /** * The private endpoint connections. */ privateEndpointConnections?: string[]; } /** * The resource selector to filter policies by resource properties. */ interface ResourceSelectorResponse { /** * The name of the resource selector. */ name?: string; /** * The list of the selector expressions. */ selectors?: outputs.authorization.SelectorResponse[]; } /** * Expiration of the role eligibility schedule */ interface RoleEligibilityScheduleRequestPropertiesResponseExpiration { /** * Duration of the role eligibility schedule in TimeSpan. */ duration?: string; /** * End DateTime of the role eligibility schedule. */ endDateTime?: string; /** * Type of the role eligibility schedule expiration */ type?: string; } /** * Schedule info of the role eligibility schedule */ interface RoleEligibilityScheduleRequestPropertiesResponseScheduleInfo { /** * Expiration of the role eligibility schedule */ expiration?: outputs.authorization.RoleEligibilityScheduleRequestPropertiesResponseExpiration; /** * Start DateTime of the role eligibility schedule. */ startDateTime?: string; } /** * Ticket Info of the role eligibility */ interface RoleEligibilityScheduleRequestPropertiesResponseTicketInfo { /** * Ticket number for the role eligibility */ ticketNumber?: string; /** * Ticket system name for the role eligibility */ ticketSystem?: string; } /** * The role management policy approval rule. */ interface RoleManagementPolicyApprovalRuleResponse { /** * The id of the rule. */ id?: string; /** * The type of rule * Expected value is 'RoleManagementPolicyApprovalRule'. */ ruleType: "RoleManagementPolicyApprovalRule"; /** * The approval setting */ setting?: outputs.authorization.ApprovalSettingsResponse; /** * The target of the current rule. */ target?: outputs.authorization.RoleManagementPolicyRuleTargetResponse; } /** * The role management policy authentication context rule. */ interface RoleManagementPolicyAuthenticationContextRuleResponse { /** * The claim value. */ claimValue?: string; /** * The id of the rule. */ id?: string; /** * The value indicating if rule is enabled. */ isEnabled?: boolean; /** * The type of rule * Expected value is 'RoleManagementPolicyAuthenticationContextRule'. */ ruleType: "RoleManagementPolicyAuthenticationContextRule"; /** * The target of the current rule. */ target?: outputs.authorization.RoleManagementPolicyRuleTargetResponse; } /** * The role management policy enablement rule. */ interface RoleManagementPolicyEnablementRuleResponse { /** * The list of enabled rules. */ enabledRules?: string[]; /** * The id of the rule. */ id?: string; /** * The type of rule * Expected value is 'RoleManagementPolicyEnablementRule'. */ ruleType: "RoleManagementPolicyEnablementRule"; /** * The target of the current rule. */ target?: outputs.authorization.RoleManagementPolicyRuleTargetResponse; } /** * The role management policy expiration rule. */ interface RoleManagementPolicyExpirationRuleResponse { /** * The members not restricted by expiration rule. */ exceptionMembers?: outputs.authorization.UserSetResponse[]; /** * The id of the rule. */ id?: string; /** * The value indicating whether expiration is required. */ isExpirationRequired?: boolean; /** * The maximum duration of expiration in timespan. */ maximumDuration?: string; /** * The type of rule * Expected value is 'RoleManagementPolicyExpirationRule'. */ ruleType: "RoleManagementPolicyExpirationRule"; /** * The target of the current rule. */ target?: outputs.authorization.RoleManagementPolicyRuleTargetResponse; } /** * The role management policy notification rule. */ interface RoleManagementPolicyNotificationRuleResponse { /** * The id of the rule. */ id?: string; /** * Determines if the notification will be sent to the recipient type specified in the policy rule. */ isDefaultRecipientsEnabled?: boolean; /** * The notification level. */ notificationLevel?: string; /** * The list of notification recipients. */ notificationRecipients?: string[]; /** * The type of notification. */ notificationType?: string; /** * The recipient type. */ recipientType?: string; /** * The type of rule * Expected value is 'RoleManagementPolicyNotificationRule'. */ ruleType: "RoleManagementPolicyNotificationRule"; /** * The target of the current rule. */ target?: outputs.authorization.RoleManagementPolicyRuleTargetResponse; } /** * The role management policy PIM only mode rule. */ interface RoleManagementPolicyPimOnlyModeRuleResponse { /** * The id of the rule. */ id?: string; /** * The PIM Only Mode settings */ pimOnlyModeSettings?: outputs.authorization.PIMOnlyModeSettingsResponse; /** * The type of rule * Expected value is 'RoleManagementPolicyPimOnlyModeRule'. */ ruleType: "RoleManagementPolicyPimOnlyModeRule"; /** * The target of the current rule. */ target?: outputs.authorization.RoleManagementPolicyRuleTargetResponse; } /** * The role management policy rule target. */ interface RoleManagementPolicyRuleTargetResponse { /** * The caller of the setting. */ caller?: string; /** * The list of enforced settings. */ enforcedSettings?: string[]; /** * The list of inheritable settings. */ inheritableSettings?: string[]; /** * The assignment level to which rule is applied. */ level?: string; /** * The type of operation. */ operations?: string[]; /** * The list of target objects. */ targetObjects?: string[]; } /** * The selector expression. */ interface SelectorResponse { /** * The list of values to filter in. */ in?: string[]; /** * The selector kind. */ kind?: string; /** * The list of values to filter out. */ notIn?: string[]; } /** * Subscription policies. */ interface SubscriptionPoliciesResponse { /** * The subscription location placement ID. */ locationPlacementId?: string; /** * The subscription quota ID. */ quotaId?: string; /** * The subscription spending limit. */ spendingLimit?: string; } /** * Subscription information. */ interface SubscriptionResponse { /** * The authorization source of the request. */ authorizationSource?: string; /** * The subscription display name. */ displayName?: string; /** * The fully qualified ID for the subscription. */ id?: string; /** * An array containing the tenants managing the subscription. */ managedByTenants?: outputs.authorization.ManagedByTenantResponse[]; /** * The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted. */ state?: string; /** * The subscription ID. */ subscriptionId?: string; /** * The subscription policies. */ subscriptionPolicies?: outputs.authorization.SubscriptionPoliciesResponse; /** * The tags attached to the subscription. */ tags?: { [key: string]: string; }; /** * The subscription tenant ID. */ tenantId?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The detail of a user. */ interface UserSetResponse { /** * The description of the user. */ description?: string; /** * The object id of the user. */ id?: string; /** * The value indicating whether the user is a backup fallback approver */ isBackup?: boolean; /** * The type of user. */ userType?: string; } /** * The detail of a subject. */ interface UsersOrServicePrincipalSetResponse { /** * The display Name of the entity. */ displayName?: string; /** * The object id of the entity. */ id?: string; /** * The type of user. */ type?: string; } } export declare namespace automanage { /** * Automanage configuration profile assignment properties. */ interface ConfigurationProfileAssignmentPropertiesResponse { /** * The Automanage configurationProfile ARM Resource URI. */ configurationProfile?: string; /** * The status of onboarding, which only appears in the response. */ status: string; /** * The target VM resource URI */ targetId: string; } /** * Automanage configuration profile properties. */ interface ConfigurationProfilePropertiesResponse { /** * configuration dictionary of the configuration profile. */ configuration?: any; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace automation { /** * The properties of the create advanced schedule monthly occurrence. */ interface AdvancedScheduleMonthlyOccurrenceResponse { /** * Day of the occurrence. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. */ day?: string; /** * Occurrence of the week within the month. Must be between 1 and 5 */ occurrence?: number; } /** * The properties of the create Advanced Schedule. */ interface AdvancedScheduleResponse { /** * Days of the month that the job should execute on. Must be between 1 and 31. */ monthDays?: number[]; /** * Occurrences of days within a month. */ monthlyOccurrences?: outputs.automation.AdvancedScheduleMonthlyOccurrenceResponse[]; /** * Days of the week that the job should execute on. */ weekDays?: string[]; } /** * Error response of an operation failure */ interface AutomationErrorResponseResponse { /** * Error code */ code?: string; /** * Error message indicating why the operation failed. */ message?: string; } /** * Azure query for the update configuration. */ interface AzureQueryPropertiesResponse { /** * List of locations to scope the query to. */ locations?: string[]; /** * List of Subscription or Resource Group ARM Ids. */ scope?: string[]; /** * Tag settings for the VM. */ tagSettings?: outputs.automation.TagSettingsPropertiesResponse; } /** * The connection type property associated with the entity. */ interface ConnectionTypeAssociationPropertyResponse { /** * Gets or sets the name of the connection type. */ name?: string; } /** * Definition of the runbook property type. */ interface ContentHashResponse { /** * Gets or sets the content hash algorithm used to hash the content. */ algorithm: string; /** * Gets or sets expected hash value of the content. */ value: string; } /** * Definition of the content link. */ interface ContentLinkResponse { /** * Gets or sets the hash. */ contentHash?: outputs.automation.ContentHashResponse; /** * Gets or sets the uri of content. */ uri?: string; /** * Gets or sets the version of the content. */ version?: string; } /** * Definition of the content source. */ interface ContentSourceResponse { /** * Gets or sets the hash. */ hash?: outputs.automation.ContentHashResponse; /** * Gets or sets the content source type. */ type?: string; /** * Gets or sets the value of the content. This is based on the content source type. */ value?: string; /** * Gets or sets the version of the content. */ version?: string; } /** * Definition of deleted runbook. */ interface DeletedRunbookResponse { /** * Gets or sets the creation time. */ creationTime?: string; /** * Gets or sets the last modified time. */ deletionTime?: string; /** * The resource id. */ id?: string; /** * Gets or sets the location of the resource. */ location?: string; /** * Gets or sets name of the resource. */ name?: string; /** * Gets or sets the Runbook Id. */ runbookId?: string; /** * Type of the runbook. */ runbookType?: string; /** * Gets or sets runtime of the runbook. */ runtime?: string; /** * Environment of the runbook. */ runtimeEnvironment?: string; } /** * The Dsc configuration property associated with the entity. */ interface DscConfigurationAssociationPropertyResponse { /** * Gets or sets the name of the Dsc configuration. */ name?: string; } /** * Definition of the configuration parameter type. */ interface DscConfigurationParameterResponse { /** * Gets or sets the default value of parameter. */ defaultValue?: string; /** * Gets or sets a Boolean value to indicate whether the parameter is mandatory or not. */ isMandatory?: boolean; /** * Get or sets the position of the parameter. */ position?: number; /** * Gets or sets the type of the parameter. */ type?: string; } /** * User identity used for CMK. */ interface EncryptionPropertiesIdentityResponse { /** * The user identity used for CMK. It will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentity?: any; } /** * The encryption settings for automation account */ interface EncryptionPropertiesResponse { /** * User identity used for CMK. */ identity?: outputs.automation.EncryptionPropertiesIdentityResponse; /** * Encryption Key Source */ keySource?: string; /** * Key vault properties. */ keyVaultProperties?: outputs.automation.KeyVaultPropertiesResponse; } /** * Definition of the connection fields. */ interface FieldDefinitionResponse { /** * Gets or sets the isEncrypted flag of the connection field definition. */ isEncrypted?: boolean; /** * Gets or sets the isOptional flag of the connection field definition. */ isOptional?: boolean; /** * Gets or sets the type of the connection field definition. */ type: string; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. The value must be an UUID. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The identity type. */ type?: string; /** * The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.automation.UserAssignedIdentitiesPropertiesResponse; }; } /** * Automation key which is used to register a DSC Node */ interface KeyResponse { /** * Automation key name. */ keyName: string; /** * Automation key permissions. */ permissions: string; /** * Value of the Automation Key used for registration. */ value: string; } /** * Settings concerning key vault encryption for a configuration store. */ interface KeyVaultPropertiesResponse { /** * The name of key used to encrypt data. */ keyName?: string; /** * The key version of the key used to encrypt data. */ keyVersion?: string; /** * The URI of the key vault key used to encrypt data. */ keyvaultUri?: string; } /** * Linux specific update configuration. */ interface LinuxPropertiesResponse { /** * packages excluded from the software update configuration. */ excludedPackageNameMasks?: string[]; /** * Update classifications included in the software update configuration. */ includedPackageClassifications?: string; /** * packages included from the software update configuration. */ includedPackageNameMasks?: string[]; /** * Reboot setting for the software update configuration. */ rebootSetting?: string; } /** * Definition of the module error info type. */ interface ModuleErrorInfoResponse { /** * Gets or sets the error code. */ code?: string; /** * Gets or sets the error message. */ message?: string; } /** * Non Azure query for the update configuration. */ interface NonAzureQueryPropertiesResponse { /** * Log Analytics Saved Search name. */ functionAlias?: string; /** * Workspace Id for Log Analytics in which the saved Search is resided. */ workspaceId?: string; } /** * Definition of the package error info type. */ interface PackageErrorInfoResponse { /** * Package import error code. */ code?: string; /** * Package import error message. */ message?: string; } /** * A private endpoint connection */ interface PrivateEndpointConnectionResponse { /** * Gets the groupIds. */ groupIds?: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * Private endpoint which the connection belongs to. */ privateEndpoint?: outputs.automation.PrivateEndpointPropertyResponse; /** * Connection State of the Private Endpoint Connection. */ privateLinkServiceConnectionState?: outputs.automation.PrivateLinkServiceConnectionStatePropertyResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.automation.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Private endpoint which the connection belongs to. */ interface PrivateEndpointPropertyResponse { /** * Resource id of the private endpoint. */ id?: string; } /** * Connection State of the Private Endpoint Connection. */ interface PrivateLinkServiceConnectionStatePropertyResponse { /** * Any action that is required beyond basic workflow (approve/ reject/ disconnect) */ actionsRequired: string; /** * The private link service connection description. */ description?: string; /** * The private link service connection status. */ status?: string; } /** * Definition of RunAs credential to use for hybrid worker. */ interface RunAsCredentialAssociationPropertyResponse { /** * Gets or sets the name of the credential. */ name?: string; } /** * The runbook property associated with the entity. */ interface RunbookAssociationPropertyResponse { /** * Gets or sets the name of the runbook. */ name?: string; } interface RunbookDraftResponse { /** * Gets or sets the creation time of the runbook draft. */ creationTime?: string; /** * Gets or sets the draft runbook content link. */ draftContentLink?: outputs.automation.ContentLinkResponse; /** * Gets or sets whether runbook is in edit mode. */ inEdit?: boolean; /** * Gets or sets the last modified time of the runbook draft. */ lastModifiedTime?: string; /** * Gets or sets the runbook output types. */ outputTypes?: string[]; /** * Gets or sets the runbook draft parameters. */ parameters?: { [key: string]: outputs.automation.RunbookParameterResponse; }; } /** * Definition of the runbook parameter type. */ interface RunbookParameterResponse { /** * Gets or sets the default value of parameter. */ defaultValue?: string; /** * Gets or sets a Boolean value to indicate whether the parameter is mandatory or not. */ isMandatory?: boolean; /** * Get or sets the position of the parameter. */ position?: number; /** * Gets or sets the type of the parameter. */ type?: string; } /** * Definition of schedule parameters. */ interface SUCSchedulePropertiesResponse { /** * Gets or sets the advanced schedule. */ advancedSchedule?: outputs.automation.AdvancedScheduleResponse; /** * Gets or sets the creation time. */ creationTime?: string; /** * Gets or sets the description. */ description?: string; /** * Gets or sets the end time of the schedule. */ expiryTime?: string; /** * Gets or sets the expiry time's offset in minutes. */ expiryTimeOffsetMinutes?: number; /** * Gets or sets the frequency of the schedule. */ frequency?: string; /** * Gets or sets the interval of the schedule. */ interval?: number; /** * Gets or sets a value indicating whether this schedule is enabled. */ isEnabled?: boolean; /** * Gets or sets the last modified time. */ lastModifiedTime?: string; /** * Gets or sets the next run time of the schedule. */ nextRun?: string; /** * Gets or sets the next run time's offset in minutes. */ nextRunOffsetMinutes?: number; /** * Gets or sets the start time of the schedule. */ startTime?: string; /** * Gets the start time's offset in minutes. */ startTimeOffsetMinutes: number; /** * Gets or sets the time zone of the schedule. */ timeZone?: string; } /** * The schedule property associated with the entity. */ interface ScheduleAssociationPropertyResponse { /** * Gets or sets the name of the Schedule. */ name?: string; } /** * The account SKU. */ interface SkuResponse { /** * Gets or sets the SKU capacity. */ capacity?: number; /** * Gets or sets the SKU family. */ family?: string; /** * Gets or sets the SKU name of the account. */ name: string; } /** * Task properties of the software update configuration. */ interface SoftwareUpdateConfigurationTasksResponse { /** * Post task properties. */ postTask?: outputs.automation.TaskPropertiesResponse; /** * Pre task properties. */ preTask?: outputs.automation.TaskPropertiesResponse; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Tag filter information for the VM. */ interface TagSettingsPropertiesResponse { /** * Filter VMs by Any or All specified tags. */ filterOperator?: string; /** * Dictionary of tags with its list of values. */ tags?: { [key: string]: string[]; }; } /** * Group specific to the update configuration. */ interface TargetPropertiesResponse { /** * List of Azure queries in the software update configuration. */ azureQueries?: outputs.automation.AzureQueryPropertiesResponse[]; /** * List of non Azure queries in the software update configuration. */ nonAzureQueries?: outputs.automation.NonAzureQueryPropertiesResponse[]; } /** * Task properties of the software update configuration. */ interface TaskPropertiesResponse { /** * Gets or sets the parameters of the task. */ parameters?: { [key: string]: string; }; /** * Gets or sets the name of the runbook. */ source?: string; } /** * Update specific properties of the software update configuration. */ interface UpdateConfigurationResponse { /** * List of azure resource Ids for azure virtual machines targeted by the software update configuration. */ azureVirtualMachines?: string[]; /** * Maximum time allowed for the software update configuration run. Duration needs to be specified using the format PT[n]H[n]M[n]S as per ISO8601 */ duration?: string; /** * Linux specific update configuration. */ linux?: outputs.automation.LinuxPropertiesResponse; /** * List of names of non-azure machines targeted by the software update configuration. */ nonAzureComputerNames?: string[]; /** * operating system of target machines */ operatingSystem: string; /** * Group targets for the software update configuration. */ targets?: outputs.automation.TargetPropertiesResponse; /** * Windows specific update configuration. */ windows?: outputs.automation.WindowsPropertiesResponse; } interface UserAssignedIdentitiesPropertiesResponse { /** * The client id of user assigned identity. */ clientId: string; /** * The principal id of user assigned identity. */ principalId: string; } /** * Windows specific update configuration. */ interface WindowsPropertiesResponse { /** * KB numbers excluded from the software update configuration. */ excludedKbNumbers?: string[]; /** * KB numbers included from the software update configuration. */ includedKbNumbers?: string[]; /** * Update classification included in the software update configuration. A comma separated string with required values */ includedUpdateClassifications?: string; /** * Reboot setting for the software update configuration. */ rebootSetting?: string; } } export declare namespace avs { /** * The properties of an Arc addon */ interface AddonArcPropertiesResponse { /** * Addon type * Expected value is 'Arc'. */ addonType: "Arc"; /** * The state of the addon provisioning */ provisioningState: string; /** * The VMware vCenter resource ID */ vCenter?: string; } /** * The properties of an HCX addon */ interface AddonHcxPropertiesResponse { /** * Addon type * Expected value is 'HCX'. */ addonType: "HCX"; /** * The HCX offer, example VMware MaaS Cloud Provider (Enterprise) */ offer: string; /** * The state of the addon provisioning */ provisioningState: string; } /** * The properties of a Site Recovery Manager (SRM) addon */ interface AddonSrmPropertiesResponse { /** * Addon type * Expected value is 'SRM'. */ addonType: "SRM"; /** * The Site Recovery Manager (SRM) license */ licenseKey?: string; /** * The state of the addon provisioning */ provisioningState: string; } /** * The properties of a vSphere Replication (VR) addon */ interface AddonVrPropertiesResponse { /** * Addon type * Expected value is 'VR'. */ addonType: "VR"; /** * The state of the addon provisioning */ provisioningState: string; /** * The vSphere Replication Server (VRS) count */ vrsCount: number; } /** * The properties describing private cloud availability zone distribution */ interface AvailabilityPropertiesResponse { /** * The secondary availability zone for the private cloud */ secondaryZone?: number; /** * The availability strategy for the private cloud */ strategy?: string; /** * The primary availability zone for the private cloud */ zone?: number; } /** * An ExpressRoute Circuit */ interface CircuitResponse { /** * Identifier of the ExpressRoute Circuit (Microsoft Colo only) */ expressRouteID: string; /** * ExpressRoute Circuit private peering identifier */ expressRoutePrivatePeeringID: string; /** * CIDR of primary subnet */ primarySubnet: string; /** * CIDR of secondary subnet */ secondarySubnet: string; } /** * Zone and associated hosts info */ interface ClusterZoneResponse { /** * List of hosts belonging to the availability zone in a cluster */ hosts: string[]; /** * Availability zone identifier */ zone: string; } /** * An iSCSI volume from Microsoft.StoragePool provider */ interface DiskPoolVolumeResponse { /** * Name of the LUN to be used for datastore */ lunName: string; /** * Mode that describes whether the LUN has to be mounted as a datastore or * attached as a LUN */ mountOption?: string; /** * Device path */ path: string; /** * Azure resource ID of the iSCSI target */ targetId: string; } /** * diskPoolVolumeResponseProvideDefaults sets the appropriate defaults for DiskPoolVolumeResponse */ function diskPoolVolumeResponseProvideDefaults(val: DiskPoolVolumeResponse): DiskPoolVolumeResponse; /** * An Elastic SAN volume from Microsoft.ElasticSan provider */ interface ElasticSanVolumeResponse { /** * Azure resource ID of the Elastic SAN Volume */ targetId: string; } /** * An Encryption Key */ interface EncryptionKeyVaultPropertiesResponse { /** * The auto-detected version of the key if versionType is auto-detected. */ autoDetectedKeyVersion: string; /** * The name of the key. */ keyName?: string; /** * The state of key provided */ keyState: string; /** * The URL of the vault. */ keyVaultUrl?: string; /** * The version of the key. */ keyVersion?: string; /** * Property of the key if user provided or auto detected */ versionType: string; } /** * The properties of customer managed encryption key */ interface EncryptionResponse { /** * The key vault where the encryption key is stored */ keyVaultProperties?: outputs.avs.EncryptionKeyVaultPropertiesResponse; /** * Status of customer managed encryption key */ status?: string; } /** * Endpoint addresses */ interface EndpointsResponse { /** * Endpoint FQDN for the HCX Cloud Manager */ hcxCloudManager: string; /** * Endpoint IP for the HCX Cloud Manager */ hcxCloudManagerIp: string; /** * Endpoint FQDN for the NSX-T Data Center manager */ nsxtManager: string; /** * Endpoint IP for the NSX-T Data Center manager */ nsxtManagerIp: string; /** * Endpoint IP for Virtual Center Server Appliance */ vcenterIp: string; /** * Endpoint FQDN for Virtual Center Server Appliance */ vcsa: string; } /** * vCenter Single Sign On Identity Source */ interface IdentitySourceResponse { /** * The domain's NetBIOS name */ alias?: string; /** * The base distinguished name for groups */ baseGroupDN?: string; /** * The base distinguished name for users */ baseUserDN?: string; /** * The domain's DNS name */ domain?: string; /** * The name of the identity source */ name?: string; /** * The password of the Active Directory user with a minimum of read-only access to * Base DN for users and groups. */ password?: string; /** * Primary server URL */ primaryServer?: string; /** * Secondary server URL */ secondaryServer?: string; /** * Protect LDAP communication using SSL certificate (LDAPS) */ ssl?: string; /** * The ID of an Active Directory user with a minimum of read-only access to Base * DN for users and group */ username?: string; } /** * A key-value pair representing a label. */ interface LabelResponse { /** * The key of the label. */ key: string; /** * The value of the label. */ value: string; } /** * The properties of a management cluster */ interface ManagementClusterResponse { /** * The identity */ clusterId: number; /** * The cluster size */ clusterSize?: number; /** * The hosts */ hosts?: string[]; /** * The state of the cluster provisioning */ provisioningState: string; /** * Name of the vsan datastore associated with the cluster */ vsanDatastoreName?: string; } /** * An Azure NetApp Files volume from Microsoft.NetApp provider */ interface NetAppVolumeResponse { /** * Azure resource ID of the NetApp volume */ id: string; } /** * a powershell credential object */ interface PSCredentialExecutionParameterResponse { /** * The parameter name */ name: string; /** * password for login */ password?: string; /** * script execution parameter type * Expected value is 'Credential'. */ type: "Credential"; /** * username for login */ username?: string; } /** * a plain text value execution parameter */ interface ScriptSecureStringExecutionParameterResponse { /** * The parameter name */ name: string; /** * A secure value for the passed parameter, not to be stored in logs */ secureValue?: string; /** * script execution parameter type * Expected value is 'SecureValue'. */ type: "SecureValue"; } /** * a plain text value execution parameter */ interface ScriptStringExecutionParameterResponse { /** * The parameter name */ name: string; /** * script execution parameter type * Expected value is 'Value'. */ type: "Value"; /** * The value for the passed parameter */ value?: string; } /** * The resource model definition representing SKU */ interface SkuResponse { /** * If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. */ capacity?: number; /** * If the service has different generations of hardware, for the same SKU, then that can be captured here. */ family?: string; /** * The name of the SKU. E.g. P3. It is typically a letter+number code */ name: string; /** * The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. */ size?: string; /** * This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. */ tier?: string; } /** * Managed service identity (either system assigned, or none) */ interface SystemAssignedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (either system assigned, or none). */ type: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * VM-Host placement policy properties */ interface VmHostPlacementPolicyPropertiesResponse { /** * vm-host placement policy affinity strength (should/must) */ affinityStrength?: string; /** * placement policy affinity type */ affinityType: string; /** * placement policy azure hybrid benefit opt-in type */ azureHybridBenefitType?: string; /** * Display name of the placement policy */ displayName?: string; /** * Host members list */ hostMembers: string[]; /** * The provisioning state */ provisioningState: string; /** * Whether the placement policy is enabled or disabled */ state?: string; /** * Placement Policy type * Expected value is 'VmHost'. */ type: "VmHost"; /** * Virtual machine members list */ vmMembers: string[]; } /** * VM-VM placement policy properties */ interface VmVmPlacementPolicyPropertiesResponse { /** * placement policy affinity type */ affinityType: string; /** * Display name of the placement policy */ displayName?: string; /** * The provisioning state */ provisioningState: string; /** * Whether the placement policy is enabled or disabled */ state?: string; /** * Placement Policy type * Expected value is 'VmVm'. */ type: "VmVm"; /** * Virtual machine members list */ vmMembers: string[]; } /** * The properties of a VMware Firewall license */ interface VmwareFirewallLicensePropertiesResponse { /** * The Broadcom contract number associated with the license. */ broadcomContractNumber?: string; /** * The Broadcom site ID associated with the license. */ broadcomSiteId?: string; /** * Number of cores included in the license, measured per hour */ cores: number; /** * UTC datetime when the license expires */ endDate: string; /** * The kind of license. * Expected value is 'VmwareFirewall'. */ kind: "VmwareFirewall"; /** * Additional labels passed through for license reporting. */ labels?: outputs.avs.LabelResponse[]; /** * License key */ licenseKey?: string; /** * The state of the license provisioning */ provisioningState: string; } /** * NSX DHCP Relay */ interface WorkloadNetworkDhcpRelayResponse { /** * Type of DHCP: SERVER or RELAY. * Expected value is 'RELAY'. */ dhcpType: "RELAY"; /** * Display name of the DHCP entity. */ displayName?: string; /** * The provisioning state */ provisioningState: string; /** * NSX revision number. */ revision?: number; /** * NSX Segments consuming DHCP. */ segments: string[]; /** * DHCP Relay Addresses. Max 3. */ serverAddresses?: string[]; } /** * NSX DHCP Server */ interface WorkloadNetworkDhcpServerResponse { /** * Type of DHCP: SERVER or RELAY. * Expected value is 'SERVER'. */ dhcpType: "SERVER"; /** * Display name of the DHCP entity. */ displayName?: string; /** * DHCP Server Lease Time. */ leaseTime?: number; /** * The provisioning state */ provisioningState: string; /** * NSX revision number. */ revision?: number; /** * NSX Segments consuming DHCP. */ segments: string[]; /** * DHCP Server Address. */ serverAddress?: string; } /** * Ports and any VIF attached to segment. */ interface WorkloadNetworkSegmentPortVifResponse { /** * Name of port or VIF attached to segment. */ portName?: string; } /** * Subnet configuration for segment */ interface WorkloadNetworkSegmentSubnetResponse { /** * DHCP Range assigned for subnet. */ dhcpRanges?: string[]; /** * Gateway address. */ gatewayAddress?: string; } } export declare namespace awsconnector { /** * Definition of AbortIncompleteMultipartUpload */ interface AbortIncompleteMultipartUploadResponse { /** * Specifies the number of days after which Amazon S3 stops an incomplete multipart upload. */ daysAfterInitiation?: number; } /** * Definition of AccelerateConfiguration */ interface AccelerateConfigurationResponse { /** * Specifies the transfer acceleration status of the bucket. */ accelerationStatus?: string; } /** * Definition of AcceleratorCountRequest */ interface AcceleratorCountRequestResponse { /** * The maximum value. */ max?: number; /** * The minimum value. */ min?: number; } /** * Definition of AcceleratorTotalMemoryMiBRequest */ interface AcceleratorTotalMemoryMiBRequestResponse { /** * The memory maximum in MiB. */ max?: number; /** * The memory minimum in MiB. */ min?: number; } /** * Definition of AccessAnalyzerAnalyzer */ interface AccessAnalyzerAnalyzerPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsAccessAnalyzerAnalyzerPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of AccessConfigResponse */ interface AccessConfigResponseResponse { /** *

The current authentication mode of the cluster.

*/ authenticationMode?: outputs.awsconnector.AuthenticationModeEnumValueResponse; /** *

Specifies whether or not the cluster creator IAM principal was set as a cluster admin access entry during cluster creation time.

*/ bootstrapClusterCreatorAdminPermissions?: boolean; } /** * Definition of AccessControlTranslation */ interface AccessControlTranslationResponse { /** * Specifies the replica ownership. For default and valid values, see [PUT bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) in the *Amazon S3 API Reference*. */ owner?: string; } /** * Definition of AccessLogSetting */ interface AccessLogSettingResponse { /** * The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with ``amazon-apigateway-``. This parameter is required to enable access logging. */ destinationArn?: string; /** * A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference). The format must include at least ``$context.requestId``. This parameter is required to enable access logging. */ format?: string; } /** * Definition of AccessRules */ interface AccessRulesResponse { /** * A Boolean value that indicates whether the access control list (ACL) permissions that are applied to individual objects override the getObject option that is currently specified. */ allowPublicOverrides?: boolean; /** * Specifies the anonymous access to all objects in a bucket. */ getObject?: string; } /** * Definition of AccountAttributeValue */ interface AccountAttributeValueResponse { /** *

The value of the attribute.

*/ attributeValue?: string; } /** * Definition of AcmCertificateSummary */ interface AcmCertificateSummaryPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsAcmCertificateSummaryPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of ActionConditionModelProperties */ interface ActionConditionModelPropertiesResponse { /** * Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition. */ action?: string; } /** * Definition of ActionDefinition */ interface ActionDefinitionNetworkFirewallRuleGroupResponse { /** * Property publishMetricAction */ publishMetricAction?: outputs.awsconnector.PublishMetricActionNetworkFirewallRuleGroupResponse; } /** * Definition of ActionDefinition */ interface ActionDefinitionResponse { /** * Property publishMetricAction */ publishMetricAction?: outputs.awsconnector.PublishMetricActionResponse; } /** * Definition of Action */ interface ActionResponse { /** * [HTTPS listeners] Information for using Amazon Cognito to authenticate users. Specify only when ``Type`` is ``authenticate-cognito``. Specifies information required when integrating with Amazon Cognito to authenticate users. */ authenticateCognitoConfig?: outputs.awsconnector.AuthenticateCognitoConfigResponse; /** * [HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). Specify only when ``Type`` is ``authenticate-oidc``. Specifies information required using an identity provide (IdP) that is compliant with OpenID Connect (OIDC) to authenticate users. */ authenticateOidcConfig?: outputs.awsconnector.AuthenticateOidcConfigResponse; /** * [Application Load Balancer] Information for creating an action that returns a custom HTTP response. Specify only when ``Type`` is ``fixed-response``. Specifies information required when returning a custom HTTP response. */ fixedResponseConfig?: outputs.awsconnector.FixedResponseConfigResponse; /** * Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``. Information for creating an action that distributes requests among one or more target groups. For Network Load Balancers, you can specify a single target group. Specify only when ``Type`` is ``forward``. If you specify both ``ForwardConfig`` and ``TargetGroupArn``, you can specify only one target group using ``ForwardConfig`` and it must be the same target group specified in ``TargetGroupArn``. */ forwardConfig?: outputs.awsconnector.ForwardConfigResponse; /** * The order for the action. This value is required for rules with multiple actions. The action with the lowest value for order is performed first. */ order?: number; /** * [Application Load Balancer] Information for creating a redirect action. Specify only when ``Type`` is ``redirect``. Information about a redirect action. A URI consists of the following components: protocol://hostname:port/path?query. You must modify at least one of the following components to avoid a redirect loop: protocol, hostname, port, or path. Any components that you do not modify retain their original values. You can reuse URI components using the following reserved keywords: + #{protocol} + #{host} + #{port} + #{path} (the leading '/' is removed) + #{query} For example, you can change the path to '/new/#{path}', the hostname to 'example.#{host}', or the query to '#{query}&value=xyz'. */ redirectConfig?: outputs.awsconnector.RedirectConfigResponse; /** * The Amazon Resource Name (ARN) of the target group. Specify only when ``Type`` is ``forward`` and you want to route to a single target group. To route to one or more target groups, use ``ForwardConfig`` instead. */ targetGroupArn?: string; /** * The type of action. */ type?: string; } /** * Definition of Active */ interface ActiveModelResponse { /** * When true, StackSets performs non-conflicting operations concurrently and queues conflicting operations. After conflicting operations finish, StackSets starts queued operations in request order. */ active?: boolean; } /** * Definition of AddOn */ interface AddOnResponse { /** * The add-on type */ addOnType?: string; /** * An object that represents additional parameters when enabling or modifying the automatic snapshot add-on */ autoSnapshotAddOnRequest?: outputs.awsconnector.AutoSnapshotAddOnResponse; /** * Status of the Addon */ status?: string; } /** * Definition of AdditionalAuthenticationProvider */ interface AdditionalAuthenticationProviderResponse { /** *

The authentication type: API key, Identity and Access Management (IAM), OpenID Connect (OIDC), Amazon Cognito user pools, or Lambda.

*/ authenticationType?: outputs.awsconnector.AuthenticationTypeEnumValueResponse; /** *

Configuration for Lambda function authorization.

*/ lambdaAuthorizerConfig?: outputs.awsconnector.LambdaAuthorizerConfigResponse; /** *

The OIDC configuration.

*/ openIDConnectConfig?: outputs.awsconnector.OpenIDConnectConfigResponse; /** *

The Amazon Cognito user pool configuration.

*/ userPoolConfig?: outputs.awsconnector.CognitoUserPoolConfigResponse; } /** * Definition of Address */ interface AddressResponse { /** * Property addressDefinition */ addressDefinition?: string; } /** * Definition of AdvancedEventSelector */ interface AdvancedEventSelectorResponse { /** * Contains all selector statements in an advanced event selector. */ fieldSelectors?: outputs.awsconnector.AdvancedFieldSelectorResponse[]; /** * An optional, descriptive name for an advanced event selector, such as 'Log data events for only two S3 buckets'. */ name?: string; } /** * Definition of AdvancedFieldSelector */ interface AdvancedFieldSelectorResponse { /** * An operator that includes events that match the last few characters of the event record field specified as the value of Field. */ endsWith?: string[]; /** * An operator that includes events that match the exact value of the event record field specified as the value of Field. This is the only valid operator that you can use with the readOnly, eventCategory, and resources.type fields. */ equals?: string[]; /** * A field in an event record on which to filter events to be logged. Supported fields include readOnly, eventCategory, eventSource (for management events), eventName, resources.type, and resources.ARN. */ field?: string; /** * An operator that excludes events that match the last few characters of the event record field specified as the value of Field. */ notEndsWith?: string[]; /** * An operator that excludes events that match the exact value of the event record field specified as the value of Field. */ notEquals?: string[]; /** * An operator that excludes events that match the first few characters of the event record field specified as the value of Field. */ notStartsWith?: string[]; /** * An operator that includes events that match the first few characters of the event record field specified as the value of Field. */ startsWith?: string[]; } /** * Definition of AdvancedSecurityOptions */ interface AdvancedSecurityOptionsResponse { /** *

Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.

*/ anonymousAuthDisableDate?: string; /** *

True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

*/ anonymousAuthEnabled?: boolean; /** *

True if fine-grained access control is enabled.

*/ enabled?: boolean; /** *

True if the internal user database is enabled.

*/ internalUserDatabaseEnabled?: boolean; /** *

Container for information about the SAML configuration for OpenSearch Dashboards.

*/ samlOptions?: outputs.awsconnector.SAMLOptionsOutputResponse; } /** * Definition of AliasTarget */ interface AliasTargetResponse { /** *

Alias resource record sets only: The value that you specify depends on where you want to route queries:

Amazon API Gateway custom regional APIs and edge-optimized APIs

Specify the applicable domain name for your API. You can get the applicable value using the CLI command get-domain-names:

  • For regional APIs, specify the value of regionalDomainName.

  • For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net.

The name of the record that you're creating must match a custom domain name for your API, such as api.example.com.

Amazon Virtual Private Cloud interface VPC endpoint

Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the CLI command describe-vpc-endpoints.

CloudFront distribution

Specify the domain name that CloudFront assigned when you created your distribution.

Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.

You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.

For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.

Elastic Beanstalk environment

If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name.

For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.

For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute:

  • Amazon Web Services Management Console: For information about how to get the value by using the console, see Using Custom Domains with Elastic Beanstalk in the Elastic Beanstalk Developer Guide.

  • Elastic Beanstalk API: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the Elastic Beanstalk API Reference.

  • CLI: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the CLI Command Reference.

ELB load balancer

Specify the DNS name that is associated with the load balancer. Get the DNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI.

  • Amazon Web Services Management Console: Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field.

    If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.

  • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide:

  • CLI: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide:

Global Accelerator accelerator

Specify the DNS name for your accelerator:

Amazon S3 bucket that is configured as a static website

Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide.

Another Route 53 resource record set

Specify the value of the Name element for a resource record set in the current hosted zone.

If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.

*/ dnsName?: string; /** *

Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets: When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced Amazon Web Services resource, such as an ELB load balancer or another resource record set in the hosted zone.

Note the following:

CloudFront distributions

You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.

Elastic Beanstalk environments that have regionalized subdomains

If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.

If the environment contains a single Amazon EC2 instance, there are no special requirements.

ELB load balancers

Health checking behavior depends on the type of load balancer:

  • Classic Load Balancers: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.

  • Application and Network Load Balancers: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:

    • For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.

    • A target group that has no registered targets is considered unhealthy.

When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.

S3 buckets

There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket.

Other records in the same hosted zone

If the Amazon Web Services resource that you specify in DNSName is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.

For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.

*/ evaluateTargetHealth?: boolean; /** *

Alias resource records sets only: The value used depends on where you want to route traffic:

Amazon API Gateway custom regional APIs and edge-optimized APIs

Specify the hosted zone ID for your API. You can get the applicable value using the CLI command get-domain-names:

  • For regional APIs, specify the value of regionalHostedZoneId.

  • For edge-optimized APIs, specify the value of distributionHostedZoneId.

Amazon Virtual Private Cloud interface VPC endpoint

Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the CLI command describe-vpc-endpoints.

CloudFront distribution

Specify Z2FDTNDATAQYW2.

Alias resource record sets for CloudFront can't be created in a private zone.

Elastic Beanstalk environment

Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and quotas in the Amazon Web Services General Reference.

ELB load balancer

Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:

  • Elastic Load Balancing endpoints and quotas topic in the Amazon Web Services General Reference: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.

  • Amazon Web Services Management Console: Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.

  • Elastic Load Balancing API: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide:

  • CLI: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide:

Global Accelerator accelerator

Specify Z2BJ6XQ5FK7U4H.

An Amazon S3 bucket configured as a static website

Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference.

Another Route 53 resource record set in your hosted zone

Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)

*/ hostedZoneId?: string; } /** * Definition of AmdSevSnpSpecificationEnumValue */ interface AmdSevSnpSpecificationEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of AnalyticsConfiguration */ interface AnalyticsConfigurationResponse { /** * The ID that identifies the analytics configuration. */ id?: string; /** * The prefix that an object must have to be included in the analytics results. */ prefix?: string; /** * Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes. Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket. */ storageClassAnalysis?: outputs.awsconnector.StorageClassAnalysisResponse; /** * The tags to use when evaluating an analytics filter. The analytics only includes objects that meet the filter's criteria. If no filter is specified, all of the contents of the bucket are included in the analysis. */ tagFilters?: outputs.awsconnector.TagFilterResponse[]; } /** * Definition of AnomalyDetection */ interface AnomalyDetectionResponse { /** *

Indicates whether anomaly mitigation is in progress.

*/ mitigationInEffect?: outputs.awsconnector.MitigationInEffectEnumEnumValueResponse; /** *

The latest anomaly detection result.

*/ result?: outputs.awsconnector.AnomalyResultEnumEnumValueResponse; } /** * Definition of AnomalyResultEnumEnumValue */ interface AnomalyResultEnumEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ApiGatewayRestApi */ interface ApiGatewayRestApiPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsApiGatewayRestApiPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of ApiGatewayStage */ interface ApiGatewayStagePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsApiGatewayStagePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of AppSyncGraphqlApi */ interface AppSyncGraphqlApiPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsAppSyncGraphqlApiPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of ApplicationResourceLifecycleConfig */ interface ApplicationResourceLifecycleConfigResponse { /** * The ARN of an IAM service role that Elastic Beanstalk has permission to assume. The ServiceRole property is required the first time that you provide a ResourceLifecycleConfig for the application. After you provide it once, Elastic Beanstalk persists the Service Role with the application, and you don't need to specify it again. You can, however, specify it in subsequent updates to change the Service Role to another value. */ serviceRole?: string; /** * Defines lifecycle settings for application versions. */ versionLifecycleConfig?: outputs.awsconnector.ApplicationVersionLifecycleConfigResponse; } /** * Definition of Application */ interface ApplicationResponse { /** *

This option is for advanced users only. This is meta information about third-party applications that third-party vendors use for testing purposes.

*/ additionalInfo?: { [key: string]: string; }; /** *

Arguments for Amazon EMR to pass to the application.

*/ args?: string[]; /** *

The name of the application.

*/ name?: string; /** *

The version of the application.

*/ version?: string; } /** * Definition of ApplicationVersionLifecycleConfig */ interface ApplicationVersionLifecycleConfigResponse { /** * Specify a max age rule to restrict the length of time that application versions are retained for an application. */ maxAgeRule?: outputs.awsconnector.MaxAgeRuleResponse; /** * Specify a max count rule to restrict the number of application versions that are retained for an application. */ maxCountRule?: outputs.awsconnector.MaxCountRuleResponse; } /** * Definition of ArchitectureValuesEnumValue */ interface ArchitectureValuesEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ArchiveRule */ interface ArchiveRuleResponse { /** * Property filter */ filter?: outputs.awsconnector.FilterResponse[]; /** * The archive rule name */ ruleName?: string; } /** * Definition of ArtifactNamespaceEnumValue */ interface ArtifactNamespaceEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ArtifactPackagingEnumValue */ interface ArtifactPackagingEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ArtifactsTypeEnumValue */ interface ArtifactsTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of AttachmentStatusEnumValue */ interface AttachmentStatusEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of AttributeDefinition */ interface AttributeDefinitionResponse { /** * A name for the attribute. */ attributeName?: string; /** * The data type for the attribute, where: + ``S`` - the attribute is of type String + ``N`` - the attribute is of type Number + ``B`` - the attribute is of type Binary */ attributeType?: string; } /** * Definition of AuthTypeEnumValue */ interface AuthTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of AuthenticateCognitoConfig */ interface AuthenticateCognitoConfigResponse { /** * The query parameters (up to 10) to include in the redirect request to the authorization endpoint. */ authenticationRequestExtraParams?: { [key: string]: string; }; /** * The behavior if the user is not authenticated. The following are possible values: + deny```` - Return an HTTP 401 Unauthorized error. + allow ```` - Allow the request to be forwarded to the target. + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value. */ onUnauthenticatedRequest?: string; /** * The set of user claims to be requested from the IdP. The default is ``openid``. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. */ scope?: string; /** * The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. */ sessionCookieName?: string; /** * The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days). */ sessionTimeout?: string; /** * The Amazon Resource Name (ARN) of the Amazon Cognito user pool. */ userPoolArn?: string; /** * The ID of the Amazon Cognito user pool client. */ userPoolClientId?: string; /** * The domain prefix or fully-qualified domain name of the Amazon Cognito user pool. */ userPoolDomain?: string; } /** * Definition of AuthenticateOidcConfig */ interface AuthenticateOidcConfigResponse { /** * The query parameters (up to 10) to include in the redirect request to the authorization endpoint. */ authenticationRequestExtraParams?: { [key: string]: string; }; /** * The authorization endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. */ authorizationEndpoint?: string; /** * The OAuth 2.0 client identifier. */ clientId?: string; /** * The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule, you can omit this parameter if you set ``UseExistingClientSecret`` to true. */ clientSecret?: string; /** * The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. */ issuer?: string; /** * The behavior if the user is not authenticated. The following are possible values: + deny```` - Return an HTTP 401 Unauthorized error. + allow ```` - Allow the request to be forwarded to the target. + authenticate```` - Redirect the request to the IdP authorization endpoint. This is the default value. */ onUnauthenticatedRequest?: string; /** * The set of user claims to be requested from the IdP. The default is ``openid``. To verify which scope values your IdP supports and how to separate multiple values, see the documentation for your IdP. */ scope?: string; /** * The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie. */ sessionCookieName?: string; /** * The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days). */ sessionTimeout?: string; /** * The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. */ tokenEndpoint?: string; /** * Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule, you can omit this parameter or set it to false. */ useExistingClientSecret?: boolean; /** * The user info endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path. */ userInfoEndpoint?: string; } /** * Definition of AuthenticationModeEnumValue */ interface AuthenticationModeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of AuthenticationTypeEnumValue */ interface AuthenticationTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of AuthorizationConfig */ interface AuthorizationConfigResponse { /** * The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the ``EFSVolumeConfiguration`` must either be omitted or set to ``/`` which will enforce the path set on the EFS access point. If an access point is used, transit encryption must be on in the ``EFSVolumeConfiguration``. For more information, see [Working with Amazon EFS access points](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html) in the *Amazon Elastic File System User Guide*. */ accessPointId?: string; /** * Determines whether to use the Amazon ECS task role defined in a task definition when mounting the Amazon EFS file system. If it is turned on, transit encryption must be turned on in the ``EFSVolumeConfiguration``. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Using Amazon EFS access points](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html#efs-volume-accesspoints) in the *Amazon Elastic Container Service Developer Guide*. */ iam?: string; } /** * Definition of AutoDeployment */ interface AutoDeploymentResponse { /** * If set to true, StackSets automatically deploys additional stack instances to AWS Organizations accounts that are added to a target organization or organizational unit (OU) in the specified Regions. If an account is removed from a target organization or OU, StackSets deletes stack instances from the account in the specified Regions. */ enabled?: boolean; /** * If set to true, stack resources are retained when an account is removed from a target organization or OU. If set to false, stack resources are deleted. Specify only if Enabled is set to True. */ retainStacksOnAccountRemoval?: boolean; } /** * Definition of AutoScalingAutoScalingGroup */ interface AutoScalingAutoScalingGroupPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsAutoScalingAutoScalingGroupPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of NotificationConfiguration */ interface AutoScalingGroupNotificationConfigurationResponse { /** * A list of event types that send a notification. Event types can include any of the following types. *Allowed values*: + ``autoscaling:EC2_INSTANCE_LAUNCH`` + ``autoscaling:EC2_INSTANCE_LAUNCH_ERROR`` + ``autoscaling:EC2_INSTANCE_TERMINATE`` + ``autoscaling:EC2_INSTANCE_TERMINATE_ERROR`` + ``autoscaling:TEST_NOTIFICATION`` */ notificationTypes?: string[]; /** * The Amazon Resource Name (ARN) of the Amazon SNS topic. */ topicARN?: string; } /** * Definition of AutoSnapshotAddOn */ interface AutoSnapshotAddOnResponse { /** * The daily time when an automatic snapshot will be created. */ snapshotTimeOfDay?: string; } /** * Definition of AutoTuneOptionsOutput */ interface AutoTuneOptionsOutputResponse { /** *

Any errors that occurred while enabling or disabling Auto-Tune.

*/ errorMessage?: string; /** *

The current state of Auto-Tune on the domain.

*/ state?: outputs.awsconnector.AutoTuneStateEnumValueResponse; /** *

Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.

*/ useOffPeakWindow?: boolean; } /** * Definition of AutoTuneStateEnumValue */ interface AutoTuneStateEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of AvailabilityZone */ interface AvailabilityZoneResponse { /** *

The name of the Availability Zone.

*/ name?: string; } /** * Definition of awsAccessAnalyzerAnalyzer */ interface AwsAccessAnalyzerAnalyzerPropertiesResponse { /** * The configuration for the analyzer */ analyzerConfiguration?: outputs.awsconnector.UnusedAccessConfigurationResponse; /** * Analyzer name */ analyzerName?: string; /** * Property archiveRules */ archiveRules?: outputs.awsconnector.ArchiveRuleResponse[]; /** * Amazon Resource Name (ARN) of the analyzer */ arn?: string; /** * An array of key-value pairs to apply to this resource. */ tags?: outputs.awsconnector.TagResponse[]; /** * The type of the analyzer, must be one of ACCOUNT, ORGANIZATION, ACCOUNT_UNUSED_ACCESS or ORGANIZATION_UNUSED_ACCESS */ type?: string; } /** * Definition of awsAcmCertificateSummary */ interface AwsAcmCertificateSummaryPropertiesResponse { /** *

Amazon Resource Name (ARN) of the certificate. This is of the form:

arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012

For more information about ARNs, see Amazon Resource Names (ARNs).

*/ certificateArn?: string; /** *

The time at which the certificate was requested.

*/ createdAt?: string; /** *

Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.

*/ domainName?: string; /** *

Indicates whether the certificate has been exported. This value exists only when the certificate type is PRIVATE.

*/ exported?: boolean; /** *

Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID).

*/ extendedKeyUsages?: string[]; /** *

When called by ListCertificates, indicates whether the full list of subject alternative names has been included in the response. If false, the response includes all of the subject alternative names included in the certificate. If true, the response only includes the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

*/ hasAdditionalSubjectAlternativeNames?: boolean; /** *

The date and time when the certificate was imported. This value exists only when the certificate type is IMPORTED.

*/ importedAt?: string; /** *

Indicates whether the certificate is currently in use by any Amazon Web Services resources.

*/ inUse?: boolean; /** *

The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED.

*/ issuedAt?: string; /** *

The algorithm that was used to generate the public-private key pair.

*/ keyAlgorithm?: outputs.awsconnector.KeyAlgorithmEnumValueResponse; /** *

A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.

*/ keyUsages?: string[]; /** *

The time after which the certificate is not valid.

*/ notAfter?: string; /** *

The time before which the certificate is not valid.

*/ notBefore?: string; /** *

Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the RenewCertificate command.

*/ renewalEligibility?: outputs.awsconnector.RenewalEligibilityEnumValueResponse; /** *

The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED.

*/ revokedAt?: string; /** *

The status of the certificate.

A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.

*/ status?: outputs.awsconnector.CertificateStatusEnumValueResponse; /** *

One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.

When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.

*/ subjectAlternativeNameSummaries?: string[]; /** *

The source of the certificate. For certificates provided by ACM, this value is AMAZON_ISSUED. For certificates that you imported with ImportCertificate, this value is IMPORTED. ACM does not provide managed renewal for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see Importing Certificates in the Certificate Manager User Guide.

*/ type?: outputs.awsconnector.CertificateTypeEnumValueResponse; } /** * Definition of awsApiGatewayRestApi */ interface AwsApiGatewayRestApiPropertiesResponse { /** * The source of the API key for metering requests according to a usage plan. Valid values are: ``HEADER`` to read the API key from the ``X-API-Key`` header of a request. ``AUTHORIZER`` to read the API key from the ``UsageIdentifierKey`` from a custom authorizer. */ apiKeySourceType?: string; /** * The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads. */ binaryMediaTypes?: string[]; /** * An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format. */ body?: any; /** * The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. ``S3Location`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML. On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://www.openapis.org/), becoming the foundation of the OpenAPI Specification. */ bodyS3Location?: outputs.awsconnector.S3LocationResponse; /** * The ID of the RestApi that you want to clone from. */ cloneFrom?: string; /** * The description of the RestApi. */ description?: string; /** * Specifies whether clients can invoke your API by using the default ``execute-api`` endpoint. By default, clients can invoke your API with the default ``https://{api_id}.execute-api.{region}.amazonaws.com`` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint */ disableExecuteApiEndpoint?: boolean; /** * A list of the endpoint types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the ``Parameters`` property. The ``EndpointConfiguration`` property type specifies the endpoint types of a REST API. ``EndpointConfiguration`` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource. */ endpointConfiguration?: outputs.awsconnector.EndpointConfigurationResponse; /** * A query parameter to indicate whether to rollback the API update (``true``) or not (``false``) when a warning is encountered. The default value is ``false``. */ failOnWarnings?: boolean; /** * A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size. */ minimumCompressionSize?: number; /** * This property applies only when you use OpenAPI to define your REST API. The ``Mode`` determines how API Gateway handles resource updates. Valid values are ``overwrite`` or ``merge``. For ``overwrite``, the new API definition replaces the existing one. The existing API identifier remains unchanged. For ``merge``, the new API definition is merged with the existing API. If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is ``overwrite``. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use the default mode to define top-level ``RestApi`` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties. */ mode?: string; /** * The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification. */ name?: string; /** * Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ``ignore=documentation`` as a ``parameters`` value, as in the AWS CLI command of ``aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'``. */ parameters?: { [key: string]: string; }; /** * A policy document that contains the permissions for the ``RestApi`` resource. To set the ARN for the policy, use the ``!Join`` intrinsic function with ``''`` as delimiter and values of ``'execute-api:/'`` and ``'*'``. */ policy?: string; /** * Property restApiId */ restApiId?: string; /** * Property rootResourceId */ rootResourceId?: string; /** * The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with ``aws:``. The tag value can be up to 256 characters. */ tags?: outputs.awsconnector.TagResponse[]; } /** * Definition of awsApiGatewayStage */ interface AwsApiGatewayStagePropertiesResponse { /** * Access log settings, including the access log format and access log destination ARN. The ``AccessLogSetting`` property type specifies settings for logging access in this stage. ``AccessLogSetting`` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource. */ accessLogSetting?: outputs.awsconnector.AccessLogSettingResponse; /** * Specifies whether a cache cluster is enabled for the stage. */ cacheClusterEnabled?: boolean; /** * The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html). */ cacheClusterSize?: string; /** * Settings for the canary deployment in this stage. Configuration settings of a canary deployment. */ canarySetting?: outputs.awsconnector.CanarySettingResponse; /** * The identifier of a client certificate for an API stage. */ clientCertificateId?: string; /** * The identifier of the Deployment that the stage points to. */ deploymentId?: string; /** * The stage's description. */ description?: string; /** * The version of the associated API documentation. */ documentationVersion?: string; /** * A map that defines the method settings for a Stage resource. Keys (designated as ``/{method_setting_key`` below) are method paths defined as ``{resource_path}/{http_method}`` for an individual method override, or ``/\*/\*`` for overriding all methods in the stage. */ methodSettings?: outputs.awsconnector.MethodSettingResponse[]; /** * The string identifier of the associated RestApi. */ restApiId?: string; /** * The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters. */ stageName?: string; /** * The collection of tags. Each tag element is associated with a given resource. */ tags?: outputs.awsconnector.TagResponse[]; /** * Specifies whether active tracing with X-ray is enabled for the Stage. */ tracingEnabled?: boolean; /** * A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``. */ variables?: { [key: string]: string; }; } /** * Definition of awsAppSyncGraphqlApi */ interface AwsAppSyncGraphqlApiPropertiesResponse { /** *

A list of additional authentication providers for the GraphqlApi API.

*/ additionalAuthenticationProviders?: outputs.awsconnector.AdditionalAuthenticationProviderResponse[]; /** *

The API ID.

*/ apiId?: string; /** *

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

*/ apiType?: outputs.awsconnector.GraphQLApiTypeEnumValueResponse; /** *

The Amazon Resource Name (ARN).

*/ arn?: string; /** *

The authentication type.

*/ authenticationType?: outputs.awsconnector.AuthenticationTypeEnumValueResponse; /** *

The DNS records for the API.

*/ dns?: { [key: string]: string; }; /** *

The enhancedMetricsConfig object.

*/ enhancedMetricsConfig?: outputs.awsconnector.EnhancedMetricsConfigResponse; /** *

Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled.

For more information about introspection, see GraphQL introspection.

*/ introspectionConfig?: outputs.awsconnector.GraphQLApiIntrospectionConfigEnumValueResponse; /** *

Configuration for Lambda function authorization.

*/ lambdaAuthorizerConfig?: outputs.awsconnector.LambdaAuthorizerConfigResponse; /** *

The Amazon CloudWatch Logs configuration.

*/ logConfig?: outputs.awsconnector.LogConfigResponse; /** *

The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.

*/ mergedApiExecutionRoleArn?: string; /** *

The API name.

*/ name?: string; /** *

The OpenID Connect configuration.

*/ openIDConnectConfig?: outputs.awsconnector.OpenIDConnectConfigResponse; /** *

The account owner of the GraphQL API.

*/ owner?: string; /** *

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

*/ ownerContact?: string; /** *

The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds.

Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

*/ queryDepthLimit?: number; /** *

The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.

*/ resolverCountLimit?: number; /** *

The tags.

*/ tags?: { [key: string]: string; }; /** *

The URIs.

*/ uris?: { [key: string]: string; }; /** *

The Amazon Cognito user pool configuration.

*/ userPoolConfig?: outputs.awsconnector.UserPoolConfigResponse; /** *

Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

*/ visibility?: outputs.awsconnector.GraphQLApiVisibilityEnumValueResponse; /** *

The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.

*/ wafWebAclArn?: string; /** *

A flag indicating whether to use X-Ray tracing for this GraphqlApi.

*/ xrayEnabled?: boolean; } /** * Definition of awsAutoScalingAutoScalingGroup */ interface AwsAutoScalingAutoScalingGroupPropertiesResponse { /** * The name of the Auto Scaling group. This name must be unique per Region per account. The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters. You cannot use a colon (:) in the name. */ autoScalingGroupName?: string; /** * A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the ``VPCZoneIdentifier`` property, or for attaching a network interface when an existing network interface ID is specified in a launch template. */ availabilityZones?: string[]; /** * Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see [Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-capacity-rebalancing.html) in the in the *Amazon EC2 Auto Scaling User Guide*. */ capacityRebalance?: boolean; /** * Reserved. */ context?: string; /** * *Only needed if you use simple scaling policies.* The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see [Scaling cooldowns for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html) in the *Amazon EC2 Auto Scaling User Guide*. Default: ``300`` seconds */ cooldown?: string; /** * The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the ``InService`` state. During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see [Set the default instance warmup for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the *Amazon EC2 Auto Scaling User Guide*. To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, *even if it is set to 0 seconds*. To remove a value that you previously set, include the property but specify ``-1`` for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of ``0`` or other nominal value. Default: None */ defaultInstanceWarmup?: number; /** * The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure automatic scaling. The number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity when creating the stack, the default is the minimum size of the group. CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price. */ desiredCapacity?: string; /** * The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports ``DesiredCapacityType`` for attribute-based instance type selection only. For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. By default, Amazon EC2 Auto Scaling specifies ``units``, which translates into number of instances. Valid values: ``units`` | ``vcpu`` | ``memory-mib`` */ desiredCapacityType?: string; /** * The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the ``InService`` state. For more information, see [Set the health check grace period for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the *Amazon EC2 Auto Scaling User Guide*. Default: ``0`` seconds */ healthCheckGracePeriod?: number; /** * A comma-separated value string of one or more health check types. The valid values are ``EC2``, ``ELB``, and ``VPC_LATTICE``. ``EC2`` is the default health check and cannot be disabled. For more information, see [Health checks for Auto Scaling instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/healthcheck.html) in the *Amazon EC2 Auto Scaling User Guide*. Only specify ``EC2`` if you must clear a value that was previously set. */ healthCheckType?: string; /** * The ID of the instance used to base the launch configuration on. For more information, see [Create an Auto Scaling group using an EC2 instance](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the *Amazon EC2 Auto Scaling User Guide*. If you specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``LaunchConfigurationName``, don't specify ``InstanceId``. */ instanceId?: string; /** * An instance maintenance policy. For more information, see [Set instance maintenance policy](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*. ``InstanceMaintenancePolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. For more information, see [Instance maintenance policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the *Amazon EC2 Auto Scaling User Guide*. */ instanceMaintenancePolicy?: outputs.awsconnector.InstanceMaintenancePolicyResponse; /** * The name of the launch configuration to use to launch instances. Required only if you don't specify ``LaunchTemplate``, ``MixedInstancesPolicy``, or ``InstanceId``. */ launchConfigurationName?: string; /** * Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a ``MixedInstancesPolicy``. For more information about creating launch templates, see [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. If you omit this property, you must specify ``MixedInstancesPolicy``, ``LaunchConfigurationName``, or ``InstanceId``. Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group. You must specify the following: + The ID or the name of the launch template, but not both. + The version of the launch template. ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource. */ launchTemplate?: outputs.awsconnector.LaunchTemplateSpecificationResponse; /** * One or more lifecycle hooks to add to the Auto Scaling group before instances are launched. */ lifecycleHookSpecificationList?: outputs.awsconnector.LifecycleHookSpecificationResponse[]; /** * A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the ``TargetGroupARNs`` property instead. */ loadBalancerNames?: string[]; /** * The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see [Replacing Auto Scaling instances based on maximum instance lifetime](https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html) in the *Amazon EC2 Auto Scaling User Guide*. */ maxInstanceLifetime?: number; /** * The maximum size of the group. With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above ``MaxSize`` to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go above ``MaxSize`` by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group). */ maxSize?: string; /** * Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled. */ metricsCollection?: outputs.awsconnector.MetricsCollectionResponse[]; /** * The minimum size of the group. */ minSize?: string; /** * An embedded object that specifies a mixed instances policy. The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group. A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. You can create a mixed instances policy for new and existing Auto Scaling groups. You must use a launch template to configure the policy. You cannot use a launch configuration. There are key differences between Spot Instances and On-Demand Instances: + The price for Spot Instances varies based on demand + Amazon EC2 can terminate an individual Spot Instance as the availability of, or price for, Spot Instances changes When a Spot Instance is terminated, Amazon EC2 Auto Scaling group attempts to launch a replacement instance to maintain the desired capacity for the group. ``MixedInstancesPolicy`` is a property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. */ mixedInstancesPolicy?: outputs.awsconnector.MixedInstancesPolicyResponse; /** * Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see [Using instance scale-in protection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html) in the *Amazon EC2 Auto Scaling User Guide*. */ newInstancesProtectedFromScaleIn?: boolean; /** * A structure that specifies an Amazon SNS notification configuration for the ``NotificationConfigurations`` property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. For an example template snippet, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html). For more information, see [Get Amazon SNS notifications when your Auto Scaling group scales](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ASGettingNotifications.html) in the *Amazon EC2 Auto Scaling User Guide*. */ notificationConfiguration?: outputs.awsconnector.AutoScalingGroupNotificationConfigurationResponse; /** * Configures an Auto Scaling group to send notifications when specified events take place. */ notificationConfigurations?: outputs.awsconnector.AutoScalingGroupNotificationConfigurationResponse[]; /** * The name of the placement group into which to launch your instances. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide for Linux Instances*. A *cluster* placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group. */ placementGroup?: string; /** * The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named ``AWSServiceRoleForAutoScaling``, which it creates if it does not exist. For more information, see [Service-linked roles](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html) in the *Amazon EC2 Auto Scaling User Guide*. */ serviceLinkedRoleARN?: string; /** * One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see [Tag Auto Scaling groups and instances](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html) in the *Amazon EC2 Auto Scaling User Guide*. */ tags?: outputs.awsconnector.TagPropertyResponse[]; /** * The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see [Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html) in the *Amazon EC2 Auto Scaling User Guide*. */ targetGroupARNs?: string[]; /** * A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see [Work with Amazon EC2 Auto Scaling termination policies](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html) in the *Amazon EC2 Auto Scaling User Guide*. Valid values: ``Default`` | ``AllocationStrategy`` | ``ClosestToNextInstanceHour`` | ``NewestInstance`` | ``OldestInstance`` | ``OldestLaunchConfiguration`` | ``OldestLaunchTemplate`` | ``arn:aws:lambda:region:account-id:function:my-function:my-alias`` */ terminationPolicies?: string[]; /** * A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to declare a dependency on the [VPC-gateway attachment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-vpc-gateway-attachment.html). When you update ``VPCZoneIdentifier``, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an [UpdatePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatepolicy.html). Required to launch instances into a nondefault VPC. If you specify ``VPCZoneIdentifier`` with ``AvailabilityZones``, the subnets that you specify for this property must reside in those Availability Zones. */ vpcZoneIdentifier?: string[]; } /** * Definition of awsCloudFormationStack */ interface AwsCloudFormationStackPropertiesResponse { /** * Property capabilities */ capabilities?: string[]; /** * Property changeSetId */ changeSetId?: string; /** * Property creationTime */ creationTime?: string; /** * Property description */ description?: string; /** * Property disableRollback */ disableRollback?: boolean; /** * Property enableTerminationProtection */ enableTerminationProtection?: boolean; /** * Property lastUpdateTime */ lastUpdateTime?: string; /** * Property notificationARNs */ notificationARNs?: string[]; /** * Property outputs */ outputs?: outputs.awsconnector.OutputResponse[]; /** * Property parameters */ parameters?: { [key: string]: string; }; /** * Property parentId */ parentId?: string; /** * Property roleARN */ roleARN?: string; /** * Property rootId */ rootId?: string; /** * Property stackId */ stackId?: string; /** * Property stackName */ stackName?: string; /** * Property stackPolicyBody */ stackPolicyBody?: any; /** * Property stackPolicyURL */ stackPolicyURL?: string; /** * Property stackStatus */ stackStatus?: string; /** * Property stackStatusReason */ stackStatusReason?: string; /** * Property tags */ tags?: outputs.awsconnector.TagResponse[]; /** * Property templateBody */ templateBody?: any; /** * Property templateURL */ templateURL?: string; /** * Property timeoutInMinutes */ timeoutInMinutes?: number; } /** * Definition of awsCloudFormationStackSet */ interface AwsCloudFormationStackSetPropertiesResponse { /** * The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. */ administrationRoleARN?: string; /** * Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if PermissionModel is SERVICE_MANAGED. */ autoDeployment?: outputs.awsconnector.AutoDeploymentResponse; /** * Specifies the AWS account that you are acting from. By default, SELF is specified. For self-managed permissions, specify SELF; for service-managed permissions, if you are signed in to the organization's management account, specify SELF. If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN. */ callAs?: string; /** * In some cases, you must explicitly acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances. */ capabilities?: string[]; /** * A description of the stack set. You can use the description to identify the stack set's purpose or other important information. */ description?: string; /** * The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the AWSCloudFormationStackSetExecutionRole role for the stack set operation. */ executionRoleName?: string; /** * Describes whether StackSets performs non-conflicting operations concurrently and queues conflicting operations. */ managedExecution?: outputs.awsconnector.ActiveModelResponse; /** * The user-specified preferences for how AWS CloudFormation performs a stack set operation. */ operationPreferences?: outputs.awsconnector.OperationPreferencesResponse; /** * The input parameters for the stack set template. */ parameters?: outputs.awsconnector.ParameterResponse[]; /** * Describes how the IAM roles required for stack set operations are created. By default, SELF-MANAGED is specified. */ permissionModel?: string; /** * A group of stack instances with parameters in some specific accounts and regions. */ stackInstancesGroup?: outputs.awsconnector.StackInstancesResponse[]; /** * The ID of the stack set that you're creating. */ stackSetId?: string; /** * The name to associate with the stack set. The name must be unique in the Region where you create your stack set. */ stackSetName?: string; /** * The key-value pairs to associate with this stack set and the stacks created from it. AWS CloudFormation also propagates these tags to supported resources that are created in the stacks. A maximum number of 50 tags can be specified. */ tags?: outputs.awsconnector.TagResponse[]; /** * The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. */ templateBody?: string; /** * Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. */ templateURL?: string; } /** * Definition of awsCloudFrontDistribution */ interface AwsCloudFrontDistributionPropertiesResponse { /** * The distribution's configuration. A distribution configuration. */ distributionConfig?: outputs.awsconnector.DistributionConfigResponse; /** * Property domainName */ domainName?: string; /** * Property id */ id?: string; /** * A complex type that contains zero or more ``Tag`` elements. */ tags?: outputs.awsconnector.TagResponse[]; } /** * awsCloudFrontDistributionPropertiesResponseProvideDefaults sets the appropriate defaults for AwsCloudFrontDistributionPropertiesResponse */ function awsCloudFrontDistributionPropertiesResponseProvideDefaults(val: AwsCloudFrontDistributionPropertiesResponse): AwsCloudFrontDistributionPropertiesResponse; /** * Definition of awsCloudTrailTrail */ interface AwsCloudTrailTrailPropertiesResponse { /** * The advanced event selectors that were used to select events for the data store. */ advancedEventSelectors?: outputs.awsconnector.AdvancedEventSelectorResponse[]; /** * Property arn */ arn?: string; /** * Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn. */ cloudWatchLogsLogGroupArn?: string; /** * Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group. */ cloudWatchLogsRoleArn?: string; /** * Specifies whether log file validation is enabled. The default is false. */ enableLogFileValidation?: boolean; /** * Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. You can configure up to five event selectors for a trail. */ eventSelectors?: outputs.awsconnector.EventSelectorResponse[]; /** * Specifies whether the trail is publishing events from global services such as IAM to the log files. */ includeGlobalServiceEvents?: boolean; /** * Lets you enable Insights event logging by specifying the Insights selectors that you want to enable on an existing trail. */ insightSelectors?: outputs.awsconnector.InsightSelectorResponse[]; /** * Whether the CloudTrail is currently logging AWS API calls. */ isLogging?: boolean; /** * Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted. As a best practice, consider using trails that log events in all regions. */ isMultiRegionTrail?: boolean; /** * Specifies whether the trail is created for all accounts in an organization in AWS Organizations, or only for the current AWS account. The default is false, and cannot be true unless the call is made on behalf of an AWS account that is the master account for an organization in AWS Organizations. */ isOrganizationTrail?: boolean; /** * Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by 'alias/', a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier. */ kmsKeyId?: string; /** * Specifies the name of the Amazon S3 bucket designated for publishing log files. See Amazon S3 Bucket Naming Requirements. */ s3BucketName?: string; /** * Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see Finding Your CloudTrail Log Files. The maximum length is 200 characters. */ s3KeyPrefix?: string; /** * Property snsTopicArn */ snsTopicArn?: string; /** * Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters. */ snsTopicName?: string; /** * Property tags */ tags?: outputs.awsconnector.TagResponse[]; /** * Property trailName */ trailName?: string; } /** * Definition of awsCloudWatchAlarm */ interface AwsCloudWatchAlarmPropertiesResponse { /** * Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE. */ actionsEnabled?: boolean; /** * The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see [PutMetricAlarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) in the *API Reference*. */ alarmActions?: string[]; /** * The description of the alarm. */ alarmDescription?: string; /** * The name of the alarm. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the alarm name. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. */ alarmName?: string; /** * Property arn */ arn?: string; /** * The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand. */ comparisonOperator?: string; /** * The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an 'M out of N' alarm. In that case, this value is the M, and the value that you set for ``EvaluationPeriods`` is the N value. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*. If you omit this parameter, CW uses the same value here that you set for ``EvaluationPeriods``, and the alarm goes to alarm state if that many consecutive periods are breaching. */ datapointsToAlarm?: number; /** * The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify ``Dimensions``. Instead, you use ``Metrics``. */ dimensions?: outputs.awsconnector.DimensionResponse[]; /** * Used only for alarms based on percentiles. If ``ignore``, the alarm state does not change during periods with too few data points to be statistically significant. If ``evaluate`` or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available. */ evaluateLowSampleCountPercentile?: string; /** * The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an 'M out of N' alarm, this value is the N, and ``DatapointsToAlarm`` is the M. For more information, see [Evaluating an Alarm](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarm-evaluation) in the *User Guide*. */ evaluationPeriods?: number; /** * The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both. For an alarm based on a math expression, you can't specify ``ExtendedStatistic``. Instead, you use ``Metrics``. */ extendedStatistic?: string; /** * The actions to execute when this alarm transitions to the ``INSUFFICIENT_DATA`` state from any other state. Each action is specified as an Amazon Resource Name (ARN). */ insufficientDataActions?: string[]; /** * The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use ``Metrics`` instead and you can't specify ``MetricName``. */ metricName?: string; /** * An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression. If you specify the ``Metrics`` parameter, you cannot specify ``MetricName``, ``Dimensions``, ``Period``, ``Namespace``, ``Statistic``, ``ExtendedStatistic``, or ``Unit``. */ metrics?: outputs.awsconnector.MetricDataQueryResponse[]; /** * The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify ``Namespace`` and you use ``Metrics`` instead. For a list of namespaces for metrics from AWS services, see [Services That Publish Metrics.](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/aws-services-cloudwatch-metrics.html) */ namespace?: string; /** * The actions to execute when this alarm transitions to the ``OK`` state from any other state. Each action is specified as an Amazon Resource Name (ARN). */ okActions?: string[]; /** * The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60. For an alarm based on a math expression, you can't specify ``Period``, and instead you use the ``Metrics`` parameter. *Minimum:* 10 */ period?: number; /** * The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ``ExtendedStatistic``. For an alarm based on a metric, you must specify either ``Statistic`` or ``ExtendedStatistic`` but not both. For an alarm based on a math expression, you can't specify ``Statistic``. Instead, you use ``Metrics``. */ statistic?: string; /** * Property tags */ tags?: outputs.awsconnector.TagResponse[]; /** * The value to compare with the specified statistic. */ threshold?: number; /** * In an alarm based on an anomaly detection model, this is the ID of the ``ANOMALY_DETECTION_BAND`` function used as the threshold for the alarm. */ thresholdMetricId?: string; /** * Sets how this alarm is to handle missing data points. Valid values are ``breaching``, ``notBreaching``, ``ignore``, and ``missing``. For more information, see [Configuring How Alarms Treat Missing Data](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data) in the *Amazon User Guide*. If you omit this parameter, the default behavior of ``missing`` is used. */ treatMissingData?: string; /** * The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a ``Metrics`` array. You can specify the following values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None. */ unit?: string; } /** * awsCloudWatchAlarmPropertiesResponseProvideDefaults sets the appropriate defaults for AwsCloudWatchAlarmPropertiesResponse */ function awsCloudWatchAlarmPropertiesResponseProvideDefaults(val: AwsCloudWatchAlarmPropertiesResponse): AwsCloudWatchAlarmPropertiesResponse; /** * Definition of awsCodeBuildProject */ interface AwsCodeBuildProjectPropertiesResponse { /** *

The Amazon Resource Name (ARN) of the build project.

*/ arn?: string; /** *

Information about the build output artifacts for the build project.

*/ artifacts?: outputs.awsconnector.ProjectArtifactsResponse; /** *

Information about the build badge for the build project.

*/ badge?: outputs.awsconnector.ProjectBadgeResponse; /** *

A ProjectBuildBatchConfig object that defines the batch build options for the project.

*/ buildBatchConfig?: outputs.awsconnector.ProjectBuildBatchConfigResponse; /** *

Information about the cache for the build project.

*/ cache?: outputs.awsconnector.ProjectCacheResponse; /** *

The maximum number of concurrent builds that are allowed for this project.

New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

*/ concurrentBuildLimit?: number; /** *

When the build project was created, expressed in Unix time format.

*/ created?: string; /** *

A description that makes the build project easy to identify.

*/ description?: string; /** *

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).

*/ encryptionKey?: string; /** *

Information about the build environment for this build project.

*/ environment?: outputs.awsconnector.ProjectEnvironmentResponse; /** *

An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

*/ fileSystemLocations?: outputs.awsconnector.ProjectFileSystemLocationResponse[]; /** *

When the build project's settings were last modified, expressed in Unix time format.

*/ lastModified?: string; /** *

Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.

*/ logsConfig?: outputs.awsconnector.LogsConfigResponse; /** *

The name of the build project.

*/ name?: string; /** * Property projectVisibility */ projectVisibility?: outputs.awsconnector.ProjectVisibilityTypeEnumValueResponse; /** *

Contains the project identifier used with the public build APIs.

*/ publicProjectAlias?: string; /** *

The number of minutes a build is allowed to be queued before it times out.

*/ queuedTimeoutInMinutes?: number; /** *

The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

*/ resourceAccessRole?: string; /** *

An array of ProjectArtifacts objects.

*/ secondaryArtifacts?: outputs.awsconnector.ProjectArtifactsResponse[]; /** *

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

*/ secondarySourceVersions?: outputs.awsconnector.ProjectSourceVersionResponse[]; /** *

An array of ProjectSource objects.

*/ secondarySources?: outputs.awsconnector.ProjectSourceResponse[]; /** *

The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.

*/ serviceRole?: string; /** *

Information about the build input source code for this build project.

*/ source?: outputs.awsconnector.ProjectSourceResponse; /** *

A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

  • For CodeCommit: the commit ID, branch, or Git tag to use.

  • For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

*/ sourceVersion?: string; /** *

A list of tag key and value pairs associated with this build project.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

*/ tags?: outputs.awsconnector.TagResponse[]; /** *

How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.

*/ timeoutInMinutes?: number; /** *

Information about the VPC configuration that CodeBuild accesses.

*/ vpcConfig?: outputs.awsconnector.VpcConfigResponse; /** *

Information about a webhook that connects repository events to a build project in CodeBuild.

*/ webhook?: outputs.awsconnector.WebhookResponse; } /** * Definition of awsCodeBuildSourceCredentialsInfo */ interface AwsCodeBuildSourceCredentialsInfoPropertiesResponse { /** *

The Amazon Resource Name (ARN) of the token.

*/ arn?: string; /** *

The type of authentication used by the credentials. Valid options are OAUTH, BASIC_AUTH, PERSONAL_ACCESS_TOKEN, or CODECONNECTIONS.

*/ authType?: outputs.awsconnector.AuthTypeEnumValueResponse; /** *

The connection ARN if your serverType type is GITLAB or GITLAB_SELF_MANAGED and your authType is CODECONNECTIONS.

*/ resource?: string; /** *

The type of source provider. The valid options are GITHUB, GITHUB_ENTERPRISE, GITLAB, GITLAB_SELF_MANAGED, or BITBUCKET.

*/ serverType?: outputs.awsconnector.ServerTypeEnumValueResponse; } /** * Definition of awsConfigServiceConfigurationRecorder */ interface AwsConfigServiceConfigurationRecorderPropertiesResponse { /** *

The name of the configuration recorder. Config automatically assigns the name of 'default' when creating the configuration recorder.

You cannot change the name of the configuration recorder after it has been created. To change the configuration recorder name, you must delete it and create a new configuration recorder with a new name.

*/ name?: string; /** *

Specifies which resource types Config records for configuration changes.

High Number of Config Evaluations

You may notice increased activity in your account during your initial month recording with Config when compared to subsequent months. During the initial bootstrapping process, Config runs evaluations on all the resources in your account that you have selected for Config to record.

If you are running ephemeral workloads, you may see increased activity from Config as it records configuration changes associated with creating and deleting these temporary resources. An ephemeral workload is a temporary use of computing resources that are loaded and run when needed. Examples include Amazon Elastic Compute Cloud (Amazon EC2) Spot Instances, Amazon EMR jobs, and Auto Scaling. If you want to avoid the increased activity from running ephemeral workloads, you can run these types of workloads in a separate account with Config turned off to avoid increased configuration recording and rule evaluations.

*/ recordingGroup?: outputs.awsconnector.RecordingGroupResponse; /** *

Specifies the default recording frequency that Config uses to record configuration changes. Config supports Continuous recording and Daily recording.

  • Continuous recording allows you to record configuration changes continuously whenever a change occurs.

  • Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded.

Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

You can also override the recording frequency for specific resource types.

*/ recordingMode?: outputs.awsconnector.RecordingModeResponse; /** *

Amazon Resource Name (ARN) of the IAM role assumed by Config and used by the configuration recorder.

While the API model does not require this field, the server will reject a request without a defined roleARN for the configuration recorder.

Pre-existing Config role

If you have used an Amazon Web Services service that uses Config, such as Security Hub or Control Tower, and an Config role has already been created, make sure that the IAM role that you use when setting up Config keeps the same minimum permissions as the already created Config role. You must do this so that the other Amazon Web Services service continues to run as expected.

For example, if Control Tower has an IAM role that allows Config to read Amazon Simple Storage Service (Amazon S3) objects, make sure that the same permissions are granted within the IAM role you use when setting up Config. Otherwise, it may interfere with how Control Tower operates. For more information about IAM roles for Config, see Identity and Access Management for Config in the Config Developer Guide.

*/ roleARN?: string; } /** * Definition of awsConfigServiceConfigurationRecorderStatus */ interface AwsConfigServiceConfigurationRecorderStatusPropertiesResponse { /** *

The latest error code from when the recorder last failed.

*/ lastErrorCode?: string; /** *

The latest error message from when the recorder last failed.

*/ lastErrorMessage?: string; /** *

The time the recorder was last started.

*/ lastStartTime?: string; /** *

The status of the latest recording event processed by the recorder.

*/ lastStatus?: outputs.awsconnector.RecorderStatusEnumValueResponse; /** *

The time of the latest change in status of an recording event processed by the recorder.

*/ lastStatusChangeTime?: string; /** *

The time the recorder was last stopped.

*/ lastStopTime?: string; /** *

The name of the configuration recorder.

*/ name?: string; /** *

Specifies whether or not the recorder is currently recording.

*/ recording?: boolean; } /** * Definition of awsConfigServiceDeliveryChannel */ interface AwsConfigServiceDeliveryChannelPropertiesResponse { /** *

The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.

*/ configSnapshotDeliveryProperties?: outputs.awsconnector.ConfigSnapshotDeliveryPropertiesResponse; /** *

The name of the delivery channel. By default, Config assigns the name 'default' when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.

*/ name?: string; /** *

The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.

If you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon S3 Bucket in the Config Developer Guide.

*/ s3BucketName?: string; /** *

The prefix for the specified Amazon S3 bucket.

*/ s3KeyPrefix?: string; /** *

The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket.

*/ s3KmsKeyArn?: string; /** *

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.

If you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon SNS Topic in the Config Developer Guide.

*/ snsTopicARN?: string; } /** * Definition of awsDatabaseMigrationServiceReplicationInstance */ interface AwsDatabaseMigrationServiceReplicationInstancePropertiesResponse { /** *

The amount of storage (in gigabytes) that is allocated for the replication instance.

*/ allocatedStorage?: number; /** *

Boolean value indicating if minor version upgrades will be automatically applied to the instance.

*/ autoMinorVersionUpgrade?: boolean; /** *

The Availability Zone for the instance.

*/ availabilityZone?: string; /** *

The DNS name servers supported for the replication instance to access your on-premise source or target database.

*/ dnsNameServers?: string; /** *

The engine version number of the replication instance.

If an engine version number is not specified when a replication instance is created, the default is the latest engine version available.

When modifying a major engine version of an instance, also set AllowMajorVersionUpgrade to true.

*/ engineVersion?: string; /** *

The expiration date of the free replication instance that is part of the Free DMS program.

*/ freeUntil?: string; /** *

The time the replication instance was created.

*/ instanceCreateTime?: string; /** *

An KMS key identifier that is used to encrypt the data on the replication instance.

If you don't specify a value for the KmsKeyId parameter, then DMS uses your default encryption key.

KMS creates the default encryption key for your Amazon Web Services account. Your Amazon Web Services account has a different default encryption key for each Amazon Web Services Region.

*/ kmsKeyId?: string; /** *

Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

*/ multiAZ?: boolean; /** *

The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.

*/ networkType?: string; /** *

The pending modification values.

*/ pendingModifiedValues?: outputs.awsconnector.ReplicationPendingModifiedValuesResponse; /** *

The maintenance window times for the replication instance. Any pending upgrades to the replication instance are performed during this time.

*/ preferredMaintenanceWindow?: string; /** *

Specifies the accessibility options for the replication instance. A value of true represents an instance with a public IP address. A value of false represents an instance with a private IP address. The default value is true.

*/ publiclyAccessible?: boolean; /** *

The Amazon Resource Name (ARN) of the replication instance.

*/ replicationInstanceArn?: string; /** *

The compute and memory capacity of the replication instance as defined for the specified replication instance class. It is a required parameter, although a default value is pre-selected in the DMS console.

For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.

*/ replicationInstanceClass?: string; /** *

The replication instance identifier is a required parameter. This parameter is stored as a lowercase string.

Constraints:

  • Must contain 1-63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

*/ replicationInstanceIdentifier?: string; /** *

One or more IPv6 addresses for the replication instance.

*/ replicationInstanceIpv6Addresses?: string[]; /** *

The private IP address of the replication instance.

*/ replicationInstancePrivateIpAddress?: string; /** *

One or more private IP addresses for the replication instance.

*/ replicationInstancePrivateIpAddresses?: string[]; /** *

The public IP address of the replication instance.

*/ replicationInstancePublicIpAddress?: string; /** *

One or more public IP addresses for the replication instance.

*/ replicationInstancePublicIpAddresses?: string[]; /** *

The status of the replication instance. The possible return values include:

  • 'available'

  • 'creating'

  • 'deleted'

  • 'deleting'

  • 'failed'

  • 'modifying'

  • 'upgrading'

  • 'rebooting'

  • 'resetting-master-credentials'

  • 'storage-full'

  • 'incompatible-credentials'

  • 'incompatible-network'

  • 'maintenance'

*/ replicationInstanceStatus?: string; /** *

The subnet group for the replication instance.

*/ replicationSubnetGroup?: outputs.awsconnector.ReplicationSubnetGroupResponse; /** *

The Availability Zone of the standby replication instance in a Multi-AZ deployment.

*/ secondaryAvailabilityZone?: string; /** *

The VPC security group for the instance.

*/ vpcSecurityGroups?: outputs.awsconnector.VpcSecurityGroupMembershipResponse[]; } /** * Definition of awsDaxCluster */ interface AwsDaxClusterPropertiesResponse { /** *

The number of nodes in the cluster that are active (i.e., capable of serving requests).

*/ activeNodes?: number; /** *

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

*/ clusterArn?: string; /** *

The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.

*/ clusterDiscoveryEndpoint?: outputs.awsconnector.DaxClusterEndpointResponse; /** *

The type of encryption supported by the cluster's endpoint. Values are:

  • NONE for no encryption

    TLS for Transport Layer Security

*/ clusterEndpointEncryptionType?: outputs.awsconnector.ClusterEndpointEncryptionTypeEnumValueResponse; /** *

The name of the DAX cluster.

*/ clusterName?: string; /** *

The description of the cluster.

*/ description?: string; /** *

A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.

*/ iamRoleArn?: string; /** *

A list of nodes to be removed from the cluster.

*/ nodeIdsToRemove?: string[]; /** *

The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)

*/ nodeType?: string; /** *

A list of nodes that are currently in the cluster.

*/ nodes?: outputs.awsconnector.NodeResponse[]; /** *

Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).

*/ notificationConfiguration?: outputs.awsconnector.DaxClusterNotificationConfigurationResponse; /** *

The parameter group being used by nodes in the cluster.

*/ parameterGroup?: outputs.awsconnector.ParameterGroupStatusResponse; /** *

A range of time when maintenance of DAX cluster software will be performed. For example: sun:01:00-sun:09:00. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.

*/ preferredMaintenanceWindow?: string; /** *

A list of security groups, and the status of each, for the nodes in the cluster.

*/ securityGroups?: outputs.awsconnector.SecurityGroupMembershipResponse[]; /** *

The description of the server-side encryption status on the specified DAX cluster.

*/ sseDescription?: outputs.awsconnector.SSEDescriptionResponse; /** *

The current status of the cluster.

*/ status?: string; /** *

The subnet group where the DAX cluster is running.

*/ subnetGroup?: string; /** *

The total number of nodes in the cluster.

*/ totalNodes?: number; } /** * Definition of awsDynamoDBContinuousBackupsDescription */ interface AwsDynamoDBContinuousBackupsDescriptionPropertiesResponse { /** *

ContinuousBackupsStatus can be one of the following states: ENABLED, DISABLED

*/ continuousBackupsStatus?: outputs.awsconnector.ContinuousBackupsStatusEnumValueResponse; /** *

The description of the point in time recovery settings applied to the table.

*/ pointInTimeRecoveryDescription?: outputs.awsconnector.PointInTimeRecoveryDescriptionResponse; } /** * Definition of awsDynamoDBTable */ interface AwsDynamoDBTablePropertiesResponse { /** * Property arn */ arn?: string; /** * A list of attributes that describe the key schema for the table and indexes. This property is required to create a DDB table. Update requires: [Some interruptions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt). Replacement if you edit an existing AttributeDefinition. */ attributeDefinitions?: outputs.awsconnector.AttributeDefinitionResponse[]; /** * Specify how you are charged for read and write throughput and how you manage capacity. Valid values include: + ``PROVISIONED`` - We recommend using ``PROVISIONED`` for predictable workloads. ``PROVISIONED`` sets the billing mode to [Provisioned Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). + ``PAY_PER_REQUEST`` - We recommend using ``PAY_PER_REQUEST`` for unpredictable workloads. ``PAY_PER_REQUEST`` sets the billing mode to [On-Demand Mode](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand). If not specified, the default is ``PROVISIONED``. */ billingMode?: string; /** * The settings used to enable or disable CloudWatch Contributor Insights for the specified table. The settings used to enable or disable CloudWatch Contributor Insights. */ contributorInsightsSpecification?: outputs.awsconnector.ContributorInsightsSpecificationResponse; /** * Determines if a table is protected from deletion. When enabled, the table cannot be deleted by any user or process. This setting is disabled by default. For more information, see [Using deletion protection](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/WorkingWithTables.Basics.html#WorkingWithTables.Basics.DeletionProtection) in the *Developer Guide*. */ deletionProtectionEnabled?: boolean; /** * Global secondary indexes to be created on the table. You can create up to 20 global secondary indexes. If you update a table to include a new global secondary index, CFNlong initiates the index creation and then proceeds with the stack update. CFNlong doesn't wait for the index to complete creation because the backfilling phase can take a long time, depending on the size of the table. You can't use the index or update the table until the index's status is ``ACTIVE``. You can track its status by using the DynamoDB [DescribeTable](https://docs.aws.amazon.com/cli/latest/reference/dynamodb/describe-table.html) command. If you add or delete an index during an update, we recommend that you don't update any other resources. If your stack fails to update and is rolled back while adding a new index, you must manually delete the index. Updates are not supported. The following are exceptions: + If you update either the contributor insights specification or the provisioned throughput values of global secondary indexes, you can update the table without interruption. + You can delete or add one global secondary index without interruption. If you do both in the same update (for example, by changing the index's logical ID), the update fails. */ globalSecondaryIndexes?: outputs.awsconnector.GlobalSecondaryIndexResponse[]; /** * Specifies the properties of data being imported from the S3 bucket source to the table. If you specify the ``ImportSourceSpecification`` property, and also specify either the ``StreamSpecification``, the ``TableClass`` property, or the ``DeletionProtectionEnabled`` property, the IAM entity creating/updating stack must have ``UpdateTable`` permission. Specifies the properties of data being imported from the S3 bucket source to the table. */ importSourceSpecification?: outputs.awsconnector.ImportSourceSpecificationResponse; /** * Specifies the attributes that make up the primary key for the table. The attributes in the ``KeySchema`` property must also be defined in the ``AttributeDefinitions`` property. */ keySchema?: outputs.awsconnector.KeySchemaResponse[]; /** * The Kinesis Data Streams configuration for the specified table. The Kinesis Data Streams configuration for the specified table. */ kinesisStreamSpecification?: outputs.awsconnector.KinesisStreamSpecificationResponse; /** * Local secondary indexes to be created on the table. You can create up to 5 local secondary indexes. Each index is scoped to a given hash key value. The size of each hash key can be up to 10 gigabytes. */ localSecondaryIndexes?: outputs.awsconnector.LocalSecondaryIndexResponse[]; /** * The settings used to enable point in time recovery. The settings used to enable point in time recovery. */ pointInTimeRecoverySpecification?: outputs.awsconnector.PointInTimeRecoverySpecificationResponse; /** * Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Amazon DynamoDB Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html). If you set ``BillingMode`` as ``PROVISIONED``, you must specify this property. If you set ``BillingMode`` as ``PAY_PER_REQUEST``, you cannot specify this property. Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html). */ provisionedThroughput?: outputs.awsconnector.ProvisionedThroughputResponse; /** * A resource-based policy document that contains permissions to add to the specified table. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). When you attach a resource-based policy while creating a table, the policy creation is *strongly consistent*. For information about the considerations that you should keep in mind while attaching a resource-based policy, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html). Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table, its indexes, and stream. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). While defining resource-based policies in your CFNshort templates, the following considerations apply: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html). */ resourcePolicy?: outputs.awsconnector.ResourcePolicyResponse; /** * Specifies the settings to enable server-side encryption. Represents the settings used to enable server-side encryption. */ sseSpecification?: outputs.awsconnector.SSESpecificationResponse; /** * Property streamArn */ streamArn?: string; /** * The settings for the DDB table stream, which capture changes to items stored in the table. Represents the DynamoDB Streams configuration for a table in DynamoDB. */ streamSpecification?: outputs.awsconnector.StreamSpecificationResponse; /** * The table class of the new table. Valid values are ``STANDARD`` and ``STANDARD_INFREQUENT_ACCESS``. */ tableClass?: string; /** * A name for the table. If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the table name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. */ tableName?: string; /** * An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). */ tags?: outputs.awsconnector.TagResponse[]; /** * Specifies the Time to Live (TTL) settings for the table. For detailed information about the limits in DynamoDB, see [Limits in Amazon DynamoDB](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the Amazon DynamoDB Developer Guide. Represents the settings used to enable or disable Time to Live (TTL) for the specified table. */ timeToLiveSpecification?: outputs.awsconnector.TimeToLiveSpecificationResponse; } /** * Definition of awsEc2AccountAttribute */ interface AwsEc2AccountAttributePropertiesResponse { /** *

The name of the account attribute.

*/ attributeName?: string; /** *

The values for the account attribute.

*/ attributeValues?: outputs.awsconnector.AccountAttributeValueResponse[]; } /** * Definition of awsEc2Address */ interface AwsEc2AddressPropertiesResponse { /** *

The ID representing the allocation of the address.

*/ allocationId?: string; /** *

The ID representing the association of the address with an instance.

*/ associationId?: string; /** *

The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).

*/ carrierIp?: string; /** *

The customer-owned IP address.

*/ customerOwnedIp?: string; /** *

The ID of the customer-owned address pool.

*/ customerOwnedIpv4Pool?: string; /** *

The network (vpc).

*/ domain?: outputs.awsconnector.DomainTypeEnumValueResponse; /** *

The ID of the instance that the address is associated with (if any).

*/ instanceId?: string; /** *

The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.

*/ networkBorderGroup?: string; /** *

The ID of the network interface.

*/ networkInterfaceId?: string; /** *

The ID of the Amazon Web Services account that owns the network interface.

*/ networkInterfaceOwnerId?: string; /** *

The private IP address associated with the Elastic IP address.

*/ privateIpAddress?: string; /** *

The Elastic IP address.

*/ publicIp?: string; /** *

The ID of an address pool.

*/ publicIpv4Pool?: string; /** *

Any tags assigned to the Elastic IP address.

*/ tags?: outputs.awsconnector.TagResponse[]; } /** * Definition of awsEc2FlowLog */ interface AwsEc2FlowLogPropertiesResponse { /** * The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts. */ deliverCrossAccountRole?: string; /** * The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName. */ deliverLogsPermissionArn?: string; /** * Property destinationOptions */ destinationOptions?: outputs.awsconnector.DestinationOptionsModelPropertiesResponse; /** * The Flow Log ID */ id?: string; /** * Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group, an Amazon S3 bucket, or a Kinesis Firehose stream. The value specified for this parameter depends on the value specified for LogDestinationType. */ logDestination?: string; /** * Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. */ logDestinationType?: string; /** * The fields to include in the flow log record, in the order in which they should appear. */ logFormat?: string; /** * The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. If you specify LogDestinationType as s3 or kinesis-data-firehose, do not specify DeliverLogsPermissionArn or LogGroupName. */ logGroupName?: string; /** * The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. You can specify 60 seconds (1 minute) or 600 seconds (10 minutes). */ maxAggregationInterval?: number; /** * The ID of the subnet, network interface, or VPC for which you want to create a flow log. */ resourceId?: string; /** * The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property. */ resourceType?: string; /** * The tags to apply to the flow logs. */ tags?: outputs.awsconnector.TagResponse[]; /** * The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic. */ trafficType?: string; } /** * Definition of awsEc2Image */ interface AwsEc2ImagePropertiesResponse { /** *

The architecture of the image.

*/ architecture?: outputs.awsconnector.ArchitectureValuesEnumValueResponse; /** *

Any block device mapping entries.

*/ blockDeviceMappings?: outputs.awsconnector.BlockDeviceMappingResponse[]; /** *

The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.

*/ bootMode?: outputs.awsconnector.BootModeValuesEnumValueResponse; /** *

The date and time the image was created.

*/ creationDate?: string; /** *

The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.

*/ deprecationTime?: string; /** *

Indicates whether deregistration protection is enabled for the AMI.

*/ deregistrationProtection?: string; /** *

The description of the AMI that was provided during image creation.

*/ description?: string; /** *

Specifies whether enhanced networking with ENA is enabled.

*/ enaSupport?: boolean; /** *

The hypervisor type of the image. Only xen is supported. ovm is not supported.

*/ hypervisor?: outputs.awsconnector.HypervisorTypeEnumValueResponse; /** *

The ID of the AMI.

*/ imageId?: string; /** *

The location of the AMI.

*/ imageLocation?: string; /** *

The owner alias (amazon | aws-marketplace).

*/ imageOwnerAlias?: string; /** *

The type of image.

*/ imageType?: outputs.awsconnector.ImageTypeValuesEnumValueResponse; /** *

If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.

*/ imdsSupport?: outputs.awsconnector.ImdsSupportValuesEnumValueResponse; /** *

The kernel associated with the image, if any. Only applicable for machine images.

*/ kernelId?: string; /** *

The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.

lastLaunchedTime data is available starting April 2017.

*/ lastLaunchedTime?: string; /** *

The name of the AMI that was provided during image creation.

*/ name?: string; /** *

The ID of the Amazon Web Services account that owns the image.

*/ ownerId?: string; /** *

This value is set to windows for Windows AMIs; otherwise, it is blank.

*/ platform?: outputs.awsconnector.PlatformValuesEnumValueResponse; /** *

The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.

*/ platformDetails?: string; /** *

Any product codes associated with the AMI.

*/ productCodes?: outputs.awsconnector.ProductCodeResponse[]; /** *

Indicates whether the image has public launch permissions. The value is true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.

*/ public?: boolean; /** *

The RAM disk associated with the image, if any. Only applicable for machine images.

*/ ramdiskId?: string; /** *

The device name of the root device volume (for example, /dev/sda1).

*/ rootDeviceName?: string; /** *

The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.

*/ rootDeviceType?: outputs.awsconnector.DeviceTypeEnumValueResponse; /** *

The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This field only appears if the AMI was created using CreateImage.

*/ sourceInstanceId?: string; /** *

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

*/ sriovNetSupport?: string; /** *

The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.

*/ state?: outputs.awsconnector.ImageStateEnumValueResponse; /** *

The reason for the state change.

*/ stateReason?: outputs.awsconnector.StateReasonResponse; /** *

Any tags assigned to the image.

*/ tags?: outputs.awsconnector.TagResponse[]; /** *

If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.

*/ tpmSupport?: outputs.awsconnector.TpmSupportValuesEnumValueResponse; /** *

The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.

*/ usageOperation?: string; /** *

The type of virtualization of the AMI.

*/ virtualizationType?: outputs.awsconnector.VirtualizationTypeEnumValueResponse; } /** * Definition of awsEc2Instance */ interface AwsEc2InstancePropertiesResponse { /** *

The AMI launch index, which can be used to find this instance in the launch group.

*/ amiLaunchIndex?: number; /** *

The architecture of the image.

*/ architecture?: outputs.awsconnector.ArchitectureValuesEnumValueResponse; /** *

Any block device mapping entries for the instance.

*/ blockDeviceMappings?: outputs.awsconnector.InstanceBlockDeviceMappingResponse[]; /** *

The boot mode that was specified by the AMI. If the value is uefi-preferred, the AMI supports both UEFI and Legacy BIOS. The currentInstanceBootMode parameter is the boot mode that is used to boot the instance at launch or start.

The operating system contained in the AMI must be configured to support the specified boot mode.

For more information, see Boot modes in the Amazon EC2 User Guide.

*/ bootMode?: outputs.awsconnector.BootModeValuesEnumValueResponse; /** *

The ID of the Capacity Reservation.

*/ capacityReservationId?: string; /** *

Information about the Capacity Reservation targeting option.

*/ capacityReservationSpecification?: outputs.awsconnector.CapacityReservationSpecificationResponseResponse; /** *

The idempotency token you provided when you launched the instance, if applicable.

*/ clientToken?: string; /** *

The CPU options for the instance.

*/ cpuOptions?: outputs.awsconnector.CpuOptionsResponse; /** *

The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the Amazon EC2 User Guide.

*/ currentInstanceBootMode?: outputs.awsconnector.InstanceBootModeValuesEnumValueResponse; /** *

Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.

*/ ebsOptimized?: boolean; /** *

Deprecated.

Amazon Elastic Graphics reached end of life on January 8, 2024. For workloads that require graphics acceleration, we recommend that you use Amazon EC2 G4ad, G4dn, or G5 instances.

*/ elasticGpuAssociations?: outputs.awsconnector.ElasticGpuAssociationResponse[]; /** *

The elastic inference accelerator associated with the instance.

*/ elasticInferenceAcceleratorAssociations?: outputs.awsconnector.ElasticInferenceAcceleratorAssociationResponse[]; /** *

Specifies whether enhanced networking with ENA is enabled.

*/ enaSupport?: boolean; /** *

Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.

*/ enclaveOptions?: outputs.awsconnector.EnclaveOptionsResponse; /** *

Indicates whether the instance is enabled for hibernation.

*/ hibernationOptions?: outputs.awsconnector.HibernationOptionsResponse; /** *

The hypervisor type of the instance. The value xen is used for both Xen and Nitro hypervisors.

*/ hypervisor?: outputs.awsconnector.HypervisorTypeEnumValueResponse; /** *

The IAM instance profile associated with the instance, if applicable.

*/ iamInstanceProfile?: outputs.awsconnector.IamInstanceProfileResponse; /** *

The ID of the AMI used to launch the instance.

*/ imageId?: string; /** *

The ID of the instance.

*/ instanceId?: string; /** *

Indicates whether this is a Spot Instance or a Scheduled Instance.

*/ instanceLifecycle?: outputs.awsconnector.InstanceLifecycleTypeEnumValueResponse; /** *

The instance type.

*/ instanceType?: outputs.awsconnector.InstanceTypeEnumValueResponse; /** *

The IPv6 address assigned to the instance.

*/ ipv6Address?: string; /** *

The kernel associated with this instance, if applicable.

*/ kernelId?: string; /** *

The name of the key pair, if this instance was launched with an associated key pair.

*/ keyName?: string; /** *

The time the instance was launched.

*/ launchTime?: string; /** *

The license configurations for the instance.

*/ licenses?: outputs.awsconnector.LicenseConfigurationResponse[]; /** *

Provides information on the recovery and maintenance options of your instance.

*/ maintenanceOptions?: outputs.awsconnector.InstanceMaintenanceOptionsResponse; /** *

The metadata options for the instance.

*/ metadataOptions?: outputs.awsconnector.InstanceMetadataOptionsResponseResponse; /** *

The monitoring for the instance.

*/ monitoring?: outputs.awsconnector.MonitoringResponse; /** *

The network interfaces for the instance.

*/ networkInterfaces?: outputs.awsconnector.InstanceNetworkInterfaceResponse[]; /** *

The Amazon Resource Name (ARN) of the Outpost.

*/ outpostArn?: string; /** *

The location where the instance launched, if applicable.

*/ placement?: outputs.awsconnector.PlacementResponse; /** *

The platform. This value is windows for Windows instances; otherwise, it is empty.

*/ platform?: outputs.awsconnector.PlatformValuesEnumValueResponse; /** *

The platform details value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.

*/ platformDetails?: string; /** *

[IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.

The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.

*/ privateDnsName?: string; /** *

The options for the instance hostname.

*/ privateDnsNameOptions?: outputs.awsconnector.PrivateDnsNameOptionsResponseResponse; /** *

The private IPv4 address assigned to the instance.

*/ privateIpAddress?: string; /** *

The product codes attached to this instance, if applicable.

*/ productCodes?: outputs.awsconnector.ProductCodeResponse[]; /** *

[IPv4 only] The public DNS name assigned to the instance. This name is not available until the instance enters the running state. This name is only available if you've enabled DNS hostnames for your VPC.

*/ publicDnsName?: string; /** *

The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.

A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.

*/ publicIpAddress?: string; /** *

The RAM disk associated with this instance, if applicable.

*/ ramdiskId?: string; /** *

The device name of the root device volume (for example, /dev/sda1).

*/ rootDeviceName?: string; /** *

The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.

*/ rootDeviceType?: outputs.awsconnector.DeviceTypeEnumValueResponse; /** *

The security groups for the instance.

*/ securityGroups?: outputs.awsconnector.GroupIdentifierResponse[]; /** *

Indicates whether source/destination checking is enabled.

*/ sourceDestCheck?: boolean; /** *

If the request is a Spot Instance request, the ID of the request.

*/ spotInstanceRequestId?: string; /** *

Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.

*/ sriovNetSupport?: string; /** *

The current state of the instance.

*/ state?: outputs.awsconnector.InstanceStateResponse; /** *

The reason for the most recent state transition.

*/ stateReason?: outputs.awsconnector.StateReasonResponse; /** *

The reason for the most recent state transition. This might be an empty string.

*/ stateTransitionReason?: string; /** *

The ID of the subnet in which the instance is running.

*/ subnetId?: string; /** *

Any tags assigned to the instance.

*/ tags?: outputs.awsconnector.TagResponse[]; /** *

If the instance is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.

*/ tpmSupport?: string; /** *

The usage operation value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.

*/ usageOperation?: string; /** *

The time that the usage operation was last updated.

*/ usageOperationUpdateTime?: string; /** *

The virtualization type of the instance.

*/ virtualizationType?: outputs.awsconnector.VirtualizationTypeEnumValueResponse; /** *

The ID of the VPC in which the instance is running.

*/ vpcId?: string; } /** * awsEc2InstancePropertiesResponseProvideDefaults sets the appropriate defaults for AwsEc2InstancePropertiesResponse */ function awsEc2InstancePropertiesResponseProvideDefaults(val: AwsEc2InstancePropertiesResponse): AwsEc2InstancePropertiesResponse; /** * Definition of awsEc2InstanceStatus */ interface AwsEc2InstanceStatusPropertiesResponse { /** *

The Availability Zone of the instance.

*/ availabilityZone?: string; /** *

Any scheduled events associated with the instance.

*/ events?: outputs.awsconnector.InstanceStatusEventResponse[]; /** *

The ID of the instance.

*/ instanceId?: string; /** *

The intended state of the instance. DescribeInstanceStatus requires that an instance be in the running state.

*/ instanceState?: outputs.awsconnector.InstanceStateResponse; /** *

Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.

*/ instanceStatus?: outputs.awsconnector.InstanceStatusSummaryResponse; /** *

The Amazon Resource Name (ARN) of the Outpost.

*/ outpostArn?: string; /** *

Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.

*/ systemStatus?: outputs.awsconnector.InstanceStatusSummaryResponse; } /** * Definition of awsEc2Ipam */ interface AwsEc2IpamPropertiesResponse { /** *

The IPAM's default resource discovery association ID.

*/ defaultResourceDiscoveryAssociationId?: string; /** *

The IPAM's default resource discovery ID.

*/ defaultResourceDiscoveryId?: string; /** *

The description for the IPAM.

*/ description?: string; /** *

The Amazon Resource Name (ARN) of the IPAM.

*/ ipamArn?: string; /** *

The ID of the IPAM.

*/ ipamId?: string; /** *

The Amazon Web Services Region of the IPAM.

*/ ipamRegion?: string; /** *

The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.

For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.

*/ operatingRegions?: outputs.awsconnector.IpamOperatingRegionResponse[]; /** *

The Amazon Web Services account ID of the owner of the IPAM.

*/ ownerId?: string; /** *

The ID of the IPAM's default private scope.

*/ privateDefaultScopeId?: string; /** *

The ID of the IPAM's default public scope.

*/ publicDefaultScopeId?: string; /** *

The IPAM's resource discovery association count.

*/ resourceDiscoveryAssociationCount?: number; /** *

The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.

*/ scopeCount?: number; /** *

The state of the IPAM.

*/ state?: outputs.awsconnector.IpamStateEnumValueResponse; /** *

The state message.

*/ stateMessage?: string; /** *

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

*/ tags?: outputs.awsconnector.TagResponse[]; /** *

IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.

*/ tier?: outputs.awsconnector.IpamTierEnumValueResponse; } /** * Definition of awsEc2KeyPair */ interface AwsEc2KeyPairPropertiesResponse { /** * Property keyFingerprint */ keyFingerprint?: string; /** * The format of the key pair. Default: ``pem`` */ keyFormat?: string; /** * A unique name for the key pair. Constraints: Up to 255 ASCII characters */ keyName?: string; /** * Property keyPairId */ keyPairId?: string; /** * The type of key pair. Note that ED25519 keys are not supported for Windows instances. If the ``PublicKeyMaterial`` property is specified, the ``KeyType`` property is ignored, and the key type is inferred from the ``PublicKeyMaterial`` value. Default: ``rsa`` */ keyType?: string; /** * The public key material. The ``PublicKeyMaterial`` property is used to import a key pair. If this property is not specified, then a new key pair will be created. */ publicKeyMaterial?: string; /** * The tags to apply to the key pair. */ tags?: outputs.awsconnector.TagResponse[]; } /** * awsEc2KeyPairPropertiesResponseProvideDefaults sets the appropriate defaults for AwsEc2KeyPairPropertiesResponse */ function awsEc2KeyPairPropertiesResponseProvideDefaults(val: AwsEc2KeyPairPropertiesResponse): AwsEc2KeyPairPropertiesResponse; /** * Definition of awsEc2NetworkAcl */ interface AwsEc2NetworkAclPropertiesResponse { /** * Property id */ id?: string; /** * The tags for the network ACL. */ tags?: outputs.awsconnector.TagResponse[]; /** * The ID of the VPC for the network ACL. */ vpcId?: string; } /** * Definition of awsEc2NetworkInterface */ interface AwsEc2NetworkInterfacePropertiesResponse { /** * Property connectionTrackingSpecification */ connectionTrackingSpecification?: outputs.awsconnector.ConnectionTrackingSpecificationResponse; /** * A description for the network interface. */ description?: string; /** * If you have instances or ENIs that rely on the IPv6 address not changing, to avoid disrupting traffic to instances or ENIs, you can enable a primary IPv6 address. Enable this option to automatically assign an IPv6 associated with the ENI attached to your instance to be the primary IPv6 address. When you enable an IPv6 address to be a primary IPv6, you cannot disable it. Traffic will be routed to the primary IPv6 address until the instance is terminated or the ENI is detached. If you have multiple IPv6 addresses associated with an ENI and you enable a primary IPv6 address, the first IPv6 address associated with the ENI becomes the primary IPv6 address. */ enablePrimaryIpv6?: boolean; /** * A list of security group IDs associated with this network interface. */ groupSet?: string[]; /** * Network interface id. */ id?: string; /** * Indicates the type of network interface. */ interfaceType?: string; /** * The number of IPv4 prefixes to assign to a network interface. When you specify a number of IPv4 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /28 prefixes. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses. */ ipv4PrefixCount?: number; /** * Assigns a list of IPv4 prefixes to the network interface. If you want EC2 to automatically assign IPv4 prefixes, use the Ipv4PrefixCount property and do not specify this property. Presently, only /28 prefixes are supported. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses. */ ipv4Prefixes?: outputs.awsconnector.Ipv4PrefixSpecificationResponse[]; /** * The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. To specify specific IPv6 addresses, use the Ipv6Addresses property and don't specify this property. */ ipv6AddressCount?: number; /** * One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet to associate with the network interface. If you're specifying a number of IPv6 addresses, use the Ipv6AddressCount property and don't specify this property. */ ipv6Addresses?: outputs.awsconnector.InstanceIpv6AddressEc2NetworkInterfaceResponse[]; /** * The number of IPv6 prefixes to assign to a network interface. When you specify a number of IPv6 prefixes, Amazon EC2 selects these prefixes from your existing subnet CIDR reservations, if available, or from free spaces in the subnet. By default, these will be /80 prefixes. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses. */ ipv6PrefixCount?: number; /** * Assigns a list of IPv6 prefixes to the network interface. If you want EC2 to automatically assign IPv6 prefixes, use the Ipv6PrefixCount property and do not specify this property. Presently, only /80 prefixes are supported. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses. */ ipv6Prefixes?: outputs.awsconnector.Ipv6PrefixSpecificationResponse[]; /** * The primary IPv6 address */ primaryIpv6Address?: string; /** * Returns the primary private IP address of the network interface. */ primaryPrivateIpAddress?: string; /** * Assigns a single private IP address to the network interface, which is used as the primary private IP address. If you want to specify multiple private IP address, use the PrivateIpAddresses property. */ privateIpAddress?: string; /** * Assigns a list of private IP addresses to the network interface. You can specify a primary private IP address by setting the value of the Primary property to true in the PrivateIpAddressSpecification property. If you want EC2 to automatically assign private IP addresses, use the SecondaryPrivateIpAddressCount property and do not specify this property. */ privateIpAddresses?: outputs.awsconnector.PrivateIpAddressSpecificationResponse[]; /** * The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses */ secondaryPrivateIpAddressCount?: number; /** * Returns the secondary private IP addresses of the network interface. */ secondaryPrivateIpAddresses?: string[]; /** * Indicates whether traffic to or from the instance is validated. */ sourceDestCheck?: boolean; /** * The ID of the subnet to associate with the network interface. */ subnetId?: string; /** * An arbitrary set of tags (key-value pairs) for this network interface. */ tags?: outputs.awsconnector.TagResponse[]; /** * The ID of the VPC */ vpcId?: string; } /** * Definition of awsEc2RouteTable */ interface AwsEc2RouteTablePropertiesResponse { /** * Property routeTableId */ routeTableId?: string; /** * Any tags assigned to the route table. */ tags?: outputs.awsconnector.TagResponse[]; /** * The ID of the VPC. */ vpcId?: string; } /** * Definition of awsEc2SecurityGroup */ interface AwsEc2SecurityGroupPropertiesResponse { /** *

A description of the security group.

*/ description?: string; /** *

The ID of the security group.

*/ groupId?: string; /** *

The name of the security group.

*/ groupName?: string; /** *

The inbound rules associated with the security group.

*/ ipPermissions?: outputs.awsconnector.IpPermissionResponse[]; /** *

The outbound rules associated with the security group.

*/ ipPermissionsEgress?: outputs.awsconnector.IpPermissionResponse[]; /** *

The Amazon Web Services account ID of the owner of the security group.

*/ ownerId?: string; /** *

Any tags assigned to the security group.

*/ tags?: outputs.awsconnector.TagResponse[]; /** *

The ID of the VPC for the security group.

*/ vpcId?: string; } /** * Definition of awsEc2Snapshot */ interface AwsEc2SnapshotPropertiesResponse { /** *

The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.

*/ dataEncryptionKeyId?: string; /** *

The description for the snapshot.

*/ description?: string; /** *

Indicates whether the snapshot is encrypted.

*/ encrypted?: boolean; /** *

The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.

*/ kmsKeyId?: string; /** *

The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon EBS User Guide.

*/ outpostArn?: string; /** *

The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console.

*/ ownerAlias?: string; /** *

The ID of the Amazon Web Services account that owns the EBS snapshot.

*/ ownerId?: string; /** *

The progress of the snapshot, as a percentage.

*/ progress?: string; /** *

Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.

*/ restoreExpiryTime?: string; /** *

The ID of the snapshot. Each snapshot receives a unique identifier when it is created.

*/ snapshotId?: string; /** *

Reserved for future use.

*/ sseType?: outputs.awsconnector.SSETypeEnumValueResponse; /** *

The time stamp when the snapshot was initiated.

*/ startTime?: string; /** *

The snapshot state.

*/ state?: outputs.awsconnector.SnapshotStateEnumValueResponse; /** *

Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.

*/ stateMessage?: string; /** *

The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.

*/ storageTier?: outputs.awsconnector.StorageTierEnumValueResponse; /** *

Any tags assigned to the snapshot.

*/ tags?: outputs.awsconnector.TagResponse[]; /** *

The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.

*/ volumeId?: string; /** *

The size of the volume, in GiB.

*/ volumeSize?: number; } /** * Definition of awsEc2Subnet */ interface AwsEc2SubnetPropertiesResponse { /** * Indicates whether a network interface created in this subnet receives an IPv6 address. The default value is ``false``. If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block. */ assignIpv6AddressOnCreation?: boolean; /** * The Availability Zone of the subnet. If you update this property, you must also update the ``CidrBlock`` property. */ availabilityZone?: string; /** * The AZ ID of the subnet. */ availabilityZoneId?: string; /** * The IPv4 CIDR block assigned to the subnet. If you update this property, we create a new subnet, and then delete the existing one. */ cidrBlock?: string; /** * Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. For more information, see [DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html#nat-gateway-nat64-dns64) in the *User Guide*. */ enableDns64?: boolean; /** * Indicates the device position for local network interfaces in this subnet. For example, ``1`` indicates local network interfaces in this subnet are the secondary network interface (eth1). */ enableLniAtDeviceIndex?: number; /** * An IPv4 IPAM pool ID for the subnet. */ ipv4IpamPoolId?: string; /** * An IPv4 netmask length for the subnet. */ ipv4NetmaskLength?: number; /** * The IPv6 CIDR block. If you specify ``AssignIpv6AddressOnCreation``, you must also specify an IPv6 CIDR block. */ ipv6CidrBlock?: string; /** * The IPv6 network ranges for the subnet, in CIDR notation. */ ipv6CidrBlocks?: string[]; /** * An IPv6 IPAM pool ID for the subnet. */ ipv6IpamPoolId?: string; /** * Indicates whether this is an IPv6 only subnet. For more information, see [Subnet basics](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html#subnet-basics) in the *User Guide*. */ ipv6Native?: boolean; /** * An IPv6 netmask length for the subnet. */ ipv6NetmaskLength?: number; /** * Indicates whether instances launched in this subnet receive a public IPv4 address. The default value is ``false``. AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [VPC pricing page](https://aws.amazon.com/vpc/pricing/). */ mapPublicIpOnLaunch?: boolean; /** * Property networkAclAssociationId */ networkAclAssociationId?: string; /** * The Amazon Resource Name (ARN) of the Outpost. */ outpostArn?: string; /** * The hostname type for EC2 instances launched into this subnet and how DNS A and AAAA record queries to the instances should be handled. For more information, see [Amazon EC2 instance hostname types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *User Guide*. Available options: + EnableResourceNameDnsAAAARecord (true | false) + EnableResourceNameDnsARecord (true | false) + HostnameType (ip-name | resource-name) */ privateDnsNameOptionsOnLaunch?: outputs.awsconnector.PrivateDnsNameOptionsOnLaunchModelPropertiesResponse; /** * Property subnetId */ subnetId?: string; /** * Any tags assigned to the subnet. */ tags?: outputs.awsconnector.TagResponse[]; /** * The ID of the VPC the subnet is in. If you update this property, you must also update the ``CidrBlock`` property. */ vpcId?: string; } /** * Definition of awsEc2VPCEndpoint */ interface AwsEc2VPCEndpointPropertiesResponse { /** * Property creationTimestamp */ creationTimestamp?: string; /** * Property dnsEntries */ dnsEntries?: string[]; /** * Property id */ id?: string; /** * Property networkInterfaceIds */ networkInterfaceIds?: string[]; /** * An endpoint policy, which controls access to the service from the VPC. The default endpoint policy allows full access to the service. Endpoint policies are supported only for gateway and interface endpoints. For CloudFormation templates in YAML, you can provide the policy in JSON or YAML format. CFNlong converts YAML policies to JSON format before calling the API to create or modify the VPC endpoint. */ policyDocument?: any; /** * Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, ``kinesis.us-east-1.amazonaws.com``), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service. To use a private hosted zone, you must set the following VPC attributes to ``true``: ``enableDnsHostnames`` and ``enableDnsSupport``. This property is supported only for interface endpoints. Default: ``false`` */ privateDnsEnabled?: boolean; /** * The IDs of the route tables. Routing is supported only for gateway endpoints. */ routeTableIds?: string[]; /** * The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Security groups are supported only for interface endpoints. */ securityGroupIds?: string[]; /** * The name of the endpoint service. */ serviceName?: string; /** * The IDs of the subnets in which to create endpoint network interfaces. You must specify this property for an interface endpoint or a Gateway Load Balancer endpoint. You can't specify this property for a gateway endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet. */ subnetIds?: string[]; /** * The type of endpoint. Default: Gateway */ vpcEndpointType?: string; /** * The ID of the VPC. */ vpcId?: string; } /** * Definition of awsEc2VPCPeeringConnection */ interface AwsEc2VPCPeeringConnectionPropertiesResponse { /** * Property id */ id?: string; /** * The AWS account ID of the owner of the accepter VPC. */ peerOwnerId?: string; /** * The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request. */ peerRegion?: string; /** * The Amazon Resource Name (ARN) of the VPC peer role for the peering connection in another AWS account. */ peerRoleArn?: string; /** * The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. */ peerVpcId?: string; /** * Property tags */ tags?: outputs.awsconnector.TagResponse[]; /** * The ID of the VPC. */ vpcId?: string; } /** * Definition of awsEc2Volume */ interface AwsEc2VolumePropertiesResponse { /** * Indicates whether the volume is auto-enabled for I/O operations. By default, Amazon EBS disables I/O to the volume from attached EC2 instances when it determines that a volume's data is potentially inconsistent. If the consistency of the volume is not a concern, and you prefer that the volume be made available immediately if it's impaired, you can configure the volume to automatically enable I/O. */ autoEnableIO?: boolean; /** * The ID of the Availability Zone in which to create the volume. For example, ``us-east-1a``. */ availabilityZone?: string; /** * Indicates whether the volume should be encrypted. The effect of setting the encryption state to ``true`` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default) in the *Amazon Elastic Compute Cloud User Guide*. Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances). */ encrypted?: boolean; /** * The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type: + ``gp3``: 3,000 - 16,000 IOPS + ``io1``: 100 - 64,000 IOPS + ``io2``: 100 - 256,000 IOPS For ``io2`` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS. This parameter is required for ``io1`` and ``io2`` volumes. The default for ``gp3`` volumes is 3,000 IOPS. This parameter is not supported for ``gp2``, ``st1``, ``sc1``, or ``standard`` volumes. */ iops?: number; /** * The identifier of the kms-key-long to use for Amazon EBS encryption. If ``KmsKeyId`` is specified, the encrypted state must be ``true``. If you omit this property and your account is enabled for encryption by default, or *Encrypted* is set to ``true``, then the volume is encrypted using the default key specified for your account. If your account does not have a default key, then the volume is encrypted using the aws-managed-key. Alternatively, if you want to specify a different key, you can specify one of the following: + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + Key alias. Specify the alias for the key, prefixed with ``alias/``. For example, for a key with the alias ``my_cmk``, use ``alias/my_cmk``. Or to specify the aws-managed-key, use ``alias/aws/ebs``. + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. */ kmsKeyId?: string; /** * Indicates whether Amazon EBS Multi-Attach is enabled. CFNlong does not currently support updating a single-attach volume to be multi-attach enabled, updating a multi-attach enabled volume to be single-attach, or updating the size or number of I/O operations per second (IOPS) of a multi-attach enabled volume. */ multiAttachEnabled?: boolean; /** * The Amazon Resource Name (ARN) of the Outpost. */ outpostArn?: string; /** * The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size. The following are the supported volumes sizes for each volume type: + ``gp2`` and ``gp3``: 1 - 16,384 GiB + ``io1``: 4 - 16,384 GiB + ``io2``: 4 - 65,536 GiB + ``st1`` and ``sc1``: 125 - 16,384 GiB + ``standard``: 1 - 1024 GiB */ size?: number; /** * The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size. */ snapshotId?: string; /** * The tags to apply to the volume during creation. */ tags?: outputs.awsconnector.TagResponse[]; /** * The throughput to provision for a volume, with a maximum of 1,000 MiB/s. This parameter is valid only for ``gp3`` volumes. The default value is 125. Valid Range: Minimum value of 125. Maximum value of 1000. */ throughput?: number; /** * Property volumeId */ volumeId?: string; /** * The volume type. This parameter can be one of the following values: + General Purpose SSD: ``gp2`` | ``gp3`` + Provisioned IOPS SSD: ``io1`` | ``io2`` + Throughput Optimized HDD: ``st1`` + Cold HDD: ``sc1`` + Magnetic: ``standard`` For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html) in the *Amazon Elastic Compute Cloud User Guide*. Default: ``gp2`` */ volumeType?: string; } /** * Definition of awsEc2Vpc */ interface AwsEc2VpcPropertiesResponse { /** * The IPv4 network range for the VPC, in CIDR notation. For example, ``10.0.0.0/16``. We modify the specified CIDR block to its canonical form; for example, if you specify ``100.68.0.18/18``, we modify it to ``100.68.0.0/18``. You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``. */ cidrBlock?: string; /** * Property cidrBlockAssociations */ cidrBlockAssociations?: string[]; /** * Property defaultNetworkAcl */ defaultNetworkAcl?: string; /** * Property defaultSecurityGroup */ defaultSecurityGroup?: string; /** * Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. Disabled by default for nondefault VPCs. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support). You can only enable DNS hostnames if you've enabled DNS support. */ enableDnsHostnames?: boolean; /** * Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range 'plus two' succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. Enabled by default. For more information, see [DNS attributes in your VPC](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-dns.html#vpc-dns-support). */ enableDnsSupport?: boolean; /** * The allowed tenancy of instances launched into the VPC. + ``default``: An instance launched into the VPC runs on shared hardware by default, unless you explicitly specify a different tenancy during instance launch. + ``dedicated``: An instance launched into the VPC runs on dedicated hardware by default, unless you explicitly specify a tenancy of ``host`` during instance launch. You cannot specify a tenancy of ``default`` during instance launch. Updating ``InstanceTenancy`` requires no replacement only if you are updating its value from ``dedicated`` to ``default``. Updating ``InstanceTenancy`` from ``default`` to ``dedicated`` requires replacement. */ instanceTenancy?: string; /** * The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. You must specify either``CidrBlock`` or ``Ipv4IpamPoolId``. */ ipv4IpamPoolId?: string; /** * The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com//vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. */ ipv4NetmaskLength?: number; /** * Property ipv6CidrBlocks */ ipv6CidrBlocks?: string[]; /** * The tags for the VPC. */ tags?: outputs.awsconnector.TagResponse[]; /** * Property vpcId */ vpcId?: string; } /** * Definition of awsEcrImageDetail */ interface AwsEcrImageDetailPropertiesResponse { /** *

The artifact media type of the image.

*/ artifactMediaType?: string; /** *

The sha256 digest of the image manifest.

*/ imageDigest?: string; /** *

The media type of the image manifest.

*/ imageManifestMediaType?: string; /** *

The date and time, expressed in standard JavaScript date format, at which the current image was pushed to the repository.

*/ imagePushedAt?: string; /** *

A summary of the last completed image scan.

*/ imageScanFindingsSummary?: outputs.awsconnector.ImageScanFindingsSummaryResponse; /** *

The current state of the scan.

*/ imageScanStatus?: outputs.awsconnector.ImageScanStatusResponse; /** *

The size, in bytes, of the image in the repository.

If the image is a manifest list, this will be the max size of all manifests in the list.

Beginning with Docker version 1.9, the Docker client compresses image layers before pushing them to a V2 Docker registry. The output of the docker images command shows the uncompressed image size, so it may return a larger image size than the image sizes returned by DescribeImages.

*/ imageSizeInBytes?: number; /** *

The list of tags associated with this image.

*/ imageTags?: string[]; /** *

The date and time, expressed in standard JavaScript date format, when Amazon ECR recorded the last image pull.

Amazon ECR refreshes the last image pull timestamp at least once every 24 hours. For example, if you pull an image once a day then the lastRecordedPullTime timestamp will indicate the exact time that the image was last pulled. However, if you pull an image once an hour, because Amazon ECR refreshes the lastRecordedPullTime timestamp at least once every 24 hours, the result may not be the exact time that the image was last pulled.

*/ lastRecordedPullTime?: string; /** *

The Amazon Web Services account ID associated with the registry to which this image belongs.

*/ registryId?: string; /** *

The name of the repository to which this image belongs.

*/ repositoryName?: string; } /** * Definition of awsEcrRepository */ interface AwsEcrRepositoryPropertiesResponse { /** * Property arn */ arn?: string; /** * If true, deleting the repository force deletes the contents of the repository. If false, the repository must be empty before attempting to delete it. If true, deleting the repository force deletes the contents of the repository. Without a force delete, you can only delete empty repositories. */ emptyOnDelete?: boolean; /** * The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. The encryption configuration for the repository. This determines how the contents of your repository are encrypted at rest. By default, when no encryption configuration is set or the ``AES256`` encryption type is used, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts your data at rest using an AES-256 encryption algorithm. This does not require any action on your part. For more control over the encryption of the contents of your repository, you can use server-side encryption with KMSlong key stored in KMSlong (KMS) to encrypt your images. For more information, see [Amazon ECR encryption at rest](https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html) in the *Amazon Elastic Container Registry User Guide*. */ encryptionConfiguration?: outputs.awsconnector.EncryptionConfigurationResponse; /** * The image scanning configuration for the repository. This determines whether images are scanned for known vulnerabilities after being pushed to the repository. The image scanning configuration for a repository. */ imageScanningConfiguration?: outputs.awsconnector.ImageScanningConfigurationResponse; /** * The tag mutability setting for the repository. If this parameter is omitted, the default setting of ``MUTABLE`` will be used which will allow image tags to be overwritten. If ``IMMUTABLE`` is specified, all image tags within the repository will be immutable which will prevent them from being overwritten. */ imageTagMutability?: string; /** * Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html). The ``LifecyclePolicy`` property type specifies a lifecycle policy. For information about lifecycle policy syntax, see [Lifecycle policy template](https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html) in the *Amazon ECR User Guide*. */ lifecyclePolicy?: outputs.awsconnector.LifecyclePolicyResponse; /** * The name to use for the repository. The repository name may be specified on its own (such as ``nginx-web-app``) or it can be prepended with a namespace to group the repository into a category (such as ``project-a/nginx-web-app``). If you don't specify a name, CFNlong generates a unique physical ID and uses that ID for the repository name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). The repository name must start with a letter and can only contain lowercase letters, numbers, hyphens, underscores, and forward slashes. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. */ repositoryName?: string; /** * The JSON repository policy text to apply to the repository. For more information, see [Amazon ECR repository policies](https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policy-examples.html) in the *Amazon Elastic Container Registry User Guide*. */ repositoryPolicyText?: any; /** * Property repositoryUri */ repositoryUri?: string; /** * An array of key-value pairs to apply to this resource. */ tags?: outputs.awsconnector.TagResponse[]; } /** * Definition of awsEcsCluster */ interface AwsEcsClusterPropertiesResponse { /** * Property arn */ arn?: string; /** * The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the [CreateService](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html) or [RunTask](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_RunTask.html) actions. If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the [CreateCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html) API operation. To use a FARGATElong capacity provider, specify either the ``FARGATE`` or ``FARGATE_SPOT`` capacity providers. The FARGATElong capacity providers are available to all accounts and only need to be associated with a cluster to be used. The [PutCapacityProvider](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutCapacityProvider.html) API operation is used to update the list of available capacity providers for a cluster after the cluster is created. */ capacityProviders?: string[]; /** * A user-generated string that you use to identify your cluster. If you don't specify a name, CFNlong generates a unique physical ID for the name. */ clusterName?: string; /** * The settings to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights for a cluster. */ clusterSettings?: outputs.awsconnector.ClusterSettingsResponse[]; /** * The execute command configuration for the cluster. The execute command configuration for the cluster. */ configuration?: outputs.awsconnector.ClusterConfigurationResponse; /** * The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used. */ defaultCapacityProviderStrategy?: outputs.awsconnector.CapacityProviderStrategyItemResponse[]; /** * Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. Use this parameter to set a default Service Connect namespace. After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the ``enabled`` parameter to ``true`` in the ``ServiceConnectConfiguration``. You can set the namespace of each service individually in the ``ServiceConnectConfiguration`` to override this default parameter. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. */ serviceConnectDefaults?: outputs.awsconnector.ServiceConnectDefaultsResponse; /** * The metadata that you apply to the cluster to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. */ tags?: outputs.awsconnector.TagResponse[]; } /** * Definition of awsEcsService */ interface AwsEcsServicePropertiesResponse { /** * The capacity provider strategy to use for the service. If a ``capacityProviderStrategy`` is specified, the ``launchType`` parameter must be omitted. If no ``capacityProviderStrategy`` or ``launchType`` is specified, the ``defaultCapacityProviderStrategy`` for the cluster is used. A capacity provider strategy may contain a maximum of 6 capacity providers. */ capacityProviderStrategy?: outputs.awsconnector.CapacityProviderStrategyItemResponse[]; /** * The short name or full Amazon Resource Name (ARN) of the cluster that you run your service on. If you do not specify a cluster, the default cluster is assumed. */ cluster?: string; /** * Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. The ``DeploymentConfiguration`` property specifies optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks. */ deploymentConfiguration?: outputs.awsconnector.DeploymentConfigurationResponse; /** * The deployment controller to use for the service. If no deployment controller is specified, the default value of ``ECS`` is used. The deployment controller to use for the service. For more information, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html) in the *Amazon Elastic Container Service Developer Guide*. */ deploymentController?: outputs.awsconnector.DeploymentControllerResponse; /** * The number of instantiations of the specified task definition to place and keep running in your service. For new services, if a desired count is not specified, a default value of ``1`` is used. When using the ``DAEMON`` scheduling strategy, the desired count is not required. For existing services, if a desired count is not specified, it is omitted from the operation. */ desiredCount?: number; /** * Specifies whether to turn on Amazon ECS managed tags for the tasks within the service. For more information, see [Tagging your Amazon ECS resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the *Amazon Elastic Container Service Developer Guide*. When you use Amazon ECS managed tags, you need to set the ``propagateTags`` request parameter. */ enableECSManagedTags?: boolean; /** * Determines whether the execute command functionality is turned on for the service. If ``true``, the execute command functionality is turned on for all containers in tasks as part of the service. */ enableExecuteCommand?: boolean; /** * The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used when your service is configured to use a load balancer. If your service has a load balancer defined and you don't specify a health check grace period value, the default value of ``0`` is used. If you do not use an Elastic Load Balancing, we recommend that you use the ``startPeriod`` in the task definition health check parameters. For more information, see [Health check](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_HealthCheck.html). If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds (about 69 years). During that time, the Amazon ECS service scheduler ignores health check status. This grace period can prevent the service scheduler from marking tasks as unhealthy and stopping them before they have time to come up. */ healthCheckGracePeriodSeconds?: number; /** * The launch type on which to run your service. For more information, see [Amazon ECS Launch Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*. */ launchType?: string; /** * A list of load balancer objects to associate with the service. If you specify the ``Role`` property, ``LoadBalancers`` must be specified as well. For information about the number of load balancers that you can specify per service, see [Service Load Balancing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html) in the *Amazon Elastic Container Service Developer Guide*. */ loadBalancers?: outputs.awsconnector.LoadBalancerResponse[]; /** * Property name */ name?: string; /** * The network configuration for the service. This parameter is required for task definitions that use the ``awsvpc`` network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*. The ``NetworkConfiguration`` property specifies an object representing the network configuration for a task or service. */ networkConfiguration?: outputs.awsconnector.NetworkConfigurationResponse; /** * An array of placement constraint objects to use for tasks in your service. You can specify a maximum of 10 constraints for each task. This limit includes constraints in the task definition and those specified at runtime. */ placementConstraints?: outputs.awsconnector.PlacementConstraintResponse[]; /** * The placement strategy objects to use for tasks in your service. You can specify a maximum of 5 strategy rules for each service. */ placementStrategies?: outputs.awsconnector.PlacementStrategyResponse[]; /** * The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the ``LATEST`` platform version is used. For more information, see [platform versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) in the *Amazon Elastic Container Service Developer Guide*. */ platformVersion?: string; /** * Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the [TagResource](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_TagResource.html) API action. The default is ``NONE``. */ propagateTags?: string; /** * The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition doesn't use the ``awsvpc`` network mode. If you specify the ``role`` parameter, you must also specify a load balancer object with the ``loadBalancers`` parameter. If your account has already created the Amazon ECS service-linked role, that role is used for your service unless you specify a role here. The service-linked role is required if your task definition uses the ``awsvpc`` network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you don't specify a role here. For more information, see [Using service-linked roles for Amazon ECS](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html) in the *Amazon Elastic Container Service Developer Guide*. If your specified role has a path other than ``/``, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name ``bar`` has a path of ``/foo/`` then you would specify ``/foo/bar`` as the role name. For more information, see [Friendly names and paths](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names) in the *IAM User Guide*. */ role?: string; /** * The scheduling strategy to use for the service. For more information, see [Services](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs_services.html). There are two service scheduler strategies available: + ``REPLICA``-The replica scheduling strategy places and maintains the desired number of tasks across your cluster. By default, the service scheduler spreads tasks across Availability Zones. You can use task placement strategies and constraints to customize task placement decisions. This scheduler strategy is required if the service uses the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types. + ``DAEMON``-The daemon scheduling strategy deploys exactly one task on each active container instance that meets all of the task placement constraints that you specify in your cluster. The service scheduler also evaluates the task placement constraints for running tasks and will stop tasks that don't meet the placement constraints. When you're using this strategy, you don't need to specify a desired number of tasks, a task placement strategy, or use Service Auto Scaling policies. Tasks using the Fargate launch type or the ``CODE_DEPLOY`` or ``EXTERNAL`` deployment controller types don't support the ``DAEMON`` scheduling strategy. */ schedulingStrategy?: string; /** * Property serviceArn */ serviceArn?: string; /** * The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. */ serviceConnectConfiguration?: outputs.awsconnector.ServiceConnectConfigurationResponse; /** * The name of your service. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. Service names must be unique within a cluster, but you can have similarly named services in multiple clusters within a Region or across multiple Regions. The stack update fails if you change any properties that require replacement and the ``ServiceName`` is configured. This is because AWS CloudFormation creates the replacement service first, but each ``ServiceName`` must be unique in the cluster. */ serviceName?: string; /** * The details of the service discovery registry to associate with this service. For more information, see [Service discovery](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). Each service may be associated with one service registry. Multiple service registries for each service isn't supported. */ serviceRegistries?: outputs.awsconnector.ServiceRegistryResponse[]; /** * The metadata that you apply to the service to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. */ tags?: outputs.awsconnector.TagResponse[]; /** * The ``family`` and ``revision`` (``family:revision``) or full ARN of the task definition to run in your service. If a ``revision`` isn't specified, the latest ``ACTIVE`` revision is used. A task definition must be specified if the service uses either the ``ECS`` or ``CODE_DEPLOY`` deployment controllers. For more information about deployment types, see [Amazon ECS deployment types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html). */ taskDefinition?: string; /** * The configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume. */ volumeConfigurations?: outputs.awsconnector.ServiceVolumeConfigurationResponse[]; } /** * awsEcsServicePropertiesResponseProvideDefaults sets the appropriate defaults for AwsEcsServicePropertiesResponse */ function awsEcsServicePropertiesResponseProvideDefaults(val: AwsEcsServicePropertiesResponse): AwsEcsServicePropertiesResponse; /** * Definition of awsEcsTaskDefinition */ interface AwsEcsTaskDefinitionPropertiesResponse { /** * A list of container definitions in JSON format that describe the different containers that make up your task. For more information about container definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*. */ containerDefinitions?: outputs.awsconnector.ContainerDefinitionResponse[]; /** * The number of ``cpu`` units used by the task. If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the ``memory`` parameter. The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate. + 256 (.25 vCPU) - Available ``memory`` values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) + 512 (.5 vCPU) - Available ``memory`` values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) + 1024 (1 vCPU) - Available ``memory`` values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) + 2048 (2 vCPU) - Available ``memory`` values: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) + 4096 (4 vCPU) - Available ``memory`` values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) + 8192 (8 vCPU) - Available ``memory`` values: 16 GB and 60 GB in 4 GB increments This option requires Linux platform ``1.4.0`` or later. + 16384 (16vCPU) - Available ``memory`` values: 32GB and 120 GB in 8 GB increments This option requires Linux platform ``1.4.0`` or later. */ cpu?: string; /** * The ephemeral storage settings to use for tasks run with the task definition. The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on FARGATElong. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon ECS Developer Guide;*. For tasks using the Fargate launch type, the task requires the following platforms: + Linux platform version ``1.4.0`` or later. + Windows platform version ``1.0.0`` or later. */ ephemeralStorage?: outputs.awsconnector.EphemeralStorageResponse; /** * The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf. The task execution IAM role is required depending on the requirements of your task. For more information, see [Amazon ECS task execution IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_execution_IAM_role.html) in the *Amazon Elastic Container Service Developer Guide*. */ executionRoleArn?: string; /** * The name of a family that this task definition is registered to. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add. To use revision numbers when you update a task definition, specify this property. If you don't specify a value, CFNlong generates a new task definition each time that you update it. */ family?: string; /** * The Elastic Inference accelerators to use for the containers in the task. */ inferenceAccelerators?: outputs.awsconnector.InferenceAcceleratorResponse[]; /** * The IPC resource namespace to use for the containers in the task. The valid values are ``host``, ``task``, or ``none``. If ``host`` is specified, then all containers within the tasks that specified the ``host`` IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same IPC resources. If ``none`` is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see [IPC settings](https://docs.docker.com/engine/reference/run/#ipc-settings---ipc) in the *Docker run reference*. If the ``host`` IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see [Docker security](https://docs.docker.com/engine/security/security/). If you are setting namespaced kernel parameters using ``systemControls`` for the containers in the task, the following will apply to your IPC resource namespace. For more information, see [System Controls](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html) in the *Amazon Elastic Container Service Developer Guide*. + For tasks that use the ``host`` IPC mode, IPC namespace related ``systemControls`` are not supported. + For tasks that use the ``task`` IPC mode, IPC namespace related ``systemControls`` will apply to all containers within a task. This parameter is not supported for Windows containers or tasks run on FARGATElong. */ ipcMode?: string; /** * The amount (in MiB) of memory used by the task. If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see [ContainerDefinition](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html). If your tasks runs on FARGATElong, this field is required. You must use one of the following values. The value you choose determines your range of valid values for the ``cpu`` parameter. + 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available ``cpu`` values: 256 (.25 vCPU) + 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available ``cpu`` values: 512 (.5 vCPU) + 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available ``cpu`` values: 1024 (1 vCPU) + Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 2048 (2 vCPU) + Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available ``cpu`` values: 4096 (4 vCPU) + Between 16 GB and 60 GB in 4 GB increments - Available ``cpu`` values: 8192 (8 vCPU) This option requires Linux platform ``1.4.0`` or later. + Between 32GB and 120 GB in 8 GB increments - Available ``cpu`` values: 16384 (16 vCPU) This option requires Linux platform ``1.4.0`` or later. */ memory?: string; /** * The Docker networking mode to use for the containers in the task. The valid values are ``none``, ``bridge``, ``awsvpc``, and ``host``. If no network mode is specified, the default is ``bridge``. For Amazon ECS tasks on Fargate, the ``awsvpc`` network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, ```` or ``awsvpc`` can be used. If the network mode is set to ``none``, you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The ``host`` and ``awsvpc`` network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the ``bridge`` mode. With the ``host`` and ``awsvpc`` network modes, exposed container ports are mapped directly to the corresponding host port (for the ``host`` network mode) or the attached elastic network interface port (for the ``awsvpc`` network mode), so you cannot take advantage of dynamic host port mappings. When using the ``host`` network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user. If the network mode is ``awsvpc``, the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see [Task Networking](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html) in the *Amazon Elastic Container Service Developer Guide*. If the network mode is ``host``, you cannot run multiple instantiations of the same task on a single container instance when port mappings are used. For more information, see [Network settings](https://docs.docker.com/engine/reference/run/#network-settings) in the *Docker run reference*. */ networkMode?: string; /** * The process namespace to use for the containers in the task. The valid values are ``host`` or ``task``. On Fargate for Linux containers, the only valid value is ``task``. For example, monitoring sidecars might need ``pidMode`` to access information about other containers running in the same task. If ``host`` is specified, all containers within the tasks that specified the ``host`` PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If ``task`` is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace for each container. For more information, see [PID settings](https://docs.docker.com/engine/reference/run/#pid-settings---pid) in the *Docker run reference*. If the ``host`` PID mode is used, there's a heightened risk of undesired process namespace exposure. For more information, see [Docker security](https://docs.docker.com/engine/security/security/). This parameter is not supported for Windows containers. This parameter is only supported for tasks that are hosted on FARGATElong if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate. */ pidMode?: string; /** * An array of placement constraint objects to use for tasks. This parameter isn't supported for tasks run on FARGATElong. */ placementConstraints?: outputs.awsconnector.TaskDefinitionPlacementConstraintResponse[]; /** * The configuration details for the App Mesh proxy. Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. The configuration details for the App Mesh proxy. For tasks that use the EC2 launch type, the container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ``ecs-init`` package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) */ proxyConfiguration?: outputs.awsconnector.ProxyConfigurationResponse; /** * The task launch types the task definition was validated against. The valid values are ``EC2``, ``FARGATE``, and ``EXTERNAL``. For more information, see [Amazon ECS launch types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the *Amazon Elastic Container Service Developer Guide*. */ requiresCompatibilities?: string[]; /** * The operating system that your tasks definitions run on. A platform family is specified only for tasks using the Fargate launch type. When you specify a task definition in a service, this value must match the ``runtimePlatform`` value of the service. Information about the platform for the Amazon ECS service or task. For more information about ``RuntimePlatform``, see [RuntimePlatform](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#runtime-platform) in the *Amazon Elastic Container Service Developer Guide*. */ runtimePlatform?: outputs.awsconnector.RuntimePlatformResponse; /** * The metadata that you apply to the task definition to help you categorize and organize them. Each tag consists of a key and an optional value. You define both of them. The following basic restrictions apply to tags: + Maximum number of tags per resource - 50 + For each resource, each tag key must be unique, and each tag key can have only one value. + Maximum key length - 128 Unicode characters in UTF-8 + Maximum value length - 256 Unicode characters in UTF-8 + If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @. + Tag keys and values are case-sensitive. + Do not use ``aws:``, ``AWS:``, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit. */ tags?: outputs.awsconnector.TagResponse[]; /** * Property taskDefinitionArn */ taskDefinitionArn?: string; /** * The short name or full Amazon Resource Name (ARN) of the IAMlong role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see [Amazon ECS Task Role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*. IAM roles for tasks on Windows require that the ``-EnableTaskIAMRole`` option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see [Windows IAM roles for tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html) in the *Amazon Elastic Container Service Developer Guide*. */ taskRoleArn?: string; /** * The list of data volume definitions for the task. For more information, see [Using data volumes in tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html) in the *Amazon Elastic Container Service Developer Guide*. The ``host`` and ``sourcePath`` parameters aren't supported for tasks run on FARGATElong. */ volumes?: outputs.awsconnector.VolumeResponse[]; } /** * Definition of awsEfsFileSystem */ interface AwsEfsFileSystemPropertiesResponse { /** * Property arn */ arn?: string; /** * For One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the *Amazon EFS User Guide*. One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available. */ availabilityZoneName?: string; /** * Use the ``BackupPolicy`` to turn automatic backups on or off for the file system. The backup policy turns automatic backups for the file system on or off. */ backupPolicy?: outputs.awsconnector.BackupPolicyResponse; /** * (Optional) A boolean that specifies whether or not to bypass the ``FileSystemPolicy`` lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future ``PutFileSystemPolicy`` requests on this file system. Set ``BypassPolicyLockoutSafetyCheck`` to ``True`` only when you intend to prevent the IAM principal that is making the request from making subsequent ``PutFileSystemPolicy`` requests on this file system. The default value is ``False``. */ bypassPolicyLockoutSafetyCheck?: boolean; /** * A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, ``/aws/elasticfilesystem``, is used to protect the encrypted file system. */ encrypted?: boolean; /** * Property fileSystemId */ fileSystemId?: string; /** * The ``FileSystemPolicy`` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*. */ fileSystemPolicy?: any; /** * Describes the protection on the file system. Describes the protection on the file system. */ fileSystemProtection?: outputs.awsconnector.FileSystemProtectionResponse; /** * Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``'Key':'Name','Value':'{value}'`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*. */ fileSystemTags?: outputs.awsconnector.ElasticFileSystemTagResponse[]; /** * The ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats: + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``. + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``. + Key alias - A previously created display name for a key, for example ``alias/projectKey1``. + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``. If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true. */ kmsKeyId?: string; /** * An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following: + When to move files in the file system from primary storage to IA storage. + When to move files in the file system from primary storage or IA storage to Archive storage. + When to move files that are in IA or Archive storage to primary storage. EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information. */ lifecyclePolicies?: outputs.awsconnector.LifecyclePolicyEfsFileSystemResponse[]; /** * The Performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems. Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems. Default is ``generalPurpose``. */ performanceMode?: string; /** * The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ``ThroughputMode`` is set to ``provisioned``. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*. */ provisionedThroughputInMibps?: number; /** * Describes the replication configuration for a specific file system. Describes the replication configuration for a specific file system. */ replicationConfiguration?: outputs.awsconnector.ReplicationConfigurationResponse; /** * Specifies the throughput mode for the file system. The mode can be ``bursting``, ``provisioned``, or ``elastic``. If you set ``ThroughputMode`` to ``provisioned``, you must also set a value for ``ProvisionedThroughputInMibps``. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*. Default is ``bursting``. */ throughputMode?: string; } /** * Definition of awsEfsMountTarget */ interface AwsEfsMountTargetPropertiesResponse { /** * The ID of the file system for which to create the mount target. */ fileSystemId?: string; /** * Property id */ id?: string; /** * Valid IPv4 address within the address range of the specified subnet. */ ipAddress?: string; /** * Up to five VPC security group IDs, of the form ``sg-xxxxxxxx``. These must be for the same VPC as subnet specified. */ securityGroups?: string[]; /** * The ID of the subnet to add the mount target in. For One Zone file systems, use the subnet that is associated with the file system's Availability Zone. */ subnetId?: string; } /** * Definition of awsEksCluster */ interface AwsEksClusterPropertiesResponse { /** *

The access configuration for the cluster.

*/ accessConfig?: outputs.awsconnector.AccessConfigResponseResponse; /** *

The Amazon Resource Name (ARN) of the cluster.

*/ arn?: string; /** *

The certificate-authority-data for your cluster.

*/ certificateAuthority?: outputs.awsconnector.CertificateResponse; /** *

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

*/ clientRequestToken?: string; /** *

The configuration used to connect to a cluster for registration.

*/ connectorConfig?: outputs.awsconnector.ConnectorConfigResponseResponse; /** *

The Unix epoch timestamp at object creation.

*/ createdAt?: string; /** *

The encryption configuration for the cluster.

*/ encryptionConfig?: outputs.awsconnector.EncryptionConfigResponse[]; /** *

The endpoint for your Kubernetes API server.

*/ endpoint?: string; /** *

An object representing the health of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.

*/ health?: outputs.awsconnector.ClusterHealthResponse; /** *

The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.

*/ id?: string; /** *

The identity provider information for the cluster.

*/ identity?: outputs.awsconnector.IdentityResponse; /** *

The Kubernetes network configuration for the cluster.

*/ kubernetesNetworkConfig?: outputs.awsconnector.KubernetesNetworkConfigResponseResponse; /** *

The logging configuration for your cluster.

*/ logging?: outputs.awsconnector.LoggingEksClusterResponse; /** *

The name of your cluster.

*/ name?: string; /** *

An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.

*/ outpostConfig?: outputs.awsconnector.OutpostConfigResponseResponse; /** *

The platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services Cloud, see Platform versions in the Amazon EKS User Guide . For more information about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the Amazon EKS User Guide .

*/ platformVersion?: string; /** *

The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC considerations and Cluster security group considerations in the Amazon EKS User Guide.

*/ resourcesVpcConfig?: outputs.awsconnector.VpcConfigResponseResponse; /** *

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf.

*/ roleArn?: string; /** *

The current status of the cluster.

*/ status?: outputs.awsconnector.ClusterStatusEnumValueResponse; /** *

Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.

*/ tags?: { [key: string]: string; }; /** *

The Kubernetes server version for the cluster.

*/ version?: string; } /** * Definition of awsEksNodegroup */ interface AwsEksNodegroupPropertiesResponse { /** * The AMI type for your node group. */ amiType?: string; /** * Property arn */ arn?: string; /** * The capacity type of your managed node group. */ capacityType?: string; /** * Name of the cluster to create the node group in. */ clusterName?: string; /** * The root device disk size (in GiB) for your node group instances. */ diskSize?: number; /** * Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. */ forceUpdateEnabled?: boolean; /** * Property id */ id?: string; /** * Specify the instance types for a node group. */ instanceTypes?: string[]; /** * The Kubernetes labels to be applied to the nodes in the node group when they are created. */ labels?: { [key: string]: string; }; /** * An object representing a node group's launch template specification. An object representing a launch template specification for AWS EKS Nodegroup. */ launchTemplate?: outputs.awsconnector.LaunchTemplateSpecificationEksNodegroupResponse; /** * The Amazon Resource Name (ARN) of the IAM role to associate with your node group. */ nodeRole?: string; /** * The unique name to give your node group. */ nodegroupName?: string; /** * The AMI version of the Amazon EKS-optimized AMI to use with your node group. */ releaseVersion?: string; /** * The remote access (SSH) configuration to use with your node group. An object representing a remote access configuration specification for AWS EKS Nodegroup. */ remoteAccess?: outputs.awsconnector.RemoteAccessResponse; /** * The scaling configuration details for the Auto Scaling group that is created for your node group. An object representing a auto scaling group specification for AWS EKS Nodegroup. */ scalingConfig?: outputs.awsconnector.ScalingConfigResponse; /** * The subnets to use for the Auto Scaling group that is created for your node group. */ subnets?: string[]; /** * The metadata, as key-value pairs, to apply to the node group to assist with categorization and organization. Follows same schema as Labels for consistency. */ tags?: { [key: string]: string; }; /** * The Kubernetes taints to be applied to the nodes in the node group when they are created. */ taints?: outputs.awsconnector.TaintResponse[]; /** * The node group update configuration. The node group update configuration. */ updateConfig?: outputs.awsconnector.UpdateConfigResponse; /** * The Kubernetes version to use for your managed nodes. */ version?: string; } /** * Definition of awsElasticBeanstalkApplication */ interface AwsElasticBeanstalkApplicationPropertiesResponse { /** * A name for the Elastic Beanstalk application. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the application name. */ applicationName?: string; /** * Your description of the application. */ description?: string; /** * Specifies an application resource lifecycle configuration to prevent your application from accumulating too many versions. */ resourceLifecycleConfig?: outputs.awsconnector.ApplicationResourceLifecycleConfigResponse; } /** * Definition of awsElasticBeanstalkConfigurationTemplate */ interface AwsElasticBeanstalkConfigurationTemplatePropertiesResponse { /** * The name of the Elastic Beanstalk application to associate with this configuration template. */ applicationName?: string; /** * An optional description for this configuration. */ description?: string; /** * The ID of an environment whose settings you want to use to create the configuration template. You must specify EnvironmentId if you don't specify PlatformArn, SolutionStackName, or SourceConfiguration. */ environmentId?: string; /** * Option values for the Elastic Beanstalk configuration, such as the instance type. If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see [Option Values](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/command-options.html) in the AWS Elastic Beanstalk Developer Guide. */ optionSettings?: outputs.awsconnector.ConfigurationOptionSettingResponse[]; /** * The Amazon Resource Name (ARN) of the custom platform. For more information, see [Custom Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/custom-platforms.html) in the AWS Elastic Beanstalk Developer Guide. */ platformArn?: string; /** * The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses. For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7. A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see [Supported Platforms](https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/concepts.platforms.html) in the AWS Elastic Beanstalk Developer Guide. You must specify SolutionStackName if you don't specify PlatformArn, EnvironmentId, or SourceConfiguration. Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks. */ solutionStackName?: string; /** * An Elastic Beanstalk configuration template to base this one on. If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.Values specified in OptionSettings override any values obtained from the SourceConfiguration.You must specify SourceConfiguration if you don't specify PlatformArn, EnvironmentId, or SolutionStackName.Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name. */ sourceConfiguration?: outputs.awsconnector.SourceConfigurationResponse; /** * The name of the configuration template */ templateName?: string; } /** * Definition of awsElasticBeanstalkEnvironment */ interface AwsElasticBeanstalkEnvironmentPropertiesResponse { /** * The name of the application that is associated with this environment. */ applicationName?: string; /** * If specified, the environment attempts to use this value as the prefix for the CNAME in your Elastic Beanstalk environment URL. If not specified, the CNAME is generated automatically by appending a random alphanumeric string to the environment name. */ cnamePrefix?: string; /** * Your description for this environment. */ description?: string; /** * Property endpointURL */ endpointURL?: string; /** * A unique name for the environment. */ environmentName?: string; /** * The Amazon Resource Name (ARN) of an existing IAM role to be used as the environment's operations role. */ operationsRole?: string; /** * Key-value pairs defining configuration options for this environment, such as the instance type. */ optionSettings?: outputs.awsconnector.OptionSettingResponse[]; /** * The Amazon Resource Name (ARN) of the custom platform to use with the environment. */ platformArn?: string; /** * The name of an Elastic Beanstalk solution stack (platform version) to use with the environment. */ solutionStackName?: string; /** * Specifies the tags applied to resources in the environment. */ tags?: outputs.awsconnector.TagResponse[]; /** * The name of the Elastic Beanstalk configuration template to use with the environment. */ templateName?: string; /** * Specifies the tier to use in creating this environment. The environment tier that you choose determines whether Elastic Beanstalk provisions resources to support a web application that handles HTTP(S) requests or a web application that handles background-processing tasks. */ tier?: outputs.awsconnector.TierResponse; /** * The name of the application version to deploy. */ versionLabel?: string; } /** * Definition of awsElasticLoadBalancingV2Listener */ interface AwsElasticLoadBalancingV2ListenerPropertiesResponse { /** * [TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy. */ alpnPolicy?: string[]; /** * The default SSL server certificate for a secure listener. You must provide exactly one certificate if the listener protocol is HTTPS or TLS. To create a certificate list for a secure listener, use [AWS::ElasticLoadBalancingV2::ListenerCertificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenercertificate.html). */ certificates?: outputs.awsconnector.CertificateElasticLoadBalancingV2ListenerResponse[]; /** * The actions for the default rule. You cannot define a condition for a default rule. To create additional rules for an Application Load Balancer, use [AWS::ElasticLoadBalancingV2::ListenerRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticloadbalancingv2-listenerrule.html). */ defaultActions?: outputs.awsconnector.ActionResponse[]; /** * Property listenerArn */ listenerArn?: string; /** * The Amazon Resource Name (ARN) of the load balancer. */ loadBalancerArn?: string; /** * The mutual authentication configuration information. Specifies the configuration information for mutual authentication. */ mutualAuthentication?: outputs.awsconnector.MutualAuthenticationResponse; /** * The port on which the load balancer is listening. You cannot specify a port for a Gateway Load Balancer. */ port?: number; /** * The protocol for connections from clients to the load balancer. For Application Load Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols are TCP, TLS, UDP, and TCP_UDP. You can’t specify the UDP or TCP_UDP protocol if dual-stack mode is enabled. You cannot specify a protocol for a Gateway Load Balancer. */ protocol?: string; /** * [HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are supported. Updating the security policy can result in interruptions if the load balancer is handling a high volume of traffic. For more information, see [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/create-https-listener.html#describe-ssl-policies) in the *Application Load Balancers Guide* and [Security policies](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/create-tls-listener.html#describe-ssl-policies) in the *Network Load Balancers Guide*. */ sslPolicy?: string; } /** * Definition of awsElasticLoadBalancingV2LoadBalancer */ interface AwsElasticLoadBalancingV2LoadBalancerPropertiesResponse { /** * Property canonicalHostedZoneID */ canonicalHostedZoneID?: string; /** * Property dnsName */ dnsName?: string; /** * Indicates whether to evaluate inbound security group rules for traffic sent to a Network Load Balancer through privatelink. */ enforceSecurityGroupInboundRulesOnPrivateLinkTraffic?: string; /** * The IP address type. The possible values are ``ipv4`` (for IPv4 addresses) and ``dualstack`` (for IPv4 and IPv6 addresses). You can’t specify ``dualstack`` for a load balancer with a UDP or TCP_UDP listener. */ ipAddressType?: string; /** * Property loadBalancerArn */ loadBalancerArn?: string; /** * The load balancer attributes. */ loadBalancerAttributes?: outputs.awsconnector.LoadBalancerAttributeResponse[]; /** * Property loadBalancerFullName */ loadBalancerFullName?: string; /** * Property loadBalancerName */ loadBalancerName?: string; /** * The name of the load balancer. This name must be unique per region per account, can have a maximum of 32 characters, must contain only alphanumeric characters or hyphens, must not begin or end with a hyphen, and must not begin with 'internal-'. If you don't specify a name, AWS CloudFormation generates a unique physical ID for the load balancer. If you specify a name, you cannot perform updates that require replacement of this resource, but you can perform other updates. To replace the resource, specify a new name. */ name?: string; /** * The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of an Internet-facing load balancer is publicly resolvable to the public IP addresses of the nodes. Therefore, Internet-facing load balancers can route requests from clients over the internet. The nodes of an internal load balancer have only private IP addresses. The DNS name of an internal load balancer is publicly resolvable to the private IP addresses of the nodes. Therefore, internal load balancers can route requests only from clients with access to the VPC for the load balancer. The default is an Internet-facing load balancer. You cannot specify a scheme for a Gateway Load Balancer. */ scheme?: string; /** * [Application Load Balancers and Network Load Balancers] The IDs of the security groups for the load balancer. */ securityGroups?: string[]; /** * The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. [Application Load Balancers] You must specify subnets from at least two Availability Zones. You cannot specify Elastic IP addresses for your subnets. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. You can specify one Elastic IP address per subnet if you need static IP addresses for your internet-facing load balancer. For internal load balancers, you can specify one private IP address per subnet from the IPv4 range of the subnet. For internet-facing load balancer, you can specify one IPv6 address per subnet. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. You cannot specify Elastic IP addresses for your subnets. */ subnetMappings?: outputs.awsconnector.SubnetMappingResponse[]; /** * The IDs of the subnets. You can specify only one subnet per Availability Zone. You must specify either subnets or subnet mappings, but not both. To specify an Elastic IP address, specify subnet mappings instead of subnets. [Application Load Balancers] You must specify subnets from at least two Availability Zones. [Application Load Balancers on Outposts] You must specify one Outpost subnet. [Application Load Balancers on Local Zones] You can specify subnets from one or more Local Zones. [Network Load Balancers] You can specify subnets from one or more Availability Zones. [Gateway Load Balancers] You can specify subnets from one or more Availability Zones. */ subnets?: string[]; /** * The tags to assign to the load balancer. */ tags?: outputs.awsconnector.TagResponse[]; /** * The type of load balancer. The default is ``application``. */ type?: string; } /** * Definition of awsElasticLoadBalancingV2TargetGroup */ interface AwsElasticLoadBalancingV2TargetGroupPropertiesResponse { /** * Indicates whether health checks are enabled. If the target type is lambda, health checks are disabled by default but can be enabled. If the target type is instance, ip, or alb, health checks are always enabled and cannot be disabled. */ healthCheckEnabled?: boolean; /** * The approximate amount of time, in seconds, between health checks of an individual target. */ healthCheckIntervalSeconds?: number; /** * [HTTP/HTTPS health checks] The destination for health checks on the targets. [HTTP1 or HTTP2 protocol version] The ping path. The default is /. [GRPC protocol version] The path of a custom health check method with the format /package.service/method. The default is /AWS.ALB/healthcheck. */ healthCheckPath?: string; /** * The port the load balancer uses when performing health checks on targets. */ healthCheckPort?: string; /** * The protocol the load balancer uses when performing health checks on targets. */ healthCheckProtocol?: string; /** * The amount of time, in seconds, during which no response from a target means a failed health check. */ healthCheckTimeoutSeconds?: number; /** * The number of consecutive health checks successes required before considering an unhealthy target healthy. */ healthyThresholdCount?: number; /** * The type of IP address used for this target group. The possible values are ipv4 and ipv6. */ ipAddressType?: string; /** * The Amazon Resource Names (ARNs) of the load balancers that route traffic to this target group. */ loadBalancerArns?: string[]; /** * [HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful response from a target. */ matcher?: outputs.awsconnector.MatcherResponse; /** * The name of the target group. */ name?: string; /** * The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081. */ port?: number; /** * The protocol to use for routing traffic to the targets. */ protocol?: string; /** * [HTTP/HTTPS protocol] The protocol version. The possible values are GRPC, HTTP1, and HTTP2. */ protocolVersion?: string; /** * The tags. */ tags?: outputs.awsconnector.TagResponse[]; /** * The ARN of the Target Group */ targetGroupArn?: string; /** * The attributes. */ targetGroupAttributes?: outputs.awsconnector.TargetGroupAttributeResponse[]; /** * The full name of the target group. */ targetGroupFullName?: string; /** * The name of the target group. */ targetGroupName?: string; /** * The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type. */ targetType?: string; /** * The targets. */ targets?: outputs.awsconnector.TargetDescriptionResponse[]; /** * The number of consecutive health check failures required before considering a target unhealthy. */ unhealthyThresholdCount?: number; /** * The identifier of the virtual private cloud (VPC). If the target is a Lambda function, this parameter does not apply. */ vpcId?: string; } /** * Definition of awsElasticLoadBalancingv2TargetHealthDescription */ interface AwsElasticLoadBalancingv2TargetHealthDescriptionPropertiesResponse { /** *

The anomaly detection result for the target.

If no anomalies were detected, the result is normal.

If anomalies were detected, the result is anomalous.

*/ anomalyDetection?: outputs.awsconnector.AnomalyDetectionResponse; /** *

The port to use to connect with the target.

*/ healthCheckPort?: string; /** *

The description of the target.

*/ target?: outputs.awsconnector.TargetDescriptionResponse; /** *

The health information for the target.

*/ targetHealth?: outputs.awsconnector.TargetHealthResponse; } /** * Definition of awsEmrCluster */ interface AwsEmrClusterPropertiesResponse { /** *

The applications installed on this cluster.

*/ applications?: outputs.awsconnector.ApplicationResponse[]; /** *

An IAM role for automatic scaling policies. The default role is EMR_AutoScaling_DefaultRole. The IAM role provides permissions that the automatic scaling feature requires to launch and terminate Amazon EC2 instances in an instance group.

*/ autoScalingRole?: string; /** *

Specifies whether the cluster should terminate after completing all steps.

*/ autoTerminate?: boolean; /** *

The Amazon Resource Name of the cluster.

*/ clusterArn?: string; /** *

Applies only to Amazon EMR releases 4.x and later. The list of configurations that are supplied to the Amazon EMR cluster.

*/ configurations?: outputs.awsconnector.ConfigurationResponse[]; /** *

Available only in Amazon EMR releases 5.7.0 and later. The ID of a custom Amazon EBS-backed Linux AMI if the cluster uses a custom AMI.

*/ customAmiId?: string; /** *

The IOPS, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.

*/ ebsRootVolumeIops?: number; /** *

The size, in GiB, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 4.x and later.

*/ ebsRootVolumeSize?: number; /** *

The throughput, in MiB/s, of the Amazon EBS root device volume of the Linux AMI that is used for each Amazon EC2 instance. Available in Amazon EMR releases 6.15.0 and later.

*/ ebsRootVolumeThroughput?: number; /** *

Provides information about the Amazon EC2 instances in a cluster grouped by category. For example, key name, subnet ID, IAM instance profile, and so on.

*/ ec2InstanceAttributes?: outputs.awsconnector.Ec2InstanceAttributesResponse; /** *

The unique identifier for the cluster.

*/ id?: string; /** *

The instance fleet configuration is available only in Amazon EMR releases 4.8.0 and later, excluding 5.0.x versions.

The instance group configuration of the cluster. A value of INSTANCE_GROUP indicates a uniform instance group configuration. A value of INSTANCE_FLEET indicates an instance fleets configuration.

*/ instanceCollectionType?: outputs.awsconnector.InstanceCollectionTypeEnumValueResponse; /** *

Attributes for Kerberos configuration when Kerberos authentication is enabled using a security configuration. For more information see Use Kerberos Authentication in the Amazon EMR Management Guide.

*/ kerberosAttributes?: outputs.awsconnector.KerberosAttributesResponse; /** *

The KMS key used for encrypting log files. This attribute is only available with Amazon EMR 5.30.0 and later, excluding Amazon EMR 6.0.0.

*/ logEncryptionKmsKeyId?: string; /** *

The path to the Amazon S3 location where logs for this cluster are stored.

*/ logUri?: string; /** *

The DNS name of the master node. If the cluster is on a private subnet, this is the private DNS name. On a public subnet, this is the public DNS name.

*/ masterPublicDnsName?: string; /** *

The name of the cluster. This parameter can't contain the characters <, >, $, |, or ` (backtick).

*/ name?: string; /** *

An approximation of the cost of the cluster, represented in m1.small/hours. This value is incremented one time for every hour an m1.small instance runs. Larger instances are weighted more, so an Amazon EC2 instance that is roughly four times more expensive would result in the normalized instance hours being incremented by four. This result is only an approximation and does not reflect the actual billing rate.

*/ normalizedInstanceHours?: number; /** *

The Amazon Linux release specified in a cluster launch RunJobFlow request. If no Amazon Linux release was specified, the default Amazon Linux release is shown in the response.

*/ osReleaseLabel?: string; /** *

The Amazon Resource Name (ARN) of the Outpost where the cluster is launched.

*/ outpostArn?: string; /** *

Placement group configured for an Amazon EMR cluster.

*/ placementGroups?: outputs.awsconnector.PlacementGroupConfigResponse[]; /** *

The Amazon EMR release label, which determines the version of open-source application packages installed on the cluster. Release labels are in the form emr-x.x.x, where x.x.x is an Amazon EMR release version such as emr-5.14.0. For more information about Amazon EMR release versions and included application versions and features, see https://docs.aws.amazon.com/emr/latest/ReleaseGuide/. The release label applies only to Amazon EMR releases version 4.0 and later. Earlier versions use AmiVersion.

*/ releaseLabel?: string; /** *

Applies only when CustomAmiID is used. Specifies the type of updates that the Amazon Linux AMI package repositories apply when an instance boots using the AMI.

*/ repoUpgradeOnBoot?: outputs.awsconnector.RepoUpgradeOnBootEnumValueResponse; /** *

The AMI version requested for this cluster.

*/ requestedAmiVersion?: string; /** *

The AMI version running on this cluster.

*/ runningAmiVersion?: string; /** *

The way that individual Amazon EC2 instances terminate when an automatic scale-in activity occurs or an instance group is resized. TERMINATE_AT_INSTANCE_HOUR indicates that Amazon EMR terminates nodes at the instance-hour boundary, regardless of when the request to terminate the instance was submitted. This option is only available with Amazon EMR 5.1.0 and later and is the default for clusters created using that version. TERMINATE_AT_TASK_COMPLETION indicates that Amazon EMR adds nodes to a deny list and drains tasks from nodes before terminating the Amazon EC2 instances, regardless of the instance-hour boundary. With either behavior, Amazon EMR removes the least active nodes first and blocks instance termination if it could lead to HDFS corruption. TERMINATE_AT_TASK_COMPLETION is available only in Amazon EMR releases 4.1.0 and later, and is the default for versions of Amazon EMR earlier than 5.1.0.

*/ scaleDownBehavior?: outputs.awsconnector.ScaleDownBehaviorEnumValueResponse; /** *

The name of the security configuration applied to the cluster.

*/ securityConfiguration?: string; /** *

The IAM role that Amazon EMR assumes in order to access Amazon Web Services resources on your behalf.

*/ serviceRole?: string; /** *

The current status details about the cluster.

*/ status?: outputs.awsconnector.EmrClusterStatusResponse; /** *

Specifies the number of steps that can be executed concurrently.

*/ stepConcurrencyLevel?: number; /** *

A list of tags associated with a cluster.

*/ tags?: outputs.awsconnector.TagResponse[]; /** *

Indicates whether Amazon EMR will lock the cluster to prevent the Amazon EC2 instances from being terminated by an API call or user intervention, or in the event of a cluster error.

*/ terminationProtected?: boolean; /** *

Indicates whether Amazon EMR should gracefully replace Amazon EC2 core instances that have degraded within the cluster.

*/ unhealthyNodeReplacement?: boolean; /** *

Indicates whether the cluster is visible to IAM principals in the Amazon Web Services account associated with the cluster. When true, IAM principals in the Amazon Web Services account can perform Amazon EMR cluster actions on the cluster that their IAM policies allow. When false, only the IAM principal that created the cluster and the Amazon Web Services account root user can perform Amazon EMR actions, regardless of IAM permissions policies attached to other IAM principals.

The default value is true if a value is not provided when creating a cluster using the Amazon EMR API RunJobFlow command, the CLI create-cluster command, or the Amazon Web Services Management Console.

*/ visibleToAllUsers?: boolean; } /** * Definition of awsGuardDutyDetector */ interface AwsGuardDutyDetectorPropertiesResponse { /** * Property dataSources */ dataSources?: outputs.awsconnector.CFNDataSourceConfigurationsResponse; /** * Property enable */ enable?: boolean; /** * Property features */ features?: outputs.awsconnector.CFNFeatureConfigurationResponse[]; /** * Property findingPublishingFrequency */ findingPublishingFrequency?: string; /** * Property id */ id?: string; /** * Property tags */ tags?: outputs.awsconnector.TagItemResponse[]; } /** * Definition of awsIamAccessKeyLastUsed */ interface AwsIamAccessKeyLastUsedPropertiesResponse { /** *

The date and time, in ISO 8601 date-time format, when the access key was most recently used. This field is null in the following situations:

  • The user does not have an access key.

  • An access key exists but has not been used since IAM began tracking this information.

  • There is no sign-in data associated with the user.

*/ lastUsedDate?: string; /** *

The Amazon Web Services Region where this access key was most recently used. The value for this field is 'N/A' in the following situations:

  • The user does not have an access key.

  • An access key exists but has not been used since IAM began tracking this information.

  • There is no sign-in data associated with the user.

For more information about Amazon Web Services Regions, see Regions and endpoints in the Amazon Web Services General Reference.

*/ region?: string; /** *

The name of the Amazon Web Services service with which this access key was most recently used. The value of this field is 'N/A' in the following situations:

  • The user does not have an access key.

  • An access key exists but has not been used since IAM started tracking this information.

  • There is no sign-in data associated with the user.

*/ serviceName?: string; } /** * Definition of awsIamAccessKeyMetadata */ interface AwsIamAccessKeyMetadataPropertiesResponse { /** *

The ID for this access key.

*/ accessKeyId?: string; /** *

The date when the access key was created.

*/ createDate?: string; /** *

The status of the access key. Active means that the key is valid for API calls; Inactive means it is not.

*/ status?: outputs.awsconnector.StatusTypeEnumValueResponse; /** *

The name of the IAM user that the key is associated with.

*/ userName?: string; } /** * Definition of awsIamGroup */ interface AwsIamGroupPropertiesResponse { /** * Property arn */ arn?: string; /** * The name of the group to create. Do not include the path in this value. The group name must be unique within the account. Group names are not distinguished by case. For example, you cannot create groups named both 'ADMINS' and 'admins'. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the group name. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities). Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{'Fn::Join': ['', [{'Ref': 'AWS::Region'}, {'Ref': 'MyResourceName'}]]}``. */ groupName?: string; /** * The Amazon Resource Name (ARN) of the IAM policy you want to attach. For more information about ARNs, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. */ managedPolicyArns?: string[]; /** * The path to the group. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. */ path?: string; /** * Adds or updates an inline policy document that is embedded in the specified IAM group. To view AWS::IAM::Group snippets, see [Declaring an Group Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-group). The name of each inline policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail. For information about limits on the number of inline policies that you can embed in a group, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. */ policies?: outputs.awsconnector.PolicyResponse[]; } /** * Definition of awsIamInstanceProfile */ interface AwsIamInstanceProfilePropertiesResponse { /** * Property arn */ arn?: string; /** * The name of the instance profile to create. This parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@- */ instanceProfileName?: string; /** * The path to the instance profile. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. */ path?: string; /** * The name of the role to associate with the instance profile. Only one role can be assigned to an EC2 instance at a time, and all applications on the instance share the same role and permissions. */ roles?: string[]; } /** * Definition of awsIamMFADevice */ interface AwsIamMFADevicePropertiesResponse { /** *

The date when the MFA device was enabled for the user.

*/ enableDate?: string; /** *

The serial number that uniquely identifies the MFA device. For virtual MFA devices, the serial number is the device ARN.

*/ serialNumber?: string; /** *

The user with whom the MFA device is associated.

*/ userName?: string; } /** * Definition of awsIamPasswordPolicy */ interface AwsIamPasswordPolicyPropertiesResponse { /** *

Specifies whether IAM users are allowed to change their own password. Gives IAM users permissions to iam:ChangePassword for only their user and to the iam:GetAccountPasswordPolicy action. This option does not attach a permissions policy to each user, rather the permissions are applied at the account-level for all users by IAM.

*/ allowUsersToChangePassword?: boolean; /** *

Indicates whether passwords in the account expire. Returns true if MaxPasswordAge contains a value greater than 0. Returns false if MaxPasswordAge is 0 or not present.

*/ expirePasswords?: boolean; /** *

Specifies whether IAM users are prevented from setting a new password via the Amazon Web Services Management Console after their password has expired. The IAM user cannot access the console until an administrator resets the password. IAM users with iam:ChangePassword permission and active access keys can reset their own expired console password using the CLI or API.

*/ hardExpiry?: boolean; /** *

The number of days that an IAM user password is valid.

*/ maxPasswordAge?: number; /** *

Minimum length to require for IAM user passwords.

*/ minimumPasswordLength?: number; /** *

Specifies the number of previous passwords that IAM users are prevented from reusing.

*/ passwordReusePrevention?: number; /** *

Specifies whether IAM user passwords must contain at least one lowercase character (a to z).

*/ requireLowercaseCharacters?: boolean; /** *

Specifies whether IAM user passwords must contain at least one numeric character (0 to 9).

*/ requireNumbers?: boolean; /** *

Specifies whether IAM user passwords must contain at least one of the following symbols:

! @ # $ % ^ & * ( ) _ + - = [ ] { } | '

*/ requireSymbols?: boolean; /** *

Specifies whether IAM user passwords must contain at least one uppercase character (A to Z).

*/ requireUppercaseCharacters?: boolean; } /** * Definition of awsIamPolicyVersion */ interface AwsIamPolicyVersionPropertiesResponse { /** *

The date and time, in ISO 8601 date-time format, when the policy version was created.

*/ createDate?: string; /** *

The policy document.

The policy document is returned in the response to the GetPolicyVersion and GetAccountAuthorizationDetails operations. It is not returned in the response to the CreatePolicyVersion or ListPolicyVersions operations.

The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy back to plain JSON text. For example, if you use Java, you can use the decode method of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar functionality.

*/ document?: string; /** *

Specifies whether the policy version is set as the policy's default version.

*/ isDefaultVersion?: boolean; /** *

The identifier for the policy version.

Policy version identifiers always begin with v (always lowercase). When a policy is created, the first policy version is v1.

*/ versionId?: string; } /** * Definition of awsIamRole */ interface AwsIamRolePropertiesResponse { /** * Property arn */ arn?: string; /** * The trust policy that is associated with this role. Trust policies define which entities can assume the role. You can associate only one trust policy with a role. For an example of a policy that can be used to assume a role, see [Template Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html#aws-resource-iam-role--examples). For more information about the elements that you can use in an IAM policy, see [Policy Elements Reference](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements.html) in the *User Guide*. */ assumeRolePolicyDocument?: any; /** * A description of the role that you provide. */ description?: string; /** * A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role. For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*. */ managedPolicyArns?: string[]; /** * The maximum session duration (in seconds) that you want to set for the specified role. If you do not specify a value for this setting, the default value of one hour is applied. This setting can have a value from 1 hour to 12 hours. Anyone who assumes the role from the CLI or API can use the ``DurationSeconds`` API parameter or the ``duration-seconds`` CLI parameter to request a longer session. The ``MaxSessionDuration`` setting determines the maximum duration that can be requested using the ``DurationSeconds`` parameter. If users don't specify a value for the ``DurationSeconds`` parameter, their security credentials are valid for one hour by default. This applies when you use the ``AssumeRole*`` API operations or the ``assume-role*`` CLI operations but does not apply when you use those operations to create a console URL. For more information, see [Using IAM roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*. */ maxSessionDuration?: number; /** * The path to the role. For more information about paths, see [IAM Identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*. This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters. */ path?: string; /** * The ARN of the policy used to set the permissions boundary for the role. For more information about permissions boundaries, see [Permissions boundaries for IAM identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*. */ permissionsBoundary?: string; /** * Adds or updates an inline policy document that is embedded in the specified IAM role. When you embed an inline policy in a role, the inline policy is used as part of the role's access (permissions) policy. The role's trust policy is created at the same time as the role. You can update a role's trust policy later. For more information about IAM roles, go to [Using Roles to Delegate Permissions and Federate Identities](https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html). A role can also have an attached managed policy. For information about policies, see [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*. For information about limits on the number of inline policies that you can embed with a role, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*. If an external policy (such as ``AWS::IAM::Policy`` or */ policies?: outputs.awsconnector.PolicyResponse[]; /** * Property roleId */ roleId?: string; /** * A name for the IAM role, up to 64 characters in length. For valid values, see the ``RoleName`` parameter for the [CreateRole](https://docs.aws.amazon.com/IAM/latest/APIReference/API_CreateRole.html) action in the *User Guide*. This parameter allows (per its [regex pattern](http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The role name must be unique within the account. Role names are not distinguished by case. For example, you cannot create roles named both 'Role1' and 'role1'. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the role name. If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Finding and Acknowledging Application Capabilities (Console)](https://docs.aws.amazon.com/serverlessrepo/latest/devguide/acknowledging-application-capabilities.html#acknowledging-application-capabilities-console). */ roleName?: string; /** * A list of tags that are attached to the role. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*. */ tags?: outputs.awsconnector.TagResponse[]; } /** * awsIamRolePropertiesResponseProvideDefaults sets the appropriate defaults for AwsIamRolePropertiesResponse */ function awsIamRolePropertiesResponseProvideDefaults(val: AwsIamRolePropertiesResponse): AwsIamRolePropertiesResponse; /** * Definition of awsIamServerCertificate */ interface AwsIamServerCertificatePropertiesResponse { /** * Amazon Resource Name (ARN) of the server certificate */ arn?: string; /** * Property certificateBody */ certificateBody?: string; /** * Property certificateChain */ certificateChain?: string; /** * Property path */ path?: string; /** * Property privateKey */ privateKey?: string; /** * Property serverCertificateName */ serverCertificateName?: string; /** * Property tags */ tags?: outputs.awsconnector.TagResponse[]; } /** * Definition of awsIamVirtualMFADevice */ interface AwsIamVirtualMFADevicePropertiesResponse { /** * Property path */ path?: string; /** * Property serialNumber */ serialNumber?: string; /** * Property tags */ tags?: outputs.awsconnector.TagResponse[]; /** * Property users */ users?: string[]; /** * Property virtualMfaDeviceName */ virtualMfaDeviceName?: string; } /** * Definition of awsKmsAlias */ interface AwsKmsAliasPropertiesResponse { /** * Specifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``. If you change the value of the ``AliasName`` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC). The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ``alias/aws/``. The ``alias/aws/`` prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk). */ aliasName?: string; /** * Associates the alias with the specified [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). The KMS key must be in the same AWS-account and Region. A valid key ID is required. If you supply a null or empty string value, this operation returns an error. For help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *Developer Guide*. Specify the key ID or the key ARN of the KMS key. For example: + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html). */ targetKeyId?: string; } /** * Definition of awsKmsKey */ interface AwsKmsKeyPropertiesResponse { /** * Property arn */ arn?: string; /** * Skips ('bypasses') the key policy lockout safety check. The default value is false. Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policy-default.html#prevent-unmanageable-key) in the *Developer Guide*. Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. */ bypassPolicyLockoutSafetyCheck?: boolean; /** * A description of the KMS key. Use a description that helps you to distinguish this KMS key from others in the account, such as its intended use. */ description?: string; /** * Enables automatic rotation of the key material for the specified KMS key. By default, automatic key rotation is not enabled. KMS supports automatic rotation only for symmetric encryption KMS keys (``KeySpec`` = ``SYMMETRIC_DEFAULT``). For asymmetric KMS keys, HMAC KMS keys, and KMS keys with Origin ``EXTERNAL``, omit the ``EnableKeyRotation`` property or set it to ``false``. To enable automatic key rotation of the key material for a multi-Region KMS key, set ``EnableKeyRotation`` to ``true`` on the primary key (created by using ``AWS::KMS::Key``). KMS copies the rotation status to all replica keys. For details, see [Rotating multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-manage.html#multi-region-rotate) in the *Developer Guide*. When you enable automatic rotation, KMS automatically creates new key material for the KMS key one year after the enable date and every year thereafter. KMS retains all key material until you delete the KMS key. For detailed information about automatic key rotation, see [Rotating KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/rotate-keys.html) in the *Developer Guide*. */ enableKeyRotation?: boolean; /** * Specifies whether the KMS key is enabled. Disabled KMS keys cannot be used in cryptographic operations. When ``Enabled`` is ``true``, the *key state* of the KMS key is ``Enabled``. When ``Enabled`` is ``false``, the key state of the KMS key is ``Disabled``. The default value is ``true``. The actual key state of the KMS key might be affected by actions taken outside of CloudFormation, such as running the [EnableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKey.html), [DisableKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html), or [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operations. For information about the key states of a KMS key, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. */ enabled?: boolean; /** * Property keyId */ keyId?: string; /** * The key policy to attach to the KMS key. If you provide a key policy, it must meet the following criteria: + The key policy must allow the caller to make a subsequent [PutKeyPolicy](https://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html) request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default-allow-root-enable-iam) in the *Developer Guide*. (To omit this condition, set ``BypassPolicyLockoutSafetyCheck`` to true.) + Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new AWS principal (for example, an IAM user or role), you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see [Changes that I make are not always immediately visible](https://docs.aws.amazon.com/IAM/latest/UserGuide/troubleshoot_general.html#troubleshoot_general_eventual-consistency) in the *User Guide*. If you do not provide a key policy, KMS attaches a default key policy to the KMS key. For more information, see [Default key policy](https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default) in the *Developer Guide*. A key policy document can include only the following characters: + Printable ASCII characters + Printable characters in the Basic Latin and Latin-1 Supplement character set + The tab (``\u0009``), line feed (``\u000A``), and carriage return (``\u000D``) special characters *Minimum*: ``1`` *Maximum*: ``32768`` */ keyPolicy?: any; /** * Specifies the type of KMS key to create. The default value, ``SYMMETRIC_DEFAULT``, creates a KMS key with a 256-bit symmetric key for encryption and decryption. In China Regions, ``SYMMETRIC_DEFAULT`` creates a 128-bit symmetric key that uses SM4 encryption. You can't change the ``KeySpec`` value after the KMS key is created. For help choosing a key spec for your KMS key, see [Choosing a KMS key type](https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-choose.html) in the *Developer Guide*. The ``KeySpec`` property determines the type of key material in the KMS key and the algorithms that the KMS key supports. To further restrict the algorithms that can be used with the KMS key, use a condition key in its key policy or IAM policy. For more information, see [condition keys](https://docs.aws.amazon.com/kms/latest/developerguide/policy-conditions.html#conditions-kms) in the *Developer Guide*. If you change the value of the ``KeySpec`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. [Services that are integrated with](https://aws.amazon.com/kms/features/#AWS_Service_Integration) use symmetric encryption KMS keys to protect your data. These services do not support encryption with asymmetric KMS keys. For help determining whether a KMS key is asymmetric, see [Identifying asymmetric KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/find-symm-asymm.html) in the *Developer Guide*. KMS supports the following key specs for KMS keys: + Symmetric encryption key (default) + ``SYMMETRIC_DEFAULT`` (AES-256-GCM) + HMAC keys (symmetric) + ``HMAC_224`` + ``HMAC_256`` + ``HMAC_384`` + ``HMAC_512`` + Asymmetric RSA key pairs + ``RSA_2048`` + ``RSA_3072`` + ``RSA_4096`` + Asymmetric NIST-recommended elliptic curve key pairs + ``ECC_NIST_P256`` (secp256r1) + ``ECC_NIST_P384`` (secp384r1) + ``ECC_NIST_P521`` (secp521r1) + Other asymmetric elliptic curve key pairs + ``ECC_SECG_P256K1`` (secp256k1), commonly used for cryptocurrencies. + SM2 key pairs (China Regions only) + ``SM2`` */ keySpec?: string; /** * Determines the [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations) for which you can use the KMS key. The default value is ``ENCRYPT_DECRYPT``. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the ``KeyUsage`` value after the KMS key is created. If you change the value of the ``KeyUsage`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. Select only one valid value. + For symmetric encryption KMS keys, omit the property or specify ``ENCRYPT_DECRYPT``. + For asymmetric KMS keys with RSA key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``. + For asymmetric KMS keys with ECC key material, specify ``SIGN_VERIFY``. + For asymmetric KMS keys with SM2 (China Regions only) key material, specify ``ENCRYPT_DECRYPT`` or ``SIGN_VERIFY``. + For HMAC KMS keys, specify ``GENERATE_VERIFY_MAC``. */ keyUsage?: string; /** * Creates a multi-Region primary key that you can replicate in other AWS-Regions. You can't change the ``MultiRegion`` value after the KMS key is created. For a list of AWS-Regions in which multi-Region keys are supported, see [Multi-Region keys in](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the **. If you change the value of the ``MultiRegion`` property on an existing KMS key, the update request fails, regardless of the value of the [UpdateReplacePolicy attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-updatereplacepolicy.html). This prevents you from accidentally deleting a KMS key by changing an immutable property value. For a multi-Region key, set to this property to ``true``. For a single-Region key, omit this property or set it to ``false``. The default value is ``false``. *Multi-Region keys* are an KMS feature that lets you create multiple interoperable KMS keys in different AWS-Regions. Because these KMS keys have the same key ID, key material, and other metadata, you can use them to encrypt data in one AWS-Region and decrypt it in a different AWS-Region without making a cross-Region call or exposing the plaintext data. For more information, see [Multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) in the *Developer Guide*. You can create a symmetric encryption, HMAC, or asymmetric multi-Region KMS key, and you can create a multi-Region key with imported key material. However, you cannot create a multi-Region key in a custom key store. To create a replica of this primary key in a different AWS-Region , create an [AWS::KMS::ReplicaKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-replicakey.html) resource in a CloudFormation stack in the replica Region. Specify the key ARN of this primary key. */ multiRegion?: boolean; /** * The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is ``AWS_KMS``, which means that KMS creates the key material. To [create a KMS key with no key material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys-create-cmk.html) (for imported key material), set this value to ``EXTERNAL``. For more information about importing key material into KMS, see [Importing Key Material](https://docs.aws.amazon.com/kms/latest/developerguide/importing-keys.html) in the *Developer Guide*. You can ignore ``ENABLED`` when Origin is ``EXTERNAL``. When a KMS key with Origin ``EXTERNAL`` is created, the key state is ``PENDING_IMPORT`` and ``ENABLED`` is ``false``. After you import the key material, ``ENABLED`` updated to ``true``. The KMS key can then be used for Cryptographic Operations. CFN doesn't support creating an ``Origin`` parameter of the ``AWS_CLOUDHSM`` or ``EXTERNAL_KEY_STORE`` values. */ origin?: string; /** * Specifies the number of days in the waiting period before KMS deletes a KMS key that has been removed from a CloudFormation stack. Enter a value between 7 and 30 days. The default value is 30 days. When you remove a KMS key from a CloudFormation stack, KMS schedules the KMS key for deletion and starts the mandatory waiting period. The ``PendingWindowInDays`` property determines the length of waiting period. During the waiting period, the key state of KMS key is ``Pending Deletion`` or ``Pending Replica Deletion``, which prevents the KMS key from being used in cryptographic operations. When the waiting period expires, KMS permanently deletes the KMS key. KMS will not delete a [multi-Region primary key](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-overview.html) that has replica keys. If you remove a multi-Region primary key from a CloudFormation stack, its key state changes to ``PendingReplicaDeletion`` so it cannot be replicated or used in cryptographic operations. This state can persist indefinitely. When the last of its replica keys is deleted, the key state of the primary key changes to ``PendingDeletion`` and the waiting period specified by ``PendingWindowInDays`` begins. When this waiting period expires, KMS deletes the primary key. For details, see [Deleting multi-Region keys](https://docs.aws.amazon.com/kms/latest/developerguide/multi-region-keys-delete.html) in the *Developer Guide*. You cannot use a CloudFormation template to cancel deletion of the KMS key after you remove it from the stack, regardless of the waiting period. If you specify a KMS key in your template, even one with the same name, CloudFormation creates a new KMS key. To cancel deletion of a KMS key, use the KMS console or the [CancelKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_CancelKeyDeletion.html) operation. For information about the ``Pending Deletion`` and ``Pending Replica Deletion`` key states, see [Key state: Effect on your KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/key-state.html) in the *Developer Guide*. For more information about deleting KMS keys, see the [ScheduleKeyDeletion](https://docs.aws.amazon.com/kms/latest/APIReference/API_ScheduleKeyDeletion.html) operation in the *API Reference* and [Deleting KMS keys](https://docs.aws.amazon.com/kms/latest/developerguide/deleting-keys.html) in the *Developer Guide*. */ pendingWindowInDays?: number; /** * Property rotationPeriodInDays */ rotationPeriodInDays?: number; /** * Assigns one or more tags to the replica key. Tagging or untagging a KMS key can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*. For information about tags in KMS, see [Tagging keys](https://docs.aws.amazon.com/kms/latest/developerguide/tagging-keys.html) in the *Developer Guide*. For information about tags in CloudFormation, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). */ tags?: outputs.awsconnector.TagResponse[]; } /** * awsKmsKeyPropertiesResponseProvideDefaults sets the appropriate defaults for AwsKmsKeyPropertiesResponse */ function awsKmsKeyPropertiesResponseProvideDefaults(val: AwsKmsKeyPropertiesResponse): AwsKmsKeyPropertiesResponse; /** * Definition of awsLambdaFunctionCodeLocation */ interface AwsLambdaFunctionCodeLocationPropertiesResponse { /** *

URI of a container image in the Amazon ECR registry.

*/ imageUri?: string; /** *

A presigned URL that you can use to download the deployment package.

*/ location?: string; /** *

The service that's hosting the file.

*/ repositoryType?: string; /** *

The resolved URI for the image.

*/ resolvedImageUri?: string; } /** * Definition of awsLambdaFunction */ interface AwsLambdaFunctionPropertiesResponse { /** * The instruction set architecture that the function supports. Enter a string array with one of the valid values (arm64 or x86_64). The default value is ``x86_64``. */ architectures?: string[]; /** * Property arn */ arn?: string; /** * The code for the function. The [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html) for a Lambda function. To deploy a function defined as a container image, you specify the location of a container image in the Amazon ECR registry. For a .zip file deployment package, you can specify the location of an object in Amazon S3. For Node.js and Python functions, you can specify the function code inline in the template. Changes to a deployment package in Amazon S3 or a container image in ECR are not detected automatically during stack updates. To update the function code, change the object key or version in the template. */ code?: outputs.awsconnector.CodeResponse; /** * To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function. */ codeSigningConfigArn?: string; /** * A dead-letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see [Dead-letter queues](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#invocation-dlq). The [dead-letter queue](https://docs.aws.amazon.com/lambda/latest/dg/invocation-async.html#dlq) for failed asynchronous invocations. */ deadLetterConfig?: outputs.awsconnector.DeadLetterConfigResponse; /** * A description of the function. */ description?: string; /** * Environment variables that are accessible from function code during execution. A function's environment variable settings. You can use environment variables to adjust your function's behavior without updating code. An environment variable is a pair of strings that are stored in a function's version-specific configuration. */ environment?: outputs.awsconnector.EnvironmentResponse; /** * The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB. The size of the function's ``/tmp`` directory in MB. The default value is 512, but it can be any whole number between 512 and 10,240 MB. */ ephemeralStorage?: outputs.awsconnector.EphemeralStorageLambdaFunctionResponse; /** * Connection settings for an Amazon EFS file system. To connect a function to a file system, a mount target must be available in every Availability Zone that your function connects to. If your template contains an [AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html) resource, you must also specify a ``DependsOn`` attribute to ensure that the mount target is created or updated before the function. For more information about using the ``DependsOn`` attribute, see [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html). */ fileSystemConfigs?: outputs.awsconnector.FileSystemConfigResponse[]; /** * The name of the Lambda function, up to 64 characters in length. If you don't specify a name, CFN generates one. If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. */ functionName?: string; /** * The name of the method within your code that Lambda calls to run your function. Handler is required if the deployment package is a .zip file archive. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see [Lambda programming model](https://docs.aws.amazon.com/lambda/latest/dg/foundation-progmodel.html). */ handler?: string; /** * Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms). Configuration values that override the container image Dockerfile settings. For more information, see [Container image settings](https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms). */ imageConfig?: outputs.awsconnector.ImageConfigResponse; /** * The ARN of the KMSlong (KMS) customer managed key that's used to encrypt your function's [environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-encryption). When [Lambda SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart-security.html) is activated, Lambda also uses this key is to encrypt your function's snapshot. If you deploy your function using a container image, Lambda also uses this key to encrypt your function when it's deployed. Note that this is not the same key that's used to protect your container image in the Amazon Elastic Container Registry (Amazon ECR). If you don't provide a customer managed key, Lambda uses a default service key. */ kmsKeyArn?: string; /** * A list of [function layers](https://docs.aws.amazon.com/lambda/latest/dg/configuration-layers.html) to add to the function's execution environment. Specify each layer by its ARN, including the version. */ layers?: string[]; /** * The function's Amazon CloudWatch Logs configuration settings. The function's Amazon CloudWatch Logs configuration settings. */ loggingConfig?: outputs.awsconnector.LoggingConfigResponse; /** * The amount of [memory available to the function](https://docs.aws.amazon.com/lambda/latest/dg/configuration-function-common.html#configuration-memory-console) at runtime. Increasing the function memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB. Note that new AWS accounts have reduced concurrency and memory quotas. AWS raises these quotas automatically based on your usage. You can also request a quota increase. */ memorySize?: number; /** * The type of deployment package. Set to ``Image`` for container image and set ``Zip`` for .zip file archive. */ packageType?: string; /** * The number of simultaneous executions to reserve for the function. */ reservedConcurrentExecutions?: number; /** * The Amazon Resource Name (ARN) of the function's execution role. */ role?: string; /** * The identifier of the function's [runtime](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html). Runtime is required if the deployment package is a .zip file archive. The following list includes deprecated runtimes. For more information, see [Runtime deprecation policy](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#runtime-support-policy). */ runtime?: string; /** * Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html). Sets the runtime management configuration for a function's version. For more information, see [Runtime updates](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html). */ runtimeManagementConfig?: outputs.awsconnector.RuntimeManagementConfigResponse; /** * The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting. The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting. */ snapStart?: outputs.awsconnector.SnapStartResponse; /** * The function's [SnapStart](https://docs.aws.amazon.com/lambda/latest/dg/snapstart.html) setting. */ snapStartResponse?: outputs.awsconnector.SnapStartResponseResponse; /** * A list of [tags](https://docs.aws.amazon.com/lambda/latest/dg/tagging.html) to apply to the function. */ tags?: outputs.awsconnector.TagResponse[]; /** * The amount of time (in seconds) that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds. For more information, see [Lambda execution environment](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-context.html). */ timeout?: number; /** * Set ``Mode`` to ``Active`` to sample and trace a subset of incoming requests with [X-Ray](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html). The function's [](https://docs.aws.amazon.com/lambda/latest/dg/services-xray.html) tracing configuration. To sample and record incoming requests, set ``Mode`` to ``Active``. */ tracingConfig?: outputs.awsconnector.TracingConfigResponse; /** * For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can access resources and the internet only through that VPC. For more information, see [Configuring a Lambda function to access resources in a VPC](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). The VPC security groups and subnets that are attached to a Lambda function. When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see [VPC Settings](https://docs.aws.amazon.com/lambda/latest/dg/configuration-vpc.html). When you delete a function, CFN monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before CFN can delete the VPC's resources. To monitor network interfaces, CFN needs the ``ec2:DescribeNetworkInterfaces`` permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, CFN does not wait for network interfaces to be deleted. */ vpcConfig?: outputs.awsconnector.VpcConfigLambdaFunctionResponse; } /** * Definition of awsLightsailBucket */ interface AwsLightsailBucketPropertiesResponse { /** * Indicates whether the bundle that is currently applied to a bucket can be changed to another bundle. You can update a bucket's bundle only one time within a monthly AWS billing cycle. */ ableToUpdateBundle?: boolean; /** * An object that sets the public accessibility of objects in the specified bucket. */ accessRules?: outputs.awsconnector.AccessRulesResponse; /** * Property bucketArn */ bucketArn?: string; /** * The name for the bucket. */ bucketName?: string; /** * The ID of the bundle to use for the bucket. */ bundleId?: string; /** * Specifies whether to enable or disable versioning of objects in the bucket. */ objectVersioning?: boolean; /** * An array of strings to specify the AWS account IDs that can access the bucket. */ readOnlyAccessAccounts?: string[]; /** * The names of the Lightsail resources for which to set bucket access. */ resourcesReceivingAccess?: string[]; /** * An array of key-value pairs to apply to this resource. */ tags?: outputs.awsconnector.TagResponse[]; /** * The URL of the bucket. */ url?: string; } /** * Definition of awsLightsailInstance */ interface AwsLightsailInstancePropertiesResponse { /** * An array of objects representing the add-ons to enable for the new instance. */ addOns?: outputs.awsconnector.AddOnResponse[]; /** * The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request. */ availabilityZone?: string; /** * The ID for a virtual private server image (e.g., app_wordpress_4_4 or app_lamp_7_0 ). Use the get blueprints operation to return a list of available images (or blueprints ). */ blueprintId?: string; /** * The bundle of specification information for your virtual private server (or instance ), including the pricing plan (e.g., micro_1_0 ). */ bundleId?: string; /** * Hardware of the Instance. */ hardware?: outputs.awsconnector.HardwareResponse; /** * Property instanceArn */ instanceArn?: string; /** * The names to use for your new Lightsail instance. */ instanceName?: string; /** * Is the IP Address of the Instance is the static IP */ isStaticIp?: boolean; /** * The name of your key pair. */ keyPairName?: string; /** * Location of a resource. */ location?: outputs.awsconnector.LocationResponse; /** * Networking of the Instance. */ networking?: outputs.awsconnector.NetworkingResponse; /** * Private IP Address of the Instance */ privateIpAddress?: string; /** * Public IP Address of the Instance */ publicIpAddress?: string; /** * Resource type of Lightsail instance. */ resourceType?: string; /** * SSH Key Name of the Lightsail instance. */ sshKeyName?: string; /** * Current State of the Instance. */ state?: outputs.awsconnector.StateResponse; /** * Support code to help identify any issues */ supportCode?: string; /** * An array of key-value pairs to apply to this resource. */ tags?: outputs.awsconnector.TagResponse[]; /** * A launch script you can create that configures a server with additional user data. For example, you might want to run apt-get -y update. */ userData?: string; /** * Username of the Lightsail instance. */ userName?: string; } /** * Definition of awsLogsLogGroup */ interface AwsLogsLogGroupPropertiesResponse { /** * Property arn */ arn?: string; /** * Creates a data protection policy and assigns it to the log group. A data protection policy can help safeguard sensitive data that's ingested by the log group by auditing and masking the sensitive log data. When a user who does not have permission to view masked data views a log event that includes masked data, the sensitive data is replaced by asterisks. For more information, including a list of types of data that can be audited and masked, see [Protect sensitive log data with masking](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/mask-sensitive-log-data.html). */ dataProtectionPolicy?: any; /** * The Amazon Resource Name (ARN) of the KMS key to use when encrypting log data. To associate an KMS key with the log group, specify the ARN of that KMS key here. If you do so, ingested data is encrypted using this key. This association is stored as long as the data encrypted with the KMS key is still within CWL. This enables CWL to decrypt this data whenever it is requested. If you attempt to associate a KMS key with the log group but the KMS key doesn't exist or is deactivated, you will receive an ``InvalidParameterException`` error. Log group data is always encrypted in CWL. If you omit this key, the encryption does not use KMS. For more information, see [Encrypt log data in using](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/encrypt-log-data-kms.html) */ kmsKeyId?: string; /** * Specifies the log group class for this log group. There are two classes: + The ``Standard`` log class supports all CWL features. + The ``Infrequent Access`` log class supports a subset of CWL features and incurs lower costs. For details about the features supported by each class, see [Log classes](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CloudWatch_Logs_Log_Classes.html) */ logGroupClass?: string; /** * The name of the log group. If you don't specify a name, CFNlong generates a unique ID for the log group. */ logGroupName?: string; /** * The number of days to retain the log events in the specified log group. Possible values are: 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1096, 1827, 2192, 2557, 2922, 3288, and 3653. To set a log group so that its log events do not expire, use [DeleteRetentionPolicy](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DeleteRetentionPolicy.html). */ retentionInDays?: number; /** * An array of key-value pairs to apply to the log group. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html). */ tags?: outputs.awsconnector.TagResponse[]; } /** * awsLogsLogGroupPropertiesResponseProvideDefaults sets the appropriate defaults for AwsLogsLogGroupPropertiesResponse */ function awsLogsLogGroupPropertiesResponseProvideDefaults(val: AwsLogsLogGroupPropertiesResponse): AwsLogsLogGroupPropertiesResponse; /** * Definition of awsLogsLogStream */ interface AwsLogsLogStreamPropertiesResponse { /** * The name of the log group where the log stream is created. */ logGroupName?: string; /** * The name of the log stream. The name must be unique wihtin the log group. */ logStreamName?: string; } /** * Definition of awsLogsMetricFilter */ interface AwsLogsMetricFilterPropertiesResponse { /** * The name of the metric filter. */ filterName?: string; /** * A filter pattern for extracting metric data out of ingested log events. For more information, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html). */ filterPattern?: string; /** * The name of an existing log group that you want to associate with this metric filter. */ logGroupName?: string; /** * The metric transformations. */ metricTransformations?: outputs.awsconnector.MetricTransformationResponse[]; } /** * Definition of awsLogsSubscriptionFilter */ interface AwsLogsSubscriptionFilterPropertiesResponse { /** * The Amazon Resource Name (ARN) of the destination. */ destinationArn?: string; /** * The method used to distribute log data to the destination, which can be either random or grouped by log stream. */ distribution?: string; /** * The name of the subscription filter. */ filterName?: string; /** * The filtering expressions that restrict what gets delivered to the destination AWS resource. For more information about the filter pattern syntax, see [Filter and Pattern Syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html). */ filterPattern?: string; /** * The log group to associate with the subscription filter. All log events that are uploaded to this log group are filtered and delivered to the specified AWS resource if the filter pattern matches the log events. */ logGroupName?: string; /** * The ARN of an IAM role that grants CWL permissions to deliver ingested log events to the destination stream. You don't need to provide the ARN when you are working with a logical destination for cross-account delivery. */ roleArn?: string; } /** * Definition of awsMacie2JobSummary */ interface AwsMacie2JobSummaryPropertiesResponse { /** *

The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.

*/ bucketCriteria?: outputs.awsconnector.S3BucketCriteriaForJobResponse; /** *

An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

*/ bucketDefinitions?: outputs.awsconnector.S3BucketDefinitionForJobResponse[]; /** *

The date and time, in UTC and extended ISO 8601 format, when the job was created.

*/ createdAt?: string; /** *

The unique identifier for the job.

*/ jobId?: string; /** *

The current status of the job. Possible values are:

  • CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.

  • COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.

  • IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.

  • PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.

  • RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.

  • USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

*/ jobStatus?: outputs.awsconnector.JobStatusEnumValueResponse; /** *

The schedule for running the job. Possible values are:

  • ONE_TIME - The job runs only once.

  • SCHEDULED - The job runs on a daily, weekly, or monthly basis.

*/ jobType?: outputs.awsconnector.JobTypeEnumValueResponse; /** *

Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.

*/ lastRunErrorStatus?: outputs.awsconnector.LastRunErrorStatusResponse; /** *

The custom name of the job.

*/ name?: string; /** *

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.

*/ userPausedDetails?: outputs.awsconnector.UserPausedDetailsResponse; } /** * Definition of awsMacieAllowList */ interface AwsMacieAllowListPropertiesResponse { /** * AllowList ARN. */ arn?: string; /** * AllowList criteria. The regex or s3 object to use for the AllowList. */ criteria?: outputs.awsconnector.CriteriaResponse; /** * Description of AllowList. */ description?: string; /** * AllowList ID. */ id?: string; /** * Name of AllowList. */ name?: string; /** * AllowList status. The status for the AllowList */ status?: string; /** * A collection of tags associated with a resource */ tags?: outputs.awsconnector.TagResponse[]; } /** * Definition of awsNetworkFirewallFirewallPolicy */ interface AwsNetworkFirewallFirewallPolicyPropertiesResponse { /** * Property description */ description?: string; /** * Property firewallPolicy */ firewallPolicy?: outputs.awsconnector.FirewallPolicyResponse; /** * A resource ARN. */ firewallPolicyArn?: string; /** * Property firewallPolicyId */ firewallPolicyId?: string; /** * Property firewallPolicyName */ firewallPolicyName?: string; /** * Property tags */ tags?: outputs.awsconnector.TagResponse[]; } /** * Definition of awsNetworkFirewallFirewall */ interface AwsNetworkFirewallFirewallPropertiesResponse { /** * Property deleteProtection */ deleteProtection?: boolean; /** * Property description */ description?: string; /** * Property endpointIds */ endpointIds?: string[]; /** * A resource ARN. */ firewallArn?: string; /** * Property firewallId */ firewallId?: string; /** * Property firewallName */ firewallName?: string; /** * A resource ARN. */ firewallPolicyArn?: string; /** * Property firewallPolicyChangeProtection */ firewallPolicyChangeProtection?: boolean; /** * Property subnetChangeProtection */ subnetChangeProtection?: boolean; /** * Property subnetMappings */ subnetMappings?: outputs.awsconnector.SubnetMappingNetworkFirewallFirewallResponse[]; /** * Property tags */ tags?: outputs.awsconnector.TagResponse[]; /** * Property vpcId */ vpcId?: string; } /** * Definition of awsNetworkFirewallRuleGroup */ interface AwsNetworkFirewallRuleGroupPropertiesResponse { /** * Property capacity */ capacity?: number; /** * Property description */ description?: string; /** * Property ruleGroup */ ruleGroup?: outputs.awsconnector.RuleGroupResponse; /** * A resource ARN. */ ruleGroupArn?: string; /** * Property ruleGroupId */ ruleGroupId?: string; /** * Property ruleGroupName */ ruleGroupName?: string; /** * Property tags */ tags?: outputs.awsconnector.TagResponse[]; /** * Property type */ type?: string; } /** * Definition of awsOpenSearchDomainStatus */ interface AwsOpenSearchDomainStatusPropertiesResponse { /** *

Identity and Access Management (IAM) policy document specifying the access policies for the domain.

*/ accessPolicies?: string; /** *

Key-value pairs that specify advanced configuration options.

*/ advancedOptions?: { [key: string]: string; }; /** *

Settings for fine-grained access control.

*/ advancedSecurityOptions?: outputs.awsconnector.AdvancedSecurityOptionsResponse; /** *

The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

*/ arn?: string; /** *

Auto-Tune settings for the domain.

*/ autoTuneOptions?: outputs.awsconnector.AutoTuneOptionsOutputResponse; /** *

Information about a configuration change happening on the domain.

*/ changeProgressDetails?: outputs.awsconnector.ChangeProgressDetailsResponse; /** *

Container for the cluster configuration of the domain.

*/ clusterConfig?: outputs.awsconnector.ClusterConfigResponse; /** *

Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

*/ cognitoOptions?: outputs.awsconnector.CognitoOptionsResponse; /** *

Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

*/ created?: boolean; /** *

Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

*/ deleted?: boolean; /** *

Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

*/ domainEndpointOptions?: outputs.awsconnector.DomainEndpointOptionsResponse; /** *

Unique identifier for the domain.

*/ domainId?: string; /** *

Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

*/ domainName?: string; /** *

The status of any changes that are currently in progress for the domain.

*/ domainProcessingStatus?: outputs.awsconnector.DomainProcessingStatusTypeEnumValueResponse; /** *

Container for EBS-based storage settings for the domain.

*/ ebsOptions?: outputs.awsconnector.EBSOptionsResponse; /** *

Encryption at rest settings for the domain.

*/ encryptionAtRestOptions?: outputs.awsconnector.EncryptionAtRestOptionsResponse; /** *

Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

*/ endpoint?: string; /** *

If IPAddressType to set to dualstack, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.

*/ endpointV2?: string; /** *

The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

*/ endpoints?: { [key: string]: string; }; /** *

Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

*/ engineVersion?: string; /** *

The type of IP addresses supported by the endpoint for the domain.

*/ ipAddressType?: outputs.awsconnector.IPAddressTypeEnumValueResponse; /** *

Log publishing options for the domain.

*/ logPublishingOptions?: { [key: string]: outputs.awsconnector.LogPublishingOptionResponse; }; /** *

Information about the domain properties that are currently being modified.

*/ modifyingProperties?: outputs.awsconnector.ModifyingPropertiesResponse[]; /** *

Whether node-to-node encryption is enabled or disabled.

*/ nodeToNodeEncryptionOptions?: outputs.awsconnector.NodeToNodeEncryptionOptionsResponse; /** *

Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.

*/ offPeakWindowOptions?: outputs.awsconnector.OffPeakWindowOptionsResponse; /** *

The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

*/ processing?: boolean; /** *

The current status of the domain's service software.

*/ serviceSoftwareOptions?: outputs.awsconnector.ServiceSoftwareOptionsResponse; /** *

DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.

*/ snapshotOptions?: outputs.awsconnector.SnapshotOptionsResponse; /** *

Service software update options for the domain.

*/ softwareUpdateOptions?: outputs.awsconnector.SoftwareUpdateOptionsResponse; /** *

The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

*/ upgradeProcessing?: boolean; /** *

The VPC configuration for the domain.

*/ vpcOptions?: outputs.awsconnector.VPCDerivedInfoResponse; } /** * Definition of awsOrganizationsAccount */ interface AwsOrganizationsAccountPropertiesResponse { /** * If the account was created successfully, the unique identifier (ID) of the new account. */ accountId?: string; /** * The friendly name of the member account. */ accountName?: string; /** * The Amazon Resource Name (ARN) of the account. */ arn?: string; /** * The email address of the owner to assign to the new member account. */ email?: string; /** * The method by which the account joined the organization. */ joinedMethod?: string; /** * The date the account became a part of the organization. */ joinedTimestamp?: string; /** * List of parent nodes for the member account. Currently only one parent at a time is supported. Default is root. */ parentIds?: string[]; /** * The name of an IAM role that AWS Organizations automatically preconfigures in the new member account. Default name is OrganizationAccountAccessRole if not specified. */ roleName?: string; /** * The status of the account in the organization. */ status?: string; /** * A list of tags that you want to attach to the newly created account. For each tag in the list, you must specify both a tag key and a value. */ tags?: outputs.awsconnector.TagResponse[]; } /** * awsOrganizationsAccountPropertiesResponseProvideDefaults sets the appropriate defaults for AwsOrganizationsAccountPropertiesResponse */ function awsOrganizationsAccountPropertiesResponseProvideDefaults(val: AwsOrganizationsAccountPropertiesResponse): AwsOrganizationsAccountPropertiesResponse; /** * Definition of awsOrganizationsOrganization */ interface AwsOrganizationsOrganizationPropertiesResponse { /** * The Amazon Resource Name (ARN) of an organization. */ arn?: string; /** * Specifies the feature set supported by the new organization. Each feature set supports different levels of functionality. */ featureSet?: string; /** * The unique identifier (ID) of an organization. */ id?: string; /** * The Amazon Resource Name (ARN) of the account that is designated as the management account for the organization. */ managementAccountArn?: string; /** * The email address that is associated with the AWS account that is designated as the management account for the organization. */ managementAccountEmail?: string; /** * The unique identifier (ID) of the management account of an organization. */ managementAccountId?: string; /** * The unique identifier (ID) for the root. */ rootId?: string; } /** * awsOrganizationsOrganizationPropertiesResponseProvideDefaults sets the appropriate defaults for AwsOrganizationsOrganizationPropertiesResponse */ function awsOrganizationsOrganizationPropertiesResponseProvideDefaults(val: AwsOrganizationsOrganizationPropertiesResponse): AwsOrganizationsOrganizationPropertiesResponse; /** * Definition of awsRdsDBCluster */ interface AwsRdsDBClusterPropertiesResponse { /** * The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. */ allocatedStorage?: number; /** * Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster. IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. */ associatedRoles?: outputs.awsconnector.DBClusterRoleResponse[]; /** * A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window. By default, minor engine upgrades are applied automatically. */ autoMinorVersionUpgrade?: boolean; /** * A list of Availability Zones (AZs) where instances in the DB cluster can be created. For information on AWS Regions and Availability Zones, see Choosing the Regions and Availability Zones in the Amazon Aurora User Guide. */ availabilityZones?: string[]; /** * The target backtrack window, in seconds. To disable backtracking, set this value to 0. */ backtrackWindow?: number; /** * The number of days for which automated backups are retained. */ backupRetentionPeriod?: number; /** * A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster. The default is not to copy them. */ copyTagsToSnapshot?: boolean; /** * The name of your database. If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see Naming Constraints in the Amazon RDS User Guide. */ databaseName?: string; /** * The Amazon Resource Name (ARN) for the DB cluster. */ dbClusterArn?: string; /** * The DB cluster identifier. This parameter is stored as a lowercase string. */ dbClusterIdentifier?: string; /** * The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example db.m6g.xlarge. */ dbClusterInstanceClass?: string; /** * The name of the DB cluster parameter group to associate with this DB cluster. */ dbClusterParameterGroupName?: string; /** * The AWS Region-unique, immutable identifier for the DB cluster. */ dbClusterResourceId?: string; /** * The name of the DB parameter group to apply to all instances of the DB cluster. */ dbInstanceParameterGroupName?: string; /** * A DB subnet group that you want to associate with this DB cluster. */ dbSubnetGroupName?: string; /** * Reserved for future use. */ dbSystemId?: string; /** * A value that indicates whether the DB cluster has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. */ deletionProtection?: boolean; /** * The Active Directory directory ID to create the DB cluster in. */ domain?: string; /** * Specify the name of the IAM role to be used when making API calls to the Directory Service. */ domainIAMRoleName?: string; /** * The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. */ enableCloudwatchLogsExports?: string[]; /** * Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database. */ enableGlobalWriteForwarding?: boolean; /** * A value that indicates whether to enable the HTTP endpoint for DB cluster. By default, the HTTP endpoint is disabled. */ enableHttpEndpoint?: boolean; /** * A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. */ enableIAMDatabaseAuthentication?: boolean; /** * Property endpoint */ endpoint?: outputs.awsconnector.RdsDbClusterEndpointResponse; /** * The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql */ engine?: string; /** * The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. */ engineMode?: string; /** * The version number of the database engine to use. */ engineVersion?: string; /** * If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster. To define the primary database cluster of the global cluster, use the AWS::RDS::GlobalCluster resource.If you aren't configuring a global database cluster, don't specify this property. */ globalClusterIdentifier?: string; /** * The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster. */ iops?: number; /** * The Amazon Resource Name (ARN) of the AWS Key Management Service master key that is used to encrypt the database instances in the DB cluster, such as arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. If you enable the StorageEncrypted property but don't specify this property, the default master key is used. If you specify this property, you must set the StorageEncrypted property to true. */ kmsKeyId?: string; /** * A value that indicates whether to manage the master user password with AWS Secrets Manager. */ manageMasterUserPassword?: boolean; /** * The master password for the DB instance. */ masterUserPassword?: string; /** * Contains the secret managed by RDS in AWS Secrets Manager for the master user password. */ masterUserSecret?: outputs.awsconnector.MasterUserSecretResponse; /** * The name of the master user for the DB cluster. You must specify MasterUsername, unless you specify SnapshotIdentifier. In that case, don't specify MasterUsername. */ masterUsername?: string; /** * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster. To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0. */ monitoringInterval?: number; /** * The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs. */ monitoringRoleArn?: string; /** * The network type of the DB cluster. */ networkType?: string; /** * A value that indicates whether to turn on Performance Insights for the DB cluster. */ performanceInsightsEnabled?: boolean; /** * The Amazon Web Services KMS key identifier for encryption of Performance Insights data. */ performanceInsightsKmsKeyId?: string; /** * The amount of time, in days, to retain Performance Insights data. */ performanceInsightsRetentionPeriod?: number; /** * The port number on which the instances in the DB cluster accept connections. Default: 3306 if engine is set as aurora or 5432 if set to aurora-postgresql. */ port?: number; /** * The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter. The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. */ preferredBackupWindow?: string; /** * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see Adjusting the Preferred DB Cluster Maintenance Window in the Amazon Aurora User Guide. */ preferredMaintenanceWindow?: string; /** * A value that indicates whether the DB cluster is publicly accessible. */ publiclyAccessible?: boolean; /** * Property readEndpoint */ readEndpoint?: outputs.awsconnector.ReadEndpointResponse; /** * The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a Read Replica. */ replicationSourceIdentifier?: string; /** * The date and time to restore the DB cluster to. Value must be a time in Universal Coordinated Time (UTC) format. An example: 2015-03-07T23:45:00Z */ restoreToTime?: string; /** * The type of restore to be performed. You can specify one of the following values:full-copy - The new DB cluster is restored as a full copy of the source DB cluster.copy-on-write - The new DB cluster is restored as a clone of the source DB cluster. */ restoreType?: string; /** * The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. The ScalingConfiguration property type specifies the scaling configuration of an Aurora Serverless DB cluster. */ scalingConfiguration?: outputs.awsconnector.ScalingConfigurationResponse; /** * Contains the scaling configuration of an Aurora Serverless v2 DB cluster. Contains the scaling configuration of an Aurora Serverless v2 DB cluster. */ serverlessV2ScalingConfiguration?: outputs.awsconnector.ServerlessV2ScalingConfigurationResponse; /** * The identifier for the DB snapshot or DB cluster snapshot to restore from.You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.After you restore a DB cluster with a SnapshotIdentifier property, you must specify the same SnapshotIdentifier property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. However, if you don't specify the SnapshotIdentifier property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the specified SnapshotIdentifier property, and the original DB cluster is deleted. */ snapshotIdentifier?: string; /** * The identifier of the source DB cluster from which to restore. */ sourceDBClusterIdentifier?: string; /** * The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, us-east-1. */ sourceRegion?: string; /** * Indicates whether the DB instance is encrypted.If you specify the DBClusterIdentifier, SnapshotIdentifier, or SourceDBInstanceIdentifier property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. */ storageEncrypted?: boolean; /** * Specifies the storage throughput value for the DB cluster. This setting applies only to the gp3 storage type. */ storageThroughput?: number; /** * Specifies the storage type to be associated with the DB cluster. */ storageType?: string; /** * An array of key-value pairs to apply to this resource. */ tags?: outputs.awsconnector.TagResponse[]; /** * A value that indicates whether to restore the DB cluster to the latest restorable backup time. By default, the DB cluster is not restored to the latest restorable backup time. */ useLatestRestorableTime?: boolean; /** * A list of EC2 VPC security groups to associate with this DB cluster. */ vpcSecurityGroupIds?: string[]; } /** * awsRdsDBClusterPropertiesResponseProvideDefaults sets the appropriate defaults for AwsRdsDBClusterPropertiesResponse */ function awsRdsDBClusterPropertiesResponseProvideDefaults(val: AwsRdsDBClusterPropertiesResponse): AwsRdsDBClusterPropertiesResponse; /** * Definition of awsRdsDBInstance */ interface AwsRdsDBInstancePropertiesResponse { /** * The amount of storage in gibibytes (GiB) to be initially allocated for the database instance. If any value is set in the ``Iops`` parameter, ``AllocatedStorage`` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the ``Iops`` value (in 1,000 IOPS increments), then you must also increase the ``AllocatedStorage`` value (in 100-GiB increments). *Amazon Aurora* Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. *Db2* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp3): Must be an integer from 20 to 64000. + Provisioned IOPS storage (io1): Must be an integer from 100 to 64000. *MySQL* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. *MariaDB* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. *PostgreSQL* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 5 to 3072. *Oracle* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. + Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. + Magnetic storage (standard): Must be an integer from 10 to 3072. *SQL Server* Constraints to the amount of storage for each storage type are the following: + General Purpose (SSD) storage (gp2): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Provisioned IOPS storage (io1): + Enterprise and Standard editions: Must be an integer from 20 to 16384. + Web and Express editions: Must be an integer from 20 to 16384. + Magnetic storage (standard): + Enterprise and Standard editions: Must be an integer from 20 to 1024. + Web and Express editions: Must be an integer from 20 to 1024. */ allocatedStorage?: string; /** * A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the ``EngineVersion`` parameter that is a different major version than the DB instance's current version. */ allowMajorVersionUpgrade?: boolean; /** * The IAMlong (IAM) roles associated with the DB instance. *Amazon Aurora* Not applicable. The associated roles are managed by the DB cluster. */ associatedRoles?: outputs.awsconnector.DBInstanceRoleResponse[]; /** * A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically. */ autoMinorVersionUpgrade?: boolean; /** * Property automaticBackupReplicationKmsKeyId */ automaticBackupReplicationKmsKeyId?: string; /** * The destination region for the backup replication of the DB instance. For more info, see [Replicating automated backups to another Region](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html) in the *Amazon RDS User Guide*. */ automaticBackupReplicationRegion?: string; /** * The Availability Zone (AZ) where the database will be created. For information on AWS-Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html). For Amazon Aurora, each Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one. Default: A random, system-chosen Availability Zone in the endpoint's AWS-Region. Constraints: + The ``AvailabilityZone`` parameter can't be specified if the DB instance is a Multi-AZ deployment. + The specified Availability Zone must be in the same AWS-Region as the current endpoint. Example: ``us-east-1d`` */ availabilityZone?: string; /** * The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. *Amazon Aurora* Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: + Must be a value from 0 to 35 + Can't be set to 0 if the DB instance is a source to read replicas */ backupRetentionPeriod?: number; /** * The identifier of the CA certificate for this DB instance. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. */ caCertificateIdentifier?: string; /** * The details of the DB instance's server certificate. Returns the details of the DB instance’s server certificate. For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide*. */ certificateDetails?: outputs.awsconnector.CertificateDetailsResponse; /** * Specifies whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: + For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.* + For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide*. This setting doesn't apply to RDS Custom DB instances. */ certificateRotationRestart?: boolean; /** * For supported engines, indicates that the DB instance should be associated with the specified character set. *Amazon Aurora* Not applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html). */ characterSetName?: string; /** * Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting. */ copyTagsToSnapshot?: boolean; /** * The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints: + The profile must exist in your account. + The profile must have an IAM role that Amazon EC2 has permissions to assume. + The instance profile name and the associated IAM role name must start with the prefix ``AWSRDSCustom``. For the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide*. */ customIAMInstanceProfile?: string; /** * The identifier of the DB cluster that the instance will belong to. */ dbClusterIdentifier?: string; /** * The identifier for the Multi-AZ DB cluster snapshot to restore from. For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide*. Constraints: + Must match the identifier of an existing Multi-AZ DB cluster snapshot. + Can't be specified when ``DBSnapshotIdentifier`` is specified. + Must be specified when ``DBSnapshotIdentifier`` isn't specified. + If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the ``DBClusterSnapshotIdentifier`` must be the ARN of the shared snapshot. + Can't be the identifier of an Aurora DB cluster snapshot. */ dbClusterSnapshotIdentifier?: string; /** * Property dbInstanceArn */ dbInstanceArn?: string; /** * The compute and memory capacity of the DB instance, for example ``db.m5.large``. Not all DB instance classes are available in all AWS-Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see [DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* or [Aurora DB instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html) in the *Amazon Aurora User Guide*. */ dbInstanceClass?: string; /** * A name for the DB instance. If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. */ dbInstanceIdentifier?: string; /** * The meaning of this parameter differs according to the database engine you use. If you specify the ``DBSnapshotIdentifier`` property, this property only applies to RDS for Oracle. *Amazon Aurora* Not applicable. The database name is managed by the DB cluster. *Db2* The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Can't be a word reserved by the specified database engine. *MySQL* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine *MariaDB* The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints: + Must contain 1 to 64 letters or numbers. + Can't be a word reserved by the specified database engine *PostgreSQL* The name of the database to create when the DB instance is created. If this parameter is not specified, the default ``postgres`` database is created in the DB instance. Constraints: + Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). + Must contain 1 to 63 characters. + Can't be a word reserved by the specified database engine *Oracle* The Oracle System ID (SID) of the created DB instance. If you specify ``null``, the default value ``ORCL`` is used. You can't specify the string NULL, or any other reserved word, for ``DBName``. Default: ``ORCL`` Constraints: + Can't be longer than 8 characters *SQL Server* Not applicable. Must be null. */ dbName?: string; /** * The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template. To list all of the available DB parameter group names, use the following command: ``aws rds describe-db-parameter-groups --query 'DBParameterGroups[].DBParameterGroupName' --output text`` If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. If you don't specify a value for ``DBParameterGroupName`` property, the default DB parameter group for the specified engine and engine version is used. */ dbParameterGroupName?: string; /** * A list of the DB security groups to assign to the DB instance. The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template. If you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups. If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations: + ``AllocatedStorage`` + ``AutoMinorVersionUpgrade`` + ``AvailabilityZone`` + ``BackupRetentionPeriod`` + ``CharacterSetName`` + ``DBInstanceClass`` + ``DBName`` + ``DBParameterGroupName`` + ``DBSecurityGroups`` + ``DBSubnetGroupName`` + ``Engine`` + ``EngineVersion`` + ``Iops`` + ``LicenseModel`` + ``MasterUsername`` + ``MasterUserPassword`` + ``MultiAZ`` + ``OptionGroupName`` + ``PreferredBackupWindow`` + ``PreferredMaintenanceWindow`` All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as ``StorageType``, ``StorageEncrypted``, or ``KmsKeyId``. If you're already using the ``DBSecurityGroups`` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance. */ dbSecurityGroups?: string[]; /** * The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance. If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot. By specifying this property, you can create a DB instance from the specified DB snapshot. If the ``DBSnapshotIdentifier`` property is an empty string or the ``AWS::RDS::DBInstance`` declaration has no ``DBSnapshotIdentifier`` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack. Some DB instance properties aren't valid when you restore from a snapshot, such as the ``MasterUsername`` and ``MasterUserPassword`` properties. For information about the properties that you can specify, see the ``RestoreDBInstanceFromDBSnapshot`` action in the *Amazon RDS API Reference*. After you restore a DB instance with a ``DBSnapshotIdentifier`` property, you must specify the same ``DBSnapshotIdentifier`` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the ``DBSnapshotIdentifier`` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified ``DBSnapshotIdentifier`` property, and the original DB instance is deleted. If you specify the ``DBSnapshotIdentifier`` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties: + ``CharacterSetName`` + ``DBClusterIdentifier`` + ``DBName`` + ``DeleteAutomatedBackups`` + ``EnablePerformanceInsights`` + ``KmsKeyId`` + ``MasterUsername`` + ``MasterUserPassword`` + ``PerformanceInsightsKMSKeyId`` + ``PerformanceInsightsRetentionPeriod`` + ``PromotionTier`` + ``SourceDBInstanceIdentifier`` + ``SourceRegion`` + ``StorageEncrypted`` (for an encrypted snapshot) + ``Timezone`` *Amazon Aurora* Not applicable. Snapshot restore is managed by the DB cluster. */ dbSnapshotIdentifier?: string; /** * A DB subnet group to associate with the DB instance. If you update this value, the new subnet group must be a subnet group in a new VPC. If there's no DB subnet group, then the DB instance isn't a VPC DB instance. For more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. *Amazon Aurora* Not applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting. */ dbSubnetGroupName?: string; /** * The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term 'Oracle database instance' refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to ``RDSCDB``. The Oracle SID is also the name of your CDB. */ dbSystemId?: string; /** * Property dbiResourceId */ dbiResourceId?: string; /** * Indicates whether the DB instance has a dedicated log volume (DLV) enabled. */ dedicatedLogVolume?: boolean; /** * A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted. *Amazon Aurora* Not applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted. */ deleteAutomatedBackups?: boolean; /** * A value that indicates whether the DB instance has deletion protection enabled. The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html). *Amazon Aurora* Not applicable. You can enable or disable deletion protection for the DB cluster. For more information, see ``CreateDBCluster``. DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster. */ deletionProtection?: boolean; /** * The Active Directory directory ID to create the DB instance in. Currently, only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide*. */ domain?: string; /** * The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: ``arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`` */ domainAuthSecretArn?: string; /** * The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints: + Two IP addresses must be provided. If there isn't a secondary domain controller, use the IP address of the primary domain controller for both entries in the list. Example: ``123.124.125.126,234.235.236.237`` */ domainDnsIps?: string[]; /** * The fully qualified domain name (FQDN) of an Active Directory domain. Constraints: + Can't be longer than 64 characters. Example: ``mymanagedADtest.mymanagedAD.mydomain`` */ domainFqdn?: string; /** * The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances: + Amazon Aurora (The domain is managed by the DB cluster.) + RDS Custom */ domainIAMRoleName?: string; /** * The Active Directory organizational unit for your DB instance to join. Constraints: + Must be in the distinguished name format. + Can't be longer than 64 characters. Example: ``OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`` */ domainOu?: string; /** * The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide*. *Amazon Aurora* Not applicable. CloudWatch Logs exports are managed by the DB cluster. *Db2* Valid values: ``diag.log``, ``notify.log`` *MariaDB* Valid values: ``audit``, ``error``, ``general``, ``slowquery`` *Microsoft SQL Server* Valid values: ``agent``, ``error`` *MySQL* Valid values: ``audit``, ``error``, ``general``, ``slowquery`` *Oracle* Valid values: ``alert``, ``audit``, ``listener``, ``trace``, ``oemagent`` *PostgreSQL* Valid values: ``postgresql``, ``upgrade`` */ enableCloudwatchLogsExports?: string[]; /** * A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.* *Amazon Aurora* Not applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster. */ enableIAMDatabaseAuthentication?: boolean; /** * Specifies whether to enable Performance Insights for the DB instance. For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide*. This setting doesn't apply to RDS Custom DB instances. */ enablePerformanceInsights?: boolean; /** * The connection endpoint for the DB instance. The endpoint might not be shown for instances with the status of ``creating``. This data type represents the information you need to connect to an Amazon RDS DB instance. This data type is used as a response element in the following actions: + ``CreateDBInstance`` + ``DescribeDBInstances`` + ``DeleteDBInstance`` For the data structure that represents Amazon Aurora DB cluster endpoints, see ``DBClusterEndpoint``. */ endpoint?: outputs.awsconnector.RdsDbInstanceEndpointResponse; /** * The name of the database engine to use for this DB instance. Not every database engine is available in every AWS Region. This property is required when creating a DB instance. You can change the architecture of an Oracle database from the non-container database (CDB) architecture to the CDB architecture by updating the ``Engine`` value in your templates from ``oracle-ee`` or ``oracle-ee-cdb`` to ``oracle-se2-cdb``. Converting to the CDB architecture requires an interruption. Valid Values: + ``aurora-mysql`` (for Aurora MySQL DB instances) + ``aurora-postgresql`` (for Aurora PostgreSQL DB instances) + ``custom-oracle-ee`` (for RDS Custom for Oracle DB instances) + ``custom-oracle-ee-cdb`` (for RDS Custom for Oracle DB instances) + ``custom-sqlserver-ee`` (for RDS Custom for SQL Server DB instances) + ``custom-sqlserver-se`` (for RDS Custom for SQL Server DB instances) + ``custom-sqlserver-web`` (for RDS Custom for SQL Server DB instances) + ``db2-ae`` + ``db2-se`` + ``mariadb`` + ``mysql`` + ``oracle-ee`` + ``oracle-ee-cdb`` + ``oracle-se2`` + ``oracle-se2-cdb`` + ``postgres`` + ``sqlserver-ee`` + ``sqlserver-se`` + ``sqlserver-ex`` + ``sqlserver-web`` */ engine?: string; /** * The version number of the database engine to use. For a list of valid engine versions, use the ``DescribeDBEngineVersions`` action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region. *Amazon Aurora* Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. *Db2* See [Amazon RDS for Db2](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Db2.html#Db2.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* *MariaDB* See [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* *Microsoft SQL Server* See [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.* *MySQL* See [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.* *Oracle* See [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.* *PostgreSQL* See [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.* */ engineVersion?: string; /** * The number of I/O operations per second (IOPS) that the database provisions. The value must be equal to or greater than 1000. If you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide*. If you specify ``io1`` for the ``StorageType`` property, then you must also specify the ``Iops`` property. Constraints: + For RDS for Db2, MariaDB, MySQL, Oracle, and PostgreSQL - Must be a multiple between .5 and 50 of the storage amount for the DB instance. + For RDS for SQL Server - Must be a multiple between 1 and 50 of the storage amount for the DB instance. */ iops?: number; /** * The ARN of the AWS KMS key that's used to encrypt the DB instance, such as ``arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef``. If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true. If you specify the ``SourceDBInstanceIdentifier`` property, the value is inherited from the source DB instance if the read replica is created in the same region. If you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region. If you specify the ``SnapshotIdentifier`` property, the ``StorageEncrypted`` property value is inherited from the snapshot, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. If you specify ``DBSecurityGroups``, AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide*. *Amazon Aurora* Not applicable. The KMS key identifier is managed by the DB cluster. */ kmsKeyId?: string; /** * License model information for this DB instance. Valid Values: + Aurora MySQL - ``general-public-license`` + Aurora PostgreSQL - ``postgresql-license`` + RDS for Db2 - ``bring-your-own-license``. For more information about RDS for Db2 licensing, see [](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html) in the *Amazon RDS User Guide.* + RDS for MariaDB - ``general-public-license`` + RDS for Microsoft SQL Server - ``license-included`` + RDS for MySQL - ``general-public-license`` + RDS for Oracle - ``bring-your-own-license`` or ``license-included`` + RDS for PostgreSQL - ``postgresql-license`` If you've specified ``DBSecurityGroups`` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability. */ licenseModel?: string; /** * Specifies whether to manage the master user password with AWS Secrets Manager. For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* Constraints: + Can't manage the master user password with AWS Secrets Manager if ``MasterUserPassword`` is specified. */ manageMasterUserPassword?: boolean; /** * The password for the master user. The password can include any printable ASCII character except '/', ''', or '@'. *Amazon Aurora* Not applicable. The password for the master user is managed by the DB cluster. *RDS for Db2* Must contain from 8 to 255 characters. *RDS for MariaDB* Constraints: Must contain from 8 to 41 characters. *RDS for Microsoft SQL Server* Constraints: Must contain from 8 to 128 characters. *RDS for MySQL* Constraints: Must contain from 8 to 41 characters. *RDS for Oracle* Constraints: Must contain from 8 to 30 characters. *RDS for PostgreSQL* Constraints: Must contain from 8 to 128 characters. */ masterUserPassword?: string; /** * The secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.* The ``MasterUserSecret`` return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password. For more information, see [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.* */ masterUserSecret?: outputs.awsconnector.MasterUserSecretResponse; /** * The master user name for the DB instance. If you specify the ``SourceDBInstanceIdentifier`` or ``DBSnapshotIdentifier`` property, don't specify this property. The value is inherited from the source DB instance or snapshot. When migrating a self-managed Db2 database, we recommend that you use the same master username as your self-managed Db2 instance name. *Amazon Aurora* Not applicable. The name for the master user is managed by the DB cluster. *RDS for Db2* Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for MariaDB* Constraints: + Must be 1 to 16 letters or numbers. + Can't be a reserved word for the chosen database engine. *RDS for Microsoft SQL Server* Constraints: + Must be 1 to 128 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for MySQL* Constraints: + Must be 1 to 16 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for Oracle* Constraints: + Must be 1 to 30 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. *RDS for PostgreSQL* Constraints: + Must be 1 to 63 letters or numbers. + First character must be a letter. + Can't be a reserved word for the chosen database engine. */ masterUsername?: string; /** * The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide*. This setting doesn't apply to the following DB instances: + Amazon Aurora (Storage is managed by the DB cluster.) + RDS Custom */ maxAllocatedStorage?: number; /** * The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If ``MonitoringRoleArn`` is specified, then you must set ``MonitoringInterval`` to a value other than 0. This setting doesn't apply to RDS Custom. Valid Values: ``0, 1, 5, 10, 15, 30, 60`` */ monitoringInterval?: number; /** * The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, ``arn:aws:iam:123456789012:role/emaccess``. For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide*. If ``MonitoringInterval`` is set to a value other than ``0``, then you must supply a ``MonitoringRoleArn`` value. This setting doesn't apply to RDS Custom DB instances. */ monitoringRoleArn?: string; /** * Specifies whether the database instance is a Multi-AZ DB instance deployment. You can't set the ``AvailabilityZone`` parameter if the ``MultiAZ`` parameter is set to true. For more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide*. *Amazon Aurora* Not applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the ``MultiAZ`` option to be set. */ multiAZ?: boolean; /** * The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances. */ ncharCharacterSetName?: string; /** * The network type of the DB instance. Valid values: + ``IPV4`` + ``DUAL`` The network type is determined by the ``DBSubnetGroup`` specified for the DB instance. A ``DBSubnetGroup`` can support only the IPv4 protocol or the IPv4 and IPv6 protocols (``DUAL``). For more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.* */ networkType?: string; /** * Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance. */ optionGroupName?: string; /** * The AWS KMS key identifier for encryption of Performance Insights data. The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for ``PerformanceInsightsKMSKeyId``, then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region. For information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights). */ performanceInsightsKMSKeyId?: string; /** * The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values: + ``7`` + *month* * 31, where *month* is a number of months from 1-23. Examples: ``93`` (3 months * 31), ``341`` (11 months * 31), ``589`` (19 months * 31) + ``731`` Default: ``7`` days If you specify a retention period that isn't valid, such as ``94``, Amazon RDS returns an error. */ performanceInsightsRetentionPeriod?: number; /** * The port number on which the database accepts connections. *Amazon Aurora* Not applicable. The port number is managed by the DB cluster. *Db2* Default value: ``50000`` */ port?: string; /** * The daily time range during which automated backups are created if automated backups are enabled, using the ``BackupRetentionPeriod`` parameter. For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.* Constraints: + Must be in the format ``hh24:mi-hh24:mi``. + Must be in Universal Coordinated Time (UTC). + Must not conflict with the preferred maintenance window. + Must be at least 30 minutes. *Amazon Aurora* Not applicable. The daily time range for creating automated backups is managed by the DB cluster. */ preferredBackupWindow?: string; /** * The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). Format: ``ddd:hh24:mi-ddd:hh24:mi`` The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.* This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately. Constraints: Minimum 30-minute window. */ preferredMaintenanceWindow?: string; /** * The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. */ processorFeatures?: outputs.awsconnector.ProcessorFeatureResponse[]; /** * The order of priority in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide*. This setting doesn't apply to RDS Custom DB instances. Default: ``1`` Valid Values: ``0 - 15`` */ promotionTier?: number; /** * Indicates whether the DB instance is an internet-facing instance. If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address. The default behavior value depends on your VPC setup and the database subnet group. For more information, see the ``PubliclyAccessible`` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference*. */ publiclyAccessible?: boolean; /** * The open mode of an Oracle read replica. For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide*. This setting is only supported in RDS for Oracle. Default: ``open-read-only`` Valid Values: ``open-read-only`` or ``mounted`` */ replicaMode?: string; /** * The date and time to restore from. Constraints: + Must be a time in Universal Coordinated Time (UTC) format. + Must be before the latest restorable time for the DB instance. + Can't be specified if the ``UseLatestRestorableTime`` parameter is enabled. Example: ``2009-09-07T23:45:00Z`` */ restoreTime?: string; /** * The identifier of the Multi-AZ DB cluster that will act as the source for the read replica. Each DB cluster can have up to 15 read replicas. Constraints: + Must be the identifier of an existing Multi-AZ DB cluster. + Can't be specified if the ``SourceDBInstanceIdentifier`` parameter is also specified. + The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0. + The source DB cluster must be in the same AWS-Region as the read replica. Cross-Region replication isn't supported. */ sourceDBClusterIdentifier?: string; /** * The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, ``arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE``. This setting doesn't apply to RDS Custom. */ sourceDBInstanceAutomatedBackupsArn?: string; /** * If you want to create a read replica DB instance, specify the ID of the source DB instance. Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide*. For information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide*. The ``SourceDBInstanceIdentifier`` property determines whether a DB instance is a read replica. If you remove the ``SourceDBInstanceIdentifier`` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance. + If you specify a source DB instance that uses VPC security groups, we recommend that you specify the ``VPCSecurityGroups`` property. If you don't specify the property, the read replica inherits the value of the ``VPCSecurityGroups`` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's ``VPCSecurityGroups`` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues. + Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica. + If you specify ``SourceDBInstanceIdentifier``, don't specify the ``DBSnapshotIdentifier`` property. You can't create a read replica from a snapshot. + Don't set the ``BackupRetentionPeriod``, ``DBName``, ``MasterUsername``, ``MasterUserPassword``, and ``PreferredBackupWindow`` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas. + If the source DB instance is in a different region than the read replica, specify the source region in ``SourceRegion``, and specify an ARN for a valid DB instance in ``SourceDBInstanceIdentifier``. For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide*. + For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances. */ sourceDBInstanceIdentifier?: string; /** * The resource ID of the source DB instance from which to restore. */ sourceDbiResourceId?: string; /** * The ID of the region that contains the source DB instance for the read replica. */ sourceRegion?: string; /** * A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. If you specify the ``KmsKeyId`` property, then you must enable encryption. If you specify the ``SourceDBInstanceIdentifier`` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified ``KmsKeyId`` property is used. If you specify the ``DBSnapshotIdentifier`` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified ``KmsKeyId`` property is used. If you specify the ``DBSnapshotIdentifier`` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify the ``KmsKeyId`` property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to ``false``. *Amazon Aurora* Not applicable. The encryption for DB instances is managed by the DB cluster. */ storageEncrypted?: boolean; /** * Specifies the storage throughput value for the DB instance. This setting applies only to the ``gp3`` storage type. This setting doesn't apply to RDS Custom or Amazon Aurora. */ storageThroughput?: number; /** * The storage type to associate with the DB instance. If you specify ``io1``, ``io2``, or ``gp3``, you must also include a value for the ``Iops`` parameter. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: ``gp2 | gp3 | io1 | io2 | standard`` Default: ``io1``, if the ``Iops`` parameter is specified. Otherwise, ``gp2``. */ storageType?: string; /** * An optional array of key-value pairs to apply to this DB instance. */ tags?: outputs.awsconnector.TagResponse[]; /** * Property tdeCredentialArn */ tdeCredentialArn?: string; /** * Property tdeCredentialPassword */ tdeCredentialPassword?: string; /** * The time zone of the DB instance. The time zone parameter is currently supported only by [Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone). */ timezone?: string; /** * Specifies whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom DB instances. */ useDefaultProcessorFeatures?: boolean; /** * Specifies whether the DB instance is restored from the latest backup time. By default, the DB instance isn't restored from the latest backup time. Constraints: + Can't be specified if the ``RestoreTime`` parameter is provided. */ useLatestRestorableTime?: boolean; /** * A list of the VPC security group IDs to assign to the DB instance. The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template. If you plan to update the resource, don't specify VPC security groups in a shared VPC. If you set ``VPCSecurityGroups``, you must not set [DBSecurityGroups](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups), and vice versa. You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind: + You can't revert to using an RDS security group after you establish a VPC security group membership. + When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group. + To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [DBSecurityGroups](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property. To avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template. *Amazon Aurora* Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting. */ vpcSecurityGroups?: string[]; } /** * awsRdsDBInstancePropertiesResponseProvideDefaults sets the appropriate defaults for AwsRdsDBInstancePropertiesResponse */ function awsRdsDBInstancePropertiesResponseProvideDefaults(val: AwsRdsDBInstancePropertiesResponse): AwsRdsDBInstancePropertiesResponse; /** * Definition of awsRdsDBSnapshotAttributesResult */ interface AwsRdsDBSnapshotAttributesResultPropertiesResponse { /** *

The list of attributes and values for the manual DB snapshot.

*/ dbSnapshotAttributes?: outputs.awsconnector.DBSnapshotAttributeResponse[]; /** *

The identifier of the manual DB snapshot that the attributes apply to.

*/ dbSnapshotIdentifier?: string; } /** * Definition of awsRdsDBSnapshot */ interface AwsRdsDBSnapshotPropertiesResponse { /** *

Specifies the allocated storage size in gibibytes (GiB).

*/ allocatedStorage?: number; /** *

Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.

*/ availabilityZone?: string; /** *

Specifies the DB instance identifier of the DB instance this DB snapshot was created from.

*/ dbInstanceIdentifier?: string; /** *

The Amazon Resource Name (ARN) for the DB snapshot.

*/ dbSnapshotArn?: string; /** *

Specifies the identifier for the DB snapshot.

*/ dbSnapshotIdentifier?: string; /** *

The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. The Oracle SID is also the name of your CDB.

*/ dbSystemId?: string; /** *

The identifier for the source DB instance, which can't be changed and which is unique to an Amazon Web Services Region.

*/ dbiResourceId?: string; /** *

Indicates whether the DB instance has a dedicated log volume (DLV) enabled.

*/ dedicatedLogVolume?: boolean; /** *

Indicates whether the DB snapshot is encrypted.

*/ encrypted?: boolean; /** *

Specifies the name of the database engine.

*/ engine?: string; /** *

Specifies the version of the database engine.

*/ engineVersion?: string; /** *

Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

*/ iamDatabaseAuthenticationEnabled?: boolean; /** *

Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.

*/ instanceCreateTime?: string; /** *

Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.

*/ iops?: number; /** *

If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.

The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

*/ kmsKeyId?: string; /** *

License model information for the restored DB instance.

*/ licenseModel?: string; /** *

Provides the master username for the DB snapshot.

*/ masterUsername?: string; /** *

Indicates whether the snapshot is of a DB instance using the multi-tenant configuration (TRUE) or the single-tenant configuration (FALSE).

*/ multiTenant?: boolean; /** *

Provides the option group name for the DB snapshot.

*/ optionGroupName?: string; /** *

Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn't change when the snapshot is copied.

*/ originalSnapshotCreateTime?: string; /** *

The percentage of the estimated data that has been transferred.

*/ percentProgress?: number; /** *

Specifies the port that the database engine was listening on at the time of the snapshot.

*/ port?: number; /** *

The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.

*/ processorFeatures?: outputs.awsconnector.ProcessorFeatureResponse[]; /** *

Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.

*/ snapshotCreateTime?: string; /** *

The timestamp of the most recent transaction applied to the database that you're backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.

If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.

*/ snapshotDatabaseTime?: string; /** *

Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.

*/ snapshotTarget?: string; /** *

Provides the type of the DB snapshot.

*/ snapshotType?: string; /** *

The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.

*/ sourceDBSnapshotIdentifier?: string; /** *

The Amazon Web Services Region that the DB snapshot was created in or copied from.

*/ sourceRegion?: string; /** *

Specifies the status of this DB snapshot.

*/ status?: string; /** *

Specifies the storage throughput for the DB snapshot.

*/ storageThroughput?: number; /** *

Specifies the storage type associated with DB snapshot.

*/ storageType?: string; /** * Property tagList */ tagList?: outputs.awsconnector.TagResponse[]; /** *

The ARN from the key store with which to associate the instance for TDE encryption.

*/ tdeCredentialArn?: string; /** *

The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.

*/ timezone?: string; /** *

Provides the VPC ID associated with the DB snapshot.

*/ vpcId?: string; } /** * Definition of awsRdsEventSubscription */ interface AwsRdsEventSubscriptionPropertiesResponse { /** * A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it. */ enabled?: boolean; /** * A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action. */ eventCategories?: string[]; /** * The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. */ snsTopicArn?: string; /** * The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens. */ sourceIds?: string[]; /** * The type of source that will be generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned. */ sourceType?: string; /** * The name of the subscription. */ subscriptionName?: string; /** * An array of key-value pairs to apply to this resource. */ tags?: outputs.awsconnector.TagResponse[]; } /** * awsRdsEventSubscriptionPropertiesResponseProvideDefaults sets the appropriate defaults for AwsRdsEventSubscriptionPropertiesResponse */ function awsRdsEventSubscriptionPropertiesResponseProvideDefaults(val: AwsRdsEventSubscriptionPropertiesResponse): AwsRdsEventSubscriptionPropertiesResponse; /** * Definition of awsRdsExportTask */ interface AwsRdsExportTaskPropertiesResponse { /** *

The data exported from the snapshot or cluster.

Valid Values:

  • database - Export all the data from a specified database.

  • database.table table-name - Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.

  • database.schema schema-name - Export a database schema of the snapshot or cluster. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

  • database.schema.table table-name - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.

*/ exportOnly?: string[]; /** *

A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for the Amazon S3 bucket where the data is exported.

*/ exportTaskIdentifier?: string; /** *

The reason the export failed, if it failed.

*/ failureCause?: string; /** *

The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.

*/ iamRoleArn?: string; /** *

The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3. The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export must have encryption and decryption permissions to use this KMS key.

*/ kmsKeyId?: string; /** *

The progress of the snapshot or cluster export task as a percentage.

*/ percentProgress?: number; /** *

The Amazon S3 bucket where the snapshot or cluster is exported to.

*/ s3Bucket?: string; /** *

The Amazon S3 bucket prefix that is the file name and path of the exported data.

*/ s3Prefix?: string; /** *

The time when the snapshot was created.

*/ snapshotTime?: string; /** *

The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.

*/ sourceArn?: string; /** *

The type of source for the export.

*/ sourceType?: outputs.awsconnector.ExportSourceTypeEnumValueResponse; /** *

The progress status of the export task. The status can be one of the following:

  • CANCELED

  • CANCELING

  • COMPLETE

  • FAILED

  • IN_PROGRESS

  • STARTING

*/ status?: string; /** *

The time when the snapshot or cluster export task ended.

*/ taskEndTime?: string; /** *

The time when the snapshot or cluster export task started.

*/ taskStartTime?: string; /** *

The total amount of data exported, in gigabytes.

*/ totalExtractedDataInGB?: number; /** *

A warning about the snapshot or cluster export task.

*/ warningMessage?: string; } /** * Definition of awsRedshiftClusterParameterGroup */ interface AwsRedshiftClusterParameterGroupPropertiesResponse { /** * A description of the parameter group. */ description?: string; /** * The Amazon Redshift engine version to which the cluster parameter group applies. The cluster engine version determines the set of parameters. */ parameterGroupFamily?: string; /** * The name of the cluster parameter group. */ parameterGroupName?: string; /** * An array of parameters to be modified. A maximum of 20 parameters can be modified in a single request. */ parameters?: outputs.awsconnector.ParameterRedshiftClusterParameterGroupResponse[]; /** * An array of key-value pairs to apply to this resource. */ tags?: outputs.awsconnector.TagResponse[]; } /** * Definition of awsRedshiftCluster */ interface AwsRedshiftClusterPropertiesResponse { /** * Major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default value is True */ allowVersionUpgrade?: boolean; /** * The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values include the following.enabled - Use AQUA if it is available for the current Region and Amazon Redshift node type.disabled - Don't use AQUA.auto - Amazon Redshift determines whether to use AQUA. */ aquaConfigurationStatus?: string; /** * The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Default value is 1 */ automatedSnapshotRetentionPeriod?: number; /** * The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint */ availabilityZone?: string; /** * The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster modification is complete. */ availabilityZoneRelocation?: boolean; /** * The availability zone relocation status of the cluster */ availabilityZoneRelocationStatus?: string; /** * A boolean value indicating whether the resize operation is using the classic resize process. If you don't provide this parameter or set the value to false , the resize type is elastic. */ classic?: boolean; /** * A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. All alphabetical characters must be lower case, no hypens at the end, no two consecutive hyphens. Cluster name should be unique for all clusters within an AWS account */ clusterIdentifier?: string; /** * The Amazon Resource Name (ARN) of the cluster namespace. */ clusterNamespaceArn?: string; /** * The name of the parameter group to be associated with this cluster. */ clusterParameterGroupName?: string; /** * A list of security groups to be associated with this cluster. */ clusterSecurityGroups?: string[]; /** * The name of a cluster subnet group to be associated with this cluster. */ clusterSubnetGroupName?: string; /** * The type of the cluster. When cluster type is specified as single-node, the NumberOfNodes parameter is not required and if multi-node, the NumberOfNodes parameter is required */ clusterType?: string; /** * The version of the Amazon Redshift engine software that you want to deploy on the cluster.The version selected runs on all the nodes in the cluster. */ clusterVersion?: string; /** * The name of the first database to be created when the cluster is created. To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. */ dbName?: string; /** * A boolean indicating whether to enable the deferred maintenance window. */ deferMaintenance?: boolean; /** * An integer indicating the duration of the maintenance window in days. If you specify a duration, you can't specify an end time. The duration must be 45 days or less. */ deferMaintenanceDuration?: number; /** * A timestamp indicating end time for the deferred maintenance window. If you specify an end time, you can't specify a duration. */ deferMaintenanceEndTime?: string; /** * A unique identifier for the deferred maintenance window. */ deferMaintenanceIdentifier?: string; /** * A timestamp indicating the start time for the deferred maintenance window. */ deferMaintenanceStartTime?: string; /** * The destination AWS Region that you want to copy snapshots to. Constraints: Must be the name of a valid AWS Region. For more information, see Regions and Endpoints in the Amazon Web Services [https://docs.aws.amazon.com/general/latest/gr/rande.html#redshift_region] General Reference */ destinationRegion?: string; /** * The Elastic IP (EIP) address for the cluster. */ elasticIp?: string; /** * If true, the data in the cluster is encrypted at rest. */ encrypted?: boolean; /** * Property endpoint */ endpoint?: outputs.awsconnector.RedshiftClusterEndpointResponse; /** * An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.If this option is true , enhanced VPC routing is enabled.Default: false */ enhancedVpcRouting?: boolean; /** * Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM */ hsmClientCertificateIdentifier?: string; /** * Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM. */ hsmConfigurationIdentifier?: string; /** * A list of AWS Identity and Access Management (IAM) roles that can be used by the cluster to access other AWS services. You must supply the IAM roles in their Amazon Resource Name (ARN) format. You can supply up to 50 IAM roles in a single request */ iamRoles?: string[]; /** * The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster. */ kmsKeyId?: string; /** * Property loggingProperties */ loggingProperties?: outputs.awsconnector.LoggingPropertiesResponse; /** * The name for the maintenance track that you want to assign for the cluster. This name change is asynchronous. The new track name stays in the PendingModifiedValues for the cluster until the next maintenance window. When the maintenance track changes, the cluster is switched to the latest cluster release available for the maintenance track. At this point, the maintenance track name is applied. */ maintenanceTrackName?: string; /** * A boolean indicating if the redshift cluster's admin user credentials is managed by Redshift or not. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password. */ manageMasterPassword?: boolean; /** * The number of days to retain newly copied snapshots in the destination AWS Region after they are copied from the source AWS Region. If the value is -1, the manual snapshot is retained indefinitely.The value must be either -1 or an integer between 1 and 3,653. */ manualSnapshotRetentionPeriod?: number; /** * The Amazon Resource Name (ARN) for the cluster's admin user credentials secret. */ masterPasswordSecretArn?: string; /** * The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin user credentials secret. */ masterPasswordSecretKmsKeyId?: string; /** * The password associated with the master user account for the cluster that is being created. You can't use MasterUserPassword if ManageMasterPassword is true. Password must be between 8 and 64 characters in length, should have at least one uppercase letter.Must contain at least one lowercase letter.Must contain one number.Can be any printable ASCII character. */ masterUserPassword?: string; /** * The user name associated with the master user account for the cluster that is being created. The user name can't be PUBLIC and first character must be a letter. */ masterUsername?: string; /** * A boolean indicating if the redshift cluster is multi-az or not. If you don't provide this parameter or set the value to false, the redshift cluster will be single-az. */ multiAZ?: boolean; /** * The namespace resource policy document that will be attached to a Redshift cluster. */ namespaceResourcePolicy?: any; /** * The node type to be provisioned for the cluster.Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.4xlarge | ra3.16xlarge */ nodeType?: string; /** * The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. */ numberOfNodes?: number; /** * Property ownerAccount */ ownerAccount?: string; /** * The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings */ port?: number; /** * The weekly time range (in UTC) during which automated cluster maintenance can occur. */ preferredMaintenanceWindow?: string; /** * If true, the cluster can be accessed from a public network. */ publiclyAccessible?: boolean; /** * The Redshift operation to be performed. Resource Action supports pause-cluster, resume-cluster, failover-primary-compute APIs */ resourceAction?: string; /** * The identifier of the database revision. You can retrieve this value from the response to the DescribeClusterDbRevisions request. */ revisionTarget?: string; /** * A boolean indicating if we want to rotate Encryption Keys. */ rotateEncryptionKey?: boolean; /** * The name of the cluster the source snapshot was created from. This parameter is required if your IAM user has a policy containing a snapshot resource element that specifies anything other than * for the cluster name. */ snapshotClusterIdentifier?: string; /** * The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region. */ snapshotCopyGrantName?: string; /** * Indicates whether to apply the snapshot retention period to newly copied manual snapshots instead of automated snapshots. */ snapshotCopyManual?: boolean; /** * The number of days to retain automated snapshots in the destination region after they are copied from the source region. Default is 7. Constraints: Must be at least 1 and no more than 35. */ snapshotCopyRetentionPeriod?: number; /** * The name of the snapshot from which to create the new cluster. This parameter isn't case sensitive. */ snapshotIdentifier?: string; /** * The list of tags for the cluster parameter group. */ tags?: outputs.awsconnector.TagResponse[]; /** * A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. */ vpcSecurityGroupIds?: string[]; } /** * Definition of awsRoute53DomainsDomainSummary */ interface AwsRoute53DomainsDomainSummaryPropertiesResponse { /** *

Indicates whether the domain is automatically renewed upon expiration.

*/ autoRenew?: boolean; /** *

The name of the domain that the summary information applies to.

*/ domainName?: string; /** *

Expiration date of the domain in Unix time format and Coordinated Universal Time (UTC).

*/ expiry?: string; /** *

Indicates whether a domain is locked from unauthorized transfer to another party.

*/ transferLock?: boolean; } /** * Definition of awsRoute53HostedZone */ interface AwsRoute53HostedZonePropertiesResponse { /** * A complex type that contains an optional comment. If you don't want to specify a comment, omit the ``HostedZoneConfig`` and ``Comment`` elements. A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, omit both the ``HostedZoneConfig`` and ``Comment`` elements. */ hostedZoneConfig?: outputs.awsconnector.HostedZoneConfigResponse; /** * Adds, edits, or deletes tags for a health check or a hosted zone. For information about using tags for cost allocation, see [Using Cost Allocation Tags](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) in the *User Guide*. */ hostedZoneTags?: outputs.awsconnector.HostedZoneTagResponse[]; /** * Property id */ id?: string; /** * The name of the domain. Specify a fully qualified domain name, for example, *www.example.com*. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats *www.example.com* (without a trailing dot) and *www.example.com.* (with a trailing dot) as identical. If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of ``NameServers`` that are returned by the ``Fn::GetAtt`` intrinsic function. */ name?: string; /** * Property nameServers */ nameServers?: string[]; /** * Creates a configuration for DNS query logging. After you create a query logging configuration, Amazon Route 53 begins to publish log data to an Amazon CloudWatch Logs log group. DNS query logs contain information about the queries that Route 53 receives for a specified public hosted zone, such as the following: + Route 53 edge location that responded to the DNS query + Domain or subdomain that was requested + DNS record type, such as A or AAAA + DNS response code, such as ``NoError`` or ``ServFail`` + Log Group and Resource Policy Before you create a query logging configuration, perform the following operations. If you create a query logging configuration using the Route 53 console, Route 53 performs these operations automatically. Create a CloudWatch Logs log group, and make note of the ARN, which you specify when you create a query logging configuration. Note the following: You must create the log group in the us-east-1 region. You must use the same to create the log group and the hosted zone that you want to configure query logging for. When you create log groups for query logging, we recommend that you use a consistent prefix, for example: /aws/route53/hosted zone name In the next step, you'll create a resource policy, which controls access to one or more log groups and the associated resources, such as Route 53 hosted zones. There's a limit on the number of resource policies that you can create, so we recommend that you use a consistent prefix so you can use the same resource policy for all the log groups that you create for query logging. Create a CloudWatch Logs resource policy, and give it the permissions that Route 53 needs to create log streams and to send query logs to log streams. For the value of Resource, specify the ARN for the log group that you created in the previous step. To use the same resource policy for all the CloudWatch Logs log groups that you created for query logging configurations, replace the hosted zone name with *, for example: arn:aws:logs:us-east-1:123412341234:log-group:/aws/route53/* To avoid the confused deputy problem, a security issue where an entity without a permission for an action can coerce a more-privileged entity to perform it, you can optionally limit the permissions that a service has to a resource in a resource-based policy by supplying the following values: For aws:SourceArn, supply the hosted zone ARN used in creating the query logging configuration. For example, aws:SourceArn: arn:aws:route53:::hostedzone/hosted zone ID. For aws:SourceAccount, supply the account ID for the account that creates the query logging configuration. For example, aws:SourceAccount:111111111111. For more information, see The confused deputy problem in the IAM User Guide. You can't use the CloudWatch console to create or edit a resource policy. You must use the CloudWatch API, one of the SDKs, or the . + Log Streams and Edge Locations When Route 53 finishes creating the configuration for DNS query logging, it does the following: Creates a log stream for an edge location the first time that the edge location responds to DNS queries for the specified hosted zone. That log stream is used to log all queries that Route 53 responds to for that edge location. Begins to send query logs to the applicable log stream. The name of each log stream is in the following format: hosted zone ID/edge location code The edge location code is a three-letter code and an arbitrarily assigned number, for example, DFW3. The three-letter code typically corresponds with the International Air Transport Association airport code for an airport near the edge location. (These abbreviations might change in the future.) For a list of edge locations, see 'The Route 53 Global Network' on the Route 53 Product Details page. + Queries That Are Logged Query logs contain only the queries that DNS resolvers forward to Route 53. If a DNS resolver has already cached the response to a query (such as the IP address for a load balancer for example.com), the resolver will continue to return the cached response. It doesn't forward another query to Route 53 until the TTL for the corresponding resource record set expires. Depending on how many DNS queries are submitted for a resource record set, and depending on the TTL for that resource record set, query logs might contain information about only one query out of every several thousand queries that are submitted to DNS. For more information about how DNS works, see Routing Internet Traffic to Your Website or Web Application in the Amazon Route 53 Developer Guide. + Log File Format For a list of the values in each query log and the format of each value, see Logging DNS Queries in the Amazon Route 53 Developer Guide. + Pricing For information about charges for query logs, see Amazon CloudWatch Pricing. + How to Stop Logging If you want Route 53 to stop sending query logs to CloudWatch Logs, delete the query logging configuration. For more information, see DeleteQueryLoggingConfig. A complex type that contains information about a configuration for DNS query logging. */ queryLoggingConfig?: outputs.awsconnector.QueryLoggingConfigResponse; /** * *Private hosted zones:* A complex type that contains information about the VPCs that are associated with the specified hosted zone. For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``. */ vpCs?: outputs.awsconnector.VPCResponse[]; } /** * Definition of awsRoute53ResourceRecordSet */ interface AwsRoute53ResourceRecordSetPropertiesResponse { /** *

Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.

If you're creating resource records sets for a private hosted zone, note the following:

  • You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.

  • For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.

*/ aliasTarget?: outputs.awsconnector.AliasTargetResponse; /** * Property cidrRoutingConfig */ cidrRoutingConfig?: outputs.awsconnector.CidrRoutingConfigResponse; /** *

Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.

Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets:

  • When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.

  • When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.

  • When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.

  • If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.

You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets.

For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.

For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide:

*/ failover?: outputs.awsconnector.ResourceRecordSetFailoverEnumValueResponse; /** *

Geolocation resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF.

If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.

You can't create two geolocation resource record sets that specify the same geographic location.

The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements.

Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *. Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Route 53 returns a 'no answer' response for queries from those locations.

You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets.

*/ geoLocation?: outputs.awsconnector.GeoLocationResponse; /** *

GeoproximityLocation resource record sets only: A complex type that lets you control how Route 53 responds to DNS queries based on the geographic origin of the query and your resources.

*/ geoProximityLocation?: outputs.awsconnector.GeoProximityLocationResponse; /** *

If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.

Route 53 determines whether a resource record set is healthy based on one of the following:

  • By periodically sending a request to the endpoint that is specified in the health check

  • By aggregating the status of a specified group of health checks (calculated health checks)

  • By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)

Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check.

For more information, see the following topics in the Amazon Route 53 Developer Guide:

When to Specify HealthCheckId

Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:

  • Non-alias resource record sets: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets.

    If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.

    If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.

    If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.

  • Alias resource record sets: You specify the following settings:

    • You set EvaluateTargetHealth to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A).

    • You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.

    • You specify a health check ID for the non-alias resource record set.

    If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.

    If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.

    The alias resource record set can also route traffic to a group of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.

Geolocation Routing

For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has * for CountryCode is *, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:

  • The United States

  • North America

  • The default resource record set

Specifying the Health Check Endpoint by Domain Name

If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

Health check results will be unpredictable if you do the following:

  • Create a health check that has the same value for FullyQualifiedDomainName as the name of a resource record set.

  • Associate that health check with the resource record set.

*/ healthCheckId?: string; /** *

Multivalue answer resource record sets only: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer. Note the following:

  • If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.

  • If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.

  • Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.

  • If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.

  • When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.

  • If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.

You can't create multivalue answer alias records.

*/ multiValueAnswer?: boolean; /** *

For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone.

ChangeResourceRecordSets Only

Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.

You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following:

  • The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com.

  • The * can't replace any of the middle labels, for example, marketing.*.example.com.

  • If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.

    You can't use the * wildcard for resource records sets that have a type of NS.

*/ name?: string; /** *

Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an Amazon Web Services resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.

When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.

Note the following:

  • You can only specify one ResourceRecord per latency resource record set.

  • You can only create one latency resource record set for each Amazon EC2 Region.

  • You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.

  • You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.

*/ region?: outputs.awsconnector.ResourceRecordSetRegionEnumValueResponse; /** *

Information about the resource records to act upon.

If you're creating an alias resource record set, omit ResourceRecords.

*/ resourceRecords?: outputs.awsconnector.ResourceRecordResponse[]; /** *

Resource record sets that have a routing policy other than simple: An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of SetIdentifier must be unique for each resource record set.

For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.

*/ setIdentifier?: string; /** *

When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. TrafficPolicyInstanceId is the ID of the traffic policy instance that Route 53 created this resource record set for.

To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Route 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.

*/ trafficPolicyInstanceId?: string; /** *

The resource record cache time to live (TTL), in seconds. Note the following:

  • If you're creating or updating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL for the alias target.

  • If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status.

  • All of the resource record sets in a group of weighted resource record sets must have the same value for TTL.

  • If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for Weight.

*/ ttl?: number; /** *

The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

Valid values for basic resource record sets: A | AAAA | CAA | CNAME | DS |MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.

Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT

SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF. RFC 7208, Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1, has been updated to say, '...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it.' In RFC 7208, see section 14.1, The SPF DNS Record Type.

Values for alias resource record sets:

  • Amazon API Gateway custom regional APIs and edge-optimized APIs: A

  • CloudFront distributions: A

    If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA.

  • Amazon API Gateway environment that has a regionalized subdomain: A

  • ELB load balancers: A | AAAA

  • Amazon S3 buckets: A

  • Amazon Virtual Private Cloud interface VPC endpoints A

  • Another resource record set in this hosted zone: Specify the type of the resource record set that you're creating the alias for. All values are supported except NS and SOA.

    If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.

*/ type?: outputs.awsconnector.RRTypeEnumValueResponse; /** *

Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:

  • You must specify a value for the Weight element for every weighted resource record set.

  • You can only specify one ResourceRecord per weighted resource record set.

  • You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets.

  • You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements.

  • For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.

    The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.

*/ weight?: number; } /** * Definition of awsS3AccessControlPolicy */ interface AwsS3AccessControlPolicyPropertiesResponse { /** *

A list of grants.

*/ grants?: outputs.awsconnector.GrantResponse[]; /** *

Container for the bucket owner's display name and ID.

*/ owner?: outputs.awsconnector.OwnerResponse; } /** * Definition of awsS3AccessPoint */ interface AwsS3AccessPointPropertiesResponse { /** * The alias of this Access Point. This alias can be used for compatibility purposes with other AWS services and third-party applications. */ alias?: string; /** * The Amazon Resource Name (ARN) of the specified accesspoint. the Amazon Resource Name (ARN) of the specified accesspoint. */ arn?: string; /** * The name of the bucket that you want to associate this Access Point with. */ bucket?: string; /** * The AWS account ID associated with the S3 bucket associated with this access point. */ bucketAccountId?: string; /** * The name you want to assign to this Access Point. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the access point name. */ name?: string; /** * Indicates whether this Access Point allows access from the public Internet. If VpcConfiguration is specified for this Access Point, then NetworkOrigin is VPC, and the Access Point doesn't allow access from the public Internet. Otherwise, NetworkOrigin is Internet, and the Access Point allows access from the public Internet, subject to the Access Point and bucket access policies. */ networkOrigin?: string; /** * The Access Point Policy you want to apply to this access point. */ policy?: any; /** * The PublicAccessBlock configuration that you want to apply to this Access Point. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status 'The Meaning of Public' in the Amazon Simple Storage Service Developer Guide. */ publicAccessBlockConfiguration?: outputs.awsconnector.PublicAccessBlockConfigurationResponse; /** * If you include this field, Amazon S3 restricts access to this Access Point to requests from the specified Virtual Private Cloud (VPC). The Virtual Private Cloud (VPC) configuration for a bucket access point. */ vpcConfiguration?: outputs.awsconnector.VpcConfigurationResponse; } /** * Definition of awsS3BucketPolicy */ interface AwsS3BucketPolicyPropertiesResponse { /** *

The bucket policy as a JSON document.

*/ policy?: string; } /** * Definition of awsS3Bucket */ interface AwsS3BucketPropertiesResponse { /** * Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*. Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see [Amazon S3 Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the *Amazon S3 User Guide*. */ accelerateConfiguration?: outputs.awsconnector.AccelerateConfigurationResponse; /** * This is a legacy property, and it is not recommended for most use cases. A majority of modern use cases in Amazon S3 no longer require the use of ACLs, and we recommend that you keep ACLs disabled. For more information, see [Controlling object ownership](https://docs.aws.amazon.com//AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*. A canned access control list (ACL) that grants predefined permissions to the bucket. For more information about canned ACLs, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 User Guide*. S3 buckets are created with ACLs disabled by default. Therefore, unless you explicitly set the [AWS::S3::OwnershipControls](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-ownershipcontrols.html) property to enable ACLs, your resource will fail to deploy with any value other than Private. Use cases requiring ACLs are uncommon. The majority of access control configurations can be successfully and more easily achieved with bucket policies. For more information, see [AWS::S3::BucketPolicy](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-s3-policy.html). For examples of common policy configurations, including S3 Server Access Logs buckets and more, see [Bucket policy examples](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) in the *Amazon S3 User Guide*. */ accessControl?: string; /** * Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket. */ analyticsConfigurations?: outputs.awsconnector.AnalyticsConfigurationResponse[]; /** * the Amazon Resource Name (ARN) of the specified bucket. */ arn?: string; /** * Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*. Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3), AWS KMS-managed keys (SSE-KMS), or dual-layer server-side encryption with KMS-managed keys (DSSE-KMS). For information about the Amazon S3 default encryption feature, see [Amazon S3 Default Encryption for S3 Buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the *Amazon S3 User Guide*. */ bucketEncryption?: outputs.awsconnector.BucketEncryptionResponse; /** * A name for the bucket. If you don't specify a name, AWS CloudFormation generates a unique ID and uses that ID for the bucket name. The bucket name must contain only lowercase letters, numbers, periods (.), and dashes (-) and must follow [Amazon S3 bucket restrictions and limitations](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html). For more information, see [Rules for naming Amazon S3 buckets](https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules) in the *Amazon S3 User Guide*. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you need to replace the resource, specify a new name. */ bucketName?: string; /** * Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*. Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see [Enabling Cross-Origin Resource Sharing](https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the *Amazon S3 User Guide*. */ corsConfiguration?: outputs.awsconnector.CorsConfigurationResponse; /** * Property domainName */ domainName?: string; /** * Property dualStackDomainName */ dualStackDomainName?: string; /** * Defines how Amazon S3 handles Intelligent-Tiering storage. */ intelligentTieringConfigurations?: outputs.awsconnector.IntelligentTieringConfigurationResponse[]; /** * Specifies the inventory configuration for an Amazon S3 bucket. For more information, see [GET Bucket inventory](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketGETInventoryConfig.html) in the *Amazon S3 API Reference*. */ inventoryConfigurations?: outputs.awsconnector.InventoryConfigurationResponse[]; /** * Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*. Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see [Object Lifecycle Management](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the *Amazon S3 User Guide*. */ lifecycleConfiguration?: outputs.awsconnector.LifecycleConfigurationResponse; /** * Settings that define where logs are stored. Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For examples and more information, see [PUT Bucket logging](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTlogging.html) in the *Amazon S3 API Reference*. To successfully complete the ``AWS::S3::Bucket LoggingConfiguration`` request, you must have ``s3:PutObject`` and ``s3:PutObjectAcl`` in your IAM permissions. */ loggingConfiguration?: outputs.awsconnector.LoggingConfigurationResponse; /** * Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. For more information, see [PutBucketMetricsConfiguration](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTMetricConfiguration.html). */ metricsConfigurations?: outputs.awsconnector.MetricsConfigurationResponse[]; /** * Configuration that defines how Amazon S3 handles bucket notifications. Describes the notification configuration for an Amazon S3 bucket. If you create the target resource and related permissions in the same template, you might have a circular dependency. For example, you might use the ``AWS::Lambda::Permission`` resource to grant the bucket permission to invoke an AWS Lambda function. However, AWS CloudFormation can't create the bucket until the bucket has permission to invoke the function (AWS CloudFormation checks whether the bucket can invoke the function). If you're using Refs to pass the bucket name, this leads to a circular dependency. To avoid this dependency, you can create all resources without specifying the notification configuration. Then, update the stack with a notification configuration. For more information on permissions, see [AWS::Lambda::Permission](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-permission.html) and [Granting Permissions to Publish Event Notification Messages to a Destination](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html#grant-destinations-permissions-to-s3). */ notificationConfiguration?: outputs.awsconnector.NotificationConfigurationResponse; /** * This operation is not supported by directory buckets. Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). + The ``DefaultRetention`` settings require both a mode and a period. + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time. + You can enable Object Lock for new or existing buckets. For more information, see [Configuring Object Lock](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lock-configure.html). Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see [Locking Objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). */ objectLockConfiguration?: outputs.awsconnector.ObjectLockConfigurationResponse; /** * Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket. */ objectLockEnabled?: boolean; /** * Configuration that defines how Amazon S3 handles Object Ownership rules. Specifies the container element for Object Ownership rules. S3 Object Ownership is an Amazon S3 bucket-level setting that you can use to disable access control lists (ACLs) and take ownership of every object in your bucket, simplifying access management for data stored in Amazon S3. For more information, see [Controlling ownership of objects and disabling ACLs](https://docs.aws.amazon.com/AmazonS3/latest/userguide/about-object-ownership.html) in the *Amazon S3 User Guide*. */ ownershipControls?: outputs.awsconnector.OwnershipControlsResponse; /** * Configuration that defines how Amazon S3 handles public access. The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see [The Meaning of 'Public'](https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status) in the *Amazon S3 User Guide*. */ publicAccessBlockConfiguration?: outputs.awsconnector.PublicAccessBlockConfigurationResponse; /** * Property regionalDomainName */ regionalDomainName?: string; /** * Configuration for replicating objects in an S3 bucket. To enable replication, you must also enable versioning by using the ``VersioningConfiguration`` property. Amazon S3 can store replicated objects in a single destination bucket or multiple destination buckets. The destination bucket or buckets must already exist. A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB. The latest version of the replication configuration XML is V2. For more information about XML V2 replication configurations, see [Replication configuration](https://docs.aws.amazon.com/AmazonS3/latest/userguide/replication-add-config.html) in the *Amazon S3 User Guide*. */ replicationConfiguration?: outputs.awsconnector.ReplicationConfigurationS3BucketResponse; /** * An arbitrary set of tags (key-value pairs) for this S3 bucket. */ tags?: outputs.awsconnector.TagResponse[]; /** * Enables multiple versions of all objects in this bucket. You might enable versioning to prevent objects from being deleted or overwritten by mistake or to archive objects so that you can retrieve previous versions of them. Describes the versioning state of an Amazon S3 bucket. For more information, see [PUT Bucket versioning](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html) in the *Amazon S3 API Reference*. */ versioningConfiguration?: outputs.awsconnector.VersioningConfigurationResponse; /** * Information used to configure the bucket as a static website. For more information, see [Hosting Websites on Amazon S3](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). Specifies website configuration parameters for an Amazon S3 bucket. */ websiteConfiguration?: outputs.awsconnector.WebsiteConfigurationResponse; /** * Property websiteURL */ websiteURL?: string; } /** * awsS3BucketPropertiesResponseProvideDefaults sets the appropriate defaults for AwsS3BucketPropertiesResponse */ function awsS3BucketPropertiesResponseProvideDefaults(val: AwsS3BucketPropertiesResponse): AwsS3BucketPropertiesResponse; /** * Definition of awsS3ControlMultiRegionAccessPointPolicyDocument */ interface AwsS3ControlMultiRegionAccessPointPolicyDocumentPropertiesResponse { /** *

The last established policy for the Multi-Region Access Point.

*/ established?: outputs.awsconnector.EstablishedMultiRegionAccessPointPolicyResponse; /** *

The proposed policy for the Multi-Region Access Point.

*/ proposed?: outputs.awsconnector.ProposedMultiRegionAccessPointPolicyResponse; } /** * Definition of awsSageMakerApp */ interface AwsSageMakerAppPropertiesResponse { /** * The Amazon Resource Name (ARN) of the app. */ appArn?: string; /** * The name of the app. */ appName?: string; /** * The type of app. */ appType?: string; /** * The domain ID. */ domainId?: string; /** * The instance type and the Amazon Resource Name (ARN) of the SageMaker image created on the instance. */ resourceSpec?: outputs.awsconnector.ResourceSpecResponse; /** * A list of tags to apply to the app. */ tags?: outputs.awsconnector.TagResponse[]; /** * The user profile name. */ userProfileName?: string; } /** * Definition of awsSageMakerNotebookInstanceSummary */ interface AwsSageMakerNotebookInstanceSummaryPropertiesResponse { /** *

An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

*/ additionalCodeRepositories?: string[]; /** *

A timestamp that shows when the notebook instance was created.

*/ creationTime?: string; /** *

The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.

*/ defaultCodeRepository?: string; /** *

The type of ML compute instance that the notebook instance is running on.

*/ instanceType?: outputs.awsconnector.InstanceTypeEnumValueResponse; /** *

A timestamp that shows when the notebook instance was last modified.

*/ lastModifiedTime?: string; /** *

The Amazon Resource Name (ARN) of the notebook instance.

*/ notebookInstanceArn?: string; /** *

The name of a notebook instance lifecycle configuration associated with this notebook instance.

For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.

*/ notebookInstanceLifecycleConfigName?: string; /** *

The name of the notebook instance that you want a summary for.

*/ notebookInstanceName?: string; /** *

The status of the notebook instance.

*/ notebookInstanceStatus?: outputs.awsconnector.NotebookInstanceStatusEnumValueResponse; /** *

The URL that you use to connect to the Jupyter notebook running in your notebook instance.

*/ url?: string; } /** * Definition of awsSecretsManagerResourcePolicy */ interface AwsSecretsManagerResourcePolicyPropertiesResponse { /** * Property blockPublicPolicy */ blockPublicPolicy?: boolean; /** * Property id */ id?: string; /** * Property resourcePolicy */ resourcePolicy?: any; /** * Property secretId */ secretId?: string; } /** * Definition of awsSecretsManagerSecret */ interface AwsSecretsManagerSecretPropertiesResponse { /** * The description of the secret. */ description?: string; /** * A structure that specifies how to generate a password to encrypt and store in the secret. To include a specific string in the secret, use ``SecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. Generates a random password. We recommend that you specify the maximum length and include every character type that the system you are generating a password for can support. *Required permissions:* ``secretsmanager:GetRandomPassword``. For more information, see [IAM policy actions for Secrets Manager](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awssecretsmanager.html#awssecretsmanager-actions-as-permissions) and [Authentication and access control in Secrets Manager](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html). */ generateSecretString?: outputs.awsconnector.GenerateSecretStringResponse; /** * Property id */ id?: string; /** * The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt the secret value in the secret. An alias is always prefixed by ``alias/``, for example ``alias/aws/secretsmanager``. For more information, see [About aliases](https://docs.aws.amazon.com/kms/latest/developerguide/alias-about.html). To use a KMS key in a different account, use the key ARN or the alias ARN. If you don't specify this value, then Secrets Manager uses the key ``aws/secretsmanager``. If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it encrypts the secret value. If the secret is in a different AWS account from the credentials calling the API, then you can't use ``aws/secretsmanager`` to encrypt the secret, and you must create and use a customer managed KMS key. */ kmsKeyId?: string; /** * The name of the new secret. The secret name can contain ASCII letters, numbers, and the following characters: /_+=.@- Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters after the secret name at the end of the ARN. */ name?: string; /** * A custom type that specifies a ``Region`` and the ``KmsKeyId`` for a replica secret. */ replicaRegions?: outputs.awsconnector.ReplicaRegionResponse[]; /** * The text to encrypt and store in the secret. We recommend you use a JSON structure of key/value pairs for your secret value. To generate a random password, use ``GenerateSecretString`` instead. If you omit both ``GenerateSecretString`` and ``SecretString``, you create an empty secret. When you make a change to this property, a new secret version is created. */ secretString?: string; /** * A list of tags to attach to the secret. Each tag is a key and value pair of strings in a JSON text string, for example: ``[{'Key':'CostCenter','Value':'12345'},{'Key':'environment','Value':'production'}]`` Secrets Manager tag key names are case sensitive. A tag with the key 'ABC' is a different tag from one with key 'abc'. Stack-level tags, tags you apply to the CloudFormation stack, are also attached to the secret. If you check tags in permissions policies as part of your security strategy, then adding or removing a tag can change permissions. If the completion of this operation would result in you losing your permissions for this secret, then Secrets Manager blocks the operation and returns an ``Access Denied`` error. For more information, see [Control access to secrets using tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#tag-secrets-abac) and [Limit access to identities with tags that match secrets' tags](https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_examples.html#auth-and-access_tags2). For information about how to format a JSON parameter for the various command line tool environments, see [Using JSON for Parameters](https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json). If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. The following restrictions apply to tags: + Maximum number of tags per secret: 50 + Maximum key length: 127 Unicode characters in UTF-8 + Maximum value length: 255 Unicode characters in UTF-8 + Tag keys and values are case sensitive. + Do not use the ``aws:`` prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit. + If you use your tagging schema across multiple services and resources, other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @. */ tags?: outputs.awsconnector.TagResponse[]; } /** * Definition of awsSnsSubscription */ interface AwsSnsSubscriptionPropertiesResponse { /** *

The subscription's endpoint (format depends on the protocol).

*/ endpoint?: string; /** *

The subscription's owner.

*/ owner?: string; /** *

The subscription's protocol.

*/ protocol?: string; /** *

The subscription's ARN.

*/ subscriptionArn?: string; /** *

The ARN of the subscription's topic.

*/ topicArn?: string; } /** * Definition of awsSnsTopic */ interface AwsSnsTopicPropertiesResponse { /** * The archive policy determines the number of days SNS retains messages. You can set a retention period from 1 to 365 days. */ archivePolicy?: any; /** * Enables content-based deduplication for FIFO topics. + By default, ``ContentBasedDeduplication`` is set to ``false``. If you create a FIFO topic and this attribute is ``false``, you must specify a value for the ``MessageDeduplicationId`` parameter for the [Publish](https://docs.aws.amazon.com/sns/latest/api/API_Publish.html) action. + When you set ``ContentBasedDeduplication`` to ``true``, SNS uses a SHA-256 hash to generate the ``MessageDeduplicationId`` using the body of the message (but not the attributes of the message). (Optional) To override the generated value, you can specify a value for the the ``MessageDeduplicationId`` parameter for the ``Publish`` action. */ contentBasedDeduplication?: boolean; /** * The body of the policy document you want to use for this topic. You can only add one policy per topic. The policy must be in JSON string format. Length Constraints: Maximum length of 30,720. */ dataProtectionPolicy?: any; /** * Property deliveryStatusLogging */ deliveryStatusLogging?: outputs.awsconnector.LoggingConfigSnsTopicResponse[]; /** * The display name to use for an SNS topic with SMS subscriptions. The display name must be maximum 100 characters long, including hyphens (-), underscores (_), spaces, and tabs. */ displayName?: string; /** * Set to true to create a FIFO topic. */ fifoTopic?: boolean; /** * The ID of an AWS managed customer master key (CMK) for SNS or a custom CMK. For more information, see [Key terms](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html#sse-key-terms). For more examples, see ``KeyId`` in the *API Reference*. This property applies only to [server-side-encryption](https://docs.aws.amazon.com/sns/latest/dg/sns-server-side-encryption.html). */ kmsMasterKeyId?: string; /** * The signature version corresponds to the hashing algorithm used while creating the signature of the notifications, subscription confirmations, or unsubscribe confirmation messages sent by Amazon SNS. By default, ``SignatureVersion`` is set to ``1``. */ signatureVersion?: string; /** * The SNS subscriptions (endpoints) for this topic. If you specify the ``Subscription`` property in the ``AWS::SNS::Topic`` resource and it creates an associated subscription resource, the associated subscription is not deleted when the ``AWS::SNS::Topic`` resource is deleted. */ subscription?: outputs.awsconnector.SubscriptionResponse[]; /** * The list of tags to add to a new topic. To be able to tag a topic on creation, you must have the ``sns:CreateTopic`` and ``sns:TagResource`` permissions. */ tags?: outputs.awsconnector.TagResponse[]; /** * Property topicArn */ topicArn?: string; /** * The name of the topic you want to create. Topic names must include only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long. FIFO topic names must end with ``.fifo``. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the topic name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html). If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. */ topicName?: string; /** * Tracing mode of an SNS topic. By default ``TracingConfig`` is set to ``PassThrough``, and the topic passes through the tracing header it receives from an SNS publisher to its subscriptions. If set to ``Active``, SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. */ tracingConfig?: string; } /** * Definition of awsSqsQueue */ interface AwsSqsQueuePropertiesResponse { /** * Property arn */ arn?: string; /** * For first-in-first-out (FIFO) queues, specifies whether to enable content-based deduplication. During the deduplication interval, SQS treats messages that are sent with identical content as duplicates and delivers only one copy of the message. For more information, see the ``ContentBasedDeduplication`` attribute for the ``CreateQueue`` action in the *API Reference*. */ contentBasedDeduplication?: boolean; /** * For high throughput for FIFO queues, specifies whether message deduplication occurs at the message group or queue level. Valid values are ``messageGroup`` and ``queue``. To enable high throughput for a FIFO queue, set this attribute to ``messageGroup`` *and* set the ``FifoThroughputLimit`` attribute to ``perMessageGroupId``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*. */ deduplicationScope?: string; /** * The time in seconds for which the delivery of all messages in the queue is delayed. You can specify an integer value of ``0`` to ``900`` (15 minutes). The default value is ``0``. */ delaySeconds?: number; /** * If set to true, creates a FIFO queue. If you don't specify this property, SQS creates a standard queue. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*. */ fifoQueue?: boolean; /** * For high throughput for FIFO queues, specifies whether the FIFO queue throughput quota applies to the entire queue or per message group. Valid values are ``perQueue`` and ``perMessageGroupId``. To enable high throughput for a FIFO queue, set this attribute to ``perMessageGroupId`` *and* set the ``DeduplicationScope`` attribute to ``messageGroup``. If you set these attributes to anything other than these values, normal throughput is in effect and deduplication occurs as specified. For more information, see [High throughput for FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/high-throughput-fifo.html) and [Quotas related to messages](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-messages.html) in the *Developer Guide*. */ fifoThroughputLimit?: string; /** * The length of time in seconds for which SQS can reuse a data key to encrypt or decrypt messages before calling KMS again. The value must be an integer between 60 (1 minute) and 86,400 (24 hours). The default is 300 (5 minutes). A shorter time period provides better security, but results in more calls to KMS, which might incur charges after Free Tier. For more information, see [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html#sqs-how-does-the-data-key-reuse-period-work) in the *Developer Guide*. */ kmsDataKeyReusePeriodSeconds?: number; /** * The ID of an AWS Key Management Service (KMS) for SQS, or a custom KMS. To use the AWS managed KMS for SQS, specify a (default) alias ARN, alias name (e.g. ``alias/aws/sqs``), key ARN, or key ID. For more information, see the following: + [Encryption at rest](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-server-side-encryption.html) in the *Developer Guide* + [CreateQueue](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_CreateQueue.html) in the *API Reference* + [Request Parameters](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters) in the *Key Management Service API Reference* + The Key Management Service (KMS) section of the [Best Practices](https://d0.awsstatic.com/whitepapers/aws-kms-best-practices.pdf) whitepaper */ kmsMasterKeyId?: string; /** * The limit of how many bytes that a message can contain before SQS rejects it. You can specify an integer value from ``1,024`` bytes (1 KiB) to ``262,144`` bytes (256 KiB). The default value is ``262,144`` (256 KiB). */ maximumMessageSize?: number; /** * The number of seconds that SQS retains a message. You can specify an integer value from ``60`` seconds (1 minute) to ``1,209,600`` seconds (14 days). The default value is ``345,600`` seconds (4 days). */ messageRetentionPeriod?: number; /** * A name for the queue. To create a FIFO queue, the name of your FIFO queue must end with the ``.fifo`` suffix. For more information, see [FIFO queues](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/FIFO-queues.html) in the *Developer Guide*. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the queue name. For more information, see [Name type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) in the *User Guide*. If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name. */ queueName?: string; /** * Property queueUrl */ queueUrl?: string; /** * Specifies the duration, in seconds, that the ReceiveMessage action call waits until a message is in the queue in order to include it in the response, rather than returning an empty response if a message isn't yet available. You can specify an integer from 1 to 20. Short polling is used as the default or when you specify 0 for this property. For more information, see [Consuming messages using long polling](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-short-and-long-polling.html#sqs-long-polling) in the *Developer Guide*. */ receiveMessageWaitTimeSeconds?: number; /** * The string that includes the parameters for the permissions for the dead-letter queue redrive permission and which source queues can specify dead-letter queues as a JSON object. The parameters are as follows: + ``redrivePermission``: The permission type that defines which source queues can specify the current queue as the dead-letter queue. Valid values are: + ``allowAll``: (Default) Any source queues in this AWS account in the same Region can specify this queue as the dead-letter queue. + ``denyAll``: No source queues can specify this queue as the dead-letter queue. + ``byQueue``: Only queues specified by the ``sourceQueueArns`` parameter can specify this queue as the dead-letter queue. + ``sourceQueueArns``: The Amazon Resource Names (ARN)s of the source queues that can specify this queue as the dead-letter queue and redrive messages. You can specify this parameter only when the ``redrivePermission`` parameter is set to ``byQueue``. You can specify up to 10 source queue ARNs. To allow more than 10 source queues to specify dead-letter queues, set the ``redrivePermission`` parameter to ``allowAll``. */ redriveAllowPolicy?: any; /** * The string that includes the parameters for the dead-letter queue functionality of the source queue as a JSON object. The parameters are as follows: + ``deadLetterTargetArn``: The Amazon Resource Name (ARN) of the dead-letter queue to which SQS moves messages after the value of ``maxReceiveCount`` is exceeded. + ``maxReceiveCount``: The number of times a message is delivered to the source queue before being moved to the dead-letter queue. When the ``ReceiveCount`` for a message exceeds the ``maxReceiveCount`` for a queue, SQS moves the message to the dead-letter-queue. The dead-letter queue of a FIFO queue must also be a FIFO queue. Similarly, the dead-letter queue of a standard queue must also be a standard queue. *JSON* ``{ 'deadLetterTargetArn' : String, 'maxReceiveCount' : Integer }`` *YAML* ``deadLetterTargetArn : String`` ``maxReceiveCount : Integer`` */ redrivePolicy?: any; /** * Enables server-side queue encryption using SQS owned encryption keys. Only one server-side encryption option is supported per queue (for example, [SSE-KMS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sse-existing-queue.html) or [SSE-SQS](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-configure-sqs-sse-queue.html)). When ``SqsManagedSseEnabled`` is not defined, ``SSE-SQS`` encryption is enabled by default. */ sqsManagedSseEnabled?: boolean; /** * The tags that you attach to this queue. For more information, see [Resource tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) in the *User Guide*. */ tags?: outputs.awsconnector.TagResponse[]; /** * The length of time during which a message will be unavailable after a message is delivered from the queue. This blocks other components from receiving the same message and gives the initial component time to process and delete the message from the queue. Values must be from 0 to 43,200 seconds (12 hours). If you don't specify a value, AWS CloudFormation uses the default value of 30 seconds. For more information about SQS queue visibility timeouts, see [Visibility timeout](https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html) in the *Developer Guide*. */ visibilityTimeout?: number; } /** * Definition of awsSsmInstanceInformation */ interface AwsSsmInstanceInformationPropertiesResponse { /** *

The activation ID created by Amazon Web Services Systems Manager when the server or virtual machine (VM) was registered.

*/ activationId?: string; /** *

The version of SSM Agent running on your Linux managed node.

*/ agentVersion?: string; /** *

Information about the association.

*/ associationOverview?: outputs.awsconnector.InstanceAggregatedAssociationOverviewResponse; /** *

The status of the association.

*/ associationStatus?: string; /** *

The fully qualified host name of the managed node.

*/ computerName?: string; /** *

The Identity and Access Management (IAM) role assigned to the on-premises Systems Manager managed node. This call doesn't return the IAM role for Amazon Elastic Compute Cloud (Amazon EC2) instances. To retrieve the IAM role for an EC2 instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.

*/ iamRole?: string; /** *

The managed node ID.

*/ instanceId?: string; /** *

The IP address of the managed node.

*/ ipAddress?: string; /** *

Indicates whether the latest version of SSM Agent is running on your Linux managed node. This field doesn't indicate whether or not the latest version is installed on Windows managed nodes, because some older versions of Windows Server use the EC2Config service to process Systems Manager requests.

*/ isLatestVersion?: boolean; /** *

The date the association was last run.

*/ lastAssociationExecutionDate?: string; /** *

The date and time when the agent last pinged the Systems Manager service.

*/ lastPingDateTime?: string; /** *

The last date the association was successfully run.

*/ lastSuccessfulAssociationExecutionDate?: string; /** *

The name assigned to an on-premises server, edge device, or virtual machine (VM) when it is activated as a Systems Manager managed node. The name is specified as the DefaultInstanceName property using the CreateActivation command. It is applied to the managed node by specifying the Activation Code and Activation ID when you install SSM Agent on the node, as explained in Install SSM Agent for a hybrid and multicloud environment (Linux) and Install SSM Agent for a hybrid and multicloud environment (Windows). To retrieve the Name tag of an EC2 instance, use the Amazon EC2 DescribeInstances operation. For information, see DescribeInstances in the Amazon EC2 API Reference or describe-instances in the Amazon Web Services CLI Command Reference.

*/ name?: string; /** *

Connection status of SSM Agent.

The status Inactive has been deprecated and is no longer in use.

*/ pingStatus?: outputs.awsconnector.PingStatusEnumValueResponse; /** *

The name of the operating system platform running on your managed node.

*/ platformName?: string; /** *

The operating system platform type.

*/ platformType?: outputs.awsconnector.PlatformTypeEnumValueResponse; /** *

The version of the OS platform running on your managed node.

*/ platformVersion?: string; /** *

The date the server or VM was registered with Amazon Web Services as a managed node.

*/ registrationDate?: string; /** *

The type of instance. Instances are either EC2 instances or managed instances.

*/ resourceType?: outputs.awsconnector.ResourceTypeEnumValueResponse; /** *

The ID of the source resource. For IoT Greengrass devices, SourceId is the Thing name.

*/ sourceId?: string; /** *

The type of the source resource. For IoT Greengrass devices, SourceType is AWS::IoT::Thing.

*/ sourceType?: outputs.awsconnector.SourceTypeEnumValueResponse; } /** * Definition of awsSsmParameter */ interface AwsSsmParameterPropertiesResponse { /** * A regular expression used to validate the parameter value. For example, for ``String`` types with values restricted to numbers, you can specify the following: ``AllowedPattern=^\d+$`` */ allowedPattern?: string; /** * The data type of the parameter, such as ``text`` or ``aws:ec2:image``. The default is ``text``. */ dataType?: string; /** * Information about the parameter. */ description?: string; /** * The name of the parameter. The maximum length constraint listed below includes capacity for additional system attributes that aren't part of the name. The maximum length for a parameter name, including the full length of the parameter Amazon Resource Name (ARN), is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters: ``arn:aws:ssm:us-east-2:111222333444:parameter/ExampleParameterName`` */ name?: string; /** * Information about the policies assigned to a parameter. [Assigning parameter policies](https://docs.aws.amazon.com/systems-manager/latest/userguide/parameter-store-policies.html) in the *User Guide*. */ policies?: string; /** * Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs). Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a SYS parameter to identify the type of resource to which it applies, the environment, or the type of configuration data referenced by the parameter. */ tags?: any; /** * The parameter tier. */ tier?: string; /** * The type of parameter. */ type?: string; /** * The parameter value. If type is ``StringList``, the system returns a comma-separated string with no spaces between commas in the ``Value`` field. */ value?: string; } /** * Definition of awsSsmResourceComplianceSummaryItem */ interface AwsSsmResourceComplianceSummaryItemPropertiesResponse { /** *

The compliance type.

*/ complianceType?: string; /** *

A list of items that are compliant for the resource.

*/ compliantSummary?: outputs.awsconnector.CompliantSummaryResponse; /** *

Information about the execution.

*/ executionSummary?: outputs.awsconnector.ComplianceExecutionSummaryResponse; /** *

A list of items that aren't compliant for the resource.

*/ nonCompliantSummary?: outputs.awsconnector.NonCompliantSummaryResponse; /** *

The highest severity item found for the resource. The resource is compliant for this item.

*/ overallSeverity?: outputs.awsconnector.ComplianceSeverityEnumValueResponse; /** *

The resource ID.

*/ resourceId?: string; /** *

The resource type.

*/ resourceType?: string; /** *

The compliance status for the resource.

*/ status?: outputs.awsconnector.ComplianceStatusEnumValueResponse; } /** * Definition of AwsVpcConfiguration */ interface AwsVpcConfigurationResponse { /** * Whether the task's elastic network interface receives a public IP address. The default value is ``DISABLED``. */ assignPublicIp?: string; /** * The IDs of the security groups associated with the task or service. If you don't specify a security group, the default security group for the VPC is used. There's a limit of 5 security groups that can be specified per ``AwsVpcConfiguration``. All specified security groups must be from the same VPC. */ securityGroups?: string[]; /** * The IDs of the subnets associated with the task or service. There's a limit of 16 subnets that can be specified per ``AwsVpcConfiguration``. All specified subnets must be from the same VPC. */ subnets?: string[]; } /** * Definition of awsWafWebACLSummary */ interface AwsWafWebACLSummaryPropertiesResponse { /** *

A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

*/ name?: string; /** *

A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

WebACLId is returned by CreateWebACL and by ListWebACLs.

*/ webACLId?: string; } /** * Definition of awsWafv2LoggingConfiguration */ interface AwsWafv2LoggingConfigurationPropertiesResponse { /** * The Amazon Resource Names (ARNs) of the logging destinations that you want to associate with the web ACL. */ logDestinationConfigs?: string[]; /** * Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation. */ loggingFilter?: outputs.awsconnector.LoggingFilterModelPropertiesResponse; /** * Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration. */ managedByFirewallManager?: boolean; /** * The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx. */ redactedFields?: outputs.awsconnector.FieldToMatchResponse[]; /** * The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs. */ resourceArn?: string; } /** * Definition of BackupPolicy */ interface BackupPolicyResponse { /** * Set the backup policy status for the file system. + *ENABLED* - Turns automatic backups on for the file system. + *DISABLED* - Turns automatic backups off for the file system. */ status?: string; } /** * Definition of BaselineEbsBandwidthMbpsRequest */ interface BaselineEbsBandwidthMbpsRequestResponse { /** * The maximum value in Mbps. */ max?: number; /** * The minimum value in Mbps. */ min?: number; } /** * Definition of BatchReportModeTypeEnumValue */ interface BatchReportModeTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of BatchRestrictions */ interface BatchRestrictionsResponse { /** *

An array of strings that specify the compute types that are allowed for the batch build. See Build environment compute types in the CodeBuild User Guide for these values.

*/ computeTypesAllowed?: string[]; /** *

Specifies the maximum number of builds allowed.

*/ maximumBuildsAllowed?: number; } /** * Definition of BlockDeviceMapping */ interface BlockDeviceMappingResponse { /** *

The device name (for example, /dev/sdh or xvdh).

*/ deviceName?: string; /** *

Parameters used to automatically set up EBS volumes when the instance is launched.

*/ ebs?: outputs.awsconnector.EbsBlockDeviceResponse; /** *

To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.

*/ noDevice?: string; /** *

The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.

NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.

Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.

*/ virtualName?: string; } /** * Definition of BootModeValuesEnumValue */ interface BootModeValuesEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of BucketEncryption */ interface BucketEncryptionResponse { /** * Specifies the default server-side-encryption configuration. */ serverSideEncryptionConfiguration?: outputs.awsconnector.ServerSideEncryptionRuleResponse[]; } /** * Definition of BucketOwnerAccessEnumValue */ interface BucketOwnerAccessEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of BuildStatusConfig */ interface BuildStatusConfigResponse { /** *

Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.

Bitbucket

This parameter is used for the name parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.

GitHub/GitHub Enterprise Server

This parameter is used for the context parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.

*/ context?: string; /** *

Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.

Bitbucket

This parameter is used for the url parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.

GitHub/GitHub Enterprise Server

This parameter is used for the target_url parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.

*/ targetUrl?: string; } /** * Definition of CFNDataSourceConfigurations */ interface CFNDataSourceConfigurationsResponse { /** * Property kubernetes */ kubernetes?: outputs.awsconnector.CFNKubernetesConfigurationResponse; /** * Property malwareProtection */ malwareProtection?: outputs.awsconnector.CFNMalwareProtectionConfigurationResponse; /** * Property s3Logs */ s3Logs?: outputs.awsconnector.CFNS3LogsConfigurationResponse; } /** * Definition of CFNFeatureAdditionalConfiguration */ interface CFNFeatureAdditionalConfigurationResponse { /** * Property name */ name?: string; /** * Property status */ status?: string; } /** * Definition of CFNFeatureConfiguration */ interface CFNFeatureConfigurationResponse { /** * Property additionalConfiguration */ additionalConfiguration?: outputs.awsconnector.CFNFeatureAdditionalConfigurationResponse[]; /** * Property name */ name?: string; /** * Property status */ status?: string; } /** * Definition of CFNKubernetesAuditLogsConfiguration */ interface CFNKubernetesAuditLogsConfigurationResponse { /** * Property enable */ enable?: boolean; } /** * Definition of CFNKubernetesConfiguration */ interface CFNKubernetesConfigurationResponse { /** * Property auditLogs */ auditLogs?: outputs.awsconnector.CFNKubernetesAuditLogsConfigurationResponse; } /** * Definition of CFNMalwareProtectionConfiguration */ interface CFNMalwareProtectionConfigurationResponse { /** * Property scanEc2InstanceWithFindings */ scanEc2InstanceWithFindings?: outputs.awsconnector.CFNScanEc2InstanceWithFindingsConfigurationResponse; } /** * Definition of CFNS3LogsConfiguration */ interface CFNS3LogsConfigurationResponse { /** * Property enable */ enable?: boolean; } /** * Definition of CFNScanEc2InstanceWithFindingsConfiguration */ interface CFNScanEc2InstanceWithFindingsConfigurationResponse { /** * Property ebsVolumes */ ebsVolumes?: boolean; } /** * Definition of CacheBehavior */ interface CacheBehaviorResponse { /** * A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only ``GET`` and ``HEAD`` requests. + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests. + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. */ allowedMethods?: string[]; /** * The unique identifier of the cache policy that is attached to this cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. */ cachePolicyId?: string; /** * A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to ``GET`` and ``HEAD`` requests. + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. */ cachedMethods?: string[]; /** * Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*. */ compress?: boolean; /** * This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. */ defaultTTL?: number; /** * The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for this cache behavior. */ fieldLevelEncryptionId?: string; /** * This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. A ``CacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. */ forwardedValues?: outputs.awsconnector.ForwardedValuesResponse; /** * A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior. */ functionAssociations?: outputs.awsconnector.FunctionAssociationResponse[]; /** * A complex type that contains zero or more Lambda@Edge function associations for a cache behavior. */ lambdaFunctionAssociations?: outputs.awsconnector.LambdaFunctionAssociationResponse[]; /** * This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. */ maxTTL?: number; /** * This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``). */ minTTL?: number; /** * The unique identifier of the origin request policy that is attached to this cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. */ originRequestPolicyId?: string; /** * The pattern (for example, ``images/*.jpg``) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution. You can optionally include a slash (``/``) at the beginning of the path pattern. For example, ``/images/*.jpg``. CloudFront behavior is the same with or without the leading ``/``. The path pattern for the default cache behavior is ``*`` and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior. For more information, see [Path Pattern](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern) in the *Amazon CloudFront Developer Guide*. */ pathPattern?: string; /** * The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*. */ realtimeLogConfigArn?: string; /** * The identifier for a response headers policy. */ responseHeadersPolicyId?: string; /** * Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``. */ smoothStreaming?: boolean; /** * The value of ``ID`` for the origin that you want CloudFront to route requests to when they match this cache behavior. */ targetOriginId?: string; /** * A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*. */ trustedKeyGroups?: string[]; /** * We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in the trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*. */ trustedSigners?: string[]; /** * The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options: + ``allow-all``: Viewers can use HTTP or HTTPS. + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. */ viewerProtocolPolicy?: string; } /** * cacheBehaviorResponseProvideDefaults sets the appropriate defaults for CacheBehaviorResponse */ function cacheBehaviorResponseProvideDefaults(val: CacheBehaviorResponse): CacheBehaviorResponse; /** * Definition of CacheTypeEnumValue */ interface CacheTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of CanarySetting */ interface CanarySettingResponse { /** * The ID of the canary deployment. */ deploymentId?: string; /** * The percent (0-100) of traffic diverted to a canary deployment. */ percentTraffic?: number; /** * Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values. */ stageVariableOverrides?: { [key: string]: string; }; /** * A Boolean flag to indicate whether the canary deployment uses the stage cache or not. */ useStageCache?: boolean; } /** * Definition of CapacityProviderStrategyItem */ interface CapacityProviderStrategyItemResponse { /** * The *base* value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a *base* defined. If no value is specified, the default value of ``0`` is used. */ base?: number; /** * The short name of the capacity provider. */ capacityProvider?: string; /** * The *weight* value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The ``weight`` value is taken into consideration after the ``base`` value, if defined, is satisfied. If no ``weight`` value is specified, the default value of ``0`` is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of ``0`` can't be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of ``0``, any ``RunTask`` or ``CreateService`` actions using the capacity provider strategy will fail. An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of ``1``, then when the ``base`` is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of ``1`` for *capacityProviderA* and a weight of ``4`` for *capacityProviderB*, then for every one task that's run using *capacityProviderA*, four tasks would use *capacityProviderB*. */ weight?: number; } /** * Definition of CapacityReservationPreferenceEnumValue */ interface CapacityReservationPreferenceEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of CapacityReservationSpecificationResponse */ interface CapacityReservationSpecificationResponseResponse { /** *

Describes the instance's Capacity Reservation preferences. Possible preferences include:

  • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

  • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.

*/ capacityReservationPreference?: outputs.awsconnector.CapacityReservationPreferenceEnumValueResponse; /** *

Information about the targeted Capacity Reservation or Capacity Reservation group.

*/ capacityReservationTarget?: outputs.awsconnector.CapacityReservationTargetResponseResponse; } /** * Definition of CapacityReservationTargetResponse */ interface CapacityReservationTargetResponseResponse { /** *

The ID of the targeted Capacity Reservation.

*/ capacityReservationId?: string; /** *

The ARN of the targeted Capacity Reservation group.

*/ capacityReservationResourceGroupArn?: string; } /** * Definition of CertificateDetails */ interface CertificateDetailsResponse { /** * The CA identifier of the CA certificate used for the DB instance's server certificate. */ caIdentifier?: string; /** * The expiration date of the DB instance’s server certificate. */ validTill?: string; } /** * Definition of Certificate */ interface CertificateElasticLoadBalancingV2ListenerResponse { /** * The Amazon Resource Name (ARN) of the certificate. */ certificateArn?: string; } /** * Definition of Certificate */ interface CertificateResponse { /** *

The Base64-encoded certificate data required to communicate with your cluster. Add this to the certificate-authority-data section of the kubeconfig file for your cluster.

*/ data?: string; } /** * Definition of CertificateStatusEnumValue */ interface CertificateStatusEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of CertificateTypeEnumValue */ interface CertificateTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ChangeProgressDetails */ interface ChangeProgressDetailsResponse { /** *

The ID of the configuration change.

*/ changeId?: string; /** *

The current status of the configuration change.

*/ configChangeStatus?: outputs.awsconnector.ConfigChangeStatusEnumValueResponse; /** *

The IAM principal who initiated the configuration change.

*/ initiatedBy?: outputs.awsconnector.InitiatedByEnumValueResponse; /** *

The last time that the configuration change was updated.

*/ lastUpdatedTime?: string; /** *

A message corresponding to the status of the configuration change.

*/ message?: string; /** *

The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

*/ startTime?: string; } /** * Definition of CidrRoutingConfig */ interface CidrRoutingConfigResponse { /** *

The CIDR collection ID.

*/ collectionId?: string; /** *

The CIDR collection location name.

*/ locationName?: string; } /** * Definition of CloudFormationStack */ interface CloudFormationStackPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsCloudFormationStackPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of CloudFormationStackSet */ interface CloudFormationStackSetPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsCloudFormationStackSetPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of CloudFrontDistribution */ interface CloudFrontDistributionPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsCloudFrontDistributionPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * cloudFrontDistributionPropertiesResponseProvideDefaults sets the appropriate defaults for CloudFrontDistributionPropertiesResponse */ function cloudFrontDistributionPropertiesResponseProvideDefaults(val: CloudFrontDistributionPropertiesResponse): CloudFrontDistributionPropertiesResponse; /** * Definition of CloudTrailTrail */ interface CloudTrailTrailPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsCloudTrailTrailPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of CloudWatchAlarm */ interface CloudWatchAlarmPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsCloudWatchAlarmPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * cloudWatchAlarmPropertiesResponseProvideDefaults sets the appropriate defaults for CloudWatchAlarmPropertiesResponse */ function cloudWatchAlarmPropertiesResponseProvideDefaults(val: CloudWatchAlarmPropertiesResponse): CloudWatchAlarmPropertiesResponse; /** * Definition of CloudWatchLogsConfig */ interface CloudWatchLogsConfigResponse { /** *

The group name of the logs in CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.

*/ groupName?: string; /** *

The current status of the logs in CloudWatch Logs for a build project. Valid values are:

  • ENABLED: CloudWatch Logs are enabled for this build project.

  • DISABLED: CloudWatch Logs are not enabled for this build project.

*/ status?: outputs.awsconnector.LogsConfigStatusTypeEnumValueResponse; /** *

The prefix of the stream name of the CloudWatch Logs. For more information, see Working with Log Groups and Log Streams.

*/ streamName?: string; } /** * Definition of ClusterConfig */ interface ClusterConfigResponse { /** *

Container for cold storage configuration options.

*/ coldStorageOptions?: outputs.awsconnector.ColdStorageOptionsResponse; /** *

Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.

*/ dedicatedMasterCount?: number; /** *

Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.

*/ dedicatedMasterEnabled?: boolean; /** *

OpenSearch Service instance type of the dedicated master nodes in the cluster.

*/ dedicatedMasterType?: outputs.awsconnector.OpenSearchPartitionInstanceTypeEnumValueResponse; /** *

Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

*/ instanceCount?: number; /** *

Instance type of data nodes in the cluster.

*/ instanceType?: outputs.awsconnector.OpenSearchPartitionInstanceTypeEnumValueResponse; /** *

A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

*/ multiAZWithStandbyEnabled?: boolean; /** *

The number of warm nodes in the cluster.

*/ warmCount?: number; /** *

Whether to enable warm storage for the cluster.

*/ warmEnabled?: boolean; /** *

The instance type for the cluster's warm nodes.

*/ warmType?: outputs.awsconnector.OpenSearchWarmPartitionInstanceTypeEnumValueResponse; /** *

Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

*/ zoneAwarenessConfig?: outputs.awsconnector.ZoneAwarenessConfigResponse; /** *

Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

*/ zoneAwarenessEnabled?: boolean; } /** * Definition of ClusterConfiguration */ interface ClusterConfigurationResponse { /** * The details of the execute command configuration. The details of the execute command configuration. */ executeCommandConfiguration?: outputs.awsconnector.ExecuteCommandConfigurationResponse; } /** * Definition of ClusterEndpointEncryptionTypeEnumValue */ interface ClusterEndpointEncryptionTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ClusterHealth */ interface ClusterHealthResponse { /** *

An object representing the health issues of your local Amazon EKS cluster on an Amazon Web Services Outpost.

*/ issues?: outputs.awsconnector.ClusterIssueResponse[]; } /** * Definition of ClusterIssueCodeEnumValue */ interface ClusterIssueCodeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ClusterIssue */ interface ClusterIssueResponse { /** *

The error code of the issue.

*/ code?: outputs.awsconnector.ClusterIssueCodeEnumValueResponse; /** *

A description of the issue.

*/ message?: string; /** *

The resource IDs that the issue relates to.

*/ resourceIds?: string[]; } /** * Definition of ClusterSettings */ interface ClusterSettingsResponse { /** * The name of the cluster setting. The value is ``containerInsights`` . */ name?: string; /** * The value to set for the cluster setting. The supported values are ``enabled`` and ``disabled``. If you set ``name`` to ``containerInsights`` and ``value`` to ``enabled``, CloudWatch Container Insights will be on for the cluster, otherwise it will be off unless the ``containerInsights`` account setting is turned on. If a cluster value is specified, it will override the ``containerInsights`` value set with [PutAccountSetting](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSetting.html) or [PutAccountSettingDefault](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutAccountSettingDefault.html). */ value?: string; } /** * Definition of ClusterStateChangeReasonCodeEnumValue */ interface ClusterStateChangeReasonCodeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ClusterStateChangeReason */ interface ClusterStateChangeReasonResponse { /** *

The programmatic code for the state change reason.

*/ code?: outputs.awsconnector.ClusterStateChangeReasonCodeEnumValueResponse; /** *

The descriptive message for the state change reason.

*/ message?: string; } /** * Definition of ClusterStateEnumValue */ interface ClusterStateEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ClusterStatusEnumValue */ interface ClusterStatusEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ClusterTimeline */ interface ClusterTimelineResponse { /** *

The creation date and time of the cluster.

*/ creationDateTime?: string; /** *

The date and time when the cluster was terminated.

*/ endDateTime?: string; /** *

The date and time when the cluster was ready to run steps.

*/ readyDateTime?: string; } /** * Definition of CodeBuildProject */ interface CodeBuildProjectPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsCodeBuildProjectPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of CodeBuildSourceCredentialsInfo */ interface CodeBuildSourceCredentialsInfoPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsCodeBuildSourceCredentialsInfoPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Code */ interface CodeResponse { /** * URI of a [container image](https://docs.aws.amazon.com/lambda/latest/dg/lambda-images.html) in the Amazon ECR registry. */ imageUri?: string; /** * An Amazon S3 bucket in the same AWS-Region as your function. The bucket can be in a different AWS-account. */ s3Bucket?: string; /** * The Amazon S3 key of the deployment package. */ s3Key?: string; /** * For versioned objects, the version of the deployment package object to use. */ s3ObjectVersion?: string; /** * (Node.js and Python) The source code of your Lambda function. If you include your function source inline with this parameter, CFN places it in a file named ``index`` and zips it to create a [deployment package](https://docs.aws.amazon.com/lambda/latest/dg/gettingstarted-package.html). This zip file cannot exceed 4MB. For the ``Handler`` property, the first part of the handler identifier must be ``index``. For example, ``index.handler``. For JSON, you must escape quotes and special characters such as newline (``\n``) with a backslash. If you specify a function that interacts with an AWS CloudFormation custom resource, you don't have to write your own functions to send responses to the custom resource that invoked the function. AWS CloudFormation provides a response module ([cfn-response](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-lambda-function-code-cfnresponsemodule.html)) that simplifies sending responses. See [Using Lambda with CloudFormation](https://docs.aws.amazon.com/lambda/latest/dg/services-cloudformation.html) for details. */ zipFile?: string; } /** * Definition of CognitoOptions */ interface CognitoOptionsResponse { /** *

Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

*/ enabled?: boolean; /** *

The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

*/ identityPoolId?: string; /** *

The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

*/ roleArn?: string; /** *

The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

*/ userPoolId?: string; } /** * Definition of CognitoUserPoolConfig */ interface CognitoUserPoolConfigResponse { /** *

A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

*/ appIdClientRegex?: string; /** *

The Amazon Web Services Region in which the user pool was created.

*/ awsRegion?: string; /** *

The user pool ID.

*/ userPoolId?: string; } /** * Definition of ColdStorageOptions */ interface ColdStorageOptionsResponse { /** *

Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.

*/ enabled?: boolean; } /** * Definition of ComplianceExecutionSummary */ interface ComplianceExecutionSummaryResponse { /** *

An ID created by the system when PutComplianceItems was called. For example, CommandID is a valid execution ID. You can use this ID in subsequent calls.

*/ executionId?: string; /** *

The time the execution ran as a datetime object that is saved in the following format: yyyy-MM-dd'T'HH:mm:ss'Z'

*/ executionTime?: string; /** *

The type of execution. For example, Command is a valid execution type.

*/ executionType?: string; } /** * Definition of ComplianceSeverityEnumValue */ interface ComplianceSeverityEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ComplianceStatusEnumValue */ interface ComplianceStatusEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of CompliantSummary */ interface CompliantSummaryResponse { /** *

The total number of resources that are compliant.

*/ compliantCount?: number; /** *

A summary of the compliance severity by compliance type.

*/ severitySummary?: outputs.awsconnector.SeveritySummaryResponse; } /** * Definition of ComputeTypeEnumValue */ interface ComputeTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of Condition */ interface ConditionResponse { /** * A single action condition. */ actionCondition?: outputs.awsconnector.ActionConditionModelPropertiesResponse; /** * A single label name condition. */ labelNameCondition?: outputs.awsconnector.LabelNameConditionModelPropertiesResponse; } /** * Definition of ConfigChangeStatusEnumValue */ interface ConfigChangeStatusEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ConfigServiceConfigurationRecorder */ interface ConfigServiceConfigurationRecorderPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsConfigServiceConfigurationRecorderPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of ConfigServiceConfigurationRecorderStatus */ interface ConfigServiceConfigurationRecorderStatusPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsConfigServiceConfigurationRecorderStatusPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of ConfigServiceDeliveryChannel */ interface ConfigServiceDeliveryChannelPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsConfigServiceDeliveryChannelPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of ConfigSnapshotDeliveryProperties */ interface ConfigSnapshotDeliveryPropertiesResponse { /** *

The frequency with which Config delivers configuration snapshots.

*/ deliveryFrequency?: outputs.awsconnector.MaximumExecutionFrequencyEnumValueResponse; } /** * Definition of ConfigurationOptionSetting */ interface ConfigurationOptionSettingResponse { /** * A unique namespace that identifies the option's associated AWS resource. */ namespace?: string; /** * The name of the configuration option. */ optionName?: string; /** * A unique resource name for the option setting. Use it for a time–based scaling configuration option. */ resourceName?: string; /** * The current value for the configuration option. */ value?: string; } /** * Definition of Configuration */ interface ConfigurationResponse { /** *

The classification within a configuration.

*/ classification?: string; /** *

A list of additional configurations to apply within a configuration object.

*/ configurations?: outputs.awsconnector.ConfigurationResponse[]; /** *

A set of properties specified within a configuration classification.

*/ properties?: { [key: string]: string; }; } /** * Definition of ConnectionTrackingSpecification */ interface ConnectionTrackingSpecificationResponse { /** * Property tcpEstablishedTimeout */ tcpEstablishedTimeout?: number; /** * Property udpStreamTimeout */ udpStreamTimeout?: number; /** * Property udpTimeout */ udpTimeout?: number; } /** * Definition of ConnectionTrackingSpecificationResponse */ interface ConnectionTrackingSpecificationResponseResponse { /** *

Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.

*/ tcpEstablishedTimeout?: number; /** *

Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.

*/ udpStreamTimeout?: number; /** *

Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.

*/ udpTimeout?: number; } /** * connectionTrackingSpecificationResponseResponseProvideDefaults sets the appropriate defaults for ConnectionTrackingSpecificationResponseResponse */ function connectionTrackingSpecificationResponseResponseProvideDefaults(val: ConnectionTrackingSpecificationResponseResponse): ConnectionTrackingSpecificationResponseResponse; /** * Definition of ConnectorConfigResponse */ interface ConnectorConfigResponseResponse { /** *

A unique code associated with the cluster for registration purposes.

*/ activationCode?: string; /** *

The expiration time of the connected cluster. The cluster's YAML file must be applied through the native provider.

*/ activationExpiry?: string; /** *

A unique ID associated with the cluster for registration purposes.

*/ activationId?: string; /** *

The cluster's cloud service provider.

*/ provider?: string; /** *

The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.

*/ roleArn?: string; } /** * Definition of ContainerDefinition */ interface ContainerDefinitionResponse { /** * The command that's passed to the container. This parameter maps to ``Cmd`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``COMMAND`` parameter to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#cmd](https://docs.docker.com/engine/reference/builder/#cmd). If there are multiple arguments, each argument is a separated string in the array. */ command?: string[]; /** * The number of ``cpu`` units reserved for the container. This parameter maps to ``CpuShares`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--cpu-shares`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This field is optional for tasks using the Fargate launch type, and the only requirement is that the total amount of CPU reserved for all containers within a task be lower than the task-level ``cpu`` value. You can determine the number of CPU units that are available per EC2 instance type by multiplying the vCPUs listed for that instance type on the [Amazon EC2 Instances](https://aws.amazon.com/ec2/instance-types/) detail page by 1,024. Linux containers share unallocated CPU units with other containers on the container instance with the same ratio as their allocated amount. For example, if you run a single-container task on a single-core instance type with 512 CPU units specified for that container, and that's the only task running on the container instance, that container could use the full 1,024 CPU unit share at any given time. However, if you launched another copy of the same task on that container instance, each task is guaranteed a minimum of 512 CPU units when needed. Moreover, each container could float to higher CPU usage if the other container was not using it. If both tasks were 100% active all of the time, they would be limited to 512 CPU units. On Linux container instances, the Docker daemon on the container instance uses the CPU value to calculate the relative CPU share ratios for running containers. For more information, see [CPU share constraint](https://docs.docker.com/engine/reference/run/#cpu-share-constraint) in the Docker documentation. The minimum valid CPU share value that the Linux kernel allows is 2. However, the CPU parameter isn't required, and you can use CPU values below 2 in your container definitions. For CPU values below 2 (including null), the behavior varies based on your Amazon ECS container agent version: + *Agent versions less than or equal to 1.1.0:* Null and zero CPU values are passed to Docker as 0, which Docker then converts to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux kernel converts to two CPU shares. + *Agent versions greater than or equal to 1.2.0:* Null, zero, and CPU values of 1 are passed to Docker as 2. On Windows container instances, the CPU limit is enforced as an absolute limit, or a quota. Windows containers only have access to the specified amount of CPU that's described in the task definition. A null or zero CPU value is passed to Docker as ``0``, which Windows interprets as 1% of one CPU. */ cpu?: number; /** * A list of ARNs in SSM or Amazon S3 to a credential spec (``CredSpec``) file that configures the container for Active Directory authentication. We recommend that you use this parameter instead of the ``dockerSecurityOptions``. The maximum number of ARNs is 1. There are two formats for each ARN. + credentialspecdomainless:MyARN You use credentialspecdomainless:MyARN to provide a CredSpec with an additional section for a secret in . You provide the login credentials to the domain in the secret. Each task that runs on any container instance can join different domains. You can use this format without joining the container instance to a domain. + credentialspec:MyARN You use credentialspec:MyARN to provide a CredSpec for a single domain. You must join the container instance to the domain before you start any tasks that use this task definition. In both formats, replace ``MyARN`` with the ARN in SSM or Amazon S3. If you provide a ``credentialspecdomainless:MyARN``, the ``credspec`` must provide a ARN in ASMlong for a secret containing the username, password, and the domain to connect to. For better security, the instance isn't joined to the domain for domainless authentication. Other applications on the instance can't use the domainless credentials. You can use this parameter to run tasks on the same instance, even it the tasks need to join different domains. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html). */ credentialSpecs?: string[]; /** * The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. For tasks using the EC2 launch type, the container instances require at least version 1.26.0 of the container agent to turn on container dependencies. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version ``1.3.0`` or later. + Windows platform version ``1.0.0`` or later. If the task definition is used in a blue/green deployment that uses [AWS::CodeDeploy::DeploymentGroup BlueGreenDeploymentConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentgroup-bluegreendeploymentconfiguration.html), the ``dependsOn`` parameter is not supported. For more information see [Issue #680](https://github.com/aws-cloudformation/cloudformation-coverage-roadmap/issues/680) on the on the GitHub website. */ dependsOn?: outputs.awsconnector.ContainerDependencyResponse[]; /** * When this parameter is true, networking is off within the container. This parameter maps to ``NetworkDisabled`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/). This parameter is not supported for Windows containers. */ disableNetworking?: boolean; /** * A list of DNS search domains that are presented to the container. This parameter maps to ``DnsSearch`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--dns-search`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers. */ dnsSearchDomains?: string[]; /** * A list of DNS servers that are presented to the container. This parameter maps to ``Dns`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--dns`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers. */ dnsServers?: string[]; /** * A key/value map of labels to add to the container. This parameter maps to ``Labels`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--label`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` */ dockerLabels?: any; /** * A list of strings to provide custom configuration for multiple security systems. For more information about valid values, see [Docker Run Security Configuration](https://docs.docker.com/engine/reference/run/#security-configuration). This field isn't valid for containers in tasks using the Fargate launch type. For Linux tasks on EC2, this parameter can be used to reference custom labels for SELinux and AppArmor multi-level security systems. For any tasks on EC2, this parameter can be used to reference a credential spec file that configures a container for Active Directory authentication. For more information, see [Using gMSAs for Windows Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows-gmsa.html) and [Using gMSAs for Linux Containers](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/linux-gmsa.html) in the *Amazon Elastic Container Service Developer Guide*. This parameter maps to ``SecurityOpt`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--security-opt`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). The Amazon ECS container agent running on a container instance must register with the ``ECS_SELINUX_CAPABLE=true`` or ``ECS_APPARMOR_CAPABLE=true`` environment variables before containers placed on that instance can use these security options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. For more information about valid values, see [Docker Run Security Configuration](https://docs.docker.com/engine/reference/run/#security-configuration). Valid values: 'no-new-privileges' | 'apparmor:PROFILE' | 'label:value' | 'credentialspec:CredentialSpecFilePath' */ dockerSecurityOptions?: string[]; /** * Early versions of the Amazon ECS container agent don't properly handle ``entryPoint`` parameters. If you have problems using ``entryPoint``, update your container agent or enter your commands and arguments as ``command`` array items instead. The entry point that's passed to the container. This parameter maps to ``Entrypoint`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--entrypoint`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). For more information, see [https://docs.docker.com/engine/reference/builder/#entrypoint](https://docs.docker.com/engine/reference/builder/#entrypoint). */ entryPoint?: string[]; /** * The environment variables to pass to a container. This parameter maps to ``Env`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--env`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). We don't recommend that you use plaintext environment variables for sensitive information, such as credential data. */ environment?: outputs.awsconnector.KeyValuePairResponse[]; /** * A list of files containing the environment variables to pass to a container. This parameter maps to the ``--env-file`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). You can specify up to ten environment files. The file must have a ``.env`` file extension. Each line in an environment file contains an environment variable in ``VARIABLE=VALUE`` format. Lines beginning with ``#`` are treated as comments and are ignored. For more information about the environment variable file syntax, see [Declare default environment variables in file](https://docs.docker.com/compose/env-file/). If there are environment variables specified using the ``environment`` parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they're processed from the top down. We recommend that you use unique variable names. For more information, see [Specifying Environment Variables](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) in the *Amazon Elastic Container Service Developer Guide*. */ environmentFiles?: outputs.awsconnector.EnvironmentFileResponse[]; /** * If the ``essential`` parameter of a container is marked as ``true``, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the ``essential`` parameter of a container is marked as ``false``, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential. All tasks must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see [Application Architecture](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/application_architecture.html) in the *Amazon Elastic Container Service Developer Guide*. */ essential?: boolean; /** * A list of hostnames and IP address mappings to append to the ``/etc/hosts`` file on the container. This parameter maps to ``ExtraHosts`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--add-host`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter isn't supported for Windows containers or tasks that use the ``awsvpc`` network mode. */ extraHosts?: outputs.awsconnector.HostEntryResponse[]; /** * The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom Log Routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. */ firelensConfiguration?: outputs.awsconnector.FirelensConfigurationResponse; /** * The container health check command and associated configuration parameters for the container. This parameter maps to ``HealthCheck`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``HEALTHCHECK`` parameter of [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). The ``HealthCheck`` property specifies an object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile). This configuration maps to the ``HEALTHCHECK`` parameter of [docker run](https://docs.docker.com/engine/reference/run/). The Amazon ECS container agent only monitors and reports on the health checks specified in the task definition. Amazon ECS does not monitor Docker health checks that are embedded in a container image and not specified in the container definition. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image. If a task is run manually, and not as part of a service, the task will continue its lifecycle regardless of its health status. For tasks that are part of a service, if the task reports as unhealthy then the task will be stopped and the service scheduler will replace it. The following are notes about container health check support: + Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html). + Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see [Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html). + Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer. */ healthCheck?: outputs.awsconnector.HealthCheckResponse; /** * The hostname to use for your container. This parameter maps to ``Hostname`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--hostname`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). The ``hostname`` parameter is not supported if you're using the ``awsvpc`` network mode. */ hostname?: string; /** * The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either ``repository-url/image:tag`` or ``repository-url/image@digest``. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to ``Image`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``IMAGE`` parameter of [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). + When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image aren't propagated to already running tasks. + Images in Amazon ECR repositories can be specified by either using the full ``registry/repository:tag`` or ``registry/repository@digest``. For example, ``012345678910.dkr.ecr..amazonaws.com/:latest`` or ``012345678910.dkr.ecr..amazonaws.com/@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE``. + Images in official repositories on Docker Hub use a single name (for example, ``ubuntu`` or ``mongo``). + Images in other repositories on Docker Hub are qualified with an organization name (for example, ``amazon/amazon-ecs-agent``). + Images in other online repositories are qualified further by a domain name (for example, ``quay.io/assemblyline/ubuntu``). */ image?: string; /** * When this parameter is ``true``, you can deploy containerized applications that require ``stdin`` or a ``tty`` to be allocated. This parameter maps to ``OpenStdin`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--interactive`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). */ interactive?: boolean; /** * The ``links`` parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is ``bridge``. The ``name:internalName`` construct is analogous to ``name:alias`` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. For more information about linking Docker containers, go to [Legacy container links](https://docs.docker.com/network/links/) in the Docker documentation. This parameter maps to ``Links`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--link`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers. Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings. */ links?: string[]; /** * Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). This parameter is not supported for Windows containers. The Linux-specific options that are applied to the container, such as Linux [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html). */ linuxParameters?: outputs.awsconnector.LinuxParametersResponse; /** * The log configuration specification for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--log-driver`` option to [docker run](https://docs.docker.com/engine/reference/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the [LogConfiguration](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html) data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS Container Agent Configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. The ``LogConfiguration`` property specifies log configuration options to send to a custom log driver for the container. */ logConfiguration?: outputs.awsconnector.LogConfigurationResponse; /** * The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task ``memory`` value, if one is specified. This parameter maps to ``Memory`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--memory`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level ``memory`` and ``memoryReservation`` value, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers. */ memory?: number; /** * The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the ``memory`` parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to ``MemoryReservation`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--memory-reservation`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If a task-level memory value is not specified, you must specify a non-zero integer for one or both of ``memory`` or ``memoryReservation`` in a container definition. If you specify both, ``memory`` must be greater than ``memoryReservation``. If you specify ``memoryReservation``, then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a ``memoryReservation`` of 128 MiB, and a ``memory`` hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers. */ memoryReservation?: number; /** * The mount points for data volumes in your container. This parameter maps to ``Volumes`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--volume`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives. */ mountPoints?: outputs.awsconnector.MountPointResponse[]; /** * The name of a container. If you're linking multiple containers together in a task definition, the ``name`` of one container can be entered in the ``links`` of another container to connect the containers. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. This parameter maps to ``name`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--name`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). */ name?: string; /** * The list of port mappings for the container. Port mappings allow containers to access ports on the host container instance to send or receive traffic. For task definitions that use the ``awsvpc`` network mode, you should only specify the ``containerPort``. The ``hostPort`` can be left blank or it must be the same value as the ``containerPort``. Port mappings on Windows use the ``NetNAT`` gateway address rather than ``localhost``. There is no loopback for port mappings on Windows, so you cannot access a container's mapped port from the host itself. This parameter maps to ``PortBindings`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--publish`` option to [docker run](https://docs.docker.com/engine/reference/run/). If the network mode of a task definition is set to ``none``, then you can't specify port mappings. If the network mode of a task definition is set to ``host``, then host ports must either be undefined or they must match the container port in the port mapping. After a task reaches the ``RUNNING`` status, manual and automatic host and container port assignments are visible in the *Network Bindings* section of a container description for a selected task in the Amazon ECS console. The assignments are also visible in the ``networkBindings`` section [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) responses. */ portMappings?: outputs.awsconnector.PortMappingResponse[]; /** * When this parameter is true, the container is given elevated privileges on the host container instance (similar to the ``root`` user). This parameter maps to ``Privileged`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--privileged`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers or tasks run on FARGATElong. */ privileged?: boolean; /** * When this parameter is ``true``, a TTY is allocated. This parameter maps to ``Tty`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--tty`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). */ pseudoTerminal?: boolean; /** * When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ``ReadonlyRootfs`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--read-only`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter is not supported for Windows containers. */ readonlyRootFilesystem?: boolean; /** * The private repository authentication credentials to use. The repository credentials for private registry authentication. */ repositoryCredentials?: outputs.awsconnector.RepositoryCredentialsResponse; /** * The type and amount of a resource to assign to a container. The only supported resource is a GPU. */ resourceRequirements?: outputs.awsconnector.ResourceRequirementResponse[]; /** * The secrets to pass to the container. For more information, see [Specifying Sensitive Data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*. */ secrets?: outputs.awsconnector.SecretResponse[]; /** * Time duration (in seconds) to wait before giving up on resolving dependencies for a container. For example, you specify two containers in a task definition with containerA having a dependency on containerB reaching a ``COMPLETE``, ``SUCCESS``, or ``HEALTHY`` status. If a ``startTimeout`` value is specified for containerB and it doesn't reach the desired status within that time then containerA gives up and not start. This results in the task transitioning to a ``STOPPED`` state. When the ``ECS_CONTAINER_START_TIMEOUT`` container agent configuration variable is used, it's enforced independently from this start timeout value. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version ``1.3.0`` or later. + Windows platform version ``1.0.0`` or later. For tasks using the EC2 launch type, your container instances require at least version ``1.26.0`` of the container agent to use a container start timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version ``1.26.0-1`` of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. The valid values are 2-120 seconds. */ startTimeout?: number; /** * Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own. For tasks using the Fargate launch type, the task or service requires the following platforms: + Linux platform version ``1.3.0`` or later. + Windows platform version ``1.0.0`` or later. The max stop timeout value is 120 seconds and if the parameter is not specified, the default value of 30 seconds is used. For tasks that use the EC2 launch type, if the ``stopTimeout`` parameter isn't specified, the value set for the Amazon ECS container agent configuration variable ``ECS_CONTAINER_STOP_TIMEOUT`` is used. If neither the ``stopTimeout`` parameter or the ``ECS_CONTAINER_STOP_TIMEOUT`` agent configuration variable are set, then the default values of 30 seconds for Linux containers and 30 seconds on Windows containers are used. Your container instances require at least version 1.26.0 of the container agent to use a container stop timeout value. However, we recommend using the latest container agent version. For information about checking your agent version and updating to the latest version, see [Updating the Amazon ECS Container Agent](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-update.html) in the *Amazon Elastic Container Service Developer Guide*. If you're using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the ``ecs-init`` package. If your container instances are launched from version ``20190301`` or later, then they contain the required versions of the container agent and ``ecs-init``. For more information, see [Amazon ECS-optimized Linux AMI](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html) in the *Amazon Elastic Container Service Developer Guide*. The valid values are 2-120 seconds. */ stopTimeout?: number; /** * A list of namespaced kernel parameters to set in the container. This parameter maps to ``Sysctls`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--sysctl`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). For example, you can configure ``net.ipv4.tcp_keepalive_time`` setting to maintain longer lived connections. */ systemControls?: outputs.awsconnector.SystemControlResponse[]; /** * A list of ``ulimits`` to set in the container. This parameter maps to ``Ulimits`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--ulimit`` option to [docker run](https://docs.docker.com/engine/reference/run/). Valid naming values are displayed in the [Ulimit](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Ulimit.html) data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` This parameter is not supported for Windows containers. */ ulimits?: outputs.awsconnector.UlimitResponse[]; /** * The user to use inside the container. This parameter maps to ``User`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--user`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). When running tasks using the ``host`` network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security. You can specify the ``user`` using the following formats. If specifying a UID or GID, you must specify it as a positive integer. + ``user`` + ``user:group`` + ``uid`` + ``uid:gid`` + ``user:gid`` + ``uid:group`` This parameter is not supported for Windows containers. */ user?: string; /** * Data volumes to mount from another container. This parameter maps to ``VolumesFrom`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--volumes-from`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). */ volumesFrom?: outputs.awsconnector.VolumeFromResponse[]; /** * The working directory to run commands inside the container in. This parameter maps to ``WorkingDir`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--workdir`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). */ workingDirectory?: string; } /** * Definition of ContainerDependency */ interface ContainerDependencyResponse { /** * The dependency condition of the container. The following are the available conditions and their behavior: + ``START`` - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start. + ``COMPLETE`` - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container. + ``SUCCESS`` - This condition is the same as ``COMPLETE``, but it also requires that the container exits with a ``zero`` status. This condition can't be set on an essential container. + ``HEALTHY`` - This condition validates that the dependent container passes its Docker health check before permitting other containers to start. This requires that the dependent container has health checks configured. This condition is confirmed only at task startup. */ condition?: string; /** * The name of a container. */ containerName?: string; } /** * Definition of ContinuousBackupsStatusEnumValue */ interface ContinuousBackupsStatusEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ContributorInsightsSpecification */ interface ContributorInsightsSpecificationResponse { /** * Indicates whether CloudWatch Contributor Insights are to be enabled (true) or disabled (false). */ enabled?: boolean; } /** * Definition of ControlPlanePlacementResponse */ interface ControlPlanePlacementResponseResponse { /** *

The name of the placement group for the Kubernetes control plane instances.

*/ groupName?: string; } /** * Definition of Cookies */ interface CookiesResponse { /** * This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the ``WhitelistedNames`` complex type. Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the ``Forward`` element. */ forward?: string; /** * This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. */ whitelistedNames?: string[]; } /** * Definition of Coordinates */ interface CoordinatesResponse { /** *

Specifies a coordinate of the north–south position of a geographic point on the surface of the Earth (-90 - 90).

*/ latitude?: string; /** *

Specifies a coordinate of the east–west position of a geographic point on the surface of the Earth (-180 - 180).

*/ longitude?: string; } /** * Definition of CorsConfiguration */ interface CorsConfigurationResponse { /** * A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration. */ corsRules?: outputs.awsconnector.CorsRuleResponse[]; } /** * Definition of CorsRule */ interface CorsRuleResponse { /** * Headers that are specified in the ``Access-Control-Request-Headers`` header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed. */ allowedHeaders?: string[]; /** * An HTTP method that you allow the origin to run. *Allowed values*: ``GET`` | ``PUT`` | ``HEAD`` | ``POST`` | ``DELETE`` */ allowedMethods?: string[]; /** * One or more origins you want customers to be able to access the bucket from. */ allowedOrigins?: string[]; /** * One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript ``XMLHttpRequest`` object). */ exposedHeaders?: string[]; /** * A unique identifier for this rule. The value must be no more than 255 characters. */ id?: string; /** * The time in seconds that your browser is to cache the preflight response for the specified resource. */ maxAge?: number; } /** * Definition of CpuOptions */ interface CpuOptionsResponse { /** *

Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see AMD SEV-SNP.

*/ amdSevSnp?: outputs.awsconnector.AmdSevSnpSpecificationEnumValueResponse; /** *

The number of CPU cores for the instance.

*/ coreCount?: number; /** *

The number of threads per CPU core.

*/ threadsPerCore?: number; } /** * Definition of CredentialProviderTypeEnumValue */ interface CredentialProviderTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of CriteriaBlockForJob */ interface CriteriaBlockForJobResponse { /** *

An array of conditions, one for each condition that determines which buckets to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

*/ and?: outputs.awsconnector.CriteriaForJobResponse[]; } /** * Definition of CriteriaForJob */ interface CriteriaForJobResponse { /** *

A property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.

*/ simpleCriterion?: outputs.awsconnector.SimpleCriterionForJobResponse; /** *

A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding buckets from the job.

*/ tagCriterion?: outputs.awsconnector.TagCriterionForJobResponse; } /** * Definition of Criteria */ interface CriteriaResponse { /** * The S3 object key for the AllowList. */ regex?: string; /** * The S3 location for the AllowList. */ s3WordsList?: outputs.awsconnector.S3WordsListResponse; } /** * Definition of Csv */ interface CsvResponse { /** * The delimiter used for separating items in the CSV file being imported. */ delimiter?: string; /** * List of the headers used to specify a common header for all source CSV files being imported. If this field is specified then the first line of each CSV file is treated as data instead of the header. If this field is not specified the the first line of each CSV file is treated as the header. */ headerList?: string[]; } /** * Definition of CustomAction */ interface CustomActionNetworkFirewallRuleGroupResponse { /** * Property actionDefinition */ actionDefinition?: outputs.awsconnector.ActionDefinitionNetworkFirewallRuleGroupResponse; /** * Property actionName */ actionName?: string; } /** * Definition of CustomAction */ interface CustomActionResponse { /** * Property actionDefinition */ actionDefinition?: outputs.awsconnector.ActionDefinitionResponse; /** * Property actionName */ actionName?: string; } /** * Definition of CustomErrorResponse */ interface CustomErrorResponseResponse { /** * The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in ``ErrorCode``. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available. For more information, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*. */ errorCachingMinTTL?: number; /** * The HTTP status code for which you want to specify a custom error page and/or a caching duration. */ errorCode?: number; /** * The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example: + Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute ``200``, the response typically won't be intercepted. + If you don't care about distinguishing among different client errors or server errors, you can specify ``400`` or ``500`` as the ``ResponseCode`` for all 4xx or 5xx errors. + You might want to return a ``200`` status code (OK) and static website so your customers don't know that your website is down. If you specify a value for ``ResponseCode``, you must also specify a value for ``ResponsePagePath``. */ responseCode?: number; /** * The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by ``ErrorCode``, for example, ``/4xx-errors/403-forbidden.html``. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true: + The value of ``PathPattern`` matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named ``/4xx-errors``. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, ``/4xx-errors/*``. + The value of ``TargetOriginId`` specifies the value of the ``ID`` element for the origin that contains your custom error pages. If you specify a value for ``ResponsePagePath``, you must also specify a value for ``ResponseCode``. We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable. */ responsePagePath?: string; } /** * customErrorResponseResponseProvideDefaults sets the appropriate defaults for CustomErrorResponseResponse */ function customErrorResponseResponseProvideDefaults(val: CustomErrorResponseResponse): CustomErrorResponseResponse; /** * Definition of CustomOriginConfig */ interface CustomOriginConfigResponse { /** * The HTTP port that CloudFront uses to connect to the origin. Specify the HTTP port that the origin listens on. */ httpPort?: number; /** * The HTTPS port that CloudFront uses to connect to the origin. Specify the HTTPS port that the origin listens on. */ httpsPort?: number; /** * Specifies how long, in seconds, CloudFront persists its connection to the origin. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 5 seconds. For more information, see [Origin Keep-alive Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginKeepaliveTimeout) in the *Amazon CloudFront Developer Guide*. */ originKeepaliveTimeout?: number; /** * Specifies the protocol (HTTP or HTTPS) that CloudFront uses to connect to the origin. Valid values are: + ``http-only`` – CloudFront always uses HTTP to connect to the origin. + ``match-viewer`` – CloudFront connects to the origin using the same protocol that the viewer used to connect to CloudFront. + ``https-only`` – CloudFront always uses HTTPS to connect to the origin. */ originProtocolPolicy?: string; /** * Specifies how long, in seconds, CloudFront waits for a response from the origin. This is also known as the *origin response timeout*. The minimum timeout is 1 second, the maximum is 60 seconds, and the default (if you don't specify otherwise) is 30 seconds. For more information, see [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout) in the *Amazon CloudFront Developer Guide*. */ originReadTimeout?: number; /** * Specifies the minimum SSL/TLS protocol that CloudFront uses when connecting to your origin over HTTPS. Valid values include ``SSLv3``, ``TLSv1``, ``TLSv1.1``, and ``TLSv1.2``. For more information, see [Minimum Origin SSL Protocol](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginSSLProtocols) in the *Amazon CloudFront Developer Guide*. */ originSSLProtocols?: string[]; } /** * customOriginConfigResponseProvideDefaults sets the appropriate defaults for CustomOriginConfigResponse */ function customOriginConfigResponseProvideDefaults(val: CustomOriginConfigResponse): CustomOriginConfigResponse; /** * Definition of DBClusterRole */ interface DBClusterRoleResponse { /** * The name of the feature associated with the AWS Identity and Access Management (IAM) role. For the list of supported feature names, see DBEngineVersion in the Amazon RDS API Reference. */ featureName?: string; /** * The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. */ roleArn?: string; } /** * Definition of DBInstanceRole */ interface DBInstanceRoleResponse { /** * The name of the feature associated with the AWS Identity and Access Management (IAM) role. IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the ``SupportedFeatureNames`` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference*. */ featureName?: string; /** * The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance. */ roleArn?: string; } /** * Definition of DBSnapshotAttribute */ interface DBSnapshotAttributeResponse { /** *

The name of the manual DB snapshot attribute.

The attribute named restore refers to the list of Amazon Web Services accounts that have permission to copy or restore the manual DB cluster snapshot. For more information, see the ModifyDBSnapshotAttribute API action.

*/ attributeName?: string; /** *

The value or values for the manual DB snapshot attribute.

If the AttributeName field is set to restore, then this element returns a list of IDs of the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If a value of all is in the list, then the manual DB snapshot is public and available for any Amazon Web Services account to copy or restore.

*/ attributeValues?: string[]; } /** * Definition of DataExport */ interface DataExportResponse { /** * The place to store the data for an analysis. Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket. */ destination?: outputs.awsconnector.DestinationResponse; /** * The version of the output schema to use when exporting data. Must be ``V_1``. */ outputSchemaVersion?: string; } /** * Definition of DataResource */ interface DataResourceResponse { /** * The resource type in which you want to log data events. You can specify AWS::S3::Object or AWS::Lambda::Function resources. */ type?: string; /** * An array of Amazon Resource Name (ARN) strings or partial ARN strings for the specified objects. */ values?: string[]; } /** * Definition of DataSourceLevelMetricsBehaviorEnumValue */ interface DataSourceLevelMetricsBehaviorEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of DatabaseMigrationServiceReplicationInstance */ interface DatabaseMigrationServiceReplicationInstancePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsDatabaseMigrationServiceReplicationInstancePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Endpoint */ interface DaxClusterEndpointResponse { /** *

The DNS hostname of the endpoint.

*/ address?: string; /** *

The port number that applications should use to connect to the endpoint.

*/ port?: number; /** *

The URL that applications should use to connect to the endpoint. The default ports are 8111 for the 'dax' protocol and 9111 for the 'daxs' protocol.

*/ url?: string; } /** * Definition of NotificationConfiguration */ interface DaxClusterNotificationConfigurationResponse { /** *

The Amazon Resource Name (ARN) that identifies the topic.

*/ topicArn?: string; /** *

The current state of the topic. A value of “active” means that notifications will be sent to the topic. A value of “inactive” means that notifications will not be sent to the topic.

*/ topicStatus?: string; } /** * Definition of DaxCluster */ interface DaxClusterPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsDaxClusterPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of DeadLetterConfig */ interface DeadLetterConfigResponse { /** * The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic. */ targetArn?: string; } /** * Definition of DefaultActionEnumValue */ interface DefaultActionEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of DefaultCacheBehavior */ interface DefaultCacheBehaviorResponse { /** * A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices: + CloudFront forwards only ``GET`` and ``HEAD`` requests. + CloudFront forwards only ``GET``, ``HEAD``, and ``OPTIONS`` requests. + CloudFront forwards ``GET, HEAD, OPTIONS, PUT, PATCH, POST``, and ``DELETE`` requests. If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin. */ allowedMethods?: string[]; /** * The unique identifier of the cache policy that is attached to the default cache behavior. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. */ cachePolicyId?: string; /** * A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices: + CloudFront caches responses to ``GET`` and ``HEAD`` requests. + CloudFront caches responses to ``GET``, ``HEAD``, and ``OPTIONS`` requests. If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. */ cachedMethods?: string[]; /** * Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify ``true``; if not, specify ``false``. For more information, see [Serving Compressed Files](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html) in the *Amazon CloudFront Developer Guide*. */ compress?: boolean; /** * This field is deprecated. We recommend that you use the ``DefaultTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. */ defaultTTL?: number; /** * The value of ``ID`` for the field-level encryption configuration that you want CloudFront to use for encrypting specific fields of data for the default cache behavior. */ fieldLevelEncryptionId?: string; /** * This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. For more information, see [Working with policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/working-with-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. A ``DefaultCacheBehavior`` must include either a ``CachePolicyId`` or ``ForwardedValues``. We recommend that you use a ``CachePolicyId``. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include values in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send values to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies how CloudFront handles query strings, cookies, and HTTP headers. */ forwardedValues?: outputs.awsconnector.ForwardedValuesResponse; /** * A list of CloudFront functions that are associated with this cache behavior. CloudFront functions must be published to the ``LIVE`` stage to associate them with a cache behavior. */ functionAssociations?: outputs.awsconnector.FunctionAssociationResponse[]; /** * A complex type that contains zero or more Lambda@Edge function associations for a cache behavior. */ lambdaFunctionAssociations?: outputs.awsconnector.LambdaFunctionAssociationResponse[]; /** * This field is deprecated. We recommend that you use the ``MaxTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as ``Cache-Control max-age``, ``Cache-Control s-maxage``, and ``Expires`` to objects. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. */ maxTTL?: number; /** * This field is deprecated. We recommend that you use the ``MinTTL`` field in a cache policy instead of this field. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) or [Using the managed cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-cache-policies.html) in the *Amazon CloudFront Developer Guide*. The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see [Managing How Long Content Stays in an Edge Cache (Expiration)](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. You must specify ``0`` for ``MinTTL`` if you configure CloudFront to forward all headers to your origin (under ``Headers``, if you specify ``1`` for ``Quantity`` and ``*`` for ``Name``). */ minTTL?: number; /** * The unique identifier of the origin request policy that is attached to the default cache behavior. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) or [Using the managed origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-managed-origin-request-policies.html) in the *Amazon CloudFront Developer Guide*. */ originRequestPolicyId?: string; /** * The Amazon Resource Name (ARN) of the real-time log configuration that is attached to this cache behavior. For more information, see [Real-time logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/real-time-logs.html) in the *Amazon CloudFront Developer Guide*. */ realtimeLogConfigArn?: string; /** * The identifier for a response headers policy. */ responseHeadersPolicyId?: string; /** * Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify ``true``; if not, specify ``false``. If you specify ``true`` for ``SmoothStreaming``, you can still distribute other content using this cache behavior if the content matches the value of ``PathPattern``. */ smoothStreaming?: boolean; /** * The value of ``ID`` for the origin that you want CloudFront to route requests to when they use the default cache behavior. */ targetOriginId?: string; /** * A list of key groups that CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted key groups, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with a private key whose corresponding public key is in the key group. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*. */ trustedKeyGroups?: string[]; /** * We recommend using ``TrustedKeyGroups`` instead of ``TrustedSigners``. A list of AWS-account IDs whose public keys CloudFront can use to validate signed URLs or signed cookies. When a cache behavior contains trusted signers, CloudFront requires signed URLs or signed cookies for all requests that match the cache behavior. The URLs or cookies must be signed with the private key of a CloudFront key pair in a trusted signer's AWS-account. The signed URL or cookie contains information about which public key CloudFront should use to verify the signature. For more information, see [Serving private content](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*. */ trustedSigners?: string[]; /** * The protocol that viewers can use to access the files in the origin specified by ``TargetOriginId`` when a request matches the path pattern in ``PathPattern``. You can specify the following options: + ``allow-all``: Viewers can use HTTP or HTTPS. + ``redirect-to-https``: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. + ``https-only``: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). For more information about requiring the HTTPS protocol, see [Requiring HTTPS Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-viewers-to-cloudfront.html) in the *Amazon CloudFront Developer Guide*. The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see [Managing Cache Expiration](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html) in the *Amazon CloudFront Developer Guide*. */ viewerProtocolPolicy?: string; } /** * defaultCacheBehaviorResponseProvideDefaults sets the appropriate defaults for DefaultCacheBehaviorResponse */ function defaultCacheBehaviorResponseProvideDefaults(val: DefaultCacheBehaviorResponse): DefaultCacheBehaviorResponse; /** * Definition of DefaultRetention */ interface DefaultRetentionResponse { /** * The number of days that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``. */ days?: number; /** * The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``. */ mode?: string; /** * The number of years that you want to specify for the default retention period. If Object Lock is turned on, you must specify ``Mode`` and specify either ``Days`` or ``Years``. */ years?: number; } /** * Definition of DeleteMarkerReplication */ interface DeleteMarkerReplicationResponse { /** * Indicates whether to replicate delete markers. Disabled by default. */ status?: string; } /** * Definition of DeploymentAlarms */ interface DeploymentAlarmsResponse { /** * One or more CloudWatch alarm names. Use a ',' to separate the alarms. */ alarmNames?: string[]; /** * Determines whether to use the CloudWatch alarm option in the service deployment process. */ enable?: boolean; /** * Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. */ rollback?: boolean; } /** * Definition of DeploymentCircuitBreaker */ interface DeploymentCircuitBreakerResponse { /** * Determines whether to use the deployment circuit breaker logic for the service. */ enable?: boolean; /** * Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. */ rollback?: boolean; } /** * Definition of DeploymentConfiguration */ interface DeploymentConfigurationResponse { /** * Information about the CloudWatch alarms. One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment. When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure. You can only use the ``DeploymentAlarms`` method to detect failures when the ``DeploymentController`` is set to ``ECS`` (rolling update). For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*. */ alarms?: outputs.awsconnector.DeploymentAlarmsResponse; /** * The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type. The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If you use the deployment circuit breaker, a service deployment will transition to a failed state and stop launching new tasks. If you use the rollback option, when a service deployment fails, the service is rolled back to the last deployment that completed successfully. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide* The deployment circuit breaker can only be used for services using the rolling update (``ECS``) deployment type. The *deployment circuit breaker* determines whether a service deployment will fail if the service can't reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see [Rolling update](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-ecs.html) in the *Amazon Elastic Container Service Developer Guide*. For more information about API failure reasons, see [API failure reasons](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/api_failures_messages.html) in the *Amazon Elastic Container Service Developer Guide*. */ deploymentCircuitBreaker?: outputs.awsconnector.DeploymentCircuitBreakerResponse; /** * If a service is using the rolling update (``ECS``) deployment type, the ``maximumPercent`` parameter represents an upper limit on the number of your service's tasks that are allowed in the ``RUNNING`` or ``PENDING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded down to the nearest integer). This parameter enables you to define the deployment batch size. For example, if your service is using the ``REPLICA`` service scheduler and has a ``desiredCount`` of four tasks and a ``maximumPercent`` value of 200%, the scheduler may start four new tasks before stopping the four older tasks (provided that the cluster resources required to do this are available). The default ``maximumPercent`` value for a service using the ``REPLICA`` service scheduler is 200%. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and tasks that use the EC2 launch type, the *maximum percent* value is set to the default value and is used to define the upper limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If the tasks in the service use the Fargate launch type, the maximum percent value is not used, although it is returned when describing your service. */ maximumPercent?: number; /** * If a service is using the rolling update (``ECS``) deployment type, the ``minimumHealthyPercent`` represents a lower limit on the number of your service's tasks that must remain in the ``RUNNING`` state during a deployment, as a percentage of the ``desiredCount`` (rounded up to the nearest integer). This parameter enables you to deploy without using additional cluster capacity. For example, if your service has a ``desiredCount`` of four tasks and a ``minimumHealthyPercent`` of 50%, the service scheduler may stop two existing tasks to free up cluster capacity before starting two new tasks. For services that *do not* use a load balancer, the following should be noted: + A service is considered healthy if all essential containers within the tasks in the service pass their health checks. + If a task has no essential containers with a health check defined, the service scheduler will wait for 40 seconds after a task reaches a ``RUNNING`` state before the task is counted towards the minimum healthy percent total. + If a task has one or more essential containers with a health check defined, the service scheduler will wait for the task to reach a healthy status before counting it towards the minimum healthy percent total. A task is considered healthy when all essential containers within the task have passed their health checks. The amount of time the service scheduler can wait for is determined by the container health check settings. For services that *do* use a load balancer, the following should be noted: + If a task has no essential containers with a health check defined, the service scheduler will wait for the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. + If a task has an essential container with a health check defined, the service scheduler will wait for both the task to reach a healthy status and the load balancer target group health check to return a healthy status before counting the task towards the minimum healthy percent total. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the EC2 launch type, the *minimum healthy percent* value is set to the default value and is used to define the lower limit on the number of the tasks in the service that remain in the ``RUNNING`` state while the container instances are in the ``DRAINING`` state. If a service is using either the blue/green (``CODE_DEPLOY``) or ``EXTERNAL`` deployment types and is running tasks that use the Fargate launch type, the minimum healthy percent value is not used, although it is returned when describing your service. */ minimumHealthyPercent?: number; } /** * Definition of DeploymentController */ interface DeploymentControllerResponse { /** * The deployment controller type to use. There are three deployment controller types available: + ECS The rolling update (ECS) deployment type involves replacing the current running version of the container with the latest version. The number of containers Amazon ECS adds or removes from the service during a rolling update is controlled by adjusting the minimum and maximum number of healthy tasks allowed during a service deployment, as specified in the DeploymentConfiguration. + CODE_DEPLOY The blue/green (CODE_DEPLOY) deployment type uses the blue/green deployment model powered by , which allows you to verify a new deployment of a service before sending production traffic to it. + EXTERNAL The external (EXTERNAL) deployment type enables you to use any third-party deployment controller for full control over the deployment process for an Amazon ECS service. */ type?: string; } /** * Definition of DeploymentStatusEnumValue */ interface DeploymentStatusEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of DeploymentTargets */ interface DeploymentTargetsResponse { /** * The filter type you want to apply on organizational units and accounts. */ accountFilterType?: string; /** * AWS accounts that you want to create stack instances in the specified Region(s) for. */ accounts?: string[]; /** * Returns the value of the AccountsUrl property. */ accountsUrl?: string; /** * The organization root ID or organizational unit (OU) IDs to which StackSets deploys. */ organizationalUnitIds?: string[]; } /** * Definition of DestinationOptionsModelProperties */ interface DestinationOptionsModelPropertiesResponse { /** * Property fileFormat */ fileFormat?: string; /** * Property hiveCompatiblePartitions */ hiveCompatiblePartitions?: boolean; /** * Property perHourPartition */ perHourPartition?: boolean; } /** * Definition of Destination */ interface DestinationResponse { /** * The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data. Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes. */ bucketAccountId?: string; /** * The Amazon Resource Name (ARN) of the bucket to which data is exported. */ bucketArn?: string; /** * Specifies the file format used when exporting data to Amazon S3. *Allowed values*: ``CSV`` | ``ORC`` | ``Parquet`` */ format?: string; /** * The prefix to use when exporting data. The prefix is prepended to all results. */ prefix?: string; } /** * Definition of Device */ interface DeviceResponse { /** * The path inside the container at which to expose the host device. */ containerPath?: string; /** * The path for the device on the host container instance. */ hostPath?: string; /** * The explicit permissions to provide to the container for the device. By default, the container has permissions for ``read``, ``write``, and ``mknod`` for the device. */ permissions?: string[]; } /** * Definition of DeviceTypeEnumValue */ interface DeviceTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of Dimension */ interface DimensionLogsMetricFilterResponse { /** * The name for the CW metric dimension that the metric filter creates. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (:). */ key?: string; /** * The log event field that will contain the value for this dimension. This dimension will only be published for a metric if the value is found in the log event. For example, ``$.eventType`` for JSON log events, or ``$server`` for space-delimited log events. */ value?: string; } /** * Definition of Dimension */ interface DimensionNetworkFirewallFirewallPolicyResponse { /** * Property value */ value?: string; } /** * Definition of Dimension */ interface DimensionNetworkFirewallRuleGroupResponse { /** * Property value */ value?: string; } /** * Definition of Dimension */ interface DimensionResponse { /** * The name of the dimension, from 1–255 characters in length. This dimension name must have been included when the metric was published. */ name?: string; /** * The value for the dimension, from 1–255 characters in length. */ value?: string; } /** * Definition of Disk */ interface DiskResponse { /** * Instance attached to the disk. */ attachedTo?: string; /** * Attachment state of the disk. */ attachmentState?: string; /** * The names to use for your new Lightsail disk. */ diskName?: string; /** * IOPS of disk. */ iops?: number; /** * Is the Attached disk is the system disk of the Instance. */ isSystemDisk?: boolean; /** * Path of the disk attached to the instance. */ path?: string; /** * Size of the disk attached to the Instance. */ sizeInGb?: string; } /** * Definition of DistributionConfig */ interface DistributionConfigResponse { /** * A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution. */ aliases?: string[]; /** * A complex type that contains zero or more ``CacheBehavior`` elements. */ cacheBehaviors?: outputs.awsconnector.CacheBehaviorResponse[]; /** * Property cnamEs */ cnamEs?: string[]; /** * A comment to describe the distribution. The comment cannot be longer than 128 characters. */ comment?: string; /** * The identifier of a continuous deployment policy. For more information, see ``CreateContinuousDeploymentPolicy``. */ continuousDeploymentPolicyId?: string; /** * A complex type that controls the following: + Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. + How long CloudFront caches HTTP status codes in the 4xx and 5xx range. For more information about custom error pages, see [Customizing Error Responses](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html) in the *Amazon CloudFront Developer Guide*. */ customErrorResponses?: outputs.awsconnector.CustomErrorResponseResponse[]; /** * Property customOrigin */ customOrigin?: outputs.awsconnector.LegacyCustomOriginResponse; /** * A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if files don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior. A complex type that describes the default cache behavior if you don't specify a ``CacheBehavior`` element or if request URLs don't match any of the values of ``PathPattern`` in ``CacheBehavior`` elements. You must create exactly one default cache behavior. */ defaultCacheBehavior?: outputs.awsconnector.DefaultCacheBehaviorResponse; /** * The object that you want CloudFront to request from your origin (for example, ``index.html``) when a viewer requests the root URL for your distribution (``https://www.example.com``) instead of an object in your distribution (``https://www.example.com/product-description.html``). Specifying a default root object avoids exposing the contents of your distribution. Specify only the object name, for example, ``index.html``. Don't add a ``/`` before the object name. If you don't want to specify a default root object when you create a distribution, include an empty ``DefaultRootObject`` element. To delete the default root object from an existing distribution, update the distribution configuration and include an empty ``DefaultRootObject`` element. To replace the default root object, update the distribution configuration and specify the new object. For more information about the default root object, see [Creating a Default Root Object](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html) in the *Amazon CloudFront Developer Guide*. */ defaultRootObject?: string; /** * From this field, you can enable or disable the selected distribution. */ enabled?: boolean; /** * (Optional) Specify the maximum HTTP version(s) that you want viewers to use to communicate with CF. The default value for new distributions is ``http1.1``. For viewers and CF to use HTTP/2, viewers must support TLSv1.2 or later, and must support Server Name Indication (SNI). For viewers and CF to use HTTP/3, viewers must support TLSv1.3 and Server Name Indication (SNI). CF supports HTTP/3 connection migration to allow the viewer to switch networks without losing connection. For more information about connection migration, see [Connection Migration](https://www.rfc-editor.org/rfc/rfc9000.html#name-connection-migration) at RFC 9000. For more information about supported TLSv1.3 ciphers, see [Supported protocols and ciphers between viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html). */ httpVersion?: string; /** * If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify ``true``. If you specify ``false``, CloudFront responds to IPv6 DNS requests with the DNS response code ``NOERROR`` and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the ``IpAddress`` parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see [Creating a Signed URL Using a Custom Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html) in the *Amazon CloudFront Developer Guide*. If you're using an R53AWSIntlong alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true: + You enable IPv6 for the distribution + You're using alternate domain names in the URLs for your objects For more information, see [Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html) in the *Developer Guide*. If you created a CNAME resource record set, either with R53AWSIntlong or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request. */ ipV6Enabled?: boolean; /** * A complex type that controls whether access logs are written for the distribution. For more information about logging, see [Access Logs](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html) in the *Amazon CloudFront Developer Guide*. A complex type that controls whether access logs are written for the distribution. */ logging?: outputs.awsconnector.LoggingResponse; /** * A complex type that contains information about origin groups for this distribution. A complex data type for the origin groups specified for a distribution. */ originGroups?: outputs.awsconnector.OriginGroupsResponse; /** * A complex type that contains information about origins for this distribution. */ origins?: outputs.awsconnector.OriginResponse[]; /** * The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify ``PriceClass_All``, CloudFront responds to requests for your objects from all CloudFront edge locations. If you specify a price class other than ``PriceClass_All``, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance. For more information about price classes, see [Choosing the Price Class for a CloudFront Distribution](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html) in the *Amazon CloudFront Developer Guide*. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see [Amazon CloudFront Pricing](https://aws.amazon.com/cloudfront/pricing/). */ priceClass?: string; /** * A complex type that identifies ways in which you want to restrict distribution of your content. A complex type that identifies ways in which you want to restrict distribution of your content. */ restrictions?: outputs.awsconnector.RestrictionsResponse; /** * Property s3Origin */ s3Origin?: outputs.awsconnector.LegacyS3OriginResponse; /** * A Boolean that indicates whether this is a staging distribution. When this value is ``true``, this is a staging distribution. When this value is ``false``, this is not a staging distribution. */ staging?: boolean; /** * A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. A complex type that determines the distribution's SSL/TLS configuration for communicating with viewers. If the distribution doesn't use ``Aliases`` (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``—set ``CloudFrontDefaultCertificate`` to ``true`` and leave all other fields empty. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), use the fields in this type to specify the following settings: + Which viewers the distribution accepts HTTPS connections from: only viewers that support [server name indication (SNI)](https://en.wikipedia.org/wiki/Server_Name_Indication) (recommended), or all viewers including those that don't support SNI. + To accept HTTPS connections from only viewers that support SNI, set ``SSLSupportMethod`` to ``sni-only``. This is recommended. Most browsers and clients support SNI. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) + To accept HTTPS connections from all viewers, including those that don't support SNI, set ``SSLSupportMethod`` to ``vip``. This is not recommended, and results in additional monthly charges from CloudFront. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) + The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for ``MinimumProtocolVersion``. For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) in the *Amazon CloudFront Developer Guide*. + The location of the SSL/TLS certificate, [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html) (recommended) or [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html). You specify the location by setting a value in one of the following fields (not both): + ``ACMCertificateArn`` (In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization.) + ``IAMCertificateId`` (In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization.) All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ``ViewerProtocolPolicy`` in the ``CacheBehavior`` or ``DefaultCacheBehavior``. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use ``CustomOriginConfig``. For more information, see [Using HTTPS with CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https.html) and [Using Alternate Domain Names and HTTPS](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/using-https-alternate-domain-names.html) in the *Amazon CloudFront Developer Guide*. */ viewerCertificate?: outputs.awsconnector.ViewerCertificateResponse; /** * A unique identifier that specifies the WAF web ACL, if any, to associate with this distribution. To specify a web ACL created using the latest version of WAF, use the ACL ARN, for example ``arn:aws:wafv2:us-east-1:123456789012:global/webacl/ExampleWebACL/473e64fd-f30b-4765-81a0-62ad96dd167a``. To specify a web ACL created using WAF Classic, use the ACL ID, for example ``473e64fd-f30b-4765-81a0-62ad96dd167a``. WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about WAF, see the [Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html). */ webACLId?: string; } /** * distributionConfigResponseProvideDefaults sets the appropriate defaults for DistributionConfigResponse */ function distributionConfigResponseProvideDefaults(val: DistributionConfigResponse): DistributionConfigResponse; /** * Definition of DockerVolumeConfiguration */ interface DockerVolumeConfigurationResponse { /** * If this value is ``true``, the Docker volume is created if it doesn't already exist. This field is only used if the ``scope`` is ``shared``. */ autoprovision?: boolean; /** * The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement. If the driver was installed using the Docker plugin CLI, use ``docker plugin ls`` to retrieve the driver name from your container instance. If the driver was installed using another method, use Docker plugin discovery to retrieve the driver name. For more information, see [Docker plugin discovery](https://docs.docker.com/engine/extend/plugin_api/#plugin-discovery). This parameter maps to ``Driver`` in the [Create a volume](https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``xxdriver`` option to [docker volume create](https://docs.docker.com/engine/reference/commandline/volume_create/). */ driver?: string; /** * A map of Docker driver-specific options passed through. This parameter maps to ``DriverOpts`` in the [Create a volume](https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``xxopt`` option to [docker volume create](https://docs.docker.com/engine/reference/commandline/volume_create/). */ driverOpts?: any; /** * Custom metadata to add to your Docker volume. This parameter maps to ``Labels`` in the [Create a volume](https://docs.docker.com/engine/api/v1.35/#operation/VolumeCreate) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``xxlabel`` option to [docker volume create](https://docs.docker.com/engine/reference/commandline/volume_create/). */ labels?: any; /** * The scope for the Docker volume that determines its lifecycle. Docker volumes that are scoped to a ``task`` are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as ``shared`` persist after the task stops. */ scope?: string; } /** * Definition of DomainEndpointOptions */ interface DomainEndpointOptionsResponse { /** *

The fully qualified URL for the custom endpoint.

*/ customEndpoint?: string; /** *

The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

*/ customEndpointCertificateArn?: string; /** *

Whether to enable a custom endpoint for the domain.

*/ customEndpointEnabled?: boolean; /** *

True to require that all traffic to the domain arrive over HTTPS.

*/ enforceHTTPS?: boolean; /** *

Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy can be one of the following values:

  • Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2

  • Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2

  • Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites

*/ tlsSecurityPolicy?: outputs.awsconnector.TLSSecurityPolicyEnumValueResponse; } /** * Definition of DomainProcessingStatusTypeEnumValue */ interface DomainProcessingStatusTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of DomainTypeEnumValue */ interface DomainTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of DynamoDBContinuousBackupsDescription */ interface DynamoDBContinuousBackupsDescriptionPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsDynamoDBContinuousBackupsDescriptionPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of DynamoDBTable */ interface DynamoDBTablePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsDynamoDBTablePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of EBSOptions */ interface EBSOptionsResponse { /** *

Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

*/ ebsEnabled?: boolean; /** *

Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

*/ iops?: number; /** *

Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

*/ throughput?: number; /** *

Specifies the size (in GiB) of EBS volumes attached to data nodes.

*/ volumeSize?: number; /** *

Specifies the type of EBS volumes attached to data nodes.

*/ volumeType?: outputs.awsconnector.VolumeTypeEnumValueResponse; } /** * Definition of EBSTagSpecification */ interface EBSTagSpecificationResponse { /** * Determines whether to propagate the tags from the task definition to the Amazon EBS volume. Tags can only propagate to a ``SERVICE`` specified in ``ServiceVolumeConfiguration``. If no value is specified, the tags aren't propagated. */ propagateTags?: string; /** * The type of volume resource. */ resourceType?: string; /** * The tags applied to this Amazon EBS volume. ``AmazonECSCreated`` and ``AmazonECSManaged`` are reserved tags that can't be used. */ tags?: outputs.awsconnector.TagResponse[]; } /** * Definition of EFSVolumeConfiguration */ interface EFSVolumeConfigurationResponse { /** * The authorization configuration details for the Amazon EFS file system. The authorization configuration details for the Amazon EFS file system. */ authorizationConfig?: outputs.awsconnector.AuthorizationConfigResponse; /** * The Amazon EFS file system ID to use. */ filesystemId?: string; /** * The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume will be used. Specifying ``/`` will have the same effect as omitting this parameter. If an EFS access point is specified in the ``authorizationConfig``, the root directory parameter must either be omitted or set to ``/`` which will enforce the path set on the EFS access point. */ rootDirectory?: string; /** * Determines whether to use encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be turned on if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of ``DISABLED`` is used. For more information, see [Encrypting data in transit](https://docs.aws.amazon.com/efs/latest/ug/encryption-in-transit.html) in the *Amazon Elastic File System User Guide*. */ transitEncryption?: string; /** * The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you do not specify a transit encryption port, it will use the port selection strategy that the Amazon EFS mount helper uses. For more information, see [EFS mount helper](https://docs.aws.amazon.com/efs/latest/ug/efs-mount-helper.html) in the *Amazon Elastic File System User Guide*. */ transitEncryptionPort?: number; } /** * Definition of EbsBlockDevice */ interface EbsBlockDeviceResponse { /** *

Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.

*/ deleteOnTermination?: boolean; /** *

Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

This parameter is not returned by DescribeImageAttribute.

For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.

  • If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true for an encrypted volume, or false for an unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).

  • If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.

  • If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false. If you specify true, the request will fail. In this case, we recommend that you omit the parameter.

  • If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.

*/ encrypted?: boolean; /** *

The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.

The following are the supported values for each volume type:

  • gp3: 3,000 - 16,000 IOPS

  • io1: 100 - 64,000 IOPS

  • io2: 100 - 256,000 IOPS

For io2 volumes, you can achieve up to 256,000 IOPS on instances built on the Nitro System. On other instances, you can achieve performance up to 32,000 IOPS.

This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS.

*/ iops?: number; /** *

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

*/ kmsKeyId?: string; /** *

The ARN of the Outpost on which the snapshot is stored.

This parameter is not supported when using CreateImage.

*/ outpostArn?: string; /** *

The ID of the snapshot.

*/ snapshotId?: string; /** *

The throughput that the volume supports, in MiB/s.

This parameter is valid only for gp3 volumes.

Valid Range: Minimum value of 125. Maximum value of 1000.

*/ throughput?: number; /** *

The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.

The following are the supported sizes for each volume type:

  • gp2 and gp3: 1 - 16,384 GiB

  • io1: 4 - 16,384 GiB

  • io2: 4 - 65,536 GiB

  • st1 and sc1: 125 - 16,384 GiB

  • standard: 1 - 1024 GiB

*/ volumeSize?: number; /** *

The volume type. For more information, see Amazon EBS volume types in the Amazon EBS User Guide.

*/ volumeType?: outputs.awsconnector.VolumeTypeEnumValueResponse; } /** * Definition of EbsInstanceBlockDevice */ interface EbsInstanceBlockDeviceResponse { /** *

The ARN of the Amazon ECS or Fargate task to which the volume is attached.

*/ associatedResource?: string; /** *

The time stamp when the attachment initiated.

*/ attachTime?: string; /** *

Indicates whether the volume is deleted on instance termination.

*/ deleteOnTermination?: boolean; /** *

The attachment state.

*/ status?: outputs.awsconnector.AttachmentStatusEnumValueResponse; /** *

The ID of the EBS volume.

*/ volumeId?: string; /** *

The ID of the Amazon Web Services account that owns the volume.

This parameter is returned only for volumes that are attached to Fargate tasks.

*/ volumeOwnerId?: string; } /** * Definition of Ec2AccountAttribute */ interface Ec2AccountAttributePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2AccountAttributePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Ec2Address */ interface Ec2AddressPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2AddressPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Ec2FlowLog */ interface Ec2FlowLogPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2FlowLogPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Ec2Image */ interface Ec2ImagePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2ImagePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Ec2InstanceAttributes */ interface Ec2InstanceAttributesResponse { /** *

A list of additional Amazon EC2 security group IDs for the master node.

*/ additionalMasterSecurityGroups?: string[]; /** *

A list of additional Amazon EC2 security group IDs for the core and task nodes.

*/ additionalSlaveSecurityGroups?: string[]; /** *

The Availability Zone in which the cluster will run.

*/ ec2AvailabilityZone?: string; /** *

The name of the Amazon EC2 key pair to use when connecting with SSH into the master node as a user named 'hadoop'.

*/ ec2KeyName?: string; /** *

Set this parameter to the identifier of the Amazon VPC subnet where you want the cluster to launch. If you do not specify this value, and your account supports EC2-Classic, the cluster launches in EC2-Classic.

*/ ec2SubnetId?: string; /** *

The identifier of the Amazon EC2 security group for the master node.

*/ emrManagedMasterSecurityGroup?: string; /** *

The identifier of the Amazon EC2 security group for the core and task nodes.

*/ emrManagedSlaveSecurityGroup?: string; /** *

The IAM role that was specified when the cluster was launched. The Amazon EC2 instances of the cluster assume this role.

*/ iamInstanceProfile?: string; /** *

Applies to clusters configured with the instance fleets option. Specifies one or more Availability Zones in which to launch Amazon EC2 cluster instances when the EC2-Classic network configuration is supported. Amazon EMR chooses the Availability Zone with the best fit from among the list of RequestedEc2AvailabilityZones, and then launches all cluster instances within that Availability Zone. If you do not specify this value, Amazon EMR chooses the Availability Zone for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.

*/ requestedEc2AvailabilityZones?: string[]; /** *

Applies to clusters configured with the instance fleets option. Specifies the unique identifier of one or more Amazon EC2 subnets in which to launch Amazon EC2 cluster instances. Subnets must exist within the same VPC. Amazon EMR chooses the Amazon EC2 subnet with the best fit from among the list of RequestedEc2SubnetIds, and then launches all cluster instances within that Subnet. If this value is not specified, and the account and Region support EC2-Classic networks, the cluster launches instances in the EC2-Classic network and uses RequestedEc2AvailabilityZones instead of this setting. If EC2-Classic is not supported, and no Subnet is specified, Amazon EMR chooses the subnet for you. RequestedEc2SubnetIDs and RequestedEc2AvailabilityZones cannot be specified together.

*/ requestedEc2SubnetIds?: string[]; /** *

The identifier of the Amazon EC2 security group for the Amazon EMR service to access clusters in VPC private subnets.

*/ serviceAccessSecurityGroup?: string; } /** * Definition of Ec2Instance */ interface Ec2InstancePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2InstancePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * ec2InstancePropertiesResponseProvideDefaults sets the appropriate defaults for Ec2InstancePropertiesResponse */ function ec2InstancePropertiesResponseProvideDefaults(val: Ec2InstancePropertiesResponse): Ec2InstancePropertiesResponse; /** * Definition of Ec2InstanceStatus */ interface Ec2InstanceStatusPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2InstanceStatusPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Ec2Ipam */ interface Ec2IpamPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2IpamPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Ec2KeyPair */ interface Ec2KeyPairPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2KeyPairPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * ec2KeyPairPropertiesResponseProvideDefaults sets the appropriate defaults for Ec2KeyPairPropertiesResponse */ function ec2KeyPairPropertiesResponseProvideDefaults(val: Ec2KeyPairPropertiesResponse): Ec2KeyPairPropertiesResponse; /** * Definition of Ec2NetworkAcl */ interface Ec2NetworkAclPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2NetworkAclPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Ec2NetworkInterface */ interface Ec2NetworkInterfacePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2NetworkInterfacePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Ec2RouteTable */ interface Ec2RouteTablePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2RouteTablePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Ec2SecurityGroup */ interface Ec2SecurityGroupPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2SecurityGroupPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Ec2Snapshot */ interface Ec2SnapshotPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2SnapshotPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Ec2Subnet */ interface Ec2SubnetPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2SubnetPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Ec2VPCEndpoint */ interface Ec2VPCEndpointPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2VPCEndpointPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Ec2VPCPeeringConnection */ interface Ec2VPCPeeringConnectionPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2VPCPeeringConnectionPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Ec2Volume */ interface Ec2VolumePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2VolumePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Ec2Vpc */ interface Ec2VpcPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEc2VpcPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of EcrImageDetail */ interface EcrImageDetailPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEcrImageDetailPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of EcrRepository */ interface EcrRepositoryPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEcrRepositoryPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of EcsCluster */ interface EcsClusterPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEcsClusterPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of EcsService */ interface EcsServicePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEcsServicePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * ecsServicePropertiesResponseProvideDefaults sets the appropriate defaults for EcsServicePropertiesResponse */ function ecsServicePropertiesResponseProvideDefaults(val: EcsServicePropertiesResponse): EcsServicePropertiesResponse; /** * Definition of EcsTaskDefinition */ interface EcsTaskDefinitionPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEcsTaskDefinitionPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of EfsFileSystem */ interface EfsFileSystemPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEfsFileSystemPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of EfsMountTarget */ interface EfsMountTargetPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEfsMountTargetPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of EksCluster */ interface EksClusterPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEksClusterPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of EksNodegroup */ interface EksNodegroupPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEksNodegroupPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of ElasticBeanstalkApplication */ interface ElasticBeanstalkApplicationPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsElasticBeanstalkApplicationPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of ElasticBeanstalkConfigurationTemplate */ interface ElasticBeanstalkConfigurationTemplatePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsElasticBeanstalkConfigurationTemplatePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of ElasticBeanstalkEnvironment */ interface ElasticBeanstalkEnvironmentPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsElasticBeanstalkEnvironmentPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of ElasticFileSystemTag */ interface ElasticFileSystemTagResponse { /** * The tag key (String). The key can't start with ``aws:``. */ key?: string; /** * The value of the tag key. */ value?: string; } /** * Definition of ElasticGpuAssociation */ interface ElasticGpuAssociationResponse { /** *

The ID of the association.

*/ elasticGpuAssociationId?: string; /** *

The state of the association between the instance and the Elastic Graphics accelerator.

*/ elasticGpuAssociationState?: string; /** *

The time the Elastic Graphics accelerator was associated with the instance.

*/ elasticGpuAssociationTime?: string; /** *

The ID of the Elastic Graphics accelerator.

*/ elasticGpuId?: string; } /** * Definition of ElasticInferenceAcceleratorAssociation */ interface ElasticInferenceAcceleratorAssociationResponse { /** *

The Amazon Resource Name (ARN) of the elastic inference accelerator.

*/ elasticInferenceAcceleratorArn?: string; /** *

The ID of the association.

*/ elasticInferenceAcceleratorAssociationId?: string; /** *

The state of the elastic inference accelerator.

*/ elasticInferenceAcceleratorAssociationState?: string; /** *

The time at which the elastic inference accelerator is associated with an instance.

*/ elasticInferenceAcceleratorAssociationTime?: string; } /** * Definition of ElasticLoadBalancingV2Listener */ interface ElasticLoadBalancingV2ListenerPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsElasticLoadBalancingV2ListenerPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of ElasticLoadBalancingV2LoadBalancer */ interface ElasticLoadBalancingV2LoadBalancerPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsElasticLoadBalancingV2LoadBalancerPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of ElasticLoadBalancingV2TargetGroup */ interface ElasticLoadBalancingV2TargetGroupPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsElasticLoadBalancingV2TargetGroupPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of ElasticLoadBalancingv2TargetHealthDescription */ interface ElasticLoadBalancingv2TargetHealthDescriptionPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsElasticLoadBalancingv2TargetHealthDescriptionPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of EmrCluster */ interface EmrClusterPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsEmrClusterPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of ClusterStatus */ interface EmrClusterStatusResponse { /** *

A list of tuples that provides information about the errors that caused a cluster to terminate. This structure can contain up to 10 different ErrorDetail tuples.

*/ errorDetails?: outputs.awsconnector.ErrorDetailResponse[]; /** *

The current state of the cluster.

*/ state?: outputs.awsconnector.ClusterStateEnumValueResponse; /** *

The reason for the cluster status change.

*/ stateChangeReason?: outputs.awsconnector.ClusterStateChangeReasonResponse; /** *

A timeline that represents the status of a cluster over the lifetime of the cluster.

*/ timeline?: outputs.awsconnector.ClusterTimelineResponse; } /** * Definition of EnclaveOptions */ interface EnclaveOptionsResponse { /** *

If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.

*/ enabled?: boolean; } /** * Definition of EncryptionAtRestOptions */ interface EncryptionAtRestOptionsResponse { /** *

True to enable encryption at rest.

*/ enabled?: boolean; /** *

The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

*/ kmsKeyId?: string; } /** * Definition of EncryptionConfig */ interface EncryptionConfigResponse { /** *

Key Management Service (KMS) key. Either the ARN or the alias can be used.

*/ provider?: outputs.awsconnector.ProviderResponse; /** *

Specifies the resources to be encrypted. The only supported value is secrets.

*/ resources?: string[]; } /** * Definition of EncryptionConfiguration */ interface EncryptionConfigurationResponse { /** * The encryption type to use. If you use the ``KMS`` encryption type, the contents of the repository will be encrypted using server-side encryption with KMSlong key stored in KMS. When you use KMS to encrypt your data, you can either use the default AWS managed KMS key for Amazon ECR, or specify your own KMS key, which you already created. For more information, see [Protecting data using server-side encryption with an key stored in (SSE-KMS)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html) in the *Amazon Simple Storage Service Console Developer Guide*. If you use the ``AES256`` encryption type, Amazon ECR uses server-side encryption with Amazon S3-managed encryption keys which encrypts the images in the repository using an AES-256 encryption algorithm. For more information, see [Protecting data using server-side encryption with Amazon S3-managed encryption keys (SSE-S3)](https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html) in the *Ama The encryption type to use. */ encryptionType?: string; /** * If you use the ``KMS`` encryption type, specify the KMS key to use for encryption. The alias, key ID, or full ARN of the KMS key can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed KMS key for Amazon ECR will be used. If you use the KMS encryption type, specify the CMK to use for encryption. The alias, key ID, or full ARN of the CMK can be specified. The key must exist in the same Region as the repository. If no key is specified, the default AWS managed CMK for Amazon ECR will be used. */ kmsKey?: string; } /** * Definition of EncryptionConfiguration */ interface EncryptionConfigurationS3BucketResponse { /** * Specifies the ID (Key ARN or Alias ARN) of the customer managed AWS KMS key stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*. */ replicaKmsKeyID?: string; } /** * Definition of EndpointConfiguration */ interface EndpointConfigurationResponse { /** * A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is ``'EDGE'``. For a regional API and its custom domain name, the endpoint type is ``REGIONAL``. For a private API, the endpoint type is ``PRIVATE``. */ types?: string[]; /** * A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for ``PRIVATE`` endpoint type. */ vpcEndpointIds?: string[]; } /** * Definition of EnhancedMetricsConfig */ interface EnhancedMetricsConfigResponse { /** *

Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:

  • Requests: The number of invocations that occured during a request.

  • Latency: The time to complete a data source invocation.

  • Errors: The number of errors that occurred during a data source invocation.

These metrics can be emitted to CloudWatch per data source or for all data sources in the request. Metrics will be recorded by API ID and data source name. dataSourceLevelMetricsBehavior accepts one of these values at a time:

  • FULL_REQUEST_DATA_SOURCE_METRICS: Records and emits metric data for all data sources in the request.

  • PER_DATA_SOURCE_METRICS: Records and emits metric data for data sources that have the metricsConfig value set to ENABLED.

*/ dataSourceLevelMetricsBehavior?: outputs.awsconnector.DataSourceLevelMetricsBehaviorEnumValueResponse; /** *

Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:

  • Requests: The number of times a specified GraphQL operation was called.

  • GraphQL errors: The number of GraphQL errors that occurred during a specified GraphQL operation.

Metrics will be recorded by API ID and operation name. You can set the value to ENABLED or DISABLED.

*/ operationLevelMetricsConfig?: outputs.awsconnector.OperationLevelMetricsConfigEnumValueResponse; /** *

Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:

  • GraphQL errors: The number of GraphQL errors that occurred.

  • Requests: The number of invocations that occurred during a request.

  • Latency: The time to complete a resolver invocation.

  • Cache hits: The number of cache hits during a request.

  • Cache misses: The number of cache misses during a request.

These metrics can be emitted to CloudWatch per resolver or for all resolvers in the request. Metrics will be recorded by API ID and resolver name. resolverLevelMetricsBehavior accepts one of these values at a time:

  • FULL_REQUEST_RESOLVER_METRICS: Records and emits metric data for all resolvers in the request.

  • PER_RESOLVER_METRICS: Records and emits metric data for resolvers that have the metricsConfig value set to ENABLED.

*/ resolverLevelMetricsBehavior?: outputs.awsconnector.ResolverLevelMetricsBehaviorEnumValueResponse; } /** * Definition of EnvironmentFile */ interface EnvironmentFileResponse { /** * The file type to use. Environment files are objects in Amazon S3. The only supported value is ``s3``. */ type?: string; /** * The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment variable file. */ value?: string; } /** * Definition of Environment */ interface EnvironmentResponse { /** * Environment variable key-value pairs. For more information, see [Using Lambda environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html). */ variables?: { [key: string]: string; }; } /** * Definition of EnvironmentTypeEnumValue */ interface EnvironmentTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of EnvironmentVariable */ interface EnvironmentVariableResponse { /** *

The name or key of the environment variable.

*/ name?: string; /** *

The type of environment variable. Valid values include:

  • PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the value of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.

  • PLAINTEXT: An environment variable in plain text format. This is the default value.

  • SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment variables of this type, specify the name of the secret as the value of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.

*/ type?: outputs.awsconnector.EnvironmentVariableTypeEnumValueResponse; /** *

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

*/ value?: string; } /** * Definition of EnvironmentVariableTypeEnumValue */ interface EnvironmentVariableTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of EphemeralStorage */ interface EphemeralStorageLambdaFunctionResponse { /** * The size of the function's ``/tmp`` directory. */ size?: number; } /** * Definition of EphemeralStorage */ interface EphemeralStorageResponse { /** * The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is ``20`` GiB and the maximum supported value is ``200`` GiB. */ sizeInGiB?: number; } /** * Definition of ErrorDetail */ interface ErrorDetailResponse { /** *

The name or code associated with the error.

*/ errorCode?: string; /** *

A list of key value pairs that provides contextual information about why an error occured.

*/ errorData?: any[]; /** *

A message that describes the error.

*/ errorMessage?: string; } /** * Definition of EstablishedMultiRegionAccessPointPolicy */ interface EstablishedMultiRegionAccessPointPolicyResponse { /** *

The details of the last established policy.

*/ policy?: string; } /** * Definition of EventBridgeConfiguration */ interface EventBridgeConfigurationResponse { /** * Enables delivery of events to Amazon EventBridge. */ eventBridgeEnabled?: boolean; } /** * eventBridgeConfigurationResponseProvideDefaults sets the appropriate defaults for EventBridgeConfigurationResponse */ function eventBridgeConfigurationResponseProvideDefaults(val: EventBridgeConfigurationResponse): EventBridgeConfigurationResponse; /** * Definition of EventCodeEnumValue */ interface EventCodeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of EventSelector */ interface EventSelectorResponse { /** * Property dataResources */ dataResources?: outputs.awsconnector.DataResourceResponse[]; /** * An optional list of service event sources from which you do not want management events to be logged on your trail. In this release, the list can be empty (disables the filter), or it can filter out AWS Key Management Service events by containing 'kms.amazonaws.com'. By default, ExcludeManagementEventSources is empty, and AWS KMS events are included in events that are logged to your trail. */ excludeManagementEventSources?: string[]; /** * Specify if you want your event selector to include management events for your trail. */ includeManagementEvents?: boolean; /** * Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 GetConsoleOutput is a read-only API operation and RunInstances is a write-only API operation. */ readWriteType?: string; } /** * Definition of ExclusionByResourceTypes */ interface ExclusionByResourceTypesResponse { /** *

A comma-separated list of resource types to exclude from recording by the configuration recorder.

*/ resourceTypes?: string[]; } /** * Definition of ExecuteCommandConfiguration */ interface ExecuteCommandConfigurationResponse { /** * Specify an KMSlong key ID to encrypt the data between the local client and the container. */ kmsKeyId?: string; /** * The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When ``logging=OVERRIDE`` is specified, a ``logConfiguration`` must be provided. The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. */ logConfiguration?: outputs.awsconnector.ExecuteCommandLogConfigurationResponse; /** * The log setting to use for redirecting logs for your execute command results. The following log settings are available. + ``NONE``: The execute command session is not logged. + ``DEFAULT``: The ``awslogs`` configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no ``awslogs`` log driver is configured in the task definition, the output won't be logged. + ``OVERRIDE``: Specify the logging details as a part of ``logConfiguration``. If the ``OVERRIDE`` logging option is specified, the ``logConfiguration`` is required. */ logging?: string; } /** * Definition of ExecuteCommandLogConfiguration */ interface ExecuteCommandLogConfigurationResponse { /** * Determines whether to use encryption on the CloudWatch logs. If not specified, encryption will be off. */ cloudWatchEncryptionEnabled?: boolean; /** * The name of the CloudWatch log group to send logs to. The CloudWatch log group must already be created. */ cloudWatchLogGroupName?: string; /** * The name of the S3 bucket to send logs to. The S3 bucket must already be created. */ s3BucketName?: string; /** * Determines whether to use encryption on the S3 logs. If not specified, encryption is not used. */ s3EncryptionEnabled?: boolean; /** * An optional folder in the S3 bucket to place logs in. */ s3KeyPrefix?: string; } /** * Definition of ExportSourceTypeEnumValue */ interface ExportSourceTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of FSxAuthorizationConfig */ interface FSxAuthorizationConfigResponse { /** * Property credentialsParameter */ credentialsParameter?: string; /** * Property domain */ domain?: string; } /** * Definition of FSxWindowsFileServerVolumeConfiguration */ interface FSxWindowsFileServerVolumeConfigurationResponse { /** * The authorization configuration details for the Amazon FSx for Windows File Server file system. */ authorizationConfig?: outputs.awsconnector.FSxAuthorizationConfigResponse; /** * The Amazon FSx for Windows File Server file system ID to use. */ fileSystemId?: string; /** * The directory within the Amazon FSx for Windows File Server file system to mount as the root directory inside the host. */ rootDirectory?: string; } /** * Definition of FieldLogLevelEnumValue */ interface FieldLogLevelEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of FieldToMatch */ interface FieldToMatchResponse { /** * Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. */ method?: any; /** * Inspect the query string. This is the part of a URL that appears after a ? character, if any. */ queryString?: any; /** * Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive. */ singleHeader?: outputs.awsconnector.SingleHeaderModelPropertiesResponse; /** * Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg. */ uriPath?: any; } /** * Definition of FileSystemConfig */ interface FileSystemConfigResponse { /** * The Amazon Resource Name (ARN) of the Amazon EFS access point that provides access to the file system. */ arn?: string; /** * The path where the function can access the file system, starting with ``/mnt/``. */ localMountPath?: string; } /** * Definition of FileSystemProtection */ interface FileSystemProtectionResponse { /** * The status of the file system's replication overwrite protection. + ``ENABLED`` – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ``ENABLED`` by default. + ``DISABLED`` – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication. + ``REPLICATING`` – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication. If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable. */ replicationOverwriteProtection?: string; } /** * Definition of FileSystemTypeEnumValue */ interface FileSystemTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of FilterGroup */ interface FilterGroupResponse { /** * Property webhookFilter */ webhookFilter?: outputs.awsconnector.WebhookFilterResponse; } /** * Definition of Filter */ interface FilterResponse { /** * Property contains */ contains?: string[]; /** * Property eq */ eq?: string[]; /** * Property exists */ exists?: boolean; /** * Property neq */ neq?: string[]; /** * Property property */ property?: string; } /** * Definition of FilterRule */ interface FilterRuleResponse { /** * The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see [Configuring Event Notifications](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*. */ name?: string; /** * The value that the filter searches for in object key names. */ value?: string; } /** * Definition of Filter */ interface FilterWafv2LoggingConfigurationResponse { /** * How to handle logs that satisfy the filter's conditions and requirement. */ behavior?: string; /** * Match conditions for the filter. */ conditions?: outputs.awsconnector.ConditionResponse[]; /** * Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition. */ requirement?: string; } /** * Definition of FirelensConfiguration */ interface FirelensConfigurationResponse { /** * The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, valid option keys are: + ``enable-ecs-log-metadata``, which can be ``true`` or ``false`` + ``config-file-type``, which can be ``s3`` or ``file`` + ``config-file-value``, which is either an S3 ARN or a file path */ options?: any; /** * The log router to use. The valid values are ``fluentd`` or ``fluentbit``. */ type?: string; } /** * Definition of FirewallPolicy */ interface FirewallPolicyResponse { /** * Property policyVariables */ policyVariables?: outputs.awsconnector.RuleVariablesModelResponse; /** * Property statefulDefaultActions */ statefulDefaultActions?: string[]; /** * Property statefulEngineOptions */ statefulEngineOptions?: outputs.awsconnector.StatefulEngineOptionsResponse; /** * Property statefulRuleGroupReferences */ statefulRuleGroupReferences?: outputs.awsconnector.StatefulRuleGroupReferenceResponse[]; /** * Property statelessCustomActions */ statelessCustomActions?: outputs.awsconnector.CustomActionResponse[]; /** * Property statelessDefaultActions */ statelessDefaultActions?: string[]; /** * Property statelessFragmentDefaultActions */ statelessFragmentDefaultActions?: string[]; /** * Property statelessRuleGroupReferences */ statelessRuleGroupReferences?: outputs.awsconnector.StatelessRuleGroupReferenceResponse[]; /** * A resource ARN. */ tlsInspectionConfigurationArn?: string; } /** * Definition of FixedResponseConfig */ interface FixedResponseConfigResponse { /** * The content type. Valid Values: text/plain | text/css | text/html | application/javascript | application/json */ contentType?: string; /** * The message. */ messageBody?: string; /** * The HTTP response code (2XX, 4XX, or 5XX). */ statusCode?: string; } /** * Definition of ForwardConfig */ interface ForwardConfigResponse { /** * Information about the target group stickiness for a rule. Information about the target group stickiness for a rule. */ targetGroupStickinessConfig?: outputs.awsconnector.TargetGroupStickinessConfigResponse; /** * Information about how traffic will be distributed between multiple target groups in a forward rule. */ targetGroups?: outputs.awsconnector.TargetGroupTupleResponse[]; } /** * Definition of ForwardedValues */ interface ForwardedValuesResponse { /** * This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*. This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include cookies in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send cookies to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see [How CloudFront Forwards, Caches, and Logs Cookies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html) in the *Amazon CloudFront Developer Guide*. */ cookies?: outputs.awsconnector.CookiesResponse; /** * This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include headers in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send headers to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that specifies the ``Headers``, if any, that you want CloudFront to forward to the origin for this cache behavior (whitelisted headers). For the headers that you specify, CloudFront also caches separate versions of a specified object that is based on the header values in viewer requests. For more information, see [Caching Content Based on Request Headers](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html) in the *Amazon CloudFront Developer Guide*. */ headers?: string[]; /** * This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of ``QueryString`` and on the values that you specify for ``QueryStringCacheKeys``, if any: If you specify true for ``QueryString`` and you don't specify any values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin. If you specify true for ``QueryString`` and you specify one or more values for ``QueryStringCacheKeys``, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify. If you specify false for ``QueryString``, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters. For more information, see [Configuring CloudFront to Cache Based on Query String Parameters](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html) in the *Amazon CloudFront Developer Guide*. */ queryString?: boolean; /** * This field is deprecated. We recommend that you use a cache policy or an origin request policy instead of this field. If you want to include query strings in the cache key, use a cache policy. For more information, see [Creating cache policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-key-create-cache-policy) in the *Amazon CloudFront Developer Guide*. If you want to send query strings to the origin but not include them in the cache key, use an origin request policy. For more information, see [Creating origin request policies](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-origin-requests.html#origin-request-create-origin-request-policy) in the *Amazon CloudFront Developer Guide*. A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior. */ queryStringCacheKeys?: string[]; } /** * Definition of FunctionAssociation */ interface FunctionAssociationResponse { /** * The event type of the function, either ``viewer-request`` or ``viewer-response``. You cannot use origin-facing event types (``origin-request`` and ``origin-response``) with a CloudFront function. */ eventType?: string; /** * The Amazon Resource Name (ARN) of the function. */ functionARN?: string; } /** * Definition of GenerateSecretString */ interface GenerateSecretStringResponse { /** * A string of the characters that you don't want in the password. */ excludeCharacters?: string; /** * Specifies whether to exclude lowercase letters from the password. If you don't include this switch, the password can contain lowercase letters. */ excludeLowercase?: boolean; /** * Specifies whether to exclude numbers from the password. If you don't include this switch, the password can contain numbers. */ excludeNumbers?: boolean; /** * Specifies whether to exclude the following punctuation characters from the password: ``! ' # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \ ] ^ _ ` { | } ~``. If you don't include this switch, the password can contain punctuation. */ excludePunctuation?: boolean; /** * Specifies whether to exclude uppercase letters from the password. If you don't include this switch, the password can contain uppercase letters. */ excludeUppercase?: boolean; /** * The JSON key name for the key/value pair, where the value is the generated password. This pair is added to the JSON structure specified by the ``SecretStringTemplate`` parameter. If you specify this parameter, then you must also specify ``SecretStringTemplate``. */ generateStringKey?: string; /** * Specifies whether to include the space character. If you include this switch, the password can contain space characters. */ includeSpace?: boolean; /** * The length of the password. If you don't include this parameter, the default length is 32 characters. */ passwordLength?: number; /** * Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. If you don't include this switch, the password contains at least one of every character type. */ requireEachIncludedType?: boolean; /** * A template that the generated string must match. When you make a change to this property, a new secret version is created. */ secretStringTemplate?: string; } /** * Definition of GeoLocation */ interface GeoLocationResponse { /** *

The two-letter code for the continent.

Amazon Route 53 supports the following continent codes:

  • AF: Africa

  • AN: Antarctica

  • AS: Asia

  • EU: Europe

  • OC: Oceania

  • NA: North America

  • SA: South America

Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

*/ continentCode?: string; /** *

For geolocation resource record sets, the two-letter code for a country.

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.

Route 53 also supports the country code UA for Ukraine.

*/ countryCode?: string; /** *

For geolocation resource record sets, the two-letter code for a state of the United States. Route 53 doesn't support any other values for SubdivisionCode. For a list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website.

If you specify subdivisioncode, you must also specify US for CountryCode.

*/ subdivisionCode?: string; } /** * Definition of GeoProximityLocation */ interface GeoProximityLocationResponse { /** *

The Amazon Web Services Region the resource you are directing DNS traffic to, is in.

*/ awsRegion?: string; /** *

The bias increases or decreases the size of the geographic region from which Route 53 routes traffic to a resource.

To use Bias to change the size of the geographic region, specify the applicable value for the bias:

  • To expand the size of the geographic region from which Route 53 routes traffic to a resource, specify a positive integer from 1 to 99 for the bias. Route 53 shrinks the size of adjacent regions.

  • To shrink the size of the geographic region from which Route 53 routes traffic to a resource, specify a negative bias of -1 to -99. Route 53 expands the size of adjacent regions.

*/ bias?: number; /** *

Contains the longitude and latitude for a geographic region.

*/ coordinates?: outputs.awsconnector.CoordinatesResponse; /** *

Specifies an Amazon Web Services Local Zone Group.

A local Zone Group is usually the Local Zone code without the ending character. For example, if the Local Zone is us-east-1-bue-1a the Local Zone Group is us-east-1-bue-1.

You can identify the Local Zones Group for a specific Local Zone by using the describe-availability-zones CLI command:

This command returns: 'GroupName': 'us-west-2-den-1', specifying that the Local Zone us-west-2-den-1a belongs to the Local Zone Group us-west-2-den-1.

*/ localZoneGroup?: string; } /** * Definition of GeoRestriction */ interface GeoRestrictionResponse { /** * A complex type that contains a ``Location`` element for each country in which you want CloudFront either to distribute your content or not distribute your content. */ locations?: string[]; /** * The method that you want to use to restrict distribution of your content by country. */ restrictionType?: string; } /** * Definition of GitSubmodulesConfig */ interface GitSubmodulesConfigResponse { /** *

Set to true to fetch Git submodules for your CodeBuild build project.

*/ fetchSubmodules?: boolean; } /** * Definition of GlobalSecondaryIndex */ interface GlobalSecondaryIndexResponse { /** * The settings used to enable or disable CloudWatch Contributor Insights for the specified global secondary index. The settings used to enable or disable CloudWatch Contributor Insights. */ contributorInsightsSpecification?: outputs.awsconnector.ContributorInsightsSpecificationResponse; /** * The name of the global secondary index. The name must be unique among all other indexes on this table. */ indexName?: string; /** * The complete key schema for a global secondary index, which consists of one or more pairs of attribute names and key types: + ``HASH`` - partition key + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. */ keySchema?: outputs.awsconnector.KeySchemaResponse[]; /** * Represents attributes that are copied (projected) from the table into the global secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. */ projection?: outputs.awsconnector.ProjectionResponse; /** * Represents the provisioned throughput settings for the specified global secondary index. For current minimum and maximum provisioned throughput values, see [Service, Account, and Table Quotas](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Limits.html) in the *Amazon DynamoDB Developer Guide*. Throughput for the specified table, which consists of values for ``ReadCapacityUnits`` and ``WriteCapacityUnits``. For more information about the contents of a provisioned throughput structure, see [Table ProvisionedThroughput](https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_ProvisionedThroughput.html). */ provisionedThroughput?: outputs.awsconnector.ProvisionedThroughputResponse; } /** * Definition of Grant */ interface GrantResponse { /** *

The person being granted permissions.

*/ grantee?: outputs.awsconnector.GranteeResponse; /** *

Specifies the permission given to the grantee.

*/ permission?: outputs.awsconnector.PermissionEnumValueResponse; } /** * Definition of Grantee */ interface GranteeResponse { /** *

Screen name of the grantee.

*/ displayName?: string; /** *

Email address of the grantee.

Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

  • US East (N. Virginia)

  • US West (N. California)

  • US West (Oregon)

  • Asia Pacific (Singapore)

  • Asia Pacific (Sydney)

  • Asia Pacific (Tokyo)

  • Europe (Ireland)

  • South America (São Paulo)

For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

*/ emailAddress?: string; /** *

The canonical user ID of the grantee.

*/ id?: string; /** *

Type of grantee

*/ type?: outputs.awsconnector.TypeEnumValueResponse; /** *

URI of the grantee group.

*/ uri?: string; } /** * Definition of GraphQLApiIntrospectionConfigEnumValue */ interface GraphQLApiIntrospectionConfigEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of GraphQLApiTypeEnumValue */ interface GraphQLApiTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of GraphQLApiVisibilityEnumValue */ interface GraphQLApiVisibilityEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of GroupIdentifier */ interface GroupIdentifierResponse { /** *

The ID of the security group.

*/ groupId?: string; /** *

The name of the security group.

*/ groupName?: string; } /** * Definition of GuardDutyDetector */ interface GuardDutyDetectorPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsGuardDutyDetectorPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Hardware */ interface HardwareResponse { /** * CPU count of the Instance. */ cpuCount?: number; /** * Disks attached to the Instance. */ disks?: outputs.awsconnector.DiskResponse[]; /** * RAM Size of the Instance. */ ramSizeInGb?: number; } /** * Definition of Header */ interface HeaderResponse { /** * Property destination */ destination?: string; /** * Property destinationPort */ destinationPort?: string; /** * Property direction */ direction?: string; /** * Property protocol */ protocol?: string; /** * Property source */ source?: string; /** * Property sourcePort */ sourcePort?: string; } /** * Definition of HealthCheck */ interface HealthCheckResponse { /** * A string array representing the command that the container runs to determine if it is healthy. The string array must start with ``CMD`` to run the command arguments directly, or ``CMD-SHELL`` to run the command with the container's default shell. When you use the AWS Management Console JSON panel, the CLIlong, or the APIs, enclose the list of commands in double quotes and brackets. ``[ 'CMD-SHELL', 'curl -f http://localhost/ || exit 1' ]`` You don't include the double quotes and brackets when you use the AWS Management Console. ``CMD-SHELL, curl -f http://localhost/ || exit 1`` An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see ``HealthCheck`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/). */ command?: string[]; /** * The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds. */ interval?: number; /** * The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3. */ retries?: number; /** * The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the ``startPeriod`` is off. If a health check succeeds within the ``startPeriod``, then the container is considered healthy and any subsequent failures count toward the maximum number of retries. */ startPeriod?: number; /** * The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5. */ timeout?: number; } /** * Definition of HibernationOptions */ interface HibernationOptionsResponse { /** *

If true, your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.

*/ configured?: boolean; } /** * Definition of HostEntry */ interface HostEntryResponse { /** * The hostname to use in the ``/etc/hosts`` entry. */ hostname?: string; /** * The IP address to use in the ``/etc/hosts`` entry. */ ipAddress?: string; } /** * Definition of HostVolumeProperties */ interface HostVolumePropertiesResponse { /** * When the ``host`` parameter is used, specify a ``sourcePath`` to declare the path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the ``host`` parameter contains a ``sourcePath`` file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the ``sourcePath`` value doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported. If you're using the Fargate launch type, the ``sourcePath`` parameter is not supported. */ sourcePath?: string; } /** * Definition of HostedZoneConfig */ interface HostedZoneConfigResponse { /** * Any comments that you want to include about the hosted zone. */ comment?: string; } /** * Definition of HostedZoneTag */ interface HostedZoneTagResponse { /** * The value of ``Key`` depends on the operation that you want to perform: + *Add a tag to a health check or hosted zone*: ``Key`` is the name that you want to give the new tag. + *Edit a tag*: ``Key`` is the name of the tag that you want to change the ``Value`` for. + *Delete a key*: ``Key`` is the name of the tag you want to remove. + *Give a name to a health check*: Edit the default ``Name`` tag. In the Amazon Route 53 console, the list of your health checks includes a *Name* column that lets you see the name that you've given to each health check. */ key?: string; /** * The value of ``Value`` depends on the operation that you want to perform: + *Add a tag to a health check or hosted zone*: ``Value`` is the value that you want to give the new tag. + *Edit a tag*: ``Value`` is the new value that you want to assign the tag. */ value?: string; } /** * Definition of HostnameTypeEnumValue */ interface HostnameTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of HttpTokensStateEnumValue */ interface HttpTokensStateEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of HypervisorTypeEnumValue */ interface HypervisorTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of IPAddressTypeEnumValue */ interface IPAddressTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of IPSetReference */ interface IPSetReferenceResponse { /** * A resource ARN. */ referenceArn?: string; } /** * Definition of IPSet */ interface IPSetResponse { /** * Property definition */ definition?: string[]; } /** * Definition of IamAccessKeyLastUsed */ interface IamAccessKeyLastUsedPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsIamAccessKeyLastUsedPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of IamAccessKeyMetadata */ interface IamAccessKeyMetadataPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsIamAccessKeyMetadataPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of IamGroup */ interface IamGroupPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsIamGroupPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of IamInstanceProfile */ interface IamInstanceProfilePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsIamInstanceProfilePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of IamInstanceProfile */ interface IamInstanceProfileResponse { /** *

The Amazon Resource Name (ARN) of the instance profile.

*/ arn?: string; /** *

The ID of the instance profile.

*/ id?: string; } /** * Definition of IamMFADevice */ interface IamMFADevicePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsIamMFADevicePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of IamPasswordPolicy */ interface IamPasswordPolicyPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsIamPasswordPolicyPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of IamPolicyVersion */ interface IamPolicyVersionPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsIamPolicyVersionPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of IamRole */ interface IamRolePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsIamRolePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * iamRolePropertiesResponseProvideDefaults sets the appropriate defaults for IamRolePropertiesResponse */ function iamRolePropertiesResponseProvideDefaults(val: IamRolePropertiesResponse): IamRolePropertiesResponse; /** * Definition of IamServerCertificate */ interface IamServerCertificatePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsIamServerCertificatePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of IamVirtualMFADevice */ interface IamVirtualMFADevicePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsIamVirtualMFADevicePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Identity */ interface IdentityResponse { /** *

An object representing the OpenID Connect identity provider information.

*/ oidc?: outputs.awsconnector.OIDCResponse; } /** * Definition of ImageConfig */ interface ImageConfigResponse { /** * Specifies parameters that you want to pass in with ENTRYPOINT. You can specify a maximum of 1,500 parameters in the list. */ command?: string[]; /** * Specifies the entry point to their application, which is typically the location of the runtime executable. You can specify a maximum of 1,500 string entries in the list. */ entryPoint?: string[]; /** * Specifies the working directory. The length of the directory string cannot exceed 1,000 characters. */ workingDirectory?: string; } /** * Definition of ImagePullCredentialsTypeEnumValue */ interface ImagePullCredentialsTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ImageScanFindingsSummary */ interface ImageScanFindingsSummaryResponse { /** *

The image vulnerability counts, sorted by severity.

*/ findingSeverityCounts?: { [key: string]: number; }; /** *

The time of the last completed image scan.

*/ imageScanCompletedAt?: string; /** *

The time when the vulnerability data was last scanned.

*/ vulnerabilitySourceUpdatedAt?: string; } /** * Definition of ImageScanStatus */ interface ImageScanStatusResponse { /** *

The description of the image scan status.

*/ description?: string; /** *

The current state of an image scan.

*/ status?: outputs.awsconnector.ScanStatusEnumValueResponse; } /** * Definition of ImageScanningConfiguration */ interface ImageScanningConfigurationResponse { /** * The setting that determines whether images are scanned after being pushed to a repository. If set to ``true``, images will be scanned after being pushed. If this parameter is not specified, it will default to ``false`` and images will not be scanned unless a scan is manually started. The setting that determines whether images are scanned after being pushed to a repository. */ scanOnPush?: boolean; } /** * Definition of ImageStateEnumValue */ interface ImageStateEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ImageTypeValuesEnumValue */ interface ImageTypeValuesEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ImdsSupportValuesEnumValue */ interface ImdsSupportValuesEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ImportSourceSpecification */ interface ImportSourceSpecificationResponse { /** * Type of compression to be used on the input coming from the imported table. */ inputCompressionType?: string; /** * The format of the source data. Valid values for ``ImportFormat`` are ``CSV``, ``DYNAMODB_JSON`` or ``ION``. */ inputFormat?: string; /** * Additional properties that specify how the input is formatted, The format options for the data that was imported into the target table. There is one value, CsvOption. */ inputFormatOptions?: outputs.awsconnector.InputFormatOptionsResponse; /** * The S3 bucket that provides the source for the import. The S3 bucket that is being imported from. */ s3BucketSource?: outputs.awsconnector.S3BucketSourceResponse; } /** * Definition of InferenceAccelerator */ interface InferenceAcceleratorResponse { /** * The Elastic Inference accelerator device name. The ``deviceName`` must also be referenced in a container definition as a [ResourceRequirement](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ResourceRequirement.html). */ deviceName?: string; /** * The Elastic Inference accelerator type to use. */ deviceType?: string; } /** * Definition of InitiatedByEnumValue */ interface InitiatedByEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of InputFormatOptions */ interface InputFormatOptionsResponse { /** * The options for imported source files in CSV format. The values are Delimiter and HeaderList. The options for imported source files in CSV format. The values are Delimiter and HeaderList. */ csv?: outputs.awsconnector.CsvResponse; } /** * Definition of InsightSelector */ interface InsightSelectorResponse { /** * The type of insight to log on a trail. */ insightType?: string; } /** * Definition of InstanceAggregatedAssociationOverview */ interface InstanceAggregatedAssociationOverviewResponse { /** *

Detailed status information about the aggregated associations.

*/ detailedStatus?: string; /** *

The number of associations for the managed nodes.

*/ instanceAssociationStatusAggregatedCount?: { [key: string]: number; }; } /** * Definition of InstanceAttachmentEnaSrdSpecification */ interface InstanceAttachmentEnaSrdSpecificationResponse { /** *

Indicates whether ENA Express is enabled for the network interface.

*/ enaSrdEnabled?: boolean; /** *

Configures ENA Express for UDP network traffic.

*/ enaSrdUdpSpecification?: outputs.awsconnector.InstanceAttachmentEnaSrdUdpSpecificationResponse; } /** * Definition of InstanceAttachmentEnaSrdUdpSpecification */ interface InstanceAttachmentEnaSrdUdpSpecificationResponse { /** *

Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.

*/ enaSrdUdpEnabled?: boolean; } /** * Definition of InstanceAutoRecoveryStateEnumValue */ interface InstanceAutoRecoveryStateEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of InstanceBlockDeviceMapping */ interface InstanceBlockDeviceMappingResponse { /** *

The device name (for example, /dev/sdh or xvdh).

*/ deviceName?: string; /** *

Parameters used to automatically set up EBS volumes when the instance is launched.

*/ ebs?: outputs.awsconnector.EbsInstanceBlockDeviceResponse; } /** * Definition of InstanceBootModeValuesEnumValue */ interface InstanceBootModeValuesEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of InstanceCollectionTypeEnumValue */ interface InstanceCollectionTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of InstanceIpv4Prefix */ interface InstanceIpv4PrefixResponse { /** *

One or more IPv4 prefixes assigned to the network interface.

*/ ipv4Prefix?: string; } /** * Definition of InstanceIpv6Address */ interface InstanceIpv6AddressEc2NetworkInterfaceResponse { /** * Property ipv6Address */ ipv6Address?: string; } /** * Definition of InstanceIpv6Address */ interface InstanceIpv6AddressResponse { /** *

The IPv6 address.

*/ ipv6Address?: string; /** *

Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances.

*/ isPrimaryIpv6?: boolean; } /** * Definition of InstanceIpv6Prefix */ interface InstanceIpv6PrefixResponse { /** *

One or more IPv6 prefixes assigned to the network interface.

*/ ipv6Prefix?: string; } /** * Definition of InstanceLifecycleTypeEnumValue */ interface InstanceLifecycleTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of InstanceMaintenanceOptions */ interface InstanceMaintenanceOptionsResponse { /** *

Provides information on the current automatic recovery behavior of your instance.

*/ autoRecovery?: outputs.awsconnector.InstanceAutoRecoveryStateEnumValueResponse; } /** * Definition of InstanceMaintenancePolicy */ interface InstanceMaintenancePolicyResponse { /** * Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of ``-1``. Both ``MinHealthyPercentage`` and ``MaxHealthyPercentage`` must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time. */ maxHealthyPercentage?: number; /** * Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of ``-1``. */ minHealthyPercentage?: number; } /** * Definition of InstanceMetadataEndpointStateEnumValue */ interface InstanceMetadataEndpointStateEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of InstanceMetadataOptionsResponse */ interface InstanceMetadataOptionsResponseResponse { /** *

Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.

If the value is disabled, you cannot access your instance metadata.

*/ httpEndpoint?: outputs.awsconnector.InstanceMetadataEndpointStateEnumValueResponse; /** *

Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.

Default: disabled

*/ httpProtocolIpv6?: outputs.awsconnector.InstanceMetadataProtocolStateEnumValueResponse; /** *

The maximum number of hops that the metadata token can travel.

Possible values: Integers from 1 to 64

*/ httpPutResponseHopLimit?: number; /** *

Indicates whether IMDSv2 is required.

  • optional - IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1.

  • required - IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2.

*/ httpTokens?: outputs.awsconnector.HttpTokensStateEnumValueResponse; /** *

Indicates whether access to instance tags from the instance metadata is enabled or disabled. For more information, see Work with instance tags using the instance metadata.

*/ instanceMetadataTags?: outputs.awsconnector.InstanceMetadataTagsStateEnumValueResponse; /** *

The state of the metadata option changes.

pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.

applied - The metadata options have been successfully applied on the instance.

*/ state?: outputs.awsconnector.InstanceMetadataOptionsStateEnumValueResponse; } /** * instanceMetadataOptionsResponseResponseProvideDefaults sets the appropriate defaults for InstanceMetadataOptionsResponseResponse */ function instanceMetadataOptionsResponseResponseProvideDefaults(val: InstanceMetadataOptionsResponseResponse): InstanceMetadataOptionsResponseResponse; /** * Definition of InstanceMetadataOptionsStateEnumValue */ interface InstanceMetadataOptionsStateEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of InstanceMetadataProtocolStateEnumValue */ interface InstanceMetadataProtocolStateEnumValueResponse { /** * Property value */ value?: string; } /** * instanceMetadataProtocolStateEnumValueResponseProvideDefaults sets the appropriate defaults for InstanceMetadataProtocolStateEnumValueResponse */ function instanceMetadataProtocolStateEnumValueResponseProvideDefaults(val: InstanceMetadataProtocolStateEnumValueResponse): InstanceMetadataProtocolStateEnumValueResponse; /** * Definition of InstanceMetadataTagsStateEnumValue */ interface InstanceMetadataTagsStateEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of InstanceNetworkInterfaceAssociation */ interface InstanceNetworkInterfaceAssociationResponse { /** *

The carrier IP address associated with the network interface.

*/ carrierIp?: string; /** *

The customer-owned IP address associated with the network interface.

*/ customerOwnedIp?: string; /** *

The ID of the owner of the Elastic IP address.

*/ ipOwnerId?: string; /** *

The public DNS name.

*/ publicDnsName?: string; /** *

The public IP address or Elastic IP address bound to the network interface.

*/ publicIp?: string; } /** * Definition of InstanceNetworkInterfaceAttachment */ interface InstanceNetworkInterfaceAttachmentResponse { /** *

The time stamp when the attachment initiated.

*/ attachTime?: string; /** *

The ID of the network interface attachment.

*/ attachmentId?: string; /** *

Indicates whether the network interface is deleted when the instance is terminated.

*/ deleteOnTermination?: boolean; /** *

The index of the device on the instance for the network interface attachment.

*/ deviceIndex?: number; /** *

Contains the ENA Express settings for the network interface that's attached to the instance.

*/ enaSrdSpecification?: outputs.awsconnector.InstanceAttachmentEnaSrdSpecificationResponse; /** *

The index of the network card.

*/ networkCardIndex?: number; /** *

The attachment state.

*/ status?: outputs.awsconnector.AttachmentStatusEnumValueResponse; } /** * Definition of InstanceNetworkInterface */ interface InstanceNetworkInterfaceResponse { /** *

The association information for an Elastic IPv4 associated with the network interface.

*/ association?: outputs.awsconnector.InstanceNetworkInterfaceAssociationResponse; /** *

The network interface attachment.

*/ attachment?: outputs.awsconnector.InstanceNetworkInterfaceAttachmentResponse; /** *

A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see Connection tracking timeouts in the Amazon Elastic Compute Cloud User Guide.

*/ connectionTrackingConfiguration?: outputs.awsconnector.ConnectionTrackingSpecificationResponseResponse; /** *

The description.

*/ description?: string; /** *

The security groups.

*/ groups?: outputs.awsconnector.GroupIdentifierResponse[]; /** *

The type of network interface.

Valid values: interface | efa | trunk

*/ interfaceType?: string; /** *

The IPv4 delegated prefixes that are assigned to the network interface.

*/ ipv4Prefixes?: outputs.awsconnector.InstanceIpv4PrefixResponse[]; /** *

The IPv6 addresses associated with the network interface.

*/ ipv6Addresses?: outputs.awsconnector.InstanceIpv6AddressResponse[]; /** *

The IPv6 delegated prefixes that are assigned to the network interface.

*/ ipv6Prefixes?: outputs.awsconnector.InstanceIpv6PrefixResponse[]; /** *

The MAC address.

*/ macAddress?: string; /** *

The ID of the network interface.

*/ networkInterfaceId?: string; /** *

The ID of the Amazon Web Services account that created the network interface.

*/ ownerId?: string; /** *

The private DNS name.

*/ privateDnsName?: string; /** *

The IPv4 address of the network interface within the subnet.

*/ privateIpAddress?: string; /** *

The private IPv4 addresses associated with the network interface.

*/ privateIpAddresses?: outputs.awsconnector.InstancePrivateIpAddressResponse[]; /** *

Indicates whether source/destination checking is enabled.

*/ sourceDestCheck?: boolean; /** *

The status of the network interface.

*/ status?: outputs.awsconnector.NetworkInterfaceStatusEnumValueResponse; /** *

The ID of the subnet.

*/ subnetId?: string; /** *

The ID of the VPC.

*/ vpcId?: string; } /** * instanceNetworkInterfaceResponseProvideDefaults sets the appropriate defaults for InstanceNetworkInterfaceResponse */ function instanceNetworkInterfaceResponseProvideDefaults(val: InstanceNetworkInterfaceResponse): InstanceNetworkInterfaceResponse; /** * Definition of InstancePrivateIpAddress */ interface InstancePrivateIpAddressResponse { /** *

The association information for an Elastic IP address for the network interface.

*/ association?: outputs.awsconnector.InstanceNetworkInterfaceAssociationResponse; /** *

Indicates whether this IPv4 address is the primary private IP address of the network interface.

*/ primary?: boolean; /** *

The private IPv4 DNS name.

*/ privateDnsName?: string; /** *

The private IPv4 address of the network interface.

*/ privateIpAddress?: string; } /** * Definition of InstanceRequirements */ interface InstanceRequirementsResponse { /** * The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type. To exclude accelerator-enabled instance types, set ``Max`` to ``0``. Default: No minimum or maximum limits ``AcceleratorCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of accelerators for an instance type. */ acceleratorCount?: outputs.awsconnector.AcceleratorCountRequestResponse; /** * Indicates whether instance types must have accelerators by specific manufacturers. + For instance types with NVIDIA devices, specify ``nvidia``. + For instance types with AMD devices, specify ``amd``. + For instance types with AWS devices, specify ``amazon-web-services``. + For instance types with Xilinx devices, specify ``xilinx``. Default: Any manufacturer */ acceleratorManufacturers?: string[]; /** * Lists the accelerators that must be on an instance type. + For instance types with NVIDIA A100 GPUs, specify ``a100``. + For instance types with NVIDIA V100 GPUs, specify ``v100``. + For instance types with NVIDIA K80 GPUs, specify ``k80``. + For instance types with NVIDIA T4 GPUs, specify ``t4``. + For instance types with NVIDIA M60 GPUs, specify ``m60``. + For instance types with AMD Radeon Pro V520 GPUs, specify ``radeon-pro-v520``. + For instance types with Xilinx VU9P FPGAs, specify ``vu9p``. Default: Any accelerator */ acceleratorNames?: string[]; /** * The minimum and maximum total memory size for the accelerators on an instance type, in MiB. Default: No minimum or maximum limits ``AcceleratorTotalMemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total memory size for the accelerators for an instance type, in MiB. */ acceleratorTotalMemoryMiB?: outputs.awsconnector.AcceleratorTotalMemoryMiBRequestResponse; /** * Lists the accelerator types that must be on an instance type. + For instance types with GPU accelerators, specify ``gpu``. + For instance types with FPGA accelerators, specify ``fpga``. + For instance types with inference accelerators, specify ``inference``. Default: Any accelerator type */ acceleratorTypes?: string[]; /** * The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes. You can use strings with one or more wild cards, represented by an asterisk (``*``), to allow an instance type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. For example, if you specify ``c5*``, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types. If you specify ``AllowedInstanceTypes``, you can't specify ``ExcludedInstanceTypes``. Default: All instance types */ allowedInstanceTypes?: string[]; /** * Indicates whether bare metal instance types are included, excluded, or required. Default: ``excluded`` */ bareMetal?: string; /** * The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide for Linux Instances*. Default: No minimum or maximum limits ``BaselineEbsBandwidthMbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum baseline bandwidth performance for an instance type, in Mbps. */ baselineEbsBandwidthMbps?: outputs.awsconnector.BaselineEbsBandwidthMbpsRequestResponse; /** * Indicates whether burstable performance instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide for Linux Instances*. Default: ``excluded`` */ burstablePerformance?: string; /** * Lists which specific CPU manufacturers to include. + For instance types with Intel CPUs, specify ``intel``. + For instance types with AMD CPUs, specify ``amd``. + For instance types with AWS CPUs, specify ``amazon-web-services``. Don't confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template. Default: Any manufacturer */ cpuManufacturers?: string[]; /** * The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (``*``), to exclude an instance family, type, size, or generation. The following are examples: ``m5.8xlarge``, ``c5*.*``, ``m5a.*``, ``r*``, ``*3*``. For example, if you specify ``c5*``, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify ``m5a.*``, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types. If you specify ``ExcludedInstanceTypes``, you can't specify ``AllowedInstanceTypes``. Default: No excluded instance types */ excludedInstanceTypes?: string[]; /** * Indicates whether current or previous generation instance types are included. + For current generation instance types, specify ``current``. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide for Linux Instances*. + For previous generation instance types, specify ``previous``. Default: Any current or previous generation */ instanceGenerations?: string[]; /** * Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide for Linux Instances*. Default: ``included`` */ localStorage?: string; /** * Indicates the type of local storage that is required. + For instance types with hard disk drive (HDD) storage, specify ``hdd``. + For instance types with solid state drive (SSD) storage, specify ``ssd``. Default: Any local storage type */ localStorageTypes?: string[]; /** * [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To indicate no price protection threshold, specify a high value, such as ``999999``. If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. If you don't specify either, then ``SpotMaxPricePercentageOverLowestPrice`` is used and the value for that parameter defaults to ``100``. */ maxSpotPriceAsPercentageOfOptimalOnDemandPrice?: number; /** * The minimum and maximum amount of memory per vCPU for an instance type, in GiB. Default: No minimum or maximum limits ``MemoryGiBPerVCpuRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum amount of memory per vCPU for an instance type, in GiB. */ memoryGiBPerVCpu?: outputs.awsconnector.MemoryGiBPerVCpuRequestResponse; /** * The minimum and maximum instance memory size for an instance type, in MiB. ``MemoryMiBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum instance memory size for an instance type, in MiB. */ memoryMiB?: outputs.awsconnector.MemoryMiBRequestResponse; /** * The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits ``NetworkBandwidthGbpsRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum network bandwidth for an instance type, in Gbps. Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide for Linux Instances*. */ networkBandwidthGbps?: outputs.awsconnector.NetworkBandwidthGbpsRequestResponse; /** * The minimum and maximum number of network interfaces for an instance type. Default: No minimum or maximum limits ``NetworkInterfaceCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of network interfaces for an instance type. */ networkInterfaceCount?: outputs.awsconnector.NetworkInterfaceCountRequestResponse; /** * [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as ``999999``. If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. Default: ``20`` */ onDemandMaxPricePercentageOverLowestPrice?: number; /** * Indicates whether instance types must provide On-Demand Instance hibernation support. Default: ``false`` */ requireHibernateSupport?: boolean; /** * [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as ``999999``. If you set ``DesiredCapacityType`` to ``vcpu`` or ``memory-mib``, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one of ``SpotMaxPricePercentageOverLowestPrice`` or ``MaxSpotPriceAsPercentageOfOptimalOnDemandPrice`` can be specified. Default: ``100`` */ spotMaxPricePercentageOverLowestPrice?: number; /** * The minimum and maximum total local storage size for an instance type, in GB. Default: No minimum or maximum limits ``TotalLocalStorageGBRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum total local storage size for an instance type, in GB. */ totalLocalStorageGB?: outputs.awsconnector.TotalLocalStorageGBRequestResponse; /** * The minimum and maximum number of vCPUs for an instance type. ``VCpuCountRequest`` is a property of the ``InstanceRequirements`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property type that describes the minimum and maximum number of vCPUs for an instance type. */ vCpuCount?: outputs.awsconnector.VCpuCountRequestResponse; } /** * Definition of InstanceRoleTypeEnumValue */ interface InstanceRoleTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of InstanceStateNameEnumValue */ interface InstanceStateNameEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of InstanceState */ interface InstanceStateResponse { /** *

The state of the instance as a 16-bit unsigned integer.

The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.

The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.

The valid values for instance-state-code will all be in the range of the low byte and they are:

  • 0 : pending

  • 16 : running

  • 32 : shutting-down

  • 48 : terminated

  • 64 : stopping

  • 80 : stopped

You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.

*/ code?: number; /** *

The current state of the instance.

*/ name?: outputs.awsconnector.InstanceStateNameEnumValueResponse; } /** * Definition of InstanceStatusDetails */ interface InstanceStatusDetailsResponse { /** *

The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.

*/ impairedSince?: string; /** *

The type of instance status.

*/ name?: outputs.awsconnector.StatusNameEnumValueResponse; /** *

The status.

*/ status?: outputs.awsconnector.StatusTypeEnumValueResponse; } /** * Definition of InstanceStatusEvent */ interface InstanceStatusEventResponse { /** *

The event code.

*/ code?: outputs.awsconnector.EventCodeEnumValueResponse; /** *

A description of the event.

After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].

*/ description?: string; /** *

The ID of the event.

*/ instanceEventId?: string; /** *

The latest scheduled end time for the event.

*/ notAfter?: string; /** *

The earliest scheduled start time for the event.

*/ notBefore?: string; /** *

The deadline for starting the event.

*/ notBeforeDeadline?: string; } /** * Definition of InstanceStatusSummary */ interface InstanceStatusSummaryResponse { /** *

The system instance health or application instance health.

*/ details?: outputs.awsconnector.InstanceStatusDetailsResponse[]; /** *

The status.

*/ status?: outputs.awsconnector.SummaryStatusEnumValueResponse; } /** * Definition of InstanceTypeEnumValue */ interface InstanceTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of InstancesDistribution */ interface InstancesDistributionResponse { /** * The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify. The following lists the valid values: + lowest-price Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements. + prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do. */ onDemandAllocationStrategy?: string; /** * The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales. This number has the same unit of measurement as the group's desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement. Default: 0 An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones. */ onDemandBaseCapacity?: number; /** * Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond ``OnDemandBaseCapacity``. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used. Default: 100 An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones. */ onDemandPercentageAboveBaseCapacity?: number; /** * The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify. The following lists the valid values: + capacity-optimized Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. + capacity-optimized-prioritized You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements. + lowest-price Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity. + price-capacity-optimized (recommended) The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price. */ spotAllocationStrategy?: string; /** * The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the ``SpotAllocationStrategy`` is ``lowest-price``. Value must be in the range of 1–20. Default: 2 */ spotInstancePools?: number; /** * The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ('') for the value. If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one. Valid Range: Minimum value of 0.001 */ spotMaxPrice?: string; } /** * Definition of IntelligentTieringConfiguration */ interface IntelligentTieringConfigurationResponse { /** * The ID used to identify the S3 Intelligent-Tiering configuration. */ id?: string; /** * An object key name prefix that identifies the subset of objects to which the rule applies. */ prefix?: string; /** * Specifies the status of the configuration. */ status?: string; /** * A container for a key-value pair. */ tagFilters?: outputs.awsconnector.TagFilterResponse[]; /** * Specifies a list of S3 Intelligent-Tiering storage class tiers in the configuration. At least one tier must be defined in the list. At most, you can specify two tiers in the list, one for each available AccessTier: ``ARCHIVE_ACCESS`` and ``DEEP_ARCHIVE_ACCESS``. You only need Intelligent Tiering Configuration enabled on a bucket if you want to automatically move objects stored in the Intelligent-Tiering storage class to Archive Access or Deep Archive Access tiers. */ tierings?: outputs.awsconnector.TieringResponse[]; } /** * Definition of InventoryConfiguration */ interface InventoryConfigurationResponse { /** * Contains information about where to publish the inventory results. Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket. */ destination?: outputs.awsconnector.DestinationResponse; /** * Specifies whether the inventory is enabled or disabled. If set to ``True``, an inventory list is generated. If set to ``False``, no inventory list is generated. */ enabled?: boolean; /** * The ID used to identify the inventory configuration. */ id?: string; /** * Object versions to include in the inventory list. If set to ``All``, the list includes all the object versions, which adds the version-related fields ``VersionId``, ``IsLatest``, and ``DeleteMarker`` to the list. If set to ``Current``, the list does not contain these version-related fields. */ includedObjectVersions?: string; /** * Contains the optional fields that are included in the inventory results. */ optionalFields?: string[]; /** * Specifies the inventory filter prefix. */ prefix?: string; /** * Specifies the schedule for generating inventory results. */ scheduleFrequency?: string; } /** * Definition of IpFamilyEnumValue */ interface IpFamilyEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of IpPermission */ interface IpPermissionResponse { /** *

If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP type or -1 (all ICMP types).

*/ fromPort?: number; /** *

The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).

Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.

*/ ipProtocol?: string; /** *

The IPv4 address ranges.

*/ ipRanges?: outputs.awsconnector.IpRangeResponse[]; /** *

The IPv6 address ranges.

*/ ipv6Ranges?: outputs.awsconnector.Ipv6RangeResponse[]; /** *

The prefix list IDs.

*/ prefixListIds?: outputs.awsconnector.PrefixListIdResponse[]; /** *

If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes).

*/ toPort?: number; /** *

The security group and Amazon Web Services account ID pairs.

*/ userIdGroupPairs?: outputs.awsconnector.UserIdGroupPairResponse[]; } /** * Definition of IpRange */ interface IpRangeResponse { /** *

The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.

*/ cidrIp?: string; /** *

A description for the security group rule that references this IPv4 address range.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

*/ description?: string; } /** * Definition of IpamOperatingRegion */ interface IpamOperatingRegionResponse { /** *

The name of the operating Region.

*/ regionName?: string; } /** * Definition of IpamStateEnumValue */ interface IpamStateEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of IpamTierEnumValue */ interface IpamTierEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of Ipv4PrefixSpecification */ interface Ipv4PrefixSpecificationResponse { /** * Property ipv4Prefix */ ipv4Prefix?: string; } /** * Definition of Ipv6PrefixSpecification */ interface Ipv6PrefixSpecificationResponse { /** * Property ipv6Prefix */ ipv6Prefix?: string; } /** * Definition of Ipv6Range */ interface Ipv6RangeResponse { /** *

The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.

*/ cidrIpv6?: string; /** *

A description for the security group rule that references this IPv6 address range.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*

*/ description?: string; } /** * Definition of JobComparatorEnumValue */ interface JobComparatorEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of JobStatusEnumValue */ interface JobStatusEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of JobTypeEnumValue */ interface JobTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of KerberosAttributes */ interface KerberosAttributesResponse { /** *

The Active Directory password for ADDomainJoinUser.

*/ adDomainJoinPassword?: string; /** *

Required only when establishing a cross-realm trust with an Active Directory domain. A user with sufficient privileges to join resources to the domain.

*/ adDomainJoinUser?: string; /** *

Required only when establishing a cross-realm trust with a KDC in a different realm. The cross-realm principal password, which must be identical across realms.

*/ crossRealmTrustPrincipalPassword?: string; /** *

The password used within the cluster for the kadmin service on the cluster-dedicated KDC, which maintains Kerberos principals, password policies, and keytabs for the cluster.

*/ kdcAdminPassword?: string; /** *

The name of the Kerberos realm to which all nodes in a cluster belong. For example, EC2.INTERNAL.

*/ realm?: string; } /** * Definition of KernelCapabilities */ interface KernelCapabilitiesResponse { /** * The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to ``CapAdd`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--cap-add`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). Tasks launched on FARGATElong only support adding the ``SYS_PTRACE`` kernel capability. Valid values: ``'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'`` */ add?: string[]; /** * The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to ``CapDrop`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--cap-drop`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). Valid values: ``'ALL' | 'AUDIT_CONTROL' | 'AUDIT_WRITE' | 'BLOCK_SUSPEND' | 'CHOWN' | 'DAC_OVERRIDE' | 'DAC_READ_SEARCH' | 'FOWNER' | 'FSETID' | 'IPC_LOCK' | 'IPC_OWNER' | 'KILL' | 'LEASE' | 'LINUX_IMMUTABLE' | 'MAC_ADMIN' | 'MAC_OVERRIDE' | 'MKNOD' | 'NET_ADMIN' | 'NET_BIND_SERVICE' | 'NET_BROADCAST' | 'NET_RAW' | 'SETFCAP' | 'SETGID' | 'SETPCAP' | 'SETUID' | 'SYS_ADMIN' | 'SYS_BOOT' | 'SYS_CHROOT' | 'SYS_MODULE' | 'SYS_NICE' | 'SYS_PACCT' | 'SYS_PTRACE' | 'SYS_RAWIO' | 'SYS_RESOURCE' | 'SYS_TIME' | 'SYS_TTY_CONFIG' | 'SYSLOG' | 'WAKE_ALARM'`` */ drop?: string[]; } /** * Definition of KeyAlgorithmEnumValue */ interface KeyAlgorithmEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of KeySchema */ interface KeySchemaResponse { /** * The name of a key attribute. */ attributeName?: string; /** * The role that this key attribute will assume: + ``HASH`` - partition key + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. */ keyType?: string; } /** * Definition of KeyValuePair */ interface KeyValuePairResponse { /** * The name of the key-value pair. For environment variables, this is the name of the environment variable. */ name?: string; /** * The value of the key-value pair. For environment variables, this is the value of the environment variable. */ value?: string; } /** * Definition of KinesisStreamSpecification */ interface KinesisStreamSpecificationResponse { /** * The precision for the time and date that the stream was created. */ approximateCreationDateTimePrecision?: string; /** * The ARN for a specific Kinesis data stream. Length Constraints: Minimum length of 37. Maximum length of 1024. */ streamArn?: string; } /** * Definition of KmsAlias */ interface KmsAliasPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsKmsAliasPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of KmsKey */ interface KmsKeyPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsKmsKeyPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * kmsKeyPropertiesResponseProvideDefaults sets the appropriate defaults for KmsKeyPropertiesResponse */ function kmsKeyPropertiesResponseProvideDefaults(val: KmsKeyPropertiesResponse): KmsKeyPropertiesResponse; /** * Definition of KubernetesNetworkConfigResponse */ interface KubernetesNetworkConfigResponseResponse { /** *

The IP family used to assign Kubernetes Pod and Service objects IP addresses. The IP family is always ipv4, unless you have a 1.21 or later cluster running version 1.10.1 or later of the Amazon VPC CNI plugin for Kubernetes and specified ipv6 when you created the cluster.

*/ ipFamily?: outputs.awsconnector.IpFamilyEnumValueResponse; /** *

The CIDR block that Kubernetes Pod and Service object IP addresses are assigned from. Kubernetes assigns addresses from an IPv4 CIDR block assigned to a subnet that the node is in. If you didn't specify a CIDR block when you created the cluster, then Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this was specified, then it was specified when the cluster was created and it can't be changed.

*/ serviceIpv4Cidr?: string; /** *

The CIDR block that Kubernetes pod and service IP addresses are assigned from if you created a 1.21 or later cluster with version 1.10.1 or later of the Amazon VPC CNI add-on and specified ipv6 for ipFamily when you created the cluster. Kubernetes assigns service addresses from the unique local address range (fc00::/7) because you can't specify a custom IPv6 CIDR block when you create the cluster.

*/ serviceIpv6Cidr?: string; } /** * Definition of LabelNameConditionModelProperties */ interface LabelNameConditionModelPropertiesResponse { /** * The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. */ labelName?: string; } /** * Definition of LambdaAuthorizerConfig */ interface LambdaAuthorizerConfigResponse { /** *

The number of seconds a response should be cached for. The default is 0 seconds, which disables caching. If you don't specify a value for authorizerResultTtlInSeconds, the default value is used. The maximum value is one hour (3600 seconds). The Lambda function can override this by returning a ttlOverride key in its response.

*/ authorizerResultTtlInSeconds?: number; /** *

The Amazon Resource Name (ARN) of the Lambda function to be called for authorization. This can be a standard Lambda ARN, a version ARN (.../v3), or an alias ARN.

Note: This Lambda function must have the following resource-based policy assigned to it. When configuring Lambda authorizers in the console, this is done for you. To use the Command Line Interface (CLI), run the following:

aws lambda add-permission --function-name 'arn:aws:lambda:us-east-2:111122223333:function:my-function' --statement-id 'appsync' --principal appsync.amazonaws.com --action lambda:InvokeFunction

*/ authorizerUri?: string; /** *

A regular expression for validation of tokens before the Lambda function is called.

*/ identityValidationExpression?: string; } /** * Definition of LambdaConfiguration */ interface LambdaConfigurationResponse { /** * The Amazon S3 bucket event for which to invoke the LAMlong function. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*. */ event?: string; /** * The filtering rules that determine which objects invoke the AWS Lambda function. For example, you can create a filter so that only image files with a ``.jpg`` extension invoke the function when they are added to the Amazon S3 bucket. Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*. */ filter?: outputs.awsconnector.NotificationFilterResponse; /** * The Amazon Resource Name (ARN) of the LAMlong function that Amazon S3 invokes when the specified event type occurs. */ function?: string; } /** * Definition of LambdaFunctionAssociation */ interface LambdaFunctionAssociationResponse { /** * Specifies the event type that triggers a Lambda@Edge function invocation. You can specify the following values: + ``viewer-request``: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache. + ``origin-request``: The function executes only when CloudFront sends a request to your origin. When the requested object is in the edge cache, the function doesn't execute. + ``origin-response``: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute. + ``viewer-response``: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache. If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute. */ eventType?: string; /** * A flag that allows a Lambda@Edge function to have read access to the body content. For more information, see [Accessing the Request Body by Choosing the Include Body Option](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html) in the Amazon CloudFront Developer Guide. */ includeBody?: boolean; /** * The ARN of the Lambda@Edge function. You must specify the ARN of a function version; you can't specify an alias or $LATEST. */ lambdaFunctionARN?: string; } /** * Definition of LambdaFunctionCodeLocation */ interface LambdaFunctionCodeLocationPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsLambdaFunctionCodeLocationPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of LambdaFunction */ interface LambdaFunctionPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsLambdaFunctionPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of LastRunErrorStatusCodeEnumValue */ interface LastRunErrorStatusCodeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of LastRunErrorStatus */ interface LastRunErrorStatusResponse { /** *

Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run. Possible values are:

  • ERROR - One or more errors occurred. Amazon Macie didn't process all the data specified for the job.

  • NONE - No errors occurred. Macie processed all the data specified for the job.

*/ code?: outputs.awsconnector.LastRunErrorStatusCodeEnumValueResponse; } /** * Definition of LaunchTemplateOverrides */ interface LaunchTemplateOverridesResponse { /** * The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types. You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template. If you specify ``InstanceRequirements``, you can't specify ``InstanceType``. The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types. When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values. To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance types, you can use one of the following parameters, but not both in the same request: + ``AllowedInstanceTypes`` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes. + ``ExcludedInstanceTypes`` - The instance types to exclude from the list, even if they match your specified attributes. You must specify ``VCpuCount`` and ``MemoryMiB``. All other attributes are optional. Any unspecified optional attribute is set to its default. For an example template, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html). For more information, see [Creating an Auto Scaling group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. For help determining which instance types match your attributes before you apply them to your Auto Scaling group, see [Preview instance types with specified attributes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements) in the *Amazon EC2 User Guide for Linux Instances*. ``InstanceRequirements`` is a property of the ``LaunchTemplateOverrides`` property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) property type. */ instanceRequirements?: outputs.awsconnector.InstanceRequirementsResponse; /** * The instance type, such as ``m3.xlarge``. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon Elastic Compute Cloud User Guide*. You can specify up to 40 instance types per Auto Scaling group. */ instanceType?: string; /** * Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the ``LaunchTemplate`` definition. For more information, see [Specifying a different launch template for an instance type](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html) in the *Amazon EC2 Auto Scaling User Guide*. You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the ``LaunchTemplate`` definition count towards this limit. Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group. You must specify the following: + The ID or the name of the launch template, but not both. + The version of the launch template. ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource. */ launchTemplateSpecification?: outputs.awsconnector.LaunchTemplateSpecificationResponse; /** * If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a ``WeightedCapacity`` of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see [Configure instance weighting for Amazon EC2 Auto Scaling](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html) in the *Amazon EC2 Auto Scaling User Guide*. Value must be in the range of 1-999. If you specify a value for ``WeightedCapacity`` for one instance type, you must specify a value for ``WeightedCapacity`` for all of them. Every Auto Scaling group has three size parameters (``DesiredCapacity``, ``MaxSize``, and ``MinSize``). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances. */ weightedCapacity?: string; } /** * Definition of LaunchTemplate */ interface LaunchTemplateResponse { /** * The launch template. Specifies a launch template to use when provisioning EC2 instances for an Auto Scaling group. You must specify the following: + The ID or the name of the launch template, but not both. + The version of the launch template. ``LaunchTemplateSpecification`` is property of the [AWS::AutoScaling::AutoScalingGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html) resource. It is also a property of the [AWS::AutoScaling::AutoScalingGroup LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplate.html) and [AWS::AutoScaling::AutoScalingGroup LaunchTemplateOverrides](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-launchtemplateoverrides.html) property types. For information about creating a launch template, see [AWS::EC2::LaunchTemplate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html) and [Create a launch template for an Auto Scaling group](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the *Amazon EC2 Auto Scaling User Guide*. For examples of launch templates, see [Auto scaling template snippets](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-autoscaling.html) and the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-launchtemplate.html#aws-resource-ec2-launchtemplate--examples) section in the ``AWS::EC2::LaunchTemplate`` resource. */ launchTemplateSpecification?: outputs.awsconnector.LaunchTemplateSpecificationResponse; /** * Any properties that you specify override the same properties in the launch template. */ overrides?: outputs.awsconnector.LaunchTemplateOverridesResponse[]; } /** * Definition of LaunchTemplateSpecification */ interface LaunchTemplateSpecificationEksNodegroupResponse { /** * Property id */ id?: string; /** * Property name */ name?: string; /** * Property version */ version?: string; } /** * Definition of LaunchTemplateSpecification */ interface LaunchTemplateSpecificationResponse { /** * The ID of the launch template. You must specify the ``LaunchTemplateID`` or the ``LaunchTemplateName``, but not both. */ launchTemplateId?: string; /** * The name of the launch template. You must specify the ``LaunchTemplateName`` or the ``LaunchTemplateID``, but not both. */ launchTemplateName?: string; /** * The version number of the launch template. Specifying ``$Latest`` or ``$Default`` for the template version number is not supported. However, you can specify ``LatestVersionNumber`` or ``DefaultVersionNumber`` using the ``Fn::GetAtt`` intrinsic function. For more information, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html). For an example of using the ``Fn::GetAtt`` function, see the [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-autoscaling-autoscalinggroup.html#aws-resource-autoscaling-autoscalinggroup--examples) section of the ``AWS::AutoScaling::AutoScalingGroup`` resource. */ version?: string; } /** * Definition of LegacyCustomOrigin */ interface LegacyCustomOriginResponse { /** * Property dnsName */ dnsName?: string; /** * Property httpPort */ httpPort?: number; /** * Property httpsPort */ httpsPort?: number; /** * Property originProtocolPolicy */ originProtocolPolicy?: string; /** * Property originSSLProtocols */ originSSLProtocols?: string[]; } /** * legacyCustomOriginResponseProvideDefaults sets the appropriate defaults for LegacyCustomOriginResponse */ function legacyCustomOriginResponseProvideDefaults(val: LegacyCustomOriginResponse): LegacyCustomOriginResponse; /** * Definition of LegacyS3Origin */ interface LegacyS3OriginResponse { /** * Property dnsName */ dnsName?: string; /** * Property originAccessIdentity */ originAccessIdentity?: string; } /** * Definition of LicenseConfiguration */ interface LicenseConfigurationResponse { /** *

The Amazon Resource Name (ARN) of the license configuration.

*/ licenseConfigurationArn?: string; } /** * Definition of LifecycleConfiguration */ interface LifecycleConfigurationResponse { /** * A lifecycle rule for individual objects in an Amazon S3 bucket. */ rules?: outputs.awsconnector.RuleResponse[]; } /** * Definition of LifecycleHookSpecification */ interface LifecycleHookSpecificationResponse { /** * The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is ``ABANDON``. Valid values: ``CONTINUE`` | ``ABANDON`` */ defaultResult?: string; /** * The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from ``30`` to ``7200`` seconds. The default value is ``3600`` seconds (1 hour). */ heartbeatTimeout?: number; /** * The name of the lifecycle hook. */ lifecycleHookName?: string; /** * The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions. + To create a lifecycle hook for scale-out events, specify ``autoscaling:EC2_INSTANCE_LAUNCHING``. + To create a lifecycle hook for scale-in events, specify ``autoscaling:EC2_INSTANCE_TERMINATING``. */ lifecycleTransition?: string; /** * Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target. */ notificationMetadata?: string; /** * The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue. */ notificationTargetARN?: string; /** * The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see [Configure a notification target for a lifecycle hook](https://docs.aws.amazon.com/autoscaling/ec2/userguide/prepare-for-lifecycle-notifications.html#lifecycle-hook-notification-target) in the *Amazon EC2 Auto Scaling User Guide*. Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue. */ roleARN?: string; } /** * Definition of LifecyclePolicy */ interface LifecyclePolicyEfsFileSystemResponse { /** * The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events. */ transitionToArchive?: string; /** * The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events. */ transitionToIA?: string; /** * Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events. */ transitionToPrimaryStorageClass?: string; } /** * Definition of LifecyclePolicy */ interface LifecyclePolicyResponse { /** * The JSON repository policy text to apply to the repository. The JSON repository policy text to apply to the repository. */ lifecyclePolicyText?: string; /** * The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. The AWS account ID associated with the registry that contains the repository. If you do not specify a registry, the default registry is assumed. */ registryId?: string; } /** * Definition of LightsailBucket */ interface LightsailBucketPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsLightsailBucketPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of LightsailInstance */ interface LightsailInstancePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsLightsailInstancePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of LinuxParameters */ interface LinuxParametersResponse { /** * The Linux capabilities for the container that are added to or dropped from the default configuration provided by Docker. For tasks that use the Fargate launch type, ``capabilities`` is supported for all platform versions but the ``add`` parameter is only supported if using platform version 1.4.0 or later. The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition. For more information about the default capabilities and the non-default available capabilities, see [Runtime privilege and Linux capabilities](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) in the *Docker run reference*. For more detailed information about these Linux capabilities, see the [capabilities(7)](http://man7.org/linux/man-pages/man7/capabilities.7.html) Linux manual page. */ capabilities?: outputs.awsconnector.KernelCapabilitiesResponse; /** * Any host devices to expose to the container. This parameter maps to ``Devices`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--device`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If you're using tasks that use the Fargate launch type, the ``devices`` parameter isn't supported. */ devices?: outputs.awsconnector.DeviceResponse[]; /** * Run an ``init`` process inside the container that forwards signals and reaps processes. This parameter maps to the ``--init`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` */ initProcessEnabled?: boolean; /** * The total amount of swap memory (in MiB) a container can use. This parameter will be translated to the ``--memory-swap`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration) where the value would be the sum of the container memory plus the ``maxSwap`` value. If a ``maxSwap`` value of ``0`` is specified, the container will not use swap. Accepted values are ``0`` or any positive integer. If the ``maxSwap`` parameter is omitted, the container will use the swap configuration for the container instance it is running on. A ``maxSwap`` value must be set for the ``swappiness`` parameter to be used. If you're using tasks that use the Fargate launch type, the ``maxSwap`` parameter isn't supported. If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported. */ maxSwap?: number; /** * The value for the size (in MiB) of the ``/dev/shm`` volume. This parameter maps to the ``--shm-size`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If you are using tasks that use the Fargate launch type, the ``sharedMemorySize`` parameter is not supported. */ sharedMemorySize?: number; /** * This allows you to tune a container's memory swappiness behavior. A ``swappiness`` value of ``0`` will cause swapping to not happen unless absolutely necessary. A ``swappiness`` value of ``100`` will cause pages to be swapped very aggressively. Accepted values are whole numbers between ``0`` and ``100``. If the ``swappiness`` parameter is not specified, a default value of ``60`` is used. If a value is not specified for ``maxSwap`` then this parameter is ignored. This parameter maps to the ``--memory-swappiness`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If you're using tasks that use the Fargate launch type, the ``swappiness`` parameter isn't supported. If you're using tasks on Amazon Linux 2023 the ``swappiness`` parameter isn't supported. */ swappiness?: number; /** * The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the ``--tmpfs`` option to [docker run](https://docs.docker.com/engine/reference/run/#security-configuration). If you're using tasks that use the Fargate launch type, the ``tmpfs`` parameter isn't supported. */ tmpfs?: outputs.awsconnector.TmpfsResponse[]; } /** * Definition of LoadBalancerAttribute */ interface LoadBalancerAttributeResponse { /** * The name of the attribute. The following attributes are supported by all load balancers: + ``deletion_protection.enabled`` - Indicates whether deletion protection is enabled. The value is ``true`` or ``false``. The default is ``false``. + ``load_balancing.cross_zone.enabled`` - Indicates whether cross-zone load balancing is enabled. The possible values are ``true`` and ``false``. The default for Network Load Balancers and Gateway Load Balancers is ``false``. The default for Application Load Balancers is ``true``, and cannot be changed. The following attributes are supported by both Application Load Balancers and Network Load Balancers: + ``access_logs.s3.enabled`` - Indicates whether access logs are enabled. The value is ``true`` or ``false``. The default is ``false``. + ``access_logs.s3.bucket`` - The name of the S3 bucket for the access logs. This attribute is required if access logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + ``access_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the access logs. + ``ipv6.deny_all_igw_traffic`` - Blocks internet gateway (IGW) access to the load balancer. It is set to ``false`` for internet-facing load balancers and ``true`` for internal load balancers, preventing unintended access to your internal load balancer through an internet gateway. The following attributes are supported by only Application Load Balancers: + ``idle_timeout.timeout_seconds`` - The idle timeout value, in seconds. The valid range is 1-4000 seconds. The default is 60 seconds. + ``client_keep_alive.seconds`` - The client keep alive value, in seconds. The valid range is 60-604800 seconds. The default is 3600 seconds. + ``connection_logs.s3.enabled`` - Indicates whether connection logs are enabled. The value is ``true`` or ``false``. The default is ``false``. + ``connection_logs.s3.bucket`` - The name of the S3 bucket for the connection logs. This attribute is required if connection logs are enabled. The bucket must exist in the same region as the load balancer and have a bucket policy that grants Elastic Load Balancing permissions to write to the bucket. + ``connection_logs.s3.prefix`` - The prefix for the location in the S3 bucket for the connection logs. + ``routing.http.desync_mitigation_mode`` - Determines how the load balancer handles requests that might pose a security risk to your application. The possible values are ``monitor``, ``defensive``, and ``strictest``. The default is ``defensive``. + ``routing.http.drop_invalid_header_fields.enabled`` - Indicates whether HTTP headers with invalid header fields are removed by the load balancer (``true``) or routed to targets (``false``). The default is ``false``. + ``routing.http.preserve_host_header.enabled`` - Indicates whether the Application Load Balancer should preserve the ``Host`` header in the HTTP request and send it to the target without any change. The possible values are ``true`` and ``false``. The default is ``false``. + ``routing.http.x_amzn_tls_version_and_cipher_suite.enabled`` - Indicates whether the two headers (``x-amzn-tls-version`` and ``x-amzn-tls-cipher-suite``), which contain information about the negotiated TLS version and cipher suite, are added to the client request before sending it to the target. The ``x-amzn-tls-version`` header has information about the TLS protocol version negotiated with the client, and the ``x-amzn-tls-cipher-suite`` header has information about the cipher suite negotiated with the client. Both headers are in OpenSSL format. The possible values for the attribute are ``true`` and ``false``. The default is ``false``. + ``routing.http.xff_client_port.enabled`` - Indicates whether the ``X-Forwarded-For`` header should preserve the source port that the client used to connect to the load balancer. The possible values are ``true`` and ``false``. The default is ``false``. + ``routing.http.xff_header_processing.mode`` - Enables you to modify, preserve, or remove the ``X-Forwarded-For`` header in the HTTP request before the Application Load Balancer sends the request to the target. The possible values are ``append``, ``preserve``, and ``remove``. The default is ``append``. + If the value is ``append``, the Application Load Balancer adds the client IP address (of the last hop) to the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets. + If the value is ``preserve`` the Application Load Balancer preserves the ``X-Forwarded-For`` header in the HTTP request, and sends it to targets without any change. + If the value is ``remove``, the Application Load Balancer removes the ``X-Forwarded-For`` header in the HTTP request before it sends it to targets. + ``routing.http2.enabled`` - Indicates whether HTTP/2 is enabled. The possible values are ``true`` and ``false``. The default is ``true``. Elastic Load Balancing requires that message header names contain only alphanumeric characters and hyphens. + ``waf.fail_open.enabled`` - Indicates whether to allow a WAF-enabled load balancer to route requests to targets if it is unable to forward the request to AWS WAF. The possible values are ``true`` and ``false``. The default is ``false``. The following attributes are supported by only Network Load Balancers: + ``dns_record.client_routing_policy`` - Indicates how traffic is distributed among the load balancer Availability Zones. The possible values are ``availability_zone_affinity`` with 100 percent zonal affinity, ``partial_availability_zone_affinity`` with 85 percent zonal affinity, and ``any_availability_zone`` with 0 percent zonal affinity. */ key?: string; /** * The value of the attribute. */ value?: string; } /** * Definition of LoadBalancer */ interface LoadBalancerResponse { /** * The name of the container (as it appears in a container definition) to associate with the load balancer. You need to specify the container name when configuring the target group for an Amazon ECS load balancer. */ containerName?: string; /** * The port on the container to associate with the load balancer. This port must correspond to a ``containerPort`` in the task definition the tasks in the service are using. For tasks that use the EC2 launch type, the container instance they're launched on must allow ingress traffic on the ``hostPort`` of the port mapping. */ containerPort?: number; /** * The name of the load balancer to associate with the Amazon ECS service or task set. If you are using an Application Load Balancer or a Network Load Balancer the load balancer name parameter should be omitted. */ loadBalancerName?: string; /** * The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or task set. A target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. For services using the ``ECS`` deployment controller, you can specify one or multiple target groups. For more information, see [Registering multiple target groups with a service](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/register-multiple-targetgroups.html) in the *Amazon Elastic Container Service Developer Guide*. For services using the ``CODE_DEPLOY`` deployment controller, you're required to define two target groups for the load balancer. For more information, see [Blue/green deployment with CodeDeploy](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-type-bluegreen.html) in the *Amazon Elastic Container Service Developer Guide*. If your service's task definition uses the ``awsvpc`` network mode, you must choose ``ip`` as the target type, not ``instance``. Do this when creating your target groups because tasks that use the ``awsvpc`` network mode are associated with an elastic network interface, not an Amazon EC2 instance. This network mode is required for the Fargate launch type. */ targetGroupArn?: string; } /** * Definition of LocalSecondaryIndex */ interface LocalSecondaryIndexResponse { /** * The name of the local secondary index. The name must be unique among all other indexes on this table. */ indexName?: string; /** * The complete key schema for the local secondary index, consisting of one or more pairs of attribute names and key types: + ``HASH`` - partition key + ``RANGE`` - sort key The partition key of an item is also known as its *hash attribute*. The term 'hash attribute' derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values. The sort key of an item is also known as its *range attribute*. The term 'range attribute' derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value. */ keySchema?: outputs.awsconnector.KeySchemaResponse[]; /** * Represents attributes that are copied (projected) from the table into the local secondary index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. Represents attributes that are copied (projected) from the table into an index. These are in addition to the primary key attributes and index key attributes, which are automatically projected. */ projection?: outputs.awsconnector.ProjectionResponse; } /** * Definition of Location */ interface LocationResponse { /** * The Availability Zone in which to create your instance. Use the following format: us-east-2a (case sensitive). Be sure to add the include Availability Zones parameter to your request. */ availabilityZone?: string; /** * The Region Name in which to create your instance. */ regionName?: string; } /** * Definition of LogConfig */ interface LogConfigResponse { /** *

The service role that AppSync assumes to publish to CloudWatch logs in your account.

*/ cloudWatchLogsRoleArn?: string; /** *

Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.

*/ excludeVerboseContent?: boolean; /** *

The field logging level. Values can be NONE, ERROR, or ALL.

  • NONE: No field-level logs are captured.

  • ERROR: Logs the following information only for the fields that are in error:

    • The error section in the server response.

    • Field-level errors.

    • The generated request/response functions that got resolved for error fields.

  • ALL: The following information is logged for all fields in the query:

    • Field-level tracing information.

    • The generated request/response functions that got resolved for each field.

*/ fieldLogLevel?: outputs.awsconnector.FieldLogLevelEnumValueResponse; } /** * Definition of LogConfiguration */ interface LogConfigurationResponse { /** * The log driver to use for the container. For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. For more information about using the ``awslogs`` log driver, see [Using the awslogs log driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html) in the *Amazon Elastic Container Service Developer Guide*. For more information about using the ``awsfirelens`` log driver, see [Custom log routing](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) in the *Amazon Elastic Container Service Developer Guide*. If you have a custom driver that isn't listed, you can fork the Amazon ECS container agent project that's [available on GitHub](https://github.com/aws/amazon-ecs-agent) and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we don't currently provide support for running modified copies of this software. */ logDriver?: string; /** * The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` */ options?: any; /** * The secrets to pass to the log configuration. For more information, see [Specifying sensitive data](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data.html) in the *Amazon Elastic Container Service Developer Guide*. */ secretOptions?: outputs.awsconnector.SecretResponse[]; } /** * Definition of LogPublishingOption */ interface LogPublishingOptionResponse { /** *

The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

*/ cloudWatchLogsLogGroupArn?: string; /** *

Whether the log should be published.

*/ enabled?: boolean; } /** * Definition of LogSetup */ interface LogSetupResponse { /** *

If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control plane logs. Each individual log type can be enabled or disabled independently.

*/ enabled?: boolean; /** *

The available cluster control plane log types.

*/ types?: string[]; } /** * Definition of LoggingConfig */ interface LoggingConfigResponse { /** * Set this property to filter the application logs for your function that Lambda sends to CloudWatch. Lambda only sends application logs at the selected level of detail and lower, where ``TRACE`` is the highest level and ``FATAL`` is the lowest. */ applicationLogLevel?: string; /** * The format in which Lambda sends your function's application and system logs to CloudWatch. Select between plain text and structured JSON. */ logFormat?: string; /** * The name of the Amazon CloudWatch log group the function sends logs to. By default, Lambda functions send logs to a default log group named ``/aws/lambda/``. To use a different log group, enter an existing log group or enter a new log group name. */ logGroup?: string; /** * Set this property to filter the system logs for your function that Lambda sends to CloudWatch. Lambda only sends system logs at the selected level of detail and lower, where ``DEBUG`` is the highest level and ``WARN`` is the lowest. */ systemLogLevel?: string; } /** * Definition of LoggingConfig */ interface LoggingConfigSnsTopicResponse { /** * Property failureFeedbackRoleArn */ failureFeedbackRoleArn?: string; /** * Property protocol */ protocol?: string; /** * Property successFeedbackRoleArn */ successFeedbackRoleArn?: string; /** * Property successFeedbackSampleRate */ successFeedbackSampleRate?: string; } /** * Definition of LoggingConfiguration */ interface LoggingConfigurationResponse { /** * The name of the bucket where Amazon S3 should store server access log files. You can store log files in any bucket that you own. By default, logs are stored in the bucket where the ``LoggingConfiguration`` property is defined. */ destinationBucketName?: string; /** * A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket. */ logFilePrefix?: string; /** * Amazon S3 key format for log objects. Only one format, either PartitionedPrefix or SimplePrefix, is allowed. Describes the key format for server access log file in the target bucket. You can choose between SimplePrefix and PartitionedPrefix. */ targetObjectKeyFormat?: outputs.awsconnector.TargetObjectKeyFormatResponse; } /** * Definition of Logging */ interface LoggingEksClusterResponse { /** *

The cluster control plane logging configuration for your cluster.

*/ clusterLogging?: outputs.awsconnector.LogSetupResponse[]; } /** * Definition of LoggingFilterModelProperties */ interface LoggingFilterModelPropertiesResponse { /** * Default handling for logs that don't match any of the specified filtering conditions. */ defaultBehavior?: string; /** * The filters that you want to apply to the logs. */ filters?: outputs.awsconnector.FilterWafv2LoggingConfigurationResponse[]; } /** * Definition of LoggingProperties */ interface LoggingPropertiesResponse { /** * Property bucketName */ bucketName?: string; /** * Property s3KeyPrefix */ s3KeyPrefix?: string; } /** * Definition of Logging */ interface LoggingResponse { /** * The Amazon S3 bucket to store the access logs in, for example, ``myawslogbucket.s3.amazonaws.com``. */ bucket?: string; /** * Specifies whether you want CloudFront to include cookies in access logs, specify ``true`` for ``IncludeCookies``. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify ``false`` for ``IncludeCookies``. */ includeCookies?: boolean; /** * An optional string that you want CloudFront to prefix to the access log ``filenames`` for this distribution, for example, ``myprefix/``. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty ``Prefix`` element in the ``Logging`` element. */ prefix?: string; } /** * Definition of LogsConfig */ interface LogsConfigResponse { /** *

Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.

*/ cloudWatchLogs?: outputs.awsconnector.CloudWatchLogsConfigResponse; /** *

Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.

*/ s3Logs?: outputs.awsconnector.S3LogsConfigResponse; } /** * Definition of LogsConfigStatusTypeEnumValue */ interface LogsConfigStatusTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of LogsLogGroup */ interface LogsLogGroupPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsLogsLogGroupPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * logsLogGroupPropertiesResponseProvideDefaults sets the appropriate defaults for LogsLogGroupPropertiesResponse */ function logsLogGroupPropertiesResponseProvideDefaults(val: LogsLogGroupPropertiesResponse): LogsLogGroupPropertiesResponse; /** * Definition of LogsLogStream */ interface LogsLogStreamPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsLogsLogStreamPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of LogsMetricFilter */ interface LogsMetricFilterPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsLogsMetricFilterPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of LogsSubscriptionFilter */ interface LogsSubscriptionFilterPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsLogsSubscriptionFilterPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Macie2JobSummary */ interface Macie2JobSummaryPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsMacie2JobSummaryPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of MacieAllowList */ interface MacieAllowListPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsMacieAllowListPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of MasterUserSecret */ interface MasterUserSecretResponse { /** * The AWS KMS key identifier that is used to encrypt the secret. */ kmsKeyId?: string; /** * The Amazon Resource Name (ARN) of the secret. */ secretArn?: string; } /** * Definition of MatchAttributes */ interface MatchAttributesResponse { /** * Property destinationPorts */ destinationPorts?: outputs.awsconnector.PortRangeResponse[]; /** * Property destinations */ destinations?: outputs.awsconnector.AddressResponse[]; /** * Property protocols */ protocols?: number[]; /** * Property sourcePorts */ sourcePorts?: outputs.awsconnector.PortRangeResponse[]; /** * Property sources */ sources?: outputs.awsconnector.AddressResponse[]; /** * Property tcpFlags */ tcpFlags?: outputs.awsconnector.TCPFlagFieldResponse[]; } /** * Definition of Matcher */ interface MatcherResponse { /** * You can specify values between 0 and 99. You can specify multiple values, or a range of values. The default value is 12. */ grpcCode?: string; /** * For Application Load Balancers, you can specify values between 200 and 499, and the default value is 200. You can specify multiple values or a range of values. */ httpCode?: string; } /** * Definition of MaxAgeRule */ interface MaxAgeRuleResponse { /** * Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version. */ deleteSourceFromS3?: boolean; /** * Specify true to apply the rule, or false to disable it. */ enabled?: boolean; /** * Specify the number of days to retain an application versions. */ maxAgeInDays?: number; } /** * Definition of MaxCountRule */ interface MaxCountRuleResponse { /** * Set to true to delete a version's source bundle from Amazon S3 when Elastic Beanstalk deletes the application version. */ deleteSourceFromS3?: boolean; /** * Specify true to apply the rule, or false to disable it. */ enabled?: boolean; /** * Specify the maximum number of application versions to retain. */ maxCount?: number; } /** * Definition of MaximumExecutionFrequencyEnumValue */ interface MaximumExecutionFrequencyEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of MemoryGiBPerVCpuRequest */ interface MemoryGiBPerVCpuRequestResponse { /** * The memory maximum in GiB. */ max?: number; /** * The memory minimum in GiB. */ min?: number; } /** * Definition of MemoryMiBRequest */ interface MemoryMiBRequestResponse { /** * The memory maximum in MiB. */ max?: number; /** * The memory minimum in MiB. */ min?: number; } /** * Definition of MethodSetting */ interface MethodSettingResponse { /** * Specifies whether the cached responses are encrypted. */ cacheDataEncrypted?: boolean; /** * Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. */ cacheTtlInSeconds?: number; /** * Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. */ cachingEnabled?: boolean; /** * Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs. */ dataTraceEnabled?: boolean; /** * The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``. */ httpMethod?: string; /** * Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are ``OFF``, ``ERROR``, and ``INFO``. Choose ``ERROR`` to write only error-level entries to CloudWatch Logs, or choose ``INFO`` to include all ``ERROR`` events as well as extra informational events. */ loggingLevel?: string; /** * Specifies whether Amazon CloudWatch metrics are enabled for this method. */ metricsEnabled?: boolean; /** * The resource path for this method. Forward slashes (``/``) are encoded as ``~1`` and the initial slash must include a forward slash. For example, the path value ``/resource/subresource`` must be encoded as ``/~1resource~1subresource``. To specify the root path, use only a slash (``/``). To apply settings to multiple resources and methods, specify an asterisk (``*``) for the ``HttpMethod`` and ``/*`` for the ``ResourcePath``. This parameter is required when you specify a ``MethodSetting``. */ resourcePath?: string; /** * Specifies the throttling burst limit. */ throttlingBurstLimit?: number; /** * Specifies the throttling rate limit. */ throttlingRateLimit?: number; } /** * Definition of MetricDataQuery */ interface MetricDataQueryResponse { /** * The ID of the account where the metrics are located, if this is a cross-account alarm. */ accountId?: string; /** * The math expression to be performed on the returned data, if this object is performing a math expression. This expression can use the ``Id`` of the other metrics to refer to those metrics, and can also use the ``Id`` of other expressions to use the result of those expressions. For more information about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the *User Guide*. Within each MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both. */ expression?: string; /** * A short name used to tie this object to the results in the response. This name must be unique within a single call to ``GetMetricData``. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter. */ id?: string; /** * A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents. If the metric or expression is shown in a CW dashboard widget, the label is shown. If ``Label`` is omitted, CW generates a default. */ label?: string; /** * The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data. Within one MetricDataQuery object, you must specify either ``Expression`` or ``MetricStat`` but not both. This structure defines the metric to be returned, along with the statistics, period, and units. ``MetricStat`` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type. */ metricStat?: outputs.awsconnector.MetricStatResponse; /** * The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` operation that includes a ``StorageResolution of 1 second``. */ period?: number; /** * This option indicates whether to return the timestamps and raw data values of this metric. When you create an alarm based on a metric math expression, specify ``True`` for this value for only the one math expression that the alarm is based on. You must specify ``False`` for ``ReturnData`` for all the other metrics and expressions used in the alarm. This field is required. */ returnData?: boolean; } /** * Definition of Metric */ interface MetricResponse { /** * The metric dimensions that you want to be used for the metric that the alarm will watch. */ dimensions?: outputs.awsconnector.DimensionResponse[]; /** * The name of the metric that you want the alarm to watch. This is a required field. */ metricName?: string; /** * The namespace of the metric that the alarm will watch. */ namespace?: string; } /** * Definition of MetricStat */ interface MetricStatResponse { /** * The metric to return, including the metric name, namespace, and dimensions. The ``Metric`` property type represents a specific metric. ``Metric`` is a property of the [MetricStat](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricstat.html) property type. */ metric?: outputs.awsconnector.MetricResponse; /** * The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` call that includes a ``StorageResolution`` of 1 second. If the ``StartTime`` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned: + Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute). + Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes). + Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour). */ period?: number; /** * The statistic to return. It can include any CW statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *User Guide*. */ stat?: string; /** * The unit to use for the returned data points. Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None. */ unit?: string; } /** * Definition of MetricTransformation */ interface MetricTransformationResponse { /** * (Optional) The value to emit when a filter pattern does not match a log event. This value can be null. */ defaultValue?: number; /** * The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions. Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as ``IPAddress`` or ``requestID`` as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric. CloudWatch Logs disables a metric filter if it generates 1000 different name/value pairs for your specified dimensions within a certain amount of time. This helps to prevent accidental high charges. You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see [Creating a Billing Alarm to Monitor Your Estimated Charges](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/monitor_estimated_charges_with_cloudwatch.html). */ dimensions?: outputs.awsconnector.DimensionLogsMetricFilterResponse[]; /** * The name of the CloudWatch metric. */ metricName?: string; /** * A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see [Namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Namespace). */ metricNamespace?: string; /** * The value that is published to the CloudWatch metric. For example, if you're counting the occurrences of a particular term like ``Error``, specify 1 for the metric value. If you're counting the number of bytes transferred, reference the value that is in the log event by using $. followed by the name of the field that you specified in the filter pattern, such as ``$.size``. */ metricValue?: string; /** * The unit to assign to the metric. If you omit this, the unit is set as ``None``. */ unit?: string; } /** * Definition of MetricsCollection */ interface MetricsCollectionResponse { /** * The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is ``1Minute``. */ granularity?: string; /** * Identifies the metrics to enable. You can specify one or more of the following metrics: + ``GroupMinSize`` + ``GroupMaxSize`` + ``GroupDesiredCapacity`` + ``GroupInServiceInstances`` + ``GroupPendingInstances`` + ``GroupStandbyInstances`` + ``GroupTerminatingInstances`` + ``GroupTotalInstances`` + ``GroupInServiceCapacity`` + ``GroupPendingCapacity`` + ``GroupStandbyCapacity`` + ``GroupTerminatingCapacity`` + ``GroupTotalCapacity`` + ``WarmPoolDesiredCapacity`` + ``WarmPoolWarmedCapacity`` + ``WarmPoolPendingCapacity`` + ``WarmPoolTerminatingCapacity`` + ``WarmPoolTotalCapacity`` + ``GroupAndWarmPoolDesiredCapacity`` + ``GroupAndWarmPoolTotalCapacity`` If you specify ``Granularity`` and don't specify any metrics, all metrics are enabled. For more information, see [Auto Scaling group metrics](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics) in the *Amazon EC2 Auto Scaling User Guide*. */ metrics?: string[]; } /** * Definition of MetricsConfiguration */ interface MetricsConfigurationResponse { /** * The access point that was used while performing operations on the object. The metrics configuration only includes objects that meet the filter's criteria. */ accessPointArn?: string; /** * The ID used to identify the metrics configuration. This can be any value you choose that helps you identify your metrics configuration. */ id?: string; /** * The prefix that an object must have to be included in the metrics results. */ prefix?: string; /** * Specifies a list of tag filters to use as a metrics configuration filter. The metrics configuration includes only objects that meet the filter's criteria. */ tagFilters?: outputs.awsconnector.TagFilterResponse[]; } /** * Definition of Metrics */ interface MetricsResponse { /** * A container specifying the time threshold for emitting the ``s3:Replication:OperationMissedThreshold`` event. A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics ``EventThreshold``. */ eventThreshold?: outputs.awsconnector.ReplicationTimeValueResponse; /** * Specifies whether the replication metrics are enabled. */ status?: string; } /** * Definition of MitigationInEffectEnumEnumValue */ interface MitigationInEffectEnumEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of MixedInstancesPolicy */ interface MixedInstancesPolicyResponse { /** * The instances distribution. Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy. For more information, see [Auto Scaling groups with multiple instance types and purchase options](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html) in the *Amazon EC2 Auto Scaling User Guide*. ``InstancesDistribution`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type. */ instancesDistribution?: outputs.awsconnector.InstancesDistributionResponse; /** * One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities. Use this structure to specify the launch templates and instance types (overrides) for a mixed instances policy. ``LaunchTemplate`` is a property of the [AWS::AutoScaling::AutoScalingGroup MixedInstancesPolicy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-autoscaling-autoscalinggroup-mixedinstancespolicy.html) property type. */ launchTemplate?: outputs.awsconnector.LaunchTemplateResponse; } /** * Definition of ModifyingProperties */ interface ModifyingPropertiesResponse { /** *

The current value of the domain property that is being modified.

*/ activeValue?: string; /** *

The name of the property that is currently being modified.

*/ name?: string; /** *

The value that the property that is currently being modified will eventually have.

*/ pendingValue?: string; /** *

The type of value that is currently being modified. Properties can have two types:

  • PLAIN_TEXT: Contain direct values such as '1', 'True', or 'c5.large.search'.

  • STRINGIFIED_JSON: Contain content in JSON format, such as {'Enabled':'True'}'.

*/ valueType?: outputs.awsconnector.PropertyValueTypeEnumValueResponse; } /** * Definition of Monitoring */ interface MonitoringResponse { /** *

Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

*/ state?: outputs.awsconnector.MonitoringStateEnumValueResponse; } /** * Definition of MonitoringStateEnumValue */ interface MonitoringStateEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of MonthlyTransfer */ interface MonthlyTransferResponse { /** * GbPerMonthAllocated of the Instance. */ gbPerMonthAllocated?: string; } /** * Definition of MountPoint */ interface MountPointResponse { /** * The path on the container to mount the host volume at. */ containerPath?: string; /** * If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``. */ readOnly?: boolean; /** * The name of the volume to mount. Must be a volume name referenced in the ``name`` parameter of task definition ``volume``. */ sourceVolume?: string; } /** * Definition of MutualAuthentication */ interface MutualAuthenticationResponse { /** * Indicates whether expired client certificates are ignored. */ ignoreClientCertificateExpiry?: boolean; /** * The client certificate handling method. Options are ``off``, ``passthrough`` or ``verify``. The default value is ``off``. */ mode?: string; /** * The Amazon Resource Name (ARN) of the trust store. */ trustStoreArn?: string; } /** * Definition of NetworkBandwidthGbpsRequest */ interface NetworkBandwidthGbpsRequestResponse { /** * The maximum amount of network bandwidth, in gigabits per second (Gbps). */ max?: number; /** * The minimum amount of network bandwidth, in gigabits per second (Gbps). */ min?: number; } /** * Definition of NetworkConfiguration */ interface NetworkConfigurationResponse { /** * The VPC subnets and security groups that are associated with a task. All specified subnets and security groups must be from the same VPC. An object representing the networking details for a task or service. For example ``awsvpcConfiguration={subnets=['subnet-12344321'],securityGroups=['sg-12344321']}`` */ awsvpcConfiguration?: outputs.awsconnector.AwsVpcConfigurationResponse; } /** * Definition of NetworkFirewallFirewallPolicy */ interface NetworkFirewallFirewallPolicyPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsNetworkFirewallFirewallPolicyPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of NetworkFirewallFirewall */ interface NetworkFirewallFirewallPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsNetworkFirewallFirewallPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of NetworkFirewallRuleGroup */ interface NetworkFirewallRuleGroupPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsNetworkFirewallRuleGroupPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of NetworkInterfaceCountRequest */ interface NetworkInterfaceCountRequestResponse { /** * The maximum number of network interfaces. */ max?: number; /** * The minimum number of network interfaces. */ min?: number; } /** * Definition of NetworkInterfaceStatusEnumValue */ interface NetworkInterfaceStatusEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of Networking */ interface NetworkingResponse { /** * Monthly Transfer of the Instance. */ monthlyTransfer?: outputs.awsconnector.MonthlyTransferResponse; /** * Ports to the Instance. */ ports?: outputs.awsconnector.PortResponse[]; } /** * Definition of Node */ interface NodeResponse { /** *

The Availability Zone (AZ) in which the node has been deployed.

*/ availabilityZone?: string; /** *

The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.

*/ endpoint?: outputs.awsconnector.DaxClusterEndpointResponse; /** *

The date and time (in UNIX epoch format) when the node was launched.

*/ nodeCreateTime?: string; /** *

A system-generated identifier for the node.

*/ nodeId?: string; /** *

The current status of the node. For example: available.

*/ nodeStatus?: string; /** *

The status of the parameter group associated with this node. For example, in-sync.

*/ parameterGroupStatus?: string; } /** * Definition of NodeToNodeEncryptionOptions */ interface NodeToNodeEncryptionOptionsResponse { /** *

True to enable node-to-node encryption.

*/ enabled?: boolean; } /** * Definition of NonCompliantSummary */ interface NonCompliantSummaryResponse { /** *

The total number of compliance items that aren't compliant.

*/ nonCompliantCount?: number; /** *

A summary of the non-compliance severity by compliance type

*/ severitySummary?: outputs.awsconnector.SeveritySummaryResponse; } /** * Definition of NoncurrentVersionExpiration */ interface NoncurrentVersionExpirationResponse { /** * Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*. */ newerNoncurrentVersions?: number; /** * Specifies the number of days an object is noncurrent before S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates When an Object Became Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*. */ noncurrentDays?: number; } /** * Definition of NoncurrentVersionTransition */ interface NoncurrentVersionTransitionResponse { /** * Specifies how many noncurrent versions S3 will retain. If there are this many more recent noncurrent versions, S3 will take the associated action. For more information about noncurrent versions, see [Lifecycle configuration elements](https://docs.aws.amazon.com/AmazonS3/latest/userguide/intro-lifecycle-rules.html) in the *Amazon S3 User Guide*. */ newerNoncurrentVersions?: number; /** * The class of storage used to store the object. */ storageClass?: string; /** * Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see [How Amazon S3 Calculates How Long an Object Has Been Noncurrent](https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#non-current-days-calculations) in the *Amazon S3 User Guide*. */ transitionInDays?: number; } /** * Definition of NotebookInstanceStatusEnumValue */ interface NotebookInstanceStatusEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of NotificationConfiguration */ interface NotificationConfigurationResponse { /** * Enables delivery of events to Amazon EventBridge. Amazon S3 can send events to Amazon EventBridge whenever certain events happen in your bucket, see [Using EventBridge](https://docs.aws.amazon.com/AmazonS3/latest/userguide/EventBridge.html) in the *Amazon S3 User Guide*. Unlike other destinations, delivery of events to EventBridge can be either enabled or disabled for a bucket. If enabled, all events will be sent to EventBridge and you can use EventBridge rules to route events to additional targets. For more information, see [What Is Amazon EventBridge](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is.html) in the *Amazon EventBridge User Guide* */ eventBridgeConfiguration?: outputs.awsconnector.EventBridgeConfigurationResponse; /** * Describes the LAMlong functions to invoke and the events for which to invoke them. */ lambdaConfigurations?: outputs.awsconnector.LambdaConfigurationResponse[]; /** * The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages. */ queueConfigurations?: outputs.awsconnector.QueueConfigurationResponse[]; /** * The topic to which notifications are sent and the events for which notifications are generated. */ topicConfigurations?: outputs.awsconnector.TopicConfigurationResponse[]; } /** * notificationConfigurationResponseProvideDefaults sets the appropriate defaults for NotificationConfigurationResponse */ function notificationConfigurationResponseProvideDefaults(val: NotificationConfigurationResponse): NotificationConfigurationResponse; /** * Definition of NotificationFilter */ interface NotificationFilterResponse { /** * A container for object key name prefix and suffix filtering rules. A container for object key name prefix and suffix filtering rules. For more information about object key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*. The same type of filter rule cannot be used more than once. For example, you cannot specify two prefix rules. */ s3Key?: outputs.awsconnector.S3KeyFilterResponse; } /** * Definition of OIDC */ interface OIDCResponse { /** *

The issuer URL for the OIDC identity provider.

*/ issuer?: string; } /** * Definition of ObjectLockConfiguration */ interface ObjectLockConfigurationResponse { /** * Indicates whether this bucket has an Object Lock configuration enabled. Enable ``ObjectLockEnabled`` when you apply ``ObjectLockConfiguration`` to a bucket. */ objectLockEnabled?: string; /** * Specifies the Object Lock rule for the specified object. Enable this rule when you apply ``ObjectLockConfiguration`` to a bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information, see [ObjectLockRule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-objectlockrule.html) and [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html). Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ``ObjectLockConfiguration`` to a bucket. */ rule?: outputs.awsconnector.ObjectLockRuleResponse; } /** * Definition of ObjectLockRule */ interface ObjectLockRuleResponse { /** * The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. If Object Lock is turned on, bucket settings require both ``Mode`` and a period of either ``Days`` or ``Years``. You cannot specify ``Days`` and ``Years`` at the same time. For more information about allowable values for mode and period, see [DefaultRetention](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-defaultretention.html). The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket. + The ``DefaultRetention`` settings require both a mode and a period. + The ``DefaultRetention`` period can be either ``Days`` or ``Years`` but you must select one. You cannot specify ``Days`` and ``Years`` at the same time. */ defaultRetention?: outputs.awsconnector.DefaultRetentionResponse; } /** * Definition of OffPeakWindowOptions */ interface OffPeakWindowOptionsResponse { /** *

Whether to enable an off-peak window.

This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.

*/ enabled?: boolean; /** *

Off-peak window settings for the domain.

*/ offPeakWindow?: outputs.awsconnector.OffPeakWindowResponse; } /** * Definition of OffPeakWindow */ interface OffPeakWindowResponse { /** *

A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.

*/ windowStartTime?: outputs.awsconnector.WindowStartTimeResponse; } /** * Definition of OpenIDConnectConfig */ interface OpenIDConnectConfigResponse { /** *

The number of milliseconds that a token is valid after being authenticated.

*/ authTTL?: number; /** *

The client identifier of the relying party at the OpenID identity provider. This identifier is typically obtained when the relying party is registered with the OpenID identity provider. You can specify a regular expression so that AppSync can validate against multiple client identifiers at a time.

*/ clientId?: string; /** *

The number of milliseconds that a token is valid after it's issued to a user.

*/ iatTTL?: number; /** *

The issuer for the OIDC configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

*/ issuer?: string; } /** * Definition of OpenSearchDomainStatus */ interface OpenSearchDomainStatusPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsOpenSearchDomainStatusPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of OpenSearchPartitionInstanceTypeEnumValue */ interface OpenSearchPartitionInstanceTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of OpenSearchWarmPartitionInstanceTypeEnumValue */ interface OpenSearchWarmPartitionInstanceTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of OperationLevelMetricsConfigEnumValue */ interface OperationLevelMetricsConfigEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of OperationPreferences */ interface OperationPreferencesResponse { /** * Property failureToleranceCount */ failureToleranceCount?: number; /** * Property failureTolerancePercentage */ failureTolerancePercentage?: number; /** * Property maxConcurrentCount */ maxConcurrentCount?: number; /** * Property maxConcurrentPercentage */ maxConcurrentPercentage?: number; /** * The concurrency type of deploying StackSets operations in regions, could be in parallel or one region at a time */ regionConcurrencyType?: string; /** * Property regionOrder */ regionOrder?: string[]; } /** * Definition of OptionSetting */ interface OptionSettingResponse { /** * A unique namespace that identifies the option's associated AWS resource. */ namespace?: string; /** * The name of the configuration option. */ optionName?: string; /** * A unique resource name for the option setting. Use it for a time–based scaling configuration option. */ resourceName?: string; /** * The current value for the configuration option. */ value?: string; } /** * Definition of OrganizationsAccount */ interface OrganizationsAccountPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsOrganizationsAccountPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * organizationsAccountPropertiesResponseProvideDefaults sets the appropriate defaults for OrganizationsAccountPropertiesResponse */ function organizationsAccountPropertiesResponseProvideDefaults(val: OrganizationsAccountPropertiesResponse): OrganizationsAccountPropertiesResponse; /** * Definition of OrganizationsOrganization */ interface OrganizationsOrganizationPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsOrganizationsOrganizationPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * organizationsOrganizationPropertiesResponseProvideDefaults sets the appropriate defaults for OrganizationsOrganizationPropertiesResponse */ function organizationsOrganizationPropertiesResponseProvideDefaults(val: OrganizationsOrganizationPropertiesResponse): OrganizationsOrganizationPropertiesResponse; /** * Definition of OriginCustomHeader */ interface OriginCustomHeaderResponse { /** * The name of a header that you want CloudFront to send to your origin. For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html) in the *Amazon CloudFront Developer Guide*. */ headerName?: string; /** * The value for the header that you specified in the ``HeaderName`` field. */ headerValue?: string; } /** * Definition of OriginGroupFailoverCriteria */ interface OriginGroupFailoverCriteriaResponse { /** * The status codes that, when returned from the primary origin, will trigger CloudFront to failover to the second origin. A complex data type for the status codes that you specify that, when returned by a primary origin, trigger CloudFront to failover to a second origin. */ statusCodes?: outputs.awsconnector.StatusCodesResponse; } /** * Definition of OriginGroupMember */ interface OriginGroupMemberResponse { /** * The ID for an origin in an origin group. */ originId?: string; } /** * Definition of OriginGroupMembers */ interface OriginGroupMembersResponse { /** * Items (origins) in an origin group. */ items?: outputs.awsconnector.OriginGroupMemberResponse[]; /** * The number of origins in an origin group. */ quantity?: number; } /** * Definition of OriginGroup */ interface OriginGroupResponse { /** * A complex type that contains information about the failover criteria for an origin group. A complex data type that includes information about the failover criteria for an origin group, including the status codes for which CloudFront will failover from the primary origin to the second origin. */ failoverCriteria?: outputs.awsconnector.OriginGroupFailoverCriteriaResponse; /** * The origin group's ID. */ id?: string; /** * A complex type that contains information about the origins in an origin group. A complex data type for the origins included in an origin group. */ members?: outputs.awsconnector.OriginGroupMembersResponse; } /** * Definition of OriginGroups */ interface OriginGroupsResponse { /** * The items (origin groups) in a distribution. */ items?: outputs.awsconnector.OriginGroupResponse[]; /** * The number of origin groups. */ quantity?: number; } /** * Definition of Origin */ interface OriginResponse { /** * The number of times that CloudFront attempts to connect to the origin. The minimum number is 1, the maximum is 3, and the default (if you don't specify otherwise) is 3. For a custom origin (including an Amazon S3 bucket that's configured with static website hosting), this value also specifies the number of times that CloudFront attempts to get a response from the origin, in the case of an [Origin Response Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginResponseTimeout). For more information, see [Origin Connection Attempts](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-attempts) in the *Amazon CloudFront Developer Guide*. */ connectionAttempts?: number; /** * The number of seconds that CloudFront waits when trying to establish a connection to the origin. The minimum timeout is 1 second, the maximum is 10 seconds, and the default (if you don't specify otherwise) is 10 seconds. For more information, see [Origin Connection Timeout](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#origin-connection-timeout) in the *Amazon CloudFront Developer Guide*. */ connectionTimeout?: number; /** * Use this type to specify an origin that is not an Amazon S3 bucket, with one exception. If the Amazon S3 bucket is configured with static website hosting, use this type. If the Amazon S3 bucket is not configured with static website hosting, use the ``S3OriginConfig`` type instead. A custom origin. A custom origin is any origin that is *not* an Amazon S3 bucket, with one exception. An Amazon S3 bucket that is [configured with static website hosting](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html) *is* a custom origin. */ customOriginConfig?: outputs.awsconnector.CustomOriginConfigResponse; /** * The domain name for the origin. For more information, see [Origin Domain Name](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesDomainName) in the *Amazon CloudFront Developer Guide*. */ domainName?: string; /** * A unique identifier for the origin. This value must be unique within the distribution. Use this value to specify the ``TargetOriginId`` in a ``CacheBehavior`` or ``DefaultCacheBehavior``. */ id?: string; /** * The unique identifier of an origin access control for this origin. For more information, see [Restricting access to an Amazon S3 origin](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html) in the *Amazon CloudFront Developer Guide*. */ originAccessControlId?: string; /** * A list of HTTP header names and values that CloudFront adds to the requests that it sends to the origin. For more information, see [Adding Custom Headers to Origin Requests](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/add-origin-custom-headers.html) in the *Amazon CloudFront Developer Guide*. */ originCustomHeaders?: outputs.awsconnector.OriginCustomHeaderResponse[]; /** * An optional path that CloudFront appends to the origin domain name when CloudFront requests content from the origin. For more information, see [Origin Path](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesOriginPath) in the *Amazon CloudFront Developer Guide*. */ originPath?: string; /** * CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin. For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*. CloudFront Origin Shield. Using Origin Shield can help reduce the load on your origin. For more information, see [Using Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html) in the *Amazon CloudFront Developer Guide*. */ originShield?: outputs.awsconnector.OriginShieldResponse; /** * Use this type to specify an origin that is an Amazon S3 bucket that is not configured with static website hosting. To specify any other type of origin, including an Amazon S3 bucket that is configured with static website hosting, use the ``CustomOriginConfig`` type instead. A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin or an S3 bucket that is configured as a website endpoint, use the ``CustomOriginConfig`` element instead. */ s3OriginConfig?: outputs.awsconnector.S3OriginConfigResponse; } /** * originResponseProvideDefaults sets the appropriate defaults for OriginResponse */ function originResponseProvideDefaults(val: OriginResponse): OriginResponse; /** * Definition of OriginShield */ interface OriginShieldResponse { /** * A flag that specifies whether Origin Shield is enabled. When it's enabled, CloudFront routes all requests through Origin Shield, which can help protect your origin. When it's disabled, CloudFront might send requests directly to your origin from multiple edge locations or regional edge caches. */ enabled?: boolean; /** * The AWS-Region for Origin Shield. Specify the AWS-Region that has the lowest latency to your origin. To specify a region, use the region code, not the region name. For example, specify the US East (Ohio) region as ``us-east-2``. When you enable CloudFront Origin Shield, you must specify the AWS-Region for Origin Shield. For the list of AWS-Regions that you can specify, and for help choosing the best Region for your origin, see [Choosing the for Origin Shield](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/origin-shield.html#choose-origin-shield-region) in the *Amazon CloudFront Developer Guide*. */ originShieldRegion?: string; } /** * Definition of OutpostConfigResponse */ interface OutpostConfigResponseResponse { /** *

The Amazon EC2 instance type used for the control plane. The instance type is the same for all control plane instances.

*/ controlPlaneInstanceType?: string; /** *

An object representing the placement configuration for all the control plane instances of your local Amazon EKS cluster on an Amazon Web Services Outpost. For more information, see Capacity considerations in the Amazon EKS User Guide.

*/ controlPlanePlacement?: outputs.awsconnector.ControlPlanePlacementResponseResponse; /** *

The ARN of the Outpost that you specified for use with your local Amazon EKS cluster on Outposts.

*/ outpostArns?: string[]; } /** * Definition of Output */ interface OutputResponse { /** * Property description */ description?: string; /** * Property exportName */ exportName?: string; /** * Property outputKey */ outputKey?: string; /** * Property outputValue */ outputValue?: string; } /** * Definition of Owner */ interface OwnerResponse { /** *

Container for the display name of the owner. This value is only supported in the following Amazon Web Services Regions:

  • US East (N. Virginia)

  • US West (N. California)

  • US West (Oregon)

  • Asia Pacific (Singapore)

  • Asia Pacific (Sydney)

  • Asia Pacific (Tokyo)

  • Europe (Ireland)

  • South America (São Paulo)

This functionality is not supported for directory buckets.

*/ displayName?: string; /** *

Container for the ID of the owner.

*/ id?: string; } /** * Definition of OwnershipControls */ interface OwnershipControlsResponse { /** * Specifies the container element for Object Ownership rules. */ rules?: outputs.awsconnector.OwnershipControlsRuleResponse[]; } /** * Definition of OwnershipControlsRule */ interface OwnershipControlsRuleResponse { /** * Specifies an object ownership rule. */ objectOwnership?: string; } /** * Definition of ParameterGroupStatus */ interface ParameterGroupStatusResponse { /** *

The node IDs of one or more nodes to be rebooted.

*/ nodeIdsToReboot?: string[]; /** *

The status of parameter updates.

*/ parameterApplyStatus?: string; /** *

The name of the parameter group.

*/ parameterGroupName?: string; } /** * Definition of Parameter */ interface ParameterRedshiftClusterParameterGroupResponse { /** * The name of the parameter. */ parameterName?: string; /** * The value of the parameter. If `ParameterName` is `wlm_json_configuration`, then the maximum size of `ParameterValue` is 8000 characters. */ parameterValue?: string; } /** * Definition of Parameter */ interface ParameterResponse { /** * The key associated with the parameter. If you don't specify a key and value for a particular parameter, AWS CloudFormation uses the default value that is specified in your template. */ parameterKey?: string; /** * The input value associated with the parameter. */ parameterValue?: string; } /** * Definition of PartitionedPrefix */ interface PartitionedPrefixResponse { /** * Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime. */ partitionDateSource?: string; } /** * Definition of PermissionEnumValue */ interface PermissionEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of PingStatusEnumValue */ interface PingStatusEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of PlacementConstraint */ interface PlacementConstraintResponse { /** * A cluster query language expression to apply to the constraint. The expression can have a maximum length of 2000 characters. You can't specify an expression if the constraint type is ``distinctInstance``. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*. */ expression?: string; /** * The type of constraint. Use ``distinctInstance`` to ensure that each task in a particular group is running on a different container instance. Use ``memberOf`` to restrict the selection to a group of valid candidates. */ type?: string; } /** * Definition of PlacementGroupConfig */ interface PlacementGroupConfigResponse { /** *

Role of the instance in the cluster.

Starting with Amazon EMR release 5.23.0, the only supported instance role is MASTER.

*/ instanceRole?: outputs.awsconnector.InstanceRoleTypeEnumValueResponse; /** *

Amazon EC2 Placement Group strategy associated with instance role.

Starting with Amazon EMR release 5.23.0, the only supported placement strategy is SPREAD for the MASTER instance role.

*/ placementStrategy?: outputs.awsconnector.PlacementGroupStrategyEnumValueResponse; } /** * Definition of PlacementGroupStrategyEnumValue */ interface PlacementGroupStrategyEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of Placement */ interface PlacementResponse { /** *

The affinity setting for the instance on the Dedicated Host.

This parameter is not supported for CreateFleet or ImportInstance.

*/ affinity?: string; /** *

The Availability Zone of the instance.

If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.

This parameter is not supported for CreateFleet.

*/ availabilityZone?: string; /** *

The ID of the placement group that the instance is in. If you specify GroupId, you can't specify GroupName.

*/ groupId?: string; /** *

The name of the placement group that the instance is in. If you specify GroupName, you can't specify GroupId.

*/ groupName?: string; /** *

The ID of the Dedicated Host on which the instance resides.

This parameter is not supported for CreateFleet or ImportInstance.

*/ hostId?: string; /** *

The ARN of the host resource group in which to launch the instances.

If you specify this parameter, either omit the Tenancy parameter or set it to host.

This parameter is not supported for CreateFleet.

*/ hostResourceGroupArn?: string; /** *

The number of the partition that the instance is in. Valid only if the placement group strategy is set to partition.

This parameter is not supported for CreateFleet.

*/ partitionNumber?: number; /** *

Reserved for future use.

*/ spreadDomain?: string; /** *

The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.

This parameter is not supported for CreateFleet. The host tenancy is not supported for ImportInstance or for T3 instances that are configured for the unlimited CPU credit option.

*/ tenancy?: outputs.awsconnector.TenancyEnumValueResponse; } /** * Definition of PlacementStrategy */ interface PlacementStrategyResponse { /** * The field to apply the placement strategy against. For the ``spread`` placement strategy, valid values are ``instanceId`` (or ``host``, which has the same effect), or any platform or custom attribute that is applied to a container instance, such as ``attribute:ecs.availability-zone``. For the ``binpack`` placement strategy, valid values are ``CPU`` and ``MEMORY``. For the ``random`` placement strategy, this field is not used. */ field?: string; /** * The type of placement strategy. The ``random`` placement strategy randomly places tasks on available candidates. The ``spread`` placement strategy spreads placement across available candidates evenly based on the ``field`` parameter. The ``binpack`` strategy places tasks on available candidates that have the least available amount of the resource that's specified with the ``field`` parameter. For example, if you binpack on memory, a task is placed on the instance with the least amount of remaining memory but still enough to run the task. */ type?: string; } /** * Definition of PlatformTypeEnumValue */ interface PlatformTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of PlatformValuesEnumValue */ interface PlatformValuesEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of PointInTimeRecoveryDescription */ interface PointInTimeRecoveryDescriptionResponse { /** *

Specifies the earliest point in time you can restore your table to. You can restore your table to any point in time during the last 35 days.

*/ earliestRestorableDateTime?: string; /** *

LatestRestorableDateTime is typically 5 minutes before the current time.

*/ latestRestorableDateTime?: string; /** *

The current state of point in time recovery:

  • ENABLED - Point in time recovery is enabled.

  • DISABLED - Point in time recovery is disabled.

*/ pointInTimeRecoveryStatus?: outputs.awsconnector.PointInTimeRecoveryStatusEnumValueResponse; } /** * Definition of PointInTimeRecoverySpecification */ interface PointInTimeRecoverySpecificationResponse { /** * Indicates whether point in time recovery is enabled (true) or disabled (false) on the table. */ pointInTimeRecoveryEnabled?: boolean; } /** * Definition of PointInTimeRecoveryStatusEnumValue */ interface PointInTimeRecoveryStatusEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of Policy */ interface PolicyResponse { /** * The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json). */ policyDocument?: any; /** * The friendly name (not ARN) identifying the policy. */ policyName?: string; } /** * Definition of PortMapping */ interface PortMappingResponse { /** * The application protocol that's used for the port mapping. This parameter only applies to Service Connect. We recommend that you set this parameter to be consistent with the protocol that your application uses. If you set this parameter, Amazon ECS adds protocol-specific connection handling to the Service Connect proxy. If you set this parameter, Amazon ECS adds protocol-specific telemetry in the Amazon ECS console and CloudWatch. If you don't set a value for this parameter, then TCP is used. However, Amazon ECS doesn't add protocol-specific telemetry for TCP. ``appProtocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. */ appProtocol?: string; /** * The port number on the container that's bound to the user-specified or automatically assigned host port. If you use containers in a task with the ``awsvpc`` or ``host`` network mode, specify the exposed ports using ``containerPort``. If you use containers in a task with the ``bridge`` network mode and you specify a container port and not a host port, your container automatically receives a host port in the ephemeral port range. For more information, see ``hostPort``. Port mappings that are automatically assigned in this way do not count toward the 100 reserved ports limit of a container instance. */ containerPort?: number; /** * The port number range on the container that's bound to the dynamically mapped host port range. The following rules apply when you specify a ``containerPortRange``: + You must use either the ``bridge`` network mode or the ``awsvpc`` network mode. + This parameter is available for both the EC2 and FARGATElong launch types. + This parameter is available for both the Linux and Windows operating systems. + The container instance must have at least version 1.67.0 of the container agent and at least version 1.67.0-1 of the ``ecs-init`` package + You can specify a maximum of 100 port ranges per container. + You do not specify a ``hostPortRange``. The value of the ``hostPortRange`` is set as follows: + For containers in a task with the ``awsvpc`` network mode, the ``hostPortRange`` is set to the same value as the ``containerPortRange``. This is a static mapping strategy. + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open host ports from the default ephemeral range and passes it to docker to bind them to the container ports. + The ``containerPortRange`` valid values are between 1 and 65535. + A port can only be included in one port mapping per container. + You cannot specify overlapping port ranges. + The first port in the range must be less than last port in the range. + Docker recommends that you turn off the docker-proxy in the Docker daemon config file when you have a large number of ports. For more information, see [Issue #11185](https://github.com/moby/moby/issues/11185) on the Github website. For information about how to turn off the docker-proxy in the Docker daemon config file, see [Docker daemon](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/bootstrap_container_instance.html#bootstrap_docker_daemon) in the *Amazon ECS Developer Guide*. You can call [DescribeTasks](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeTasks.html) to view the ``hostPortRange`` which are the host ports that are bound to the container ports. */ containerPortRange?: string; /** * The port number on the container instance to reserve for your container. If you specify a ``containerPortRange``, leave this field empty and the value of the ``hostPort`` is set as follows: + For containers in a task with the ``awsvpc`` network mode, the ``hostPort`` is set to the same value as the ``containerPort``. This is a static mapping strategy. + For containers in a task with the ``bridge`` network mode, the Amazon ECS agent finds open ports on the host and automatically binds them to the container ports. This is a dynamic mapping strategy. If you use containers in a task with the ``awsvpc`` or ``host`` network mode, the ``hostPort`` can either be left blank or set to the same value as the ``containerPort``. If you use containers in a task with the ``bridge`` network mode, you can specify a non-reserved host port for your container port mapping, or you can omit the ``hostPort`` (or set it to ``0``) while specifying a ``containerPort`` and your container automatically receives a port in the ephemeral port range for your container instance operating system and Docker version. The default ephemeral port range for Docker version 1.6.0 and later is listed on the instance under ``/proc/sys/net/ipv4/ip_local_port_range``. If this kernel parameter is unavailable, the default ephemeral port range from 49153 through 65535 (Linux) or 49152 through 65535 (Windows) is used. Do not attempt to specify a host port in the ephemeral port range as these are reserved for automatic assignment. In general, ports below 32768 are outside of the ephemeral port range. The default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in a running task is also reserved while the task is running. That is, after a task stops, the host port is released. The current reserved ports are displayed in the ``remainingResources`` of [DescribeContainerInstances](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_DescribeContainerInstances.html) output. A container instance can have up to 100 reserved ports at a time. This number includes the default reserved ports. Automatically assigned ports aren't included in the 100 reserved ports quota. */ hostPort?: number; /** * The name that's used for the port mapping. This parameter only applies to Service Connect. This parameter is the name that you use in the ``serviceConnectConfiguration`` of a service. The name can include up to 64 characters. The characters can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. */ name?: string; /** * The protocol used for the port mapping. Valid values are ``tcp`` and ``udp``. The default is ``tcp``. ``protocol`` is immutable in a Service Connect service. Updating this field requires a service deletion and redeployment. */ protocol?: string; } /** * Definition of PortRange */ interface PortRangeResponse { /** * Property fromPort */ fromPort?: number; /** * Property toPort */ toPort?: number; } /** * Definition of Port */ interface PortResponse { /** * Access Direction for Protocol of the Instance(inbound/outbound). */ accessDirection?: string; /** * Access From Protocol of the Instance. */ accessFrom?: string; /** * Access Type Protocol of the Instance. */ accessType?: string; /** * cidr List Aliases */ cidrListAliases?: string[]; /** * Property cidrs */ cidrs?: string[]; /** * CommonName for Protocol of the Instance. */ commonName?: string; /** * From Port of the Instance. */ fromPort?: number; /** * IPv6 Cidrs */ ipv6Cidrs?: string[]; /** * Port Protocol of the Instance. */ protocol?: string; /** * To Port of the Instance. */ toPort?: number; } /** * Definition of PortSet */ interface PortSetResponse { /** * Property definition */ definition?: string[]; } /** * Definition of PrefixListId */ interface PrefixListIdResponse { /** *

A description for the security group rule that references this prefix list ID.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

*/ description?: string; /** *

The ID of the prefix.

*/ prefixListId?: string; } /** * Definition of PrivateDnsNameOptionsOnLaunchModelProperties */ interface PrivateDnsNameOptionsOnLaunchModelPropertiesResponse { /** * Property enableResourceNameDnsAAAARecord */ enableResourceNameDnsAAAARecord?: boolean; /** * Property enableResourceNameDnsARecord */ enableResourceNameDnsARecord?: boolean; /** * Property hostnameType */ hostnameType?: string; } /** * Definition of PrivateDnsNameOptionsResponse */ interface PrivateDnsNameOptionsResponseResponse { /** *

Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.

*/ enableResourceNameDnsAAAARecord?: boolean; /** *

Indicates whether to respond to DNS queries for instance hostnames with DNS A records.

*/ enableResourceNameDnsARecord?: boolean; /** *

The type of hostname to assign to an instance.

*/ hostnameType?: outputs.awsconnector.HostnameTypeEnumValueResponse; } /** * Definition of PrivateIpAddressSpecification */ interface PrivateIpAddressSpecificationResponse { /** * Property primary */ primary?: boolean; /** * Property privateIpAddress */ privateIpAddress?: string; } /** * Definition of ProcessorFeature */ interface ProcessorFeatureResponse { /** *

The name of the processor feature. Valid names are coreCount and threadsPerCore.

*/ name?: string; /** *

The value of a processor feature name.

*/ value?: string; } /** * Definition of ProductCode */ interface ProductCodeResponse { /** *

The product code.

*/ productCodeId?: string; /** *

The type of product code.

*/ productCodeType?: outputs.awsconnector.ProductCodeValuesEnumValueResponse; } /** * Definition of ProductCodeValuesEnumValue */ interface ProductCodeValuesEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ProjectArtifacts */ interface ProjectArtifactsResponse { /** *

An identifier for this artifact definition.

*/ artifactIdentifier?: string; /** * Property bucketOwnerAccess */ bucketOwnerAccess?: outputs.awsconnector.BucketOwnerAccessEnumValueResponse; /** *

Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown.

*/ encryptionDisabled?: boolean; /** *

Information about the build output artifact location:

  • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.

  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, this is the name of the output bucket.

*/ location?: string; /** *

Along with path and namespaceType, the pattern that CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.

  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, this is the name of the output artifact object. If you set the name to be a forward slash ('/'), the artifact is stored in the root of the output bucket.

For example:

  • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

  • If path is empty, namespaceType is set to NONE, and name is set to '/', the output artifact is stored in the root of the output bucket.

  • If path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to '/', the output artifact is stored in MyArtifacts/<build-ID>.

*/ name?: string; /** *

Along with path and name, the pattern that CodeBuild uses to determine the name and location to store the output artifact:

  • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.

  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, valid values include:

    • BUILD_ID: Include the build ID in the location of the build output artifact.

    • NONE: Do not include the build ID. This is the default if namespaceType is not specified.

For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, the output artifact is stored in MyArtifacts/<build-ID>/MyArtifact.zip.

*/ namespaceType?: outputs.awsconnector.ArtifactNamespaceEnumValueResponse; /** *

If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.

*/ overrideArtifactName?: boolean; /** *

The type of build output artifact to create:

  • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.

  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, valid values include:

    • NONE: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if packaging is not specified.

    • ZIP: CodeBuild creates in the output bucket a ZIP file that contains the build output.

*/ packaging?: outputs.awsconnector.ArtifactPackagingEnumValueResponse; /** *

Along with namespaceType and name, the pattern that CodeBuild uses to name and store the output artifact:

  • If type is set to CODEPIPELINE, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.

  • If type is set to NO_ARTIFACTS, this value is ignored if specified, because no build output is produced.

  • If type is set to S3, this is the path to the output artifact. If path is not specified, path is not used.

For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, the output artifact is stored in the output bucket at MyArtifacts/MyArtifact.zip.

*/ path?: string; /** *

The type of build output artifact. Valid values include:

  • CODEPIPELINE: The build project has build output generated through CodePipeline.

    The CODEPIPELINE type is not supported for secondaryArtifacts.

  • NO_ARTIFACTS: The build project does not produce any build output.

  • S3: The build project stores build output in Amazon S3.

*/ type?: outputs.awsconnector.ArtifactsTypeEnumValueResponse; } /** * Definition of ProjectBadge */ interface ProjectBadgeResponse { /** *

Set this to true to generate a publicly accessible URL for your project's build badge.

*/ badgeEnabled?: boolean; /** *

The publicly-accessible URL through which you can access the build badge for your project.

*/ badgeRequestUrl?: string; } /** * Definition of ProjectBuildBatchConfig */ interface ProjectBuildBatchConfigResponse { /** *

Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.

REPORT_AGGREGATED_BATCH

(Default) Aggregate all of the build statuses into a single status report.

REPORT_INDIVIDUAL_BUILDS

Send a separate status report for each individual build.

*/ batchReportMode?: outputs.awsconnector.BatchReportModeTypeEnumValueResponse; /** *

Specifies if the build artifacts for the batch build should be combined into a single artifact location.

*/ combineArtifacts?: boolean; /** *

A BatchRestrictions object that specifies the restrictions for the batch build.

*/ restrictions?: outputs.awsconnector.BatchRestrictionsResponse; /** *

Specifies the service role ARN for the batch build project.

*/ serviceRole?: string; /** *

Specifies the maximum amount of time, in minutes, that the batch build must be completed in.

*/ timeoutInMins?: number; } /** * Definition of ProjectCache */ interface ProjectCacheResponse { /** *

Information about the cache location:

  • NO_CACHE or LOCAL: This value is ignored.

  • S3: This is the S3 bucket name/prefix.

*/ location?: string; /** *

An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for LOCAL cache types.

Possible values are:

LOCAL_SOURCE_CACHE

Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.

LOCAL_DOCKER_LAYER_CACHE

Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.

  • You can use a Docker layer cache in the Linux environment only.

  • The privileged flag must be set so that your project has the required Docker permissions.

  • You should consider the security implications before you use a Docker layer cache.

LOCAL_CUSTOM_CACHE

Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:

  • Only directories can be specified for caching. You cannot specify individual files.

  • Symlinks are used to reference cached directories.

  • Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file.

*/ modes?: string[]; /** *

The type of cache used by the build project. Valid values include:

  • NO_CACHE: The build project does not use any cache.

  • S3: The build project reads and writes from and to S3.

  • LOCAL: The build project stores a cache locally on a build host that is only available to that build host.

*/ type?: outputs.awsconnector.CacheTypeEnumValueResponse; } /** * Definition of ProjectEnvironment */ interface ProjectEnvironmentResponse { /** *

The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see certificate in the CodeBuild User Guide.

*/ certificate?: string; /** *

Information about the compute resources the build project uses. Available values include:

  • BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds.

  • BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds.

  • BUILD_GENERAL1_LARGE: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.

  • BUILD_GENERAL1_XLARGE: Use up to 70 GB memory and 36 vCPUs for builds, depending on your environment type.

  • BUILD_GENERAL1_2XLARGE: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.

  • BUILD_LAMBDA_1GB: Use up to 1 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

  • BUILD_LAMBDA_2GB: Use up to 2 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

  • BUILD_LAMBDA_4GB: Use up to 4 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

  • BUILD_LAMBDA_8GB: Use up to 8 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

  • BUILD_LAMBDA_10GB: Use up to 10 GB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

If you use BUILD_GENERAL1_SMALL:

  • For environment type LINUX_CONTAINER, you can use up to 3 GB memory and 2 vCPUs for builds.

  • For environment type LINUX_GPU_CONTAINER, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.

  • For environment type ARM_CONTAINER, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.

If you use BUILD_GENERAL1_LARGE:

  • For environment type LINUX_CONTAINER, you can use up to 15 GB memory and 8 vCPUs for builds.

  • For environment type LINUX_GPU_CONTAINER, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.

  • For environment type ARM_CONTAINER, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.

If you're using compute fleets during project creation, computeType will be ignored.

For more information, see Build Environment Compute Types in the CodeBuild User Guide.

*/ computeType?: outputs.awsconnector.ComputeTypeEnumValueResponse; /** *

A set of environment variables to make available to builds for this build project.

*/ environmentVariables?: outputs.awsconnector.EnvironmentVariableResponse[]; /** *

A ProjectFleet object to use for this build project.

*/ fleet?: outputs.awsconnector.ProjectFleetResponse; /** *

The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:

  • For an image tag: <registry>/<repository>:<tag>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be aws/codebuild/standard:4.0.

  • For an image digest: <registry>/<repository>@<digest>. For example, to specify an image with the digest 'sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf,' use <registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf.

For more information, see Docker images provided by CodeBuild in the CodeBuild user guide.

*/ image?: string; /** *

The type of credentials CodeBuild uses to pull images in your build. There are two valid values:

  • CODEBUILD specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal.

  • SERVICE_ROLE specifies that CodeBuild uses your build project's service role.

When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials.

*/ imagePullCredentialsType?: outputs.awsconnector.ImagePullCredentialsTypeEnumValueResponse; /** *

Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is false.

You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:

If the operating system's base image is Ubuntu Linux:

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

- timeout 15 sh -c 'until docker info; do echo .; sleep 1; done'

If the operating system's base image is Alpine Linux and the previous command does not work, add the -t argument to timeout:

- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&

- timeout -t 15 sh -c 'until docker info; do echo .; sleep 1; done'

*/ privilegedMode?: boolean; /** *

The credentials for access to a private registry.

*/ registryCredential?: outputs.awsconnector.RegistryCredentialResponse; /** *

The type of build environment to use for related builds.

  • The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Sydney), and EU (Frankfurt).

  • The environment type LINUX_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia).

  • The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia).

  • The environment types ARM_LAMBDA_CONTAINER and LINUX_LAMBDA_CONTAINER are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), EU (Frankfurt), EU (Ireland), and South America (São Paulo).

  • The environment types WINDOWS_CONTAINER and WINDOWS_SERVER_2019_CONTAINER are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).

If you're using compute fleets during project creation, type will be ignored.

For more information, see Build environment compute types in the CodeBuild user guide.

*/ type?: outputs.awsconnector.EnvironmentTypeEnumValueResponse; } /** * Definition of ProjectFileSystemLocation */ interface ProjectFileSystemLocationResponse { /** *

The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the identifier in all capital letters to CODEBUILD_. For example, if you specify my_efs for identifier, a new environment variable is create named CODEBUILD_MY_EFS.

The identifier is used to mount your file system.

*/ identifier?: string; /** *

A string that specifies the location of the file system created by Amazon EFS. Its format is efs-dns-name:/directory-path. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is fs-abcd1234.efs.us-west-2.amazonaws.com, and its mount directory is my-efs-mount-directory, then the location is fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory.

The directory path in the format efs-dns-name:/directory-path is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.

*/ location?: string; /** *

The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2. For more information, see Recommended NFS Mount Options.

*/ mountOptions?: string; /** *

The location in the container where you mount the file system.

*/ mountPoint?: string; /** *

The type of the file system. The one supported type is EFS.

*/ type?: outputs.awsconnector.FileSystemTypeEnumValueResponse; } /** * Definition of ProjectFleet */ interface ProjectFleetResponse { /** *

Specifies the compute fleet ARN for the build project.

*/ fleetArn?: string; } /** * Definition of ProjectSource */ interface ProjectSourceResponse { /** *

Information about the authorization settings for CodeBuild to access the source code to be built.

This information is for the CodeBuild console's use only. Your code should not get or set this information directly.

*/ auth?: outputs.awsconnector.SourceAuthResponse; /** *

Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

*/ buildStatusConfig?: outputs.awsconnector.BuildStatusConfigResponse; /** *

The buildspec file declaration to use for the builds in this build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

*/ buildspec?: string; /** *

Information about the Git clone depth for the build project.

*/ gitCloneDepth?: number; /** *

Information about the Git submodules configuration for the build project.

*/ gitSubmodulesConfig?: outputs.awsconnector.GitSubmodulesConfigResponse; /** *

Enable this flag to ignore SSL warnings while connecting to the project source code.

*/ insecureSsl?: boolean; /** *

Information about the location of the source code to be built. Valid values include:

  • For source code settings that are specified in the source action of a pipeline in CodePipeline, location should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.

  • For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>).

  • For source code in an Amazon S3 input bucket, one of the following.

    • The path to the ZIP file that contains the source code (for example, <bucket-name>/<path>/<object-name>.zip).

    • The path to the folder that contains the source code (for example, <bucket-name>/<path-to-source-code>/<folder>/).

  • For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitHub account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page, for Organization access, choose Request access next to each repository you want to allow CodeBuild to have access to, and then choose Authorize application. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.

  • For source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitLab account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitLab, on the Connections Authorize application page, choose Authorize. Then on the CodeConnections Create GitLab connection page, choose Connect to GitLab. (After you have connected to your GitLab account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to override the default connection and use this connection instead, set the auth object's type value to CODECONNECTIONS in the source object.

  • For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your Bitbucket account. Use the CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page, choose Grant access. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the CodeBuild console.) To instruct CodeBuild to use this connection, in the source object, set the auth object's type value to OAUTH.

If you specify CODEPIPELINE for the Type property, don't specify this property. For all of the other types, you must specify Location.

*/ location?: string; /** *

Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown.

To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.

The status of a build triggered by a webhook is always reported to your source provider.

If your project's builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect.

*/ reportBuildStatus?: boolean; /** *

An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.

*/ sourceIdentifier?: string; /** *

The type of repository that contains the source code to be built. Valid values include:

  • BITBUCKET: The source code is in a Bitbucket repository.

  • CODECOMMIT: The source code is in an CodeCommit repository.

  • CODEPIPELINE: The source code settings are specified in the source action of a pipeline in CodePipeline.

  • GITHUB: The source code is in a GitHub repository.

  • GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.

  • GITLAB: The source code is in a GitLab repository.

  • GITLAB_SELF_MANAGED: The source code is in a self-managed GitLab repository.

  • NO_SOURCE: The project does not have input source code.

  • S3: The source code is in an Amazon S3 bucket.

*/ type?: outputs.awsconnector.SourceTypeEnumValueResponse; } /** * Definition of ProjectSourceVersion */ interface ProjectSourceVersionResponse { /** *

An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.

*/ sourceIdentifier?: string; /** *

The source version for the corresponding source identifier. If specified, must be one of:

  • For CodeCommit: the commit ID, branch, or Git tag to use.

  • For GitHub or GitLab: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example, pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

  • For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

*/ sourceVersion?: string; } /** * Definition of ProjectVisibilityTypeEnumValue */ interface ProjectVisibilityTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of Projection */ interface ProjectionResponse { /** * Represents the non-key attribute names which will be projected into the index. For local secondary indexes, the total count of ``NonKeyAttributes`` summed across all of the local secondary indexes, must not exceed 100. If you project the same attribute into two different indexes, this counts as two distinct attributes when determining the total. */ nonKeyAttributes?: string[]; /** * The set of attributes that are projected into the index: + ``KEYS_ONLY`` - Only the index and primary keys are projected into the index. + ``INCLUDE`` - In addition to the attributes described in ``KEYS_ONLY``, the secondary index will include other non-key attributes that you specify. + ``ALL`` - All of the table attributes are projected into the index. When using the DynamoDB console, ``ALL`` is selected by default. */ projectionType?: string; } /** * Definition of PropertyValueTypeEnumValue */ interface PropertyValueTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ProposedMultiRegionAccessPointPolicy */ interface ProposedMultiRegionAccessPointPolicyResponse { /** *

The details of the proposed policy.

*/ policy?: string; } /** * Definition of Provider */ interface ProviderResponse { /** *

Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric and created in the same Amazon Web Services Region as the cluster. If the KMS key was created in a different account, the IAM principal must have access to the KMS key. For more information, see Allowing users in other accounts to use a KMS key in the Key Management Service Developer Guide.

*/ keyArn?: string; } /** * Definition of ProvisionedThroughput */ interface ProvisionedThroughputResponse { /** * The maximum number of strongly consistent reads consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*. If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0. */ readCapacityUnits?: number; /** * The maximum number of writes consumed per second before DynamoDB returns a ``ThrottlingException``. For more information, see [Specifying Read and Write Requirements](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ProvisionedThroughput.html) in the *Amazon DynamoDB Developer Guide*. If read/write capacity mode is ``PAY_PER_REQUEST`` the value is set to 0. */ writeCapacityUnits?: number; } /** * Definition of ProxyConfiguration */ interface ProxyConfigurationResponse { /** * The name of the container that will serve as the App Mesh proxy. */ containerName?: string; /** * The set of network configuration parameters to provide the Container Network Interface (CNI) plugin, specified as key-value pairs. + ``IgnoredUID`` - (Required) The user ID (UID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredGID`` is specified, this field can be empty. + ``IgnoredGID`` - (Required) The group ID (GID) of the proxy container as defined by the ``user`` parameter in a container definition. This is used to ensure the proxy ignores its own traffic. If ``IgnoredUID`` is specified, this field can be empty. + ``AppPorts`` - (Required) The list of ports that the application uses. Network traffic to these ports is forwarded to the ``ProxyIngressPort`` and ``ProxyEgressPort``. + ``ProxyIngressPort`` - (Required) Specifies the port that incoming traffic to the ``AppPorts`` is directed to. + ``ProxyEgressPort`` - (Required) Specifies the port that outgoing traffic from the ``AppPorts`` is directed to. + ``EgressIgnoredPorts`` - (Required) The egress traffic going to the specified ports is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list. + ``EgressIgnoredIPs`` - (Required) The egress traffic going to the specified IP addresses is ignored and not redirected to the ``ProxyEgressPort``. It can be an empty list. */ proxyConfigurationProperties?: outputs.awsconnector.KeyValuePairResponse[]; /** * The proxy type. The only supported value is ``APPMESH``. */ type?: string; } /** * Definition of PublicAccessBlockConfiguration */ interface PublicAccessBlockConfigurationResponse { /** * Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes the following behavior: + PUT Bucket ACL and PUT Object ACL calls fail if the specified ACL is public. + PUT Object calls fail if the request includes a public ACL. + PUT Bucket calls fail if the request includes a public ACL. Enabling this setting doesn't affect existing policies or ACLs. */ blockPublicAcls?: boolean; /** * Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to ``TRUE`` causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access. Enabling this setting doesn't affect existing bucket policies. */ blockPublicPolicy?: boolean; /** * Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to ``TRUE`` causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket. Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set. */ ignorePublicAcls?: boolean; /** * Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to ``TRUE`` restricts access to this bucket to only AWS-service principals and authorized users within this account if the bucket has a public policy. Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked. */ restrictPublicBuckets?: boolean; } /** * Definition of PublishMetricAction */ interface PublishMetricActionNetworkFirewallRuleGroupResponse { /** * Property dimensions */ dimensions?: outputs.awsconnector.DimensionNetworkFirewallRuleGroupResponse[]; } /** * Definition of PublishMetricAction */ interface PublishMetricActionResponse { /** * Property dimensions */ dimensions?: outputs.awsconnector.DimensionNetworkFirewallFirewallPolicyResponse[]; } /** * Definition of QueryLoggingConfig */ interface QueryLoggingConfigResponse { /** * The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to. */ cloudWatchLogsLogGroupArn?: string; } /** * Definition of QueueConfiguration */ interface QueueConfigurationResponse { /** * The Amazon S3 bucket event about which you want to publish messages to Amazon SQS. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*. */ event?: string; /** * The filtering rules that determine which objects trigger notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket. For more information, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/user-guide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*. Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*. */ filter?: outputs.awsconnector.NotificationFilterResponse; /** * The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type. FIFO queues are not allowed when enabling an SQS queue as the event notification destination. */ queue?: string; } /** * Definition of RRTypeEnumValue */ interface RRTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of RdsDBCluster */ interface RdsDBClusterPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsRdsDBClusterPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * rdsDBClusterPropertiesResponseProvideDefaults sets the appropriate defaults for RdsDBClusterPropertiesResponse */ function rdsDBClusterPropertiesResponseProvideDefaults(val: RdsDBClusterPropertiesResponse): RdsDBClusterPropertiesResponse; /** * Definition of RdsDBInstance */ interface RdsDBInstancePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsRdsDBInstancePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * rdsDBInstancePropertiesResponseProvideDefaults sets the appropriate defaults for RdsDBInstancePropertiesResponse */ function rdsDBInstancePropertiesResponseProvideDefaults(val: RdsDBInstancePropertiesResponse): RdsDBInstancePropertiesResponse; /** * Definition of RdsDBSnapshotAttributesResult */ interface RdsDBSnapshotAttributesResultPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsRdsDBSnapshotAttributesResultPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of RdsDBSnapshot */ interface RdsDBSnapshotPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsRdsDBSnapshotPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Endpoint */ interface RdsDbClusterEndpointResponse { /** * The connection endpoint for the DB cluster. */ address?: string; /** * The port number that will accept connections on this DB cluster. */ port?: string; } /** * Definition of Endpoint */ interface RdsDbInstanceEndpointResponse { /** * Specifies the DNS address of the DB instance. */ address?: string; /** * Specifies the ID that Amazon Route 53 assigns when you create a hosted zone. */ hostedZoneId?: string; /** * Specifies the port that the database engine is listening on. */ port?: string; } /** * Definition of RdsEventSubscription */ interface RdsEventSubscriptionPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsRdsEventSubscriptionPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * rdsEventSubscriptionPropertiesResponseProvideDefaults sets the appropriate defaults for RdsEventSubscriptionPropertiesResponse */ function rdsEventSubscriptionPropertiesResponseProvideDefaults(val: RdsEventSubscriptionPropertiesResponse): RdsEventSubscriptionPropertiesResponse; /** * Definition of RdsExportTask */ interface RdsExportTaskPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsRdsExportTaskPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of ReadEndpoint */ interface ReadEndpointResponse { /** * The reader endpoint for the DB cluster. */ address?: string; } /** * Definition of RecorderStatusEnumValue */ interface RecorderStatusEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of RecordingFrequencyEnumValue */ interface RecordingFrequencyEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of RecordingGroup */ interface RecordingGroupResponse { /** *

Specifies whether Config records configuration changes for all supported resource types, excluding the global IAM resource types.

If you set this field to true, when Config adds support for a new resource type, Config starts recording resources of that type automatically.

If you set this field to true, you cannot enumerate specific resource types to record in the resourceTypes field of RecordingGroup, or to exclude in the resourceTypes field of ExclusionByResourceTypes.

Region availability

Check Resource Coverage by Region Availability to see if a resource type is supported in the Amazon Web Services Region where you set up Config.

*/ allSupported?: boolean; /** *

An object that specifies how Config excludes resource types from being recorded by the configuration recorder.

Required fields

To use this option, you must set the useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES.

*/ exclusionByResourceTypes?: outputs.awsconnector.ExclusionByResourceTypesResponse; /** *

This option is a bundle which only applies to the global IAM resource types: IAM users, groups, roles, and customer managed policies. These global IAM resource types can only be recorded by Config in Regions where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

  • Asia Pacific (Hyderabad)

  • Asia Pacific (Melbourne)

  • Canada West (Calgary)

  • Europe (Spain)

  • Europe (Zurich)

  • Israel (Tel Aviv)

  • Middle East (UAE)

Aurora global clusters are recorded in all enabled Regions

The AWS::RDS::GlobalCluster resource type will be recorded in all supported Config Regions where the configuration recorder is enabled, even if includeGlobalResourceTypes is setfalse. The includeGlobalResourceTypes option is a bundle which only applies to IAM users, groups, roles, and customer managed policies.

If you do not want to record AWS::RDS::GlobalCluster in all enabled Regions, use one of the following recording strategies:

  1. Record all current and future resource types with exclusions (EXCLUSION_BY_RESOURCE_TYPES), or

  2. Record specific resource types (INCLUSION_BY_RESOURCE_TYPES).

For more information, see Selecting Which Resources are Recorded in the Config developer guide.

includeGlobalResourceTypes and the exclusion recording strategy

The includeGlobalResourceTypes field has no impact on the EXCLUSION_BY_RESOURCE_TYPES recording strategy. This means that the global IAM resource types (IAM users, groups, roles, and customer managed policies) will not be automatically added as exclusions for exclusionByResourceTypes when includeGlobalResourceTypes is set to false.

The includeGlobalResourceTypes field should only be used to modify the AllSupported field, as the default for the AllSupported field is to record configuration changes for all supported resource types excluding the global IAM resource types. To include the global IAM resource types when AllSupported is set to true, make sure to set includeGlobalResourceTypes to true.

To exclude the global IAM resource types for the EXCLUSION_BY_RESOURCE_TYPES recording strategy, you need to manually add them to the resourceTypes field of exclusionByResourceTypes.

Required and optional fields

Before you set this field to true, set the allSupported field of RecordingGroup to true. Optionally, you can set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES.

Overriding fields

If you set this field to false but list global IAM resource types in the resourceTypes field of RecordingGroup, Config will still record configuration changes for those specified resource types regardless of if you set the includeGlobalResourceTypes field to false.

If you do not want to record configuration changes to the global IAM resource types (IAM users, groups, roles, and customer managed policies), make sure to not list them in the resourceTypes field in addition to setting the includeGlobalResourceTypes field to false.

*/ includeGlobalResourceTypes?: boolean; /** *

An object that specifies the recording strategy for the configuration recorder.

  • If you set the useOnly field of RecordingStrategy to ALL_SUPPORTED_RESOURCE_TYPES, Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set the allSupported field of RecordingGroup to true. When Config adds support for a new resource type, Config automatically starts recording resources of that type.

  • If you set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for only the resource types you specify in the resourceTypes field of RecordingGroup.

  • If you set the useOnly field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for all supported resource types except the resource types that you specify to exclude from being recorded in the resourceTypes field of ExclusionByResourceTypes.

Required and optional fields

The recordingStrategy field is optional when you set the allSupported field of RecordingGroup to true.

The recordingStrategy field is optional when you list resource types in the resourceTypes field of RecordingGroup.

The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.

Overriding fields

If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.

For example, even if you set includeGlobalResourceTypes to false, global IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes field of exclusionByResourceTypes.

Global resources types and the resource exclusion recording strategy

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.

Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.

IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

  • Asia Pacific (Hyderabad)

  • Asia Pacific (Melbourne)

  • Canada West (Calgary)

  • Europe (Spain)

  • Europe (Zurich)

  • Israel (Tel Aviv)

  • Middle East (UAE)

*/ recordingStrategy?: outputs.awsconnector.RecordingStrategyResponse; /** *

A comma-separated list that specifies which resource types Config records.

For a list of valid resourceTypes values, see the Resource Type Value column in Supported Amazon Web Services resource Types in the Config developer guide.

Required and optional fields

Optionally, you can set the useOnly field of RecordingStrategy to INCLUSION_BY_RESOURCE_TYPES.

To record all configuration changes, set the allSupported field of RecordingGroup to true, and either omit this field or don't specify any resource types in this field. If you set the allSupported field to false and specify values for resourceTypes, when Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.

Region availability

Before specifying a resource type for Config to track, check Resource Coverage by Region Availability to see if the resource type is supported in the Amazon Web Services Region where you set up Config. If a resource type is supported by Config in at least one Region, you can enable the recording of that resource type in all Regions supported by Config, even if the specified resource type is not supported in the Amazon Web Services Region where you set up Config.

*/ resourceTypes?: string[]; } /** * Definition of RecordingModeOverride */ interface RecordingModeOverrideResponse { /** *

A description that you provide for the override.

*/ description?: string; /** *

The recording frequency that will be applied to all the resource types specified in the override.

  • Continuous recording allows you to record configuration changes continuously whenever a change occurs.

  • Daily recording allows you to receive a configuration item (CI) representing the most recent state of your resources over the last 24-hour period, only if it’s different from the previous CI recorded.

Firewall Manager depends on continuous recording to monitor your resources. If you are using Firewall Manager, it is recommended that you set the recording frequency to Continuous.

*/ recordingFrequency?: outputs.awsconnector.RecordingFrequencyEnumValueResponse; /** *

A comma-separated list that specifies which resource types Config includes in the override.

Daily recording is not supported for the following resource types:

  • AWS::Config::ResourceCompliance

  • AWS::Config::ConformancePackCompliance

  • AWS::Config::ConfigurationRecorder

*/ resourceTypes?: string[]; } /** * Definition of RecordingMode */ interface RecordingModeResponse { /** *

The default recording frequency that Config uses to record configuration changes.

Daily recording is not supported for the following resource types:

  • AWS::Config::ResourceCompliance

  • AWS::Config::ConformancePackCompliance

  • AWS::Config::ConfigurationRecorder

For the allSupported (ALL_SUPPORTED_RESOURCE_TYPES) recording strategy, these resource types will be set to Continuous recording.

*/ recordingFrequency?: outputs.awsconnector.RecordingFrequencyEnumValueResponse; /** *

An array of recordingModeOverride objects for you to specify your overrides for the recording mode. The recordingModeOverride object in the recordingModeOverrides array consists of three fields: a description, the new recordingFrequency, and an array of resourceTypes to override.

*/ recordingModeOverrides?: outputs.awsconnector.RecordingModeOverrideResponse[]; } /** * Definition of RecordingStrategy */ interface RecordingStrategyResponse { /** *

The recording strategy for the configuration recorder.

  • If you set this option to ALL_SUPPORTED_RESOURCE_TYPES, Config records configuration changes for all supported resource types, excluding the global IAM resource types. You also must set the allSupported field of RecordingGroup to true. When Config adds support for a new resource type, Config automatically starts recording resources of that type. For a list of supported resource types, see Supported Resource Types in the Config developer guide.

  • If you set this option to INCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for only the resource types that you specify in the resourceTypes field of RecordingGroup.

  • If you set this option to EXCLUSION_BY_RESOURCE_TYPES, Config records configuration changes for all supported resource types, except the resource types that you specify to exclude from being recorded in the resourceTypes field of ExclusionByResourceTypes.

Required and optional fields

The recordingStrategy field is optional when you set the allSupported field of RecordingGroup to true.

The recordingStrategy field is optional when you list resource types in the resourceTypes field of RecordingGroup.

The recordingStrategy field is required if you list resource types to exclude from recording in the resourceTypes field of ExclusionByResourceTypes.

Overriding fields

If you choose EXCLUSION_BY_RESOURCE_TYPES for the recording strategy, the exclusionByResourceTypes field will override other properties in the request.

For example, even if you set includeGlobalResourceTypes to false, global IAM resource types will still be automatically recorded in this option unless those resource types are specifically listed as exclusions in the resourceTypes field of exclusionByResourceTypes.

Global resource types and the exclusion recording strategy

By default, if you choose the EXCLUSION_BY_RESOURCE_TYPES recording strategy, when Config adds support for a new resource type in the Region where you set up the configuration recorder, including global resource types, Config starts recording resources of that type automatically.

Unless specifically listed as exclusions, AWS::RDS::GlobalCluster will be recorded automatically in all supported Config Regions were the configuration recorder is enabled.

IAM users, groups, roles, and customer managed policies will be recorded in the Region where you set up the configuration recorder if that is a Region where Config was available before February 2022. You cannot be record the global IAM resouce types in Regions supported by Config after February 2022. This list where you cannot record the global IAM resource types includes the following Regions:

  • Asia Pacific (Hyderabad)

  • Asia Pacific (Melbourne)

  • Canada West (Calgary)

  • Europe (Spain)

  • Europe (Zurich)

  • Israel (Tel Aviv)

  • Middle East (UAE)

*/ useOnly?: outputs.awsconnector.RecordingStrategyTypeEnumValueResponse; } /** * Definition of RecordingStrategyTypeEnumValue */ interface RecordingStrategyTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of RedirectAllRequestsTo */ interface RedirectAllRequestsToResponse { /** * Name of the host where requests are redirected. */ hostName?: string; /** * Protocol to use when redirecting requests. The default is the protocol that is used in the original request. */ protocol?: string; } /** * Definition of RedirectConfig */ interface RedirectConfigResponse { /** * The hostname. This component is not percent-encoded. The hostname can contain #{host}. */ host?: string; /** * The absolute path, starting with the leading '/'. This component is not percent-encoded. The path can contain #{host}, #{path}, and #{port}. */ path?: string; /** * The port. You can specify a value from 1 to 65535 or #{port}. */ port?: string; /** * The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP, HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP. */ protocol?: string; /** * The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include the leading '?', as it is automatically added. You can specify any of the reserved keywords. */ query?: string; /** * The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302). */ statusCode?: string; } /** * Definition of RedirectRule */ interface RedirectRuleResponse { /** * The host name to use in the redirect request. */ hostName?: string; /** * The HTTP redirect code to use on the response. Not required if one of the siblings is present. */ httpRedirectCode?: string; /** * Protocol to use when redirecting requests. The default is the protocol that is used in the original request. */ protocol?: string; /** * The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix ``docs/`` (objects in the ``docs/`` folder) to ``documents/``, you can set a condition block with ``KeyPrefixEquals`` set to ``docs/`` and in the Redirect set ``ReplaceKeyPrefixWith`` to ``/documents``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyWith`` is not provided. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). */ replaceKeyPrefixWith?: string; /** * The specific object key to use in the redirect request. For example, redirect request to ``error.html``. Not required if one of the siblings is present. Can be present only if ``ReplaceKeyPrefixWith`` is not provided. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). */ replaceKeyWith?: string; } /** * Definition of Endpoint */ interface RedshiftClusterEndpointResponse { /** * Property address */ address?: string; /** * Property port */ port?: string; } /** * Definition of RedshiftClusterParameterGroup */ interface RedshiftClusterParameterGroupPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsRedshiftClusterParameterGroupPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of RedshiftCluster */ interface RedshiftClusterPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsRedshiftClusterPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of ReferenceSets */ interface ReferenceSetsResponse { /** * Property ipSetReferences */ ipSetReferences?: { [key: string]: outputs.awsconnector.IPSetReferenceResponse; }; } /** * Definition of RegistryCredential */ interface RegistryCredentialResponse { /** *

The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager.

The credential can use the name of the credentials only if they exist in your current Amazon Web Services Region.

*/ credential?: string; /** *

The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager.

*/ credentialProvider?: outputs.awsconnector.CredentialProviderTypeEnumValueResponse; } /** * Definition of RemoteAccess */ interface RemoteAccessResponse { /** * Property ec2SshKey */ ec2SshKey?: string; /** * Property sourceSecurityGroups */ sourceSecurityGroups?: string[]; } /** * Definition of RenewalEligibilityEnumValue */ interface RenewalEligibilityEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ReplicaModifications */ interface ReplicaModificationsResponse { /** * Specifies whether Amazon S3 replicates modifications on replicas. *Allowed values*: ``Enabled`` | ``Disabled`` */ status?: string; } /** * Definition of ReplicaRegion */ interface ReplicaRegionResponse { /** * The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses ``aws/secretsmanager``. */ kmsKeyId?: string; /** * A string that represents a ``Region``, for example 'us-east-1'. */ region?: string; } /** * Definition of ReplicationConfiguration */ interface ReplicationConfigurationResponse { /** * An array of destination objects. Only one destination object is supported. */ destinations?: outputs.awsconnector.ReplicationDestinationResponse[]; } /** * Definition of ReplicationConfiguration */ interface ReplicationConfigurationS3BucketResponse { /** * The Amazon Resource Name (ARN) of the IAMlong (IAM) role that Amazon S3 assumes when replicating objects. For more information, see [How to Set Up Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-how-setup.html) in the *Amazon S3 User Guide*. */ role?: string; /** * A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules. */ rules?: outputs.awsconnector.ReplicationRuleResponse[]; } /** * Definition of ReplicationDestination */ interface ReplicationDestinationResponse { /** * The AWS For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the *Amazon EFS User Guide*. One Zone file system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available. */ availabilityZoneName?: string; /** * The ID of the destination Amazon EFS file system. */ fileSystemId?: string; /** * The ID of an kms-key-long used to protect the encrypted file system. */ kmsKeyId?: string; /** * The AWS-Region in which the destination file system is located. For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located. */ region?: string; } /** * Definition of ReplicationDestination */ interface ReplicationDestinationS3BucketResponse { /** * Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object. Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS-account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS-account that owns the source object. */ accessControlTranslation?: outputs.awsconnector.AccessControlTranslationResponse; /** * Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS-account that owns the destination bucket by specifying the ``AccessControlTranslation`` property, this is the account ID of the destination bucket owner. For more information, see [Cross-Region Replication Additional Configuration: Change Replica Owner](https://docs.aws.amazon.com/AmazonS3/latest/dev/crr-change-owner.html) in the *Amazon S3 User Guide*. If you specify the ``AccessControlTranslation`` property, the ``Account`` property is required. */ account?: string; /** * The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results. */ bucket?: string; /** * Specifies encryption-related information. Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects. */ encryptionConfiguration?: outputs.awsconnector.EncryptionConfigurationS3BucketResponse; /** * A container specifying replication metrics-related settings enabling replication metrics and events. A container specifying replication metrics-related settings enabling replication metrics and events. */ metrics?: outputs.awsconnector.MetricsResponse; /** * A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block. A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a ``Metrics`` block. */ replicationTime?: outputs.awsconnector.ReplicationTimeResponse; /** * The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica. For valid values, see the ``StorageClass`` element of the [PUT Bucket replication](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTreplication.html) action in the *Amazon S3 API Reference*. */ storageClass?: string; } /** * Definition of ReplicationPendingModifiedValues */ interface ReplicationPendingModifiedValuesResponse { /** *

The amount of storage (in gigabytes) that is allocated for the replication instance.

*/ allocatedStorage?: number; /** *

The engine version number of the replication instance.

*/ engineVersion?: string; /** *

Specifies whether the replication instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the Multi-AZ parameter is set to true.

*/ multiAZ?: boolean; /** *

The type of IP address protocol used by a replication instance, such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.

*/ networkType?: string; /** *

The compute and memory capacity of the replication instance as defined for the specified replication instance class.

For more information on the settings and capacities for the available replication instance classes, see Selecting the right DMS replication instance for your migration.

*/ replicationInstanceClass?: string; } /** * Definition of ReplicationRuleAndOperator */ interface ReplicationRuleAndOperatorResponse { /** * An object key name prefix that identifies the subset of objects to which the rule applies. */ prefix?: string; /** * An array of tags containing key and value pairs. */ tagFilters?: outputs.awsconnector.TagFilterResponse[]; } /** * Definition of ReplicationRuleFilter */ interface ReplicationRuleFilterResponse { /** * A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag. + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag. A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter. For example: + If you specify both a ``Prefix`` and a ``TagFilter``, wrap these filters in an ``And`` tag. + If you specify a filter based on multiple tags, wrap the ``TagFilter`` elements in an ``And`` tag */ and?: outputs.awsconnector.ReplicationRuleAndOperatorResponse; /** * An object key name prefix that identifies the subset of objects to which the rule applies. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). */ prefix?: string; /** * A container for specifying a tag key and value. The rule applies only to objects that have the tag in their tag set. Specifies tags to use to identify a subset of objects for an Amazon S3 bucket. */ tagFilter?: outputs.awsconnector.TagFilterResponse; } /** * Definition of ReplicationRule */ interface ReplicationRuleResponse { /** * Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations). Specifies whether Amazon S3 replicates delete markers. If you specify a ``Filter`` in your replication configuration, you must also include a ``DeleteMarkerReplication`` element. If your ``Filter`` includes a ``Tag`` element, the ``DeleteMarkerReplication`` ``Status`` must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-config-min-rule-config). For more information about delete marker replication, see [Basic Rule Configuration](https://docs.aws.amazon.com/AmazonS3/latest/dev/delete-marker-replication.html). If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see [Backward Compatibility](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations). */ deleteMarkerReplication?: outputs.awsconnector.DeleteMarkerReplicationResponse; /** * A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC). A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC). */ destination?: outputs.awsconnector.ReplicationDestinationS3BucketResponse; /** * A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element. The use of the filter field indicates that this is a V2 replication configuration. This field isn't supported in a V1 replication configuration. V1 replication configuration only supports filtering by key prefix. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element. A filter that identifies the subset of objects to which the replication rule applies. A ``Filter`` must specify exactly one ``Prefix``, ``TagFilter``, or an ``And`` child element. */ filter?: outputs.awsconnector.ReplicationRuleFilterResponse; /** * A unique identifier for the rule. The maximum value is 255 characters. If you don't specify a value, AWS CloudFormation generates a random ID. When using a V2 replication configuration this property is capitalized as 'ID'. */ id?: string; /** * An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string. To filter using a V1 replication configuration, add the ``Prefix`` directly as a child element of the ``Rule`` element. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). */ prefix?: string; /** * The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority. For more information, see [Replication](https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the *Amazon S3 User Guide*. */ priority?: number; /** * A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. */ sourceSelectionCriteria?: outputs.awsconnector.SourceSelectionCriteriaResponse; /** * Specifies whether the rule is enabled. */ status?: string; } /** * Definition of ReplicationSubnetGroup */ interface ReplicationSubnetGroupResponse { /** *

A description for the replication subnet group.

*/ replicationSubnetGroupDescription?: string; /** *

The identifier of the replication instance subnet group.

*/ replicationSubnetGroupIdentifier?: string; /** *

The status of the subnet group.

*/ subnetGroupStatus?: string; /** *

The subnets that are in the subnet group.

*/ subnets?: outputs.awsconnector.SubnetResponse[]; /** *

The IP addressing protocol supported by the subnet group. This is used by a replication instance with values such as IPv4 only or Dual-stack that supports both IPv4 and IPv6 addressing. IPv6 only is not yet supported.

*/ supportedNetworkTypes?: string[]; /** *

The ID of the VPC.

*/ vpcId?: string; } /** * Definition of ReplicationTime */ interface ReplicationTimeResponse { /** * Specifies whether the replication time is enabled. */ status?: string; /** * A container specifying the time by which replication should be complete for all objects and operations on objects. A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics ``EventThreshold``. */ time?: outputs.awsconnector.ReplicationTimeValueResponse; } /** * Definition of ReplicationTimeValue */ interface ReplicationTimeValueResponse { /** * Contains an integer specifying time in minutes. Valid value: 15 */ minutes?: number; } /** * Definition of RepoUpgradeOnBootEnumValue */ interface RepoUpgradeOnBootEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of RepositoryCredentials */ interface RepositoryCredentialsResponse { /** * The Amazon Resource Name (ARN) of the secret containing the private repository credentials. When you use the Amazon ECS API, CLI, or AWS SDK, if the secret exists in the same Region as the task that you're launching then you can use either the full ARN or the name of the secret. When you use the AWS Management Console, you must specify the full ARN of the secret. */ credentialsParameter?: string; } /** * Definition of ResolverLevelMetricsBehaviorEnumValue */ interface ResolverLevelMetricsBehaviorEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ResourcePolicy */ interface ResourcePolicyResponse { /** * A resource-based policy document that contains permissions to add to the specified DDB table, index, or both. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). */ policyDocument?: any; } /** * Definition of ResourceRecord */ interface ResourceRecordResponse { /** *

The current or new DNS record value, not to exceed 4,000 characters. In the case of a DELETE action, if the current value does not match the actual value, an error is returned. For descriptions about how to format Value for different record types, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

You can specify more than one value for all record types except CNAME and SOA.

If you're creating an alias resource record set, omit Value.

*/ value?: string; } /** * Definition of ResourceRecordSetFailoverEnumValue */ interface ResourceRecordSetFailoverEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ResourceRecordSetRegionEnumValue */ interface ResourceRecordSetRegionEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ResourceRequirement */ interface ResourceRequirementResponse { /** * The type of resource to assign to a container. The supported values are ``GPU`` or ``InferenceAccelerator``. */ type?: string; /** * The value for the specified resource type. If the ``GPU`` type is used, the value is the number of physical ``GPUs`` the Amazon ECS container agent reserves for the container. The number of GPUs that's reserved for all containers in a task can't exceed the number of available GPUs on the container instance that the task is launched on. If the ``InferenceAccelerator`` type is used, the ``value`` matches the ``deviceName`` for an [InferenceAccelerator](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_InferenceAccelerator.html) specified in a task definition. */ value?: string; } /** * Definition of ResourceSpec */ interface ResourceSpecResponse { /** * The instance type that the image version runs on. */ instanceType?: string; /** * The ARN of the SageMaker image that the image version belongs to. */ sageMakerImageArn?: string; /** * The ARN of the image version created on the instance. */ sageMakerImageVersionArn?: string; } /** * Definition of ResourceTypeEnumValue */ interface ResourceTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of Restrictions */ interface RestrictionsResponse { /** * A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template. A complex type that controls the countries in which your content is distributed. CF determines the location of your users using ``MaxMind`` GeoIP databases. To disable geo restriction, remove the [Restrictions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudfront-distribution-distributionconfig.html#cfn-cloudfront-distribution-distributionconfig-restrictions) property from your stack template. */ geoRestriction?: outputs.awsconnector.GeoRestrictionResponse; } /** * Definition of Route53DomainsDomainSummary */ interface Route53DomainsDomainSummaryPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsRoute53DomainsDomainSummaryPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Route53HostedZone */ interface Route53HostedZonePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsRoute53HostedZonePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Route53ResourceRecordSet */ interface Route53ResourceRecordSetPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsRoute53ResourceRecordSetPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of RoutingRuleCondition */ interface RoutingRuleConditionResponse { /** * The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element ``Condition`` is specified and sibling ``KeyPrefixEquals`` is not specified. If both are specified, then both must be true for the redirect to be applied. */ httpErrorCodeReturnedEquals?: string; /** * The object key name prefix when the redirect is applied. For example, to redirect requests for ``ExamplePage.html``, the key prefix will be ``ExamplePage.html``. To redirect request for all pages with the prefix ``docs/``, the key prefix will be ``/docs``, which identifies all objects in the docs/ folder. Required when the parent element ``Condition`` is specified and sibling ``HttpErrorCodeReturnedEquals`` is not specified. If both conditions are specified, both must be true for the redirect to be applied. */ keyPrefixEquals?: string; } /** * Definition of RoutingRule */ interface RoutingRuleResponse { /** * Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return. Specifies how requests are redirected. In the event of an error, you can specify a different error code to return. */ redirectRule?: outputs.awsconnector.RedirectRuleResponse; /** * A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error. A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the ``/docs`` folder, redirect to the ``/documents`` folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error. */ routingRuleCondition?: outputs.awsconnector.RoutingRuleConditionResponse; } /** * Definition of RuleDefinition */ interface RuleDefinitionResponse { /** * Property actions */ actions?: string[]; /** * Property matchAttributes */ matchAttributes?: outputs.awsconnector.MatchAttributesResponse; } /** * Definition of RuleGroup */ interface RuleGroupResponse { /** * Property referenceSets */ referenceSets?: outputs.awsconnector.ReferenceSetsResponse; /** * Property ruleVariables */ ruleVariables?: outputs.awsconnector.RuleVariablesResponse; /** * Property rulesSource */ rulesSource?: outputs.awsconnector.RulesSourceResponse; /** * Property statefulRuleOptions */ statefulRuleOptions?: outputs.awsconnector.StatefulRuleOptionsResponse; } /** * Definition of RuleOption */ interface RuleOptionResponse { /** * Property keyword */ keyword?: string; /** * Property settings */ settings?: string[]; } /** * Definition of Rule */ interface RuleResponse { /** * Specifies a lifecycle rule that stops incomplete multipart uploads to an Amazon S3 bucket. Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see [Stopping Incomplete Multipart Uploads Using a Bucket Lifecycle Policy](https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config) in the *Amazon S3 User Guide*. */ abortIncompleteMultipartUpload?: outputs.awsconnector.AbortIncompleteMultipartUploadResponse; /** * Indicates when objects are deleted from Amazon S3 and Amazon S3 Glacier. The date value must be in ISO 8601 format. The time is always midnight UTC. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ) */ expirationDate?: string; /** * Indicates the number of days after creation when objects are deleted from Amazon S3 and Amazon S3 Glacier. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. */ expirationInDays?: number; /** * Indicates whether Amazon S3 will remove a delete marker without any noncurrent versions. If set to true, the delete marker will be removed if there are no noncurrent versions. This cannot be specified with ``ExpirationInDays``, ``ExpirationDate``, or ``TagFilters``. */ expiredObjectDeleteMarker?: boolean; /** * Unique identifier for the rule. The value can't be longer than 255 characters. */ id?: string; /** * Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime. Specifies when noncurrent object versions expire. Upon expiration, S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that S3 delete noncurrent object versions at a specific period in the object's lifetime. For more information about setting a lifecycle rule configuration, see [AWS::S3::Bucket Rule](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-lifecycleconfig-rule.html). */ noncurrentVersionExpiration?: outputs.awsconnector.NoncurrentVersionExpirationResponse; /** * (Deprecated.) For buckets with versioning enabled (or suspended), specifies the time, in days, between when a new version of the object is uploaded to the bucket and when old versions of the object expire. When object versions expire, Amazon S3 permanently deletes them. If you specify a transition and expiration time, the expiration time must be later than the transition time. */ noncurrentVersionExpirationInDays?: number; /** * (Deprecated.) For buckets with versioning enabled (or suspended), specifies when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property. Container for the transition rule that describes when noncurrent objects transition to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the ``STANDARD_IA``, ``ONEZONE_IA``, ``INTELLIGENT_TIERING``, ``GLACIER_IR``, ``GLACIER``, or ``DEEP_ARCHIVE`` storage class at a specific period in the object's lifetime. If you specify this property, don't specify the ``NoncurrentVersionTransitions`` property. */ noncurrentVersionTransition?: outputs.awsconnector.NoncurrentVersionTransitionResponse; /** * For buckets with versioning enabled (or suspended), one or more transition rules that specify when non-current objects transition to a specified storage class. If you specify a transition and expiration time, the expiration time must be later than the transition time. If you specify this property, don't specify the ``NoncurrentVersionTransition`` property. */ noncurrentVersionTransitions?: outputs.awsconnector.NoncurrentVersionTransitionResponse[]; /** * Specifies the minimum object size in bytes for this rule to apply to. Objects must be larger than this value in bytes. For more information about size based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*. */ objectSizeGreaterThan?: string; /** * Specifies the maximum object size in bytes for this rule to apply to. Objects must be smaller than this value in bytes. For more information about sized based rules, see [Lifecycle configuration using size-based rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/lifecycle-configuration-examples.html#lc-size-rules) in the *Amazon S3 User Guide*. */ objectSizeLessThan?: string; /** * Object key prefix that identifies one or more objects to which this rule applies. Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see [XML related object key constraints](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html#object-key-xml-related-constraints). */ prefix?: string; /** * If ``Enabled``, the rule is currently being applied. If ``Disabled``, the rule is not currently being applied. */ status?: string; /** * Tags to use to identify a subset of objects to which the lifecycle rule applies. */ tagFilters?: outputs.awsconnector.TagFilterResponse[]; /** * (Deprecated.) Specifies when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transitions`` property. Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see [Transitioning Objects Using Amazon S3 Lifecycle](https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html) in the *Amazon S3 User Guide*. */ transition?: outputs.awsconnector.TransitionResponse; /** * One or more transition rules that specify when an object transitions to a specified storage class. If you specify an expiration and transition time, you must use the same time unit for both properties (either in days or by date). The expiration time must also be later than the transition time. If you specify this property, don't specify the ``Transition`` property. */ transitions?: outputs.awsconnector.TransitionResponse[]; } /** * Definition of RuleVariables */ interface RuleVariablesModelResponse { /** * Property ruleVariables */ ruleVariables?: { [key: string]: outputs.awsconnector.IPSetResponse; }; } /** * Definition of RuleVariables */ interface RuleVariablesResponse { /** * Property ipSets */ ipSets?: { [key: string]: outputs.awsconnector.IPSetResponse; }; /** * Property portSets */ portSets?: { [key: string]: outputs.awsconnector.PortSetResponse; }; } /** * Definition of RulesSourceList */ interface RulesSourceListResponse { /** * Property generatedRulesType */ generatedRulesType?: string; /** * Property targetTypes */ targetTypes?: string[]; /** * Property targets */ targets?: string[]; } /** * Definition of RulesSource */ interface RulesSourceResponse { /** * Property rulesSourceList */ rulesSourceList?: outputs.awsconnector.RulesSourceListResponse; /** * Property rulesString */ rulesString?: string; /** * Property statefulRules */ statefulRules?: outputs.awsconnector.StatefulRuleResponse[]; /** * Property statelessRulesAndCustomActions */ statelessRulesAndCustomActions?: outputs.awsconnector.StatelessRulesAndCustomActionsResponse; } /** * Definition of RuntimeManagementConfig */ interface RuntimeManagementConfigResponse { /** * The ARN of the runtime version you want the function to use. This is only required if you're using the *Manual* runtime update mode. */ runtimeVersionArn?: string; /** * Specify the runtime update mode. + *Auto (default)* - Automatically update to the most recent and secure runtime version using a [Two-phase runtime version rollout](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-two-phase). This is the best choice for most customers to ensure they always benefit from runtime updates. + *FunctionUpdate* - LAM updates the runtime of you function to the most recent and secure runtime version when you update your function. This approach synchronizes runtime updates with function deployments, giving you control over when runtime updates are applied and allowing you to detect and mitigate rare runtime update incompatibilities early. When using this setting, you need to regularly update your functions to keep their runtime up-to-date. + *Manual* - You specify a runtime version in your function configuration. The function will use this runtime version indefinitely. In the rare case where a new runtime version is incompatible with an existing function, this allows you to roll back your function to an earlier runtime version. For more information, see [Roll back a runtime version](https://docs.aws.amazon.com/lambda/latest/dg/runtimes-update.html#runtime-management-rollback). *Valid Values*: ``Auto`` | ``FunctionUpdate`` | ``Manual`` */ updateRuntimeOn?: string; } /** * Definition of RuntimePlatform */ interface RuntimePlatformResponse { /** * The CPU architecture. You can run your Linux tasks on an ARM-based platform by setting the value to ``ARM64``. This option is available for tasks that run on Linux Amazon EC2 instance or Linux containers on Fargate. */ cpuArchitecture?: string; /** * The operating system. */ operatingSystemFamily?: string; } /** * Definition of S3AccessControlPolicy */ interface S3AccessControlPolicyPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsS3AccessControlPolicyPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of S3AccessPoint */ interface S3AccessPointPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsS3AccessPointPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of S3BucketCriteriaForJob */ interface S3BucketCriteriaForJobResponse { /** *

The property- and tag-based conditions that determine which buckets to exclude from the job.

*/ excludes?: outputs.awsconnector.CriteriaBlockForJobResponse; /** *

The property- and tag-based conditions that determine which buckets to include in the job.

*/ includes?: outputs.awsconnector.CriteriaBlockForJobResponse; } /** * Definition of S3BucketDefinitionForJob */ interface S3BucketDefinitionForJobResponse { /** *

The unique identifier for the Amazon Web Services account that owns the buckets.

*/ accountId?: string; /** *

An array that lists the names of the buckets.

*/ buckets?: string[]; } /** * Definition of S3BucketPolicy */ interface S3BucketPolicyPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsS3BucketPolicyPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of S3Bucket */ interface S3BucketPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsS3BucketPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * s3bucketPropertiesResponseProvideDefaults sets the appropriate defaults for S3BucketPropertiesResponse */ function s3bucketPropertiesResponseProvideDefaults(val: S3BucketPropertiesResponse): S3BucketPropertiesResponse; /** * Definition of S3BucketSource */ interface S3BucketSourceResponse { /** * The S3 bucket that is being imported from. */ s3Bucket?: string; /** * The account number of the S3 bucket that is being imported from. If the bucket is owned by the requester this is optional. */ s3BucketOwner?: string; /** * The key prefix shared by all S3 Objects that are being imported. */ s3KeyPrefix?: string; } /** * Definition of S3ControlMultiRegionAccessPointPolicyDocument */ interface S3ControlMultiRegionAccessPointPolicyDocumentPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsS3ControlMultiRegionAccessPointPolicyDocumentPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of S3KeyFilter */ interface S3KeyFilterResponse { /** * A list of containers for the key-value pair that defines the criteria for the filter rule. */ rules?: outputs.awsconnector.FilterRuleResponse[]; } /** * Definition of S3Location */ interface S3LocationResponse { /** * The name of the S3 bucket where the OpenAPI file is stored. */ bucket?: string; /** * The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file. */ eTag?: string; /** * The file name of the OpenAPI file (Amazon S3 object name). */ key?: string; /** * For versioning-enabled buckets, a specific version of the OpenAPI file. */ version?: string; } /** * Definition of S3LogsConfig */ interface S3LogsConfigResponse { /** * Property bucketOwnerAccess */ bucketOwnerAccess?: outputs.awsconnector.BucketOwnerAccessEnumValueResponse; /** *

Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.

*/ encryptionDisabled?: boolean; /** *

The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is my-bucket, and your path prefix is build-log, then acceptable formats are my-bucket/build-log or arn:aws:s3:::my-bucket/build-log.

*/ location?: string; /** *

The current status of the S3 build logs. Valid values are:

  • ENABLED: S3 build logs are enabled for this build project.

  • DISABLED: S3 build logs are not enabled for this build project.

*/ status?: outputs.awsconnector.LogsConfigStatusTypeEnumValueResponse; } /** * Definition of S3OriginConfig */ interface S3OriginConfigResponse { /** * The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can *only* access objects in an Amazon S3 bucket through CloudFront. The format of the value is: origin-access-identity/cloudfront/*ID-of-origin-access-identity* where ``ID-of-origin-access-identity`` is the value that CloudFront returned in the ``ID`` element when you created the origin access identity. If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty ``OriginAccessIdentity`` element. To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty ``OriginAccessIdentity`` element. To replace the origin access identity, update the distribution configuration and specify the new origin access identity. For more information about the origin access identity, see [Serving Private Content through CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html) in the *Amazon CloudFront Developer Guide*. */ originAccessIdentity?: string; } /** * Definition of S3WordsList */ interface S3WordsListResponse { /** * Property bucketName */ bucketName?: string; /** * Property objectKey */ objectKey?: string; } /** * Definition of SAMLIdp */ interface SAMLIdpResponse { /** *

The unique entity ID of the application in the SAML identity provider.

*/ entityId?: string; /** *

The metadata of the SAML application, in XML format.

*/ metadataContent?: string; } /** * Definition of SAMLOptionsOutput */ interface SAMLOptionsOutputResponse { /** *

True if SAML is enabled.

*/ enabled?: boolean; /** *

Describes the SAML identity provider's information.

*/ idp?: outputs.awsconnector.SAMLIdpResponse; /** *

The key used for matching the SAML roles attribute.

*/ rolesKey?: string; /** *

The duration, in minutes, after which a user session becomes inactive.

*/ sessionTimeoutMinutes?: number; /** *

The key used for matching the SAML subject attribute.

*/ subjectKey?: string; } /** * Definition of SSEDescription */ interface SSEDescriptionResponse { /** *

The current state of server-side encryption:

  • ENABLING - Server-side encryption is being enabled.

  • ENABLED - Server-side encryption is enabled.

  • DISABLING - Server-side encryption is being disabled.

  • DISABLED - Server-side encryption is disabled.

*/ status?: outputs.awsconnector.SSEStatusEnumValueResponse; } /** * Definition of SSESpecification */ interface SSESpecificationResponse { /** * The KMS key that should be used for the KMS encryption. To specify a key, use its key ID, Amazon Resource Name (ARN), alias name, or alias ARN. Note that you should only provide this parameter if the key is different from the default DynamoDB key ``alias/aws/dynamodb``. */ kmsMasterKeyId?: string; /** * Indicates whether server-side encryption is done using an AWS managed key or an AWS owned key. If enabled (true), server-side encryption type is set to ``KMS`` and an AWS managed key is used (KMS charges apply). If disabled (false) or not specified, server-side encryption is set to AWS owned key. */ sseEnabled?: boolean; /** * Server-side encryption type. The only supported value is: + ``KMS`` - Server-side encryption that uses KMSlong. The key is stored in your account and is managed by KMS (KMS charges apply). */ sseType?: string; } /** * Definition of SSEStatusEnumValue */ interface SSEStatusEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of SSETypeEnumValue */ interface SSETypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of SageMakerApp */ interface SageMakerAppPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsSageMakerAppPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of SageMakerNotebookInstanceSummary */ interface SageMakerNotebookInstanceSummaryPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsSageMakerNotebookInstanceSummaryPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of ScaleDownBehaviorEnumValue */ interface ScaleDownBehaviorEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ScalingConfig */ interface ScalingConfigResponse { /** * Property desiredSize */ desiredSize?: number; /** * Property maxSize */ maxSize?: number; /** * Property minSize */ minSize?: number; } /** * Definition of ScalingConfiguration */ interface ScalingConfigurationResponse { /** * A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in serverless DB engine mode. A DB cluster can be paused only when it's idle (it has no connections). */ autoPause?: boolean; /** * The maximum capacity for an Aurora DB cluster in serverless DB engine mode.For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.The maximum capacity must be greater than or equal to the minimum capacity. */ maxCapacity?: number; /** * The minimum capacity for an Aurora DB cluster in serverless DB engine mode.For Aurora MySQL, valid capacity values are 1, 2, 4, 8, 16, 32, 64, 128, and 256.For Aurora PostgreSQL, valid capacity values are 2, 4, 8, 16, 32, 64, 192, and 384.The minimum capacity must be less than or equal to the maximum capacity. */ minCapacity?: number; /** * The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action.The default is 300. */ secondsBeforeTimeout?: number; /** * The time, in seconds, before an Aurora DB cluster in serverless mode is paused. */ secondsUntilAutoPause?: number; /** * The action to take when the timeout is reached, either ForceApplyCapacityChange or RollbackCapacityChange.ForceApplyCapacityChange sets the capacity to the specified value as soon as possible.RollbackCapacityChange, the default, ignores the capacity change if a scaling point isn't found in the timeout period.For more information, see Autoscaling for Aurora Serverless v1 in the Amazon Aurora User Guide. */ timeoutAction?: string; } /** * Definition of ScanStatusEnumValue */ interface ScanStatusEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of Secret */ interface SecretResponse { /** * The name of the secret. */ name?: string; /** * The secret to expose to the container. The supported values are either the full ARN of the ASMlong secret or the full ARN of the parameter in the SSM Parameter Store. For information about the require IAMlong permissions, see [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html#secrets-iam) (for Secrets Manager) or [Required IAM permissions for Amazon ECS secrets](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-parameters.html) (for Systems Manager Parameter store) in the *Amazon Elastic Container Service Developer Guide*. If the SSM Parameter Store parameter exists in the same Region as the task you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified. */ valueFrom?: string; } /** * Definition of SecretsManagerResourcePolicy */ interface SecretsManagerResourcePolicyPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsSecretsManagerResourcePolicyPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of SecretsManagerSecret */ interface SecretsManagerSecretPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsSecretsManagerSecretPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of SecurityGroupMembership */ interface SecurityGroupMembershipResponse { /** *

The unique ID for this security group.

*/ securityGroupIdentifier?: string; /** *

The status of this security group.

*/ status?: string; } /** * Definition of ServerSideEncryptionByDefault */ interface ServerSideEncryptionByDefaultResponse { /** * AWS Key Management Service (KMS) customer AWS KMS key ID to use for the default encryption. This parameter is allowed if and only if ``SSEAlgorithm`` is set to ``aws:kms`` or ``aws:kms:dsse``. You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key. + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab`` + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`` + Key Alias: ``alias/alias-name`` If you use a key ID, you can run into a LogDestination undeliverable error when creating a VPC flow log. If you are using encryption with cross-account or AWS service operations you must use a fully qualified KMS key ARN. For more information, see [Using encryption for cross-account operations](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html#bucket-encryption-update-bucket-policy). Amazon S3 only supports symmetric encryption KMS keys. For more information, see [Asymmetric keys in KMS](https://docs.aws.amazon.com//kms/latest/developerguide/symmetric-asymmetric.html) in the *Key Management Service Developer Guide*. */ kmsMasterKeyID?: string; /** * Server-side encryption algorithm to use for the default encryption. */ sseAlgorithm?: string; } /** * Definition of ServerSideEncryptionRule */ interface ServerSideEncryptionRuleResponse { /** * Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the ``BucketKeyEnabled`` element to ``true`` causes Amazon S3 to use an S3 Bucket Key. By default, S3 Bucket Key is not enabled. For more information, see [Amazon S3 Bucket Keys](https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the *Amazon S3 User Guide*. */ bucketKeyEnabled?: boolean; /** * Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates an AWS KMS key in your AWS account the first time that you add an object encrypted with SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see [PUT Bucket encryption](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUTencryption.html) in the *Amazon S3 API Reference*. */ serverSideEncryptionByDefault?: outputs.awsconnector.ServerSideEncryptionByDefaultResponse; } /** * Definition of ServerTypeEnumValue */ interface ServerTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of ServerlessV2ScalingConfiguration */ interface ServerlessV2ScalingConfigurationResponse { /** * The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128. */ maxCapacity?: number; /** * The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster. You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5. */ minCapacity?: number; } /** * Definition of ServiceConnectClientAlias */ interface ServiceConnectClientAliasResponse { /** * The ``dnsName`` is the name that you use in the applications of client tasks to connect to this service. The name must be a valid DNS name but doesn't need to be fully-qualified. The name can include up to 127 characters. The name can include lowercase letters, numbers, underscores (_), hyphens (-), and periods (.). The name can't start with a hyphen. If this parameter isn't specified, the default value of ``discoveryName.namespace`` is used. If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``. To avoid changing your applications in client Amazon ECS services, set this to the same name that the client application uses by default. For example, a few common names are ``database``, ``db``, or the lowercase name of a database, such as ``mysql`` or ``redis``. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. */ dnsName?: string; /** * The listening port number for the Service Connect proxy. This port is available inside of all of the tasks within the same namespace. To avoid changing your applications in client Amazon ECS services, set this to the same port that the client application uses by default. For more information, see [Service Connect](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect.html) in the *Amazon Elastic Container Service Developer Guide*. */ port?: number; } /** * Definition of ServiceConnectConfiguration */ interface ServiceConnectConfigurationResponse { /** * Specifies whether to use Service Connect with this service. */ enabled?: boolean; /** * The log configuration for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--log-driver`` option to [docker run](https://docs.docker.com/engine/reference/commandline/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. Understand the following when specifying a log configuration for your containers. + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to. The log configuration for the container. This parameter maps to ``LogConfig`` in the [Create a container](https://docs.docker.com/reference/cli/docker/container/create/) section of the [Docker Remote API](https://docs.docker.com/engine/api/) and the ``--log-driver`` option to [docker run](https://docs.docker.com/engine/reference/commandline/run/). By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see [Configure logging drivers](https://docs.docker.com/engine/admin/logging/overview/) in the Docker documentation. Understand the following when specifying a log configuration for your containers. + Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent. For tasks on FARGATElong, the supported log drivers are ``awslogs``, ``splunk``, and ``awsfirelens``. For tasks hosted on Amazon EC2 instances, the supported log drivers are ``awslogs``, ``fluentd``, ``gelf``, ``json-file``, ``journald``, ``logentries``,``syslog``, ``splunk``, and ``awsfirelens``. + This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. + For tasks that are hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see [Amazon ECS container agent configuration](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html) in the *Amazon Elastic Container Service Developer Guide*. + For tasks that are on FARGATElong, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to. */ logConfiguration?: outputs.awsconnector.LogConfigurationResponse; /** * The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace for use with Service Connect. The namespace must be in the same AWS Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*. */ namespace?: string; /** * The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service. This field is not required for a 'client' Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means. An object selects a port from the task definition, assigns a name for the CMAPlong service, and a list of aliases (endpoints) and ports for client applications to refer to this service. */ services?: outputs.awsconnector.ServiceConnectServiceResponse[]; } /** * Definition of ServiceConnectDefaults */ interface ServiceConnectDefaultsResponse { /** * The namespace name or full Amazon Resource Name (ARN) of the CMAPlong namespace that's used when you create a service and don't specify a Service Connect configuration. The namespace name can include up to 1024 characters. The name is case-sensitive. The name can't include hyphens (-), tilde (~), greater than (>), less than (<), or slash (/). If you enter an existing namespace name or ARN, then that namespace will be used. Any namespace type is supported. The namespace must be in this account and this AWS Region. If you enter a new name, a CMAPlong namespace will be created. Amazon ECS creates a CMAP namespace with the 'API calls' method of instance discovery only. This instance discovery method is the 'HTTP' namespace type in the CLIlong. Other types of instance discovery aren't used by Service Connect. If you update the cluster with an empty string ``''`` for the namespace name, the cluster configuration for Service Connect is removed. Note that the namespace will remain in CMAP and must be deleted separately. For more information about CMAPlong, see [Working with Services](https://docs.aws.amazon.com/cloud-map/latest/dg/working-with-services.html) in the *Developer Guide*. */ namespace?: string; } /** * Definition of ServiceConnectService */ interface ServiceConnectServiceResponse { /** * The list of client aliases for this Service Connect service. You use these to assign names that can be used by client applications. The maximum number of client aliases that you can have in this list is 1. Each alias ('endpoint') is a fully-qualified name and port number that other Amazon ECS tasks ('clients') can use to connect to this service. Each name and port mapping must be unique within the namespace. For each ``ServiceConnectService``, you must provide at least one ``clientAlias`` with one ``port``. */ clientAliases?: outputs.awsconnector.ServiceConnectClientAliasResponse[]; /** * The ``discoveryName`` is the name of the new CMAP service that Amazon ECS creates for this Amazon ECS service. This must be unique within the CMAP namespace. The name can contain up to 64 characters. The name can include lowercase letters, numbers, underscores (_), and hyphens (-). The name can't start with a hyphen. If the ``discoveryName`` isn't specified, the port mapping name from the task definition is used in ``portName.namespace``. */ discoveryName?: string; /** * The port number for the Service Connect proxy to listen on. Use the value of this field to bypass the proxy for traffic on the port number specified in the named ``portMapping`` in the task definition of this application, and then use it in your VPC security groups to allow traffic into the proxy for this Amazon ECS service. In ``awsvpc`` mode and Fargate, the default value is the container port number. The container port number is in the ``portMapping`` in the task definition. In bridge mode, the default value is the ephemeral port of the Service Connect proxy. */ ingressPortOverride?: number; /** * The ``portName`` must match the name of one of the ``portMappings`` from all the containers in the task definition of this Amazon ECS service. */ portName?: string; /** * A reference to an object that represents the configured timeouts for Service Connect. An object that represents the timeout configurations for Service Connect. If ``idleTimeout`` is set to a time that is less than ``perRequestTimeout``, the connection will close when the ``idleTimeout`` is reached and not the ``perRequestTimeout``. */ timeout?: outputs.awsconnector.TimeoutConfigurationResponse; /** * A reference to an object that represents a Transport Layer Security (TLS) configuration. An object that represents the configuration for Service Connect TLS. */ tls?: outputs.awsconnector.ServiceConnectTlsConfigurationResponse; } /** * Definition of ServiceConnectTlsCertificateAuthority */ interface ServiceConnectTlsCertificateAuthorityResponse { /** * The ARN of the AWS Private Certificate Authority certificate. */ awsPcaAuthorityArn?: string; } /** * Definition of ServiceConnectTlsConfiguration */ interface ServiceConnectTlsConfigurationResponse { /** * The signer certificate authority. An object that represents the AWS Private Certificate Authority certificate. */ issuerCertificateAuthority?: outputs.awsconnector.ServiceConnectTlsCertificateAuthorityResponse; /** * The AWS Key Management Service key. */ kmsKey?: string; /** * The Amazon Resource Name (ARN) of the IAM role that's associated with the Service Connect TLS. */ roleArn?: string; } /** * Definition of ServiceManagedEBSVolumeConfiguration */ interface ServiceManagedEBSVolumeConfigurationResponse { /** * Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the ``Encrypted`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. */ encrypted?: boolean; /** * The Linux filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start. The available filesystem types are ``ext3``, ``ext4``, and ``xfs``. If no value is specified, the ``xfs`` filesystem type is used by default. */ filesystemType?: string; /** * The number of I/O operations per second (IOPS). For ``gp3``, ``io1``, and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type. + ``gp3``: 3,000 - 16,000 IOPS + ``io1``: 100 - 64,000 IOPS + ``io2``: 100 - 256,000 IOPS This parameter is required for ``io1`` and ``io2`` volume types. The default for ``gp3`` volumes is ``3,000 IOPS``. This parameter is not supported for ``st1``, ``sc1``, or ``standard`` volume types. This parameter maps 1:1 with the ``Iops`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. */ iops?: number; /** * The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no AWS Key Management Service key is specified, the default AWS managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the ``KmsKeyId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. AWS authenticates the AWS Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails. */ kmsKeyId?: string; /** * The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your AWS infrastructure. We recommend using the Amazon ECS-managed ``AmazonECSInfrastructureRolePolicyForVolumes`` IAM policy with this role. For more information, see [Amazon ECS infrastructure IAM role](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html) in the *Amazon ECS Developer Guide*. */ roleArn?: string; /** * The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the ``Size`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. The following are the supported volume size values for each volume type. + ``gp2`` and ``gp3``: 1-16,384 + ``io1`` and ``io2``: 4-16,384 + ``st1`` and ``sc1``: 125-16,384 + ``standard``: 1-1,024 */ sizeInGiB?: number; /** * The snapshot that Amazon ECS uses to create the volume. You must specify either a snapshot ID or a volume size. This parameter maps 1:1 with the ``SnapshotId`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. */ snapshotId?: string; /** * The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the ``TagSpecifications.N`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. */ tagSpecifications?: outputs.awsconnector.EBSTagSpecificationResponse[]; /** * The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the ``Throughput`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. This parameter is only supported for the ``gp3`` volume type. */ throughput?: number; /** * The volume type. This parameter maps 1:1 with the ``VolumeType`` parameter of the [CreateVolume API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html) in the *Amazon EC2 API Reference*. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html) in the *Amazon EC2 User Guide*. The following are the supported volume types. + General Purpose SSD: ``gp2``|``gp3`` + Provisioned IOPS SSD: ``io1``|``io2`` + Throughput Optimized HDD: ``st1`` + Cold HDD: ``sc1`` + Magnetic: ``standard`` The magnetic volume type is not supported on Fargate. */ volumeType?: string; } /** * Definition of ServiceRegistry */ interface ServiceRegistryResponse { /** * The container name value to be used for your service discovery service. It's already specified in the task definition. If the task definition that your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition that your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both. */ containerName?: string; /** * The port value to be used for your service discovery service. It's already specified in the task definition. If the task definition your service task specifies uses the ``bridge`` or ``host`` network mode, you must specify a ``containerName`` and ``containerPort`` combination from the task definition. If the task definition your service task specifies uses the ``awsvpc`` network mode and a type SRV DNS record is used, you must specify either a ``containerName`` and ``containerPort`` combination or a ``port`` value. However, you can't specify both. */ containerPort?: number; /** * The port value used if your service discovery service specified an SRV record. This field might be used if both the ``awsvpc`` network mode and SRV records are used. */ port?: number; /** * The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is CMAP. For more information, see [CreateService](https://docs.aws.amazon.com/cloud-map/latest/api/API_CreateService.html). */ registryArn?: string; } /** * Definition of ServiceSoftwareOptions */ interface ServiceSoftwareOptionsResponse { /** *

The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

*/ automatedUpdateDate?: string; /** *

True if you're able to cancel your service software version update. False if you can't cancel your service software update.

*/ cancellable?: boolean; /** *

The current service software version present on the domain.

*/ currentVersion?: string; /** *

A description of the service software update status.

*/ description?: string; /** *

The new service software version, if one is available.

*/ newVersion?: string; /** *

True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

*/ optionalDeployment?: boolean; /** *

True if you're able to update your service software version. False if you can't update your service software version.

*/ updateAvailable?: boolean; /** *

The status of your service software update.

*/ updateStatus?: outputs.awsconnector.DeploymentStatusEnumValueResponse; } /** * Definition of ServiceVolumeConfiguration */ interface ServiceVolumeConfigurationResponse { /** * The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. The Amazon EBS volumes are visible in your account in the Amazon EC2 console once they are created. The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf. These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. Many of these parameters map 1:1 with the Amazon EBS ``CreateVolume`` API request parameters. */ managedEBSVolume?: outputs.awsconnector.ServiceManagedEBSVolumeConfigurationResponse; /** * The name of the volume. This value must match the volume name from the ``Volume`` object in the task definition. */ name?: string; } /** * Definition of SeveritySummary */ interface SeveritySummaryResponse { /** *

The total number of resources or compliance items that have a severity level of Critical. Critical severity is determined by the organization that published the compliance items.

*/ criticalCount?: number; /** *

The total number of resources or compliance items that have a severity level of high. High severity is determined by the organization that published the compliance items.

*/ highCount?: number; /** *

The total number of resources or compliance items that have a severity level of informational. Informational severity is determined by the organization that published the compliance items.

*/ informationalCount?: number; /** *

The total number of resources or compliance items that have a severity level of low. Low severity is determined by the organization that published the compliance items.

*/ lowCount?: number; /** *

The total number of resources or compliance items that have a severity level of medium. Medium severity is determined by the organization that published the compliance items.

*/ mediumCount?: number; /** *

The total number of resources or compliance items that have a severity level of unspecified. Unspecified severity is determined by the organization that published the compliance items.

*/ unspecifiedCount?: number; } /** * Definition of SimpleCriterionForJob */ interface SimpleCriterionForJobResponse { /** *

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

*/ comparator?: outputs.awsconnector.JobComparatorEnumValueResponse; /** *

The property to use in the condition.

*/ key?: outputs.awsconnector.SimpleCriterionKeyForJobEnumValueResponse; /** *

An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

  • ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the bucket.

  • S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of a bucket.

  • S3_BUCKET_NAME - A string that represents the name of a bucket.

  • S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of a bucket.

Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.

*/ values?: string[]; } /** * Definition of SimpleCriterionKeyForJobEnumValue */ interface SimpleCriterionKeyForJobEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of SingleHeaderModelProperties */ interface SingleHeaderModelPropertiesResponse { /** * The name of the query header to inspect. */ name?: string; } /** * Definition of SnapStartResponse */ interface SnapStartResponse { /** * When set to ``PublishedVersions``, Lambda creates a snapshot of the execution environment when you publish a function version. */ applyOn?: string | enums.awsconnector.SnapStartResponseApplyOn; /** * When you provide a [qualified Amazon Resource Name (ARN)](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using), this response element indicates whether SnapStart is activated for the specified function version. */ optimizationStatus?: string | enums.awsconnector.SnapStartResponseOptimizationStatus; } /** * Definition of SnapStartResponse */ interface SnapStartResponseResponse { /** * When set to ``PublishedVersions``, Lambda creates a snapshot of the execution environment when you publish a function version. */ applyOn?: string; /** * When you provide a [qualified Amazon Resource Name (ARN)](https://docs.aws.amazon.com/lambda/latest/dg/configuration-versions.html#versioning-versions-using), this response element indicates whether SnapStart is activated for the specified function version. */ optimizationStatus?: string; } /** * Definition of SnapshotOptions */ interface SnapshotOptionsResponse { /** *

The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

*/ automatedSnapshotStartHour?: number; } /** * Definition of SnapshotStateEnumValue */ interface SnapshotStateEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of SnsSubscription */ interface SnsSubscriptionPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsSnsSubscriptionPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of SnsTopic */ interface SnsTopicPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsSnsTopicPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of SoftwareUpdateOptions */ interface SoftwareUpdateOptionsResponse { /** *

Whether automatic service software updates are enabled for the domain.

*/ autoSoftwareUpdateEnabled?: boolean; } /** * Definition of SourceAuth */ interface SourceAuthResponse { /** *

The resource value that applies to the specified authorization type.

*/ resource?: string; /** *

The authorization type to use. Valid options are OAUTH or CODECONNECTIONS.

*/ type?: outputs.awsconnector.SourceAuthTypeEnumValueResponse; } /** * Definition of SourceAuthTypeEnumValue */ interface SourceAuthTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of SourceConfiguration */ interface SourceConfigurationResponse { /** * The name of the application associated with the configuration. */ applicationName?: string; /** * The name of the configuration template. */ templateName?: string; } /** * Definition of SourceSelectionCriteria */ interface SourceSelectionCriteriaResponse { /** * A filter that you can specify for selection for modifications on replicas. A filter that you can specify for selection for modifications on replicas. */ replicaModifications?: outputs.awsconnector.ReplicaModificationsResponse; /** * A container for filter information for the selection of Amazon S3 objects encrypted with AWS KMS. A container for filter information for the selection of S3 objects encrypted with AWS KMS. */ sseKmsEncryptedObjects?: outputs.awsconnector.SseKmsEncryptedObjectsResponse; } /** * Definition of SourceTypeEnumValue */ interface SourceTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of SqsQueue */ interface SqsQueuePropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsSqsQueuePropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of SseKmsEncryptedObjects */ interface SseKmsEncryptedObjectsResponse { /** * Specifies whether Amazon S3 replicates objects created with server-side encryption using an AWS KMS key stored in AWS Key Management Service. */ status?: string; } /** * Definition of SsmInstanceInformation */ interface SsmInstanceInformationPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsSsmInstanceInformationPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of SsmParameter */ interface SsmParameterPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsSsmParameterPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of SsmResourceComplianceSummaryItem */ interface SsmResourceComplianceSummaryItemPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsSsmResourceComplianceSummaryItemPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of StackInstances */ interface StackInstancesResponse { /** * The AWS OrganizationalUnitIds or Accounts for which to create stack instances in the specified Regions. */ deploymentTargets?: outputs.awsconnector.DeploymentTargetsResponse; /** * A list of stack set parameters whose values you want to override in the selected stack instances. */ parameterOverrides?: outputs.awsconnector.ParameterResponse[]; /** * The names of one or more Regions where you want to create stack instances using the specified AWS account(s). */ regions?: string[]; } /** * Definition of StateReason */ interface StateReasonResponse { /** *

The reason code for the state change.

*/ code?: string; /** *

The message for the state change.

  • Server.InsufficientInstanceCapacity: There was insufficient capacity available to satisfy the launch request.

  • Server.InternalError: An internal error caused the instance to terminate during launch.

  • Server.ScheduledStop: The instance was stopped due to a scheduled retirement.

  • Server.SpotInstanceShutdown: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.

  • Server.SpotInstanceTermination: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.

  • Client.InstanceInitiatedShutdown: The instance was shut down from the operating system of the instance.

  • Client.InstanceTerminated: The instance was terminated or rebooted during AMI creation.

  • Client.InternalError: A client error caused the instance to terminate during launch.

  • Client.InvalidSnapshot.NotFound: The specified snapshot was not found.

  • Client.UserInitiatedHibernate: Hibernation was initiated on the instance.

  • Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.

  • Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.

*/ message?: string; } /** * Definition of State */ interface StateResponse { /** * Status code of the Instance. */ code?: number; /** * Status code of the Instance. */ name?: string; } /** * Definition of StatefulEngineOptions */ interface StatefulEngineOptionsResponse { /** * Property ruleOrder */ ruleOrder?: string; /** * Property streamExceptionPolicy */ streamExceptionPolicy?: string; } /** * Definition of StatefulRuleGroupOverride */ interface StatefulRuleGroupOverrideResponse { /** * Property action */ action?: string; } /** * Definition of StatefulRuleGroupReference */ interface StatefulRuleGroupReferenceResponse { /** * Property override */ override?: outputs.awsconnector.StatefulRuleGroupOverrideResponse; /** * Property priority */ priority?: number; /** * A resource ARN. */ resourceArn?: string; } /** * Definition of StatefulRuleOptions */ interface StatefulRuleOptionsResponse { /** * Property ruleOrder */ ruleOrder?: string; } /** * Definition of StatefulRule */ interface StatefulRuleResponse { /** * Property action */ action?: string; /** * Property header */ header?: outputs.awsconnector.HeaderResponse; /** * Property ruleOptions */ ruleOptions?: outputs.awsconnector.RuleOptionResponse[]; } /** * Definition of StatelessRuleGroupReference */ interface StatelessRuleGroupReferenceResponse { /** * Property priority */ priority?: number; /** * A resource ARN. */ resourceArn?: string; } /** * Definition of StatelessRule */ interface StatelessRuleResponse { /** * Property priority */ priority?: number; /** * Property ruleDefinition */ ruleDefinition?: outputs.awsconnector.RuleDefinitionResponse; } /** * Definition of StatelessRulesAndCustomActions */ interface StatelessRulesAndCustomActionsResponse { /** * Property customActions */ customActions?: outputs.awsconnector.CustomActionNetworkFirewallRuleGroupResponse[]; /** * Property statelessRules */ statelessRules?: outputs.awsconnector.StatelessRuleResponse[]; } /** * Definition of StatusCodes */ interface StatusCodesResponse { /** * The items (status codes) for an origin group. */ items?: number[]; /** * The number of status codes. */ quantity?: number; } /** * Definition of StatusNameEnumValue */ interface StatusNameEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of statusTypeEnumValue */ interface StatusTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of StorageClassAnalysis */ interface StorageClassAnalysisResponse { /** * Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported. Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported. */ dataExport?: outputs.awsconnector.DataExportResponse; } /** * Definition of StorageTierEnumValue */ interface StorageTierEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of StreamSpecification */ interface StreamSpecificationResponse { /** * Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table's streams. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). Creates or updates a resource-based policy document that contains the permissions for DDB resources, such as a table, its indexes, and stream. Resource-based policies let you define access permissions by specifying who has access to each resource, and the actions they are allowed to perform on each resource. In a CFNshort template, you can provide the policy in JSON or YAML format because CFNshort converts YAML to JSON before submitting it to DDB. For more information about resource-based policies, see [Using resource-based policies for](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/access-control-resource-based.html) and [Resource-based policy examples](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-examples.html). While defining resource-based policies in your CFNshort templates, the following considerations apply: + The maximum size supported for a resource-based policy document in JSON format is 20 KB. DDB counts whitespaces when calculating the size of a policy against this limit. + Resource-based policies don't support [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html#). If you update a policy outside of the CFNshort stack template, you'll need to update the CFNshort stack with the changes. + Resource-based policies don't support out-of-band changes. If you add, update, or delete a policy outside of the CFNshort template, the change won't be overwritten if there are no changes to the policy within the template. For example, say that your template contains a resource-based policy, which you later update outside of the template. If you don't make any changes to the policy in the template, the updated policy in DDB won’t be synced with the policy in the template. Conversely, say that your template doesn’t contain a resource-based policy, but you add a policy outside of the template. This policy won’t be removed from DDB as long as you don’t add it to the template. When you add a policy to the template and update the stack, the existing policy in DDB will be updated to match the one defined in the template. For a full list of all considerations, see [Resource-based policy considerations](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/rbac-considerations.html). */ resourcePolicy?: outputs.awsconnector.ResourcePolicyResponse; /** * When an item in the table is modified, ``StreamViewType`` determines what information is written to the stream for this table. Valid values for ``StreamViewType`` are: + ``KEYS_ONLY`` - Only the key attributes of the modified item are written to the stream. + ``NEW_IMAGE`` - The entire item, as it appears after it was modified, is written to the stream. + ``OLD_IMAGE`` - The entire item, as it appeared before it was modified, is written to the stream. + ``NEW_AND_OLD_IMAGES`` - Both the new and the old item images of the item are written to the stream. */ streamViewType?: string; } /** * Definition of SubnetMapping */ interface SubnetMappingNetworkFirewallFirewallResponse { /** * A IPAddressType */ ipAddressType?: string; /** * A SubnetId. */ subnetId?: string; } /** * Definition of SubnetMapping */ interface SubnetMappingResponse { /** * [Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer. */ allocationId?: string; /** * [Network Load Balancers] The IPv6 address. */ iPv6Address?: string; /** * [Network Load Balancers] The private IPv4 address for an internal load balancer. */ privateIPv4Address?: string; /** * The ID of the subnet. */ subnetId?: string; } /** * Definition of Subnet */ interface SubnetResponse { /** *

The Availability Zone of the subnet.

*/ subnetAvailabilityZone?: outputs.awsconnector.AvailabilityZoneResponse; /** *

The subnet identifier.

*/ subnetIdentifier?: string; /** *

The status of the subnet.

*/ subnetStatus?: string; } /** * Definition of Subscription */ interface SubscriptionResponse { /** * The endpoint that receives notifications from the SNS topic. The endpoint value depends on the protocol that you specify. For more information, see the ``Endpoint`` parameter of the ``Subscribe`` action in the *API Reference*. */ endpoint?: string; /** * The subscription's protocol. For more information, see the ``Protocol`` parameter of the ``Subscribe`` action in the *API Reference*. */ protocol?: string; } /** * Definition of SummaryStatusEnumValue */ interface SummaryStatusEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of SystemControl */ interface SystemControlResponse { /** * The namespaced kernel parameter to set a ``value`` for. */ namespace?: string; /** * The namespaced kernel parameter to set a ``value`` for. Valid IPC namespace values: ``'kernel.msgmax' | 'kernel.msgmnb' | 'kernel.msgmni' | 'kernel.sem' | 'kernel.shmall' | 'kernel.shmmax' | 'kernel.shmmni' | 'kernel.shm_rmid_forced'``, and ``Sysctls`` that start with ``'fs.mqueue.*'`` Valid network namespace values: ``Sysctls`` that start with ``'net.*'`` All of these values are supported by Fargate. */ value?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Definition of TCPFlagField */ interface TCPFlagFieldResponse { /** * Property flags */ flags?: string[]; /** * Property masks */ masks?: string[]; } /** * Definition of TLSSecurityPolicyEnumValue */ interface TLSSecurityPolicyEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of TagCriterionForJob */ interface TagCriterionForJobResponse { /** *

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

*/ comparator?: outputs.awsconnector.JobComparatorEnumValueResponse; /** *

The tag keys, tag values, or tag key and value pairs to use in the condition.

*/ tagValues?: outputs.awsconnector.TagCriterionPairForJobResponse[]; } /** * Definition of TagCriterionPairForJob */ interface TagCriterionPairForJobResponse { /** *

The value for the tag key to use in the condition.

*/ key?: string; /** *

The tag value to use in the condition.

*/ value?: string; } /** * Definition of TagFilter */ interface TagFilterResponse { /** * The tag key. */ key?: string; /** * The tag value. */ value?: string; } /** * Definition of TagItem */ interface TagItemResponse { /** * Property key */ key?: string; /** * Property value */ value?: string; } /** * Definition of TagProperty */ interface TagPropertyResponse { /** * The tag key. */ key?: string; /** * Set to ``true`` if you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set to ``false`` if you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group. */ propagateAtLaunch?: boolean; /** * The tag value. */ value?: string; } /** * Definition of Tag */ interface TagResponse { /** * The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. */ key?: string; /** * The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -. */ value?: string; } /** * Definition of Taint */ interface TaintResponse { /** * Property effect */ effect?: string; /** * Property key */ key?: string; /** * Property value */ value?: string; } /** * Definition of TargetDescription */ interface TargetDescriptionResponse { /** *

An Availability Zone or all. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.

For Application Load Balancer target groups, the specified Availability Zone value is only applicable when cross-zone load balancing is off. Otherwise the parameter is ignored and treated as all.

This parameter is not supported if the target type of the target group is instance or alb.

If the target type is ip and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.

For Application Load Balancer target groups with cross-zone load balancing off, if the target type is ip and the IP address is outside of the VPC for the target group, this should be an Availability Zone inside the VPC for the target group.

If the target type is lambda, this parameter is optional and the only supported value is all.

*/ availabilityZone?: string; /** *

The ID of the target. If the target type of the target group is instance, specify an instance ID. If the target type is ip, specify an IP address. If the target type is lambda, specify the ARN of the Lambda function. If the target type is alb, specify the ARN of the Application Load Balancer target.

*/ id?: string; /** *

The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. This parameter is not used if the target is a Lambda function.

*/ port?: number; } /** * Definition of TargetGroupAttribute */ interface TargetGroupAttributeResponse { /** * The value of the attribute. */ key?: string; /** * The name of the attribute. */ value?: string; } /** * Definition of TargetGroupStickinessConfig */ interface TargetGroupStickinessConfigResponse { /** * The time period, in seconds, during which requests from a client should be routed to the same target group. The range is 1-604800 seconds (7 days). */ durationSeconds?: number; /** * Indicates whether target group stickiness is enabled. */ enabled?: boolean; } /** * Definition of TargetGroupTuple */ interface TargetGroupTupleResponse { /** * The Amazon Resource Name (ARN) of the target group. */ targetGroupArn?: string; /** * The weight. The range is 0 to 999. */ weight?: number; } /** * Definition of TargetHealthReasonEnumEnumValue */ interface TargetHealthReasonEnumEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of TargetHealth */ interface TargetHealthResponse { /** *

A description of the target health that provides additional details. If the state is healthy, a description is not provided.

*/ description?: string; /** *

The reason code.

If the target state is healthy, a reason code is not provided.

If the target state is initial, the reason code can be one of the following values:

  • Elb.RegistrationInProgress - The target is in the process of being registered with the load balancer.

  • Elb.InitialHealthChecking - The load balancer is still sending the target the minimum number of health checks required to determine its health status.

If the target state is unhealthy, the reason code can be one of the following values:

  • Target.ResponseCodeMismatch - The health checks did not return an expected HTTP code. Applies only to Application Load Balancers and Gateway Load Balancers.

  • Target.Timeout - The health check requests timed out. Applies only to Application Load Balancers and Gateway Load Balancers.

  • Target.FailedHealthChecks - The load balancer received an error while establishing a connection to the target or the target response was malformed.

  • Elb.InternalError - The health checks failed due to an internal error. Applies only to Application Load Balancers.

If the target state is unused, the reason code can be one of the following values:

  • Target.NotRegistered - The target is not registered with the target group.

  • Target.NotInUse - The target group is not used by any load balancer or the target is in an Availability Zone that is not enabled for its load balancer.

  • Target.InvalidState - The target is in the stopped or terminated state.

  • Target.IpUnusable - The target IP address is reserved for use by a load balancer.

If the target state is draining, the reason code can be the following value:

  • Target.DeregistrationInProgress - The target is in the process of being deregistered and the deregistration delay period has not expired.

If the target state is unavailable, the reason code can be the following value:

  • Target.HealthCheckDisabled - Health checks are disabled for the target group. Applies only to Application Load Balancers.

  • Elb.InternalError - Target health is unavailable due to an internal error. Applies only to Network Load Balancers.

*/ reason?: outputs.awsconnector.TargetHealthReasonEnumEnumValueResponse; /** *

The state of the target.

*/ state?: outputs.awsconnector.TargetHealthStateEnumEnumValueResponse; } /** * Definition of TargetHealthStateEnumEnumValue */ interface TargetHealthStateEnumEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of TargetObjectKeyFormat */ interface TargetObjectKeyFormatResponse { /** * Amazon S3 keys for log objects are partitioned in the following format: ``[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]`` PartitionedPrefix defaults to EventTime delivery when server access logs are delivered. */ partitionedPrefix?: outputs.awsconnector.PartitionedPrefixResponse; /** * This format defaults the prefix to the given log file prefix for delivering server access log file. */ simplePrefix?: any; } /** * Definition of TaskDefinitionPlacementConstraint */ interface TaskDefinitionPlacementConstraintResponse { /** * A cluster query language expression to apply to the constraint. For more information, see [Cluster query language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html) in the *Amazon Elastic Container Service Developer Guide*. */ expression?: string; /** * The type of constraint. The ``MemberOf`` constraint restricts selection to be from a group of valid candidates. */ type?: string; } /** * Definition of TenancyEnumValue */ interface TenancyEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of Tier */ interface TierResponse { /** * The name of this environment tier. */ name?: string; /** * The type of this environment tier. */ type?: string; /** * The version of this environment tier. When you don't set a value to it, Elastic Beanstalk uses the latest compatible worker tier version. */ version?: string; } /** * Definition of Tiering */ interface TieringResponse { /** * S3 Intelligent-Tiering access tier. See [Storage class for automatically optimizing frequently and infrequently accessed objects](https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access) for a list of access tiers in the S3 Intelligent-Tiering storage class. */ accessTier?: string; /** * The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days). */ days?: number; } /** * Definition of TimeToLiveSpecification */ interface TimeToLiveSpecificationResponse { /** * The name of the TTL attribute used to store the expiration time for items in the table. + The ``AttributeName`` property is required when enabling the TTL, or when TTL is already enabled. + To update this property, you must first disable TTL and then enable TTL with the new attribute name. */ attributeName?: string; /** * Indicates whether TTL is to be enabled (true) or disabled (false) on the table. */ enabled?: boolean; } /** * Definition of TimeoutConfiguration */ interface TimeoutConfigurationResponse { /** * The amount of time in seconds a connection will stay active while idle. A value of ``0`` can be set to disable ``idleTimeout``. The ``idleTimeout`` default for ``HTTP``/``HTTP2``/``GRPC`` is 5 minutes. The ``idleTimeout`` default for ``TCP`` is 1 hour. */ idleTimeoutSeconds?: number; /** * The amount of time waiting for the upstream to respond with a complete response per request. A value of ``0`` can be set to disable ``perRequestTimeout``. ``perRequestTimeout`` can only be set if Service Connect ``appProtocol`` isn't ``TCP``. Only ``idleTimeout`` is allowed for ``TCP`` ``appProtocol``. */ perRequestTimeoutSeconds?: number; } /** * Definition of Tmpfs */ interface TmpfsResponse { /** * The absolute file path where the tmpfs volume is to be mounted. */ containerPath?: string; /** * The list of tmpfs volume mount options. */ mountOptions?: string[]; /** * The maximum size (in MiB) of the tmpfs volume. */ size?: number; } /** * Definition of TopicConfiguration */ interface TopicConfigurationResponse { /** * The Amazon S3 bucket event about which to send notifications. For more information, see [Supported Event Types](https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html) in the *Amazon S3 User Guide*. */ event?: string; /** * The filtering rules that determine for which objects to send notifications. For example, you can create a filter so that Amazon S3 sends notifications only when image files with a ``.jpg`` extension are added to the bucket. Specifies object key name filtering rules. For information about key name filtering, see [Configuring event notifications using object key name filtering](https://docs.aws.amazon.com/AmazonS3/latest/userguide/notification-how-to-filtering.html) in the *Amazon S3 User Guide*. */ filter?: outputs.awsconnector.NotificationFilterResponse; /** * The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type. */ topic?: string; } /** * Definition of TotalLocalStorageGBRequest */ interface TotalLocalStorageGBRequestResponse { /** * The storage maximum in GB. */ max?: number; /** * The storage minimum in GB. */ min?: number; } /** * Definition of TpmSupportValuesEnumValue */ interface TpmSupportValuesEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of TracingConfig */ interface TracingConfigResponse { /** * The tracing mode. */ mode?: string; } /** * Definition of Transition */ interface TransitionResponse { /** * The storage class to which you want the object to transition. */ storageClass?: string; /** * Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC. The date value in ISO 8601 format. The timezone is always UTC. (YYYY-MM-DDThh:mm:ssZ) */ transitionDate?: string; /** * Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer. */ transitionInDays?: number; } /** * Definition of TypeEnumValue */ interface TypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of Ulimit */ interface UlimitResponse { /** * The hard limit for the ``ulimit`` type. */ hardLimit?: number; /** * The ``type`` of the ``ulimit``. */ name?: string; /** * The soft limit for the ``ulimit`` type. */ softLimit?: number; } /** * Definition of UnusedAccessConfiguration */ interface UnusedAccessConfigurationResponse { /** * The specified access age in days for which to generate findings for unused access. For example, if you specify 90 days, the analyzer will generate findings for IAM entities within the accounts of the selected organization for any access that hasn't been used in 90 or more days since the analyzer's last scan. You can choose a value between 1 and 180 days. */ unusedAccessAge?: number; } /** * Definition of UpdateConfig */ interface UpdateConfigResponse { /** * The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. This value or maxUnavailablePercentage is required to have a value.The maximum number is 100. */ maxUnavailable?: number; /** * The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value. */ maxUnavailablePercentage?: number; } /** * Definition of UserIdGroupPair */ interface UserIdGroupPairResponse { /** *

A description for the security group rule that references this user ID group pair.

Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*

*/ description?: string; /** *

The ID of the security group.

*/ groupId?: string; /** *

[Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID.

For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.

*/ groupName?: string; /** *

The status of a VPC peering connection, if applicable.

*/ peeringStatus?: string; /** *

The ID of an Amazon Web Services account.

For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.

*/ userId?: string; /** *

The ID of the VPC for the referenced security group, if applicable.

*/ vpcId?: string; /** *

The ID of the VPC peering connection, if applicable.

*/ vpcPeeringConnectionId?: string; } /** * Definition of UserPausedDetails */ interface UserPausedDetailsResponse { /** *

The date and time, in UTC and extended ISO 8601 format, when the job or job run will expire and be cancelled if you don't resume it first.

*/ jobExpiresAt?: string; /** *

The Amazon Resource Name (ARN) of the Health event that Amazon Macie sent to notify you of the job or job run's pending expiration and cancellation. This value is null if a job has been paused for less than 23 days.

*/ jobImminentExpirationHealthEventArn?: string; /** *

The date and time, in UTC and extended ISO 8601 format, when you paused the job.

*/ jobPausedAt?: string; } /** * Definition of UserPoolConfig */ interface UserPoolConfigResponse { /** *

A regular expression for validating the incoming Amazon Cognito user pool app client ID. If this value isn't set, no filtering is applied.

*/ appIdClientRegex?: string; /** *

The Amazon Web Services Region in which the user pool was created.

*/ awsRegion?: string; /** *

The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.

*/ defaultAction?: outputs.awsconnector.DefaultActionEnumValueResponse; /** *

The user pool ID.

*/ userPoolId?: string; } /** * Definition of VCpuCountRequest */ interface VCpuCountRequestResponse { /** * The maximum number of vCPUs. */ max?: number; /** * The minimum number of vCPUs. */ min?: number; } /** * Definition of VPCDerivedInfo */ interface VPCDerivedInfoResponse { /** *

The list of Availability Zones associated with the VPC subnets.

*/ availabilityZones?: string[]; /** *

The list of security group IDs associated with the VPC endpoints for the domain.

*/ securityGroupIds?: string[]; /** *

A list of subnet IDs associated with the VPC endpoints for the domain.

*/ subnetIds?: string[]; /** *

The ID for your VPC. Amazon VPC generates this value when you create a VPC.

*/ vpcId?: string; } /** * Definition of VPC */ interface VPCResponse { /** * *Private hosted zones only:* The ID of an Amazon VPC. For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``. */ vpcId?: string; /** * *Private hosted zones only:* The region that an Amazon VPC was created in. For public hosted zones, omit ``VPCs``, ``VPCId``, and ``VPCRegion``. */ vpcRegion?: string; } /** * Definition of VersioningConfiguration */ interface VersioningConfigurationResponse { /** * The versioning state of the bucket. */ status?: string; } /** * versioningConfigurationResponseProvideDefaults sets the appropriate defaults for VersioningConfigurationResponse */ function versioningConfigurationResponseProvideDefaults(val: VersioningConfigurationResponse): VersioningConfigurationResponse; /** * Definition of ViewerCertificate */ interface ViewerCertificateResponse { /** * In CloudFormation, this field name is ``AcmCertificateArn``. Note the different capitalization. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(ACM)](https://docs.aws.amazon.com/acm/latest/userguide/acm-overview.html), provide the Amazon Resource Name (ARN) of the ACM certificate. CloudFront only supports ACM certificates in the US East (N. Virginia) Region (``us-east-1``). If you specify an ACM certificate ARN, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) */ acmCertificateArn?: string; /** * If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, set this field to ``true``. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), omit this field and specify values for the following fields: + ``AcmCertificateArn`` or ``IamCertificateId`` (specify a value for one, not both) + ``MinimumProtocolVersion`` + ``SslSupportMethod`` */ cloudFrontDefaultCertificate?: boolean; /** * In CloudFormation, this field name is ``IamCertificateId``. Note the different capitalization. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs) and the SSL/TLS certificate is stored in [(IAM)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_server-certs.html), provide the ID of the IAM certificate. If you specify an IAM certificate ID, you must also specify values for ``MinimumProtocolVersion`` and ``SSLSupportMethod``. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) */ iamCertificateId?: string; /** * If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings: + The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers. + The ciphers that CloudFront can use to encrypt the content that it returns to viewers. For more information, see [Security Policy](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValues-security-policy) and [Supported Protocols and Ciphers Between Viewers and CloudFront](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers) in the *Amazon CloudFront Developer Guide*. On the CloudFront console, this setting is called *Security Policy*. When you're using SNI only (you set ``SSLSupportMethod`` to ``sni-only``), you must specify ``TLSv1`` or higher. (In CloudFormation, the field name is ``SslSupportMethod``. Note the different capitalization.) If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net`` (you set ``CloudFrontDefaultCertificate`` to ``true``), CloudFront automatically sets the security policy to ``TLSv1`` regardless of the value that you set here. */ minimumProtocolVersion?: string; /** * In CloudFormation, this field name is ``SslSupportMethod``. Note the different capitalization. If the distribution uses ``Aliases`` (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from. + ``sni-only`` – The distribution accepts HTTPS connections from only viewers that support [server name indication (SNI)](https://en.wikipedia.org/wiki/Server_Name_Indication). This is recommended. Most browsers and clients support SNI. + ``vip`` – The distribution accepts HTTPS connections from all viewers including those that don't support SNI. This is not recommended, and results in additional monthly charges from CloudFront. + ``static-ip`` - Do not specify this value unless your distribution has been enabled for this feature by the CloudFront team. If you have a use case that requires static IP addresses for a distribution, contact CloudFront through the [Center](https://aws.amazon.com/support/home). If the distribution uses the CloudFront domain name such as ``d111111abcdef8.cloudfront.net``, don't set a value for this field. */ sslSupportMethod?: string; } /** * Definition of VirtualizationTypeEnumValue */ interface VirtualizationTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of VolumeFrom */ interface VolumeFromResponse { /** * If this value is ``true``, the container has read-only access to the volume. If this value is ``false``, then the container can write to the volume. The default value is ``false``. */ readOnly?: boolean; /** * The name of another container within the same task definition to mount volumes from. */ sourceContainer?: string; } /** * Definition of Volume */ interface VolumeResponse { /** * Indicates whether the volume should be configured at launch time. This is used to create Amazon EBS volumes for standalone tasks or tasks created as part of a service. Each task definition revision may only have one volume configured at launch in the volume configuration. To configure a volume at launch time, use this task definition revision and specify a ``volumeConfigurations`` object when calling the ``CreateService``, ``UpdateService``, ``RunTask`` or ``StartTask`` APIs. */ configuredAtLaunch?: boolean; /** * This parameter is specified when you use Docker volumes. Windows containers only support the use of the ``local`` driver. To use bind mounts, specify the ``host`` parameter instead. Docker volumes aren't supported by tasks run on FARGATElong. The ``DockerVolumeConfiguration`` property specifies a Docker volume configuration and is used when you use Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the ``local`` driver. To use bind mounts, specify a ``host`` instead. */ dockerVolumeConfiguration?: outputs.awsconnector.DockerVolumeConfigurationResponse; /** * This parameter is specified when you use an Amazon Elastic File System file system for task storage. This parameter is specified when you're using an Amazon Elastic File System file system for task storage. For more information, see [Amazon EFS volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/efs-volumes.html) in the *Amazon Elastic Container Service Developer Guide*. */ efsVolumeConfiguration?: outputs.awsconnector.EFSVolumeConfigurationResponse; /** * This parameter is specified when you use Amazon FSx for Windows File Server file system for task storage. This parameter is specified when you're using [Amazon FSx for Windows File Server](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/what-is.html) file system for task storage. For more information and the input format, see [Amazon FSx for Windows File Server volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/wfsx-volumes.html) in the *Amazon Elastic Container Service Developer Guide*. */ fSxWindowsFileServerVolumeConfiguration?: outputs.awsconnector.FSxWindowsFileServerVolumeConfigurationResponse; /** * This parameter is specified when you use bind mount host volumes. The contents of the ``host`` parameter determine whether your bind mount host volume persists on the host container instance and where it's stored. If the ``host`` parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running. Windows containers can mount whole directories on the same drive as ``$env:ProgramData``. Windows containers can't mount directories on a different drive, and mount point can't be across drives. For example, you can mount ``C:\my\path:C:\my\path`` and ``D:\:D:\``, but not ``D:\my\path:C:\my\path`` or ``D:\:C:\my\path``. The ``HostVolumeProperties`` property specifies details on a container instance bind mount host volume. */ host?: outputs.awsconnector.HostVolumePropertiesResponse; /** * The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed. When using a volume configured at launch, the ``name`` is required and must also be specified as the volume name in the ``ServiceVolumeConfiguration`` or ``TaskVolumeConfiguration`` parameter when creating your service or standalone task. For all other types of volumes, this name is referenced in the ``sourceVolume`` parameter of the ``mountPoints`` object in the container definition. When a volume is using the ``efsVolumeConfiguration``, the name is required. */ name?: string; } /** * Definition of VolumeTypeEnumValue */ interface VolumeTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of VpcConfig */ interface VpcConfigLambdaFunctionResponse { /** * Allows outbound IPv6 traffic on VPC functions that are connected to dual-stack subnets. */ ipv6AllowedForDualStack?: boolean; /** * A list of VPC security group IDs. */ securityGroupIds?: string[]; /** * A list of VPC subnet IDs. */ subnetIds?: string[]; } /** * Definition of VpcConfigResponse */ interface VpcConfigResponse { /** *

The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.

*/ clusterSecurityGroupId?: string; /** *

This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .

*/ endpointPrivateAccess?: boolean; /** *

Whether the public API server endpoint is enabled.

*/ endpointPublicAccess?: boolean; /** *

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint.

*/ publicAccessCidrs?: string[]; /** *

The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane.

*/ securityGroupIds?: string[]; /** *

The subnets associated with your cluster.

*/ subnetIds?: string[]; /** *

A list of one or more subnet IDs in your Amazon VPC.

*/ subnets?: string[]; /** *

The VPC associated with your cluster.

*/ vpcId?: string; } /** * Definition of VpcConfigResponse */ interface VpcConfigResponseResponse { /** *

The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.

*/ clusterSecurityGroupId?: string; /** *

This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have nodes or Fargate pods in the cluster, then ensure that publicAccessCidrs includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide .

*/ endpointPrivateAccess?: boolean; /** *

Whether the public API server endpoint is enabled.

*/ endpointPublicAccess?: boolean; /** *

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint.

*/ publicAccessCidrs?: string[]; /** *

The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane.

*/ securityGroupIds?: string[]; /** *

The subnets associated with your cluster.

*/ subnetIds?: string[]; /** *

The VPC associated with your cluster.

*/ vpcId?: string; } /** * Definition of VpcConfiguration */ interface VpcConfigurationResponse { /** * If this field is specified, this access point will only allow connections from the specified VPC ID. */ vpcId?: string; } /** * Definition of VpcSecurityGroupMembership */ interface VpcSecurityGroupMembershipResponse { /** *

The status of the VPC security group.

*/ status?: string; /** *

The VPC security group ID.

*/ vpcSecurityGroupId?: string; } /** * Definition of WafWebACLSummary */ interface WafWebACLSummaryPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsWafWebACLSummaryPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of Wafv2LoggingConfiguration */ interface Wafv2LoggingConfigurationPropertiesResponse { /** * Amazon Resource Name (ARN) */ arn?: string; /** * AWS Account ID */ awsAccountId?: string; /** * AWS Properties */ awsProperties?: outputs.awsconnector.AwsWafv2LoggingConfigurationPropertiesResponse; /** * AWS Region */ awsRegion?: string; /** * AWS Source Schema */ awsSourceSchema?: string; /** * AWS Tags */ awsTags?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Public Cloud Connectors Resource ID */ publicCloudConnectorsResourceId?: string; /** * Public Cloud Resource Name */ publicCloudResourceName?: string; } /** * Definition of WebhookBuildTypeEnumValue */ interface WebhookBuildTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of WebhookFilter */ interface WebhookFilterResponse { /** *

Used to indicate that the pattern determines which webhook events do not trigger a build. If true, then a webhook event that does not match the pattern triggers a build. If false, then a webhook event that matches the pattern triggers a build.

*/ excludeMatchedPattern?: boolean; /** *

For a WebHookFilter that uses EVENT type, a comma-separated string that specifies one or more events. For example, the webhook filter PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED allows all push, pull request created, and pull request updated events to trigger a build.

For a WebHookFilter that uses any of the other filter types, a regular expression pattern. For example, a WebHookFilter that uses HEAD_REF for its type and the pattern ^refs/heads/ triggers a build when the head reference is a branch with a reference name refs/heads/branch-name.

*/ pattern?: string; /** *

The type of webhook filter. There are nine webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH, COMMIT_MESSAGE, TAG_NAME, RELEASE_NAME, and WORKFLOW_NAME.

  • EVENT

    • A webhook event triggers a build when the provided pattern matches one of nine event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_CLOSED, PULL_REQUEST_REOPENED, PULL_REQUEST_MERGED, RELEASED, PRERELEASED, and WORKFLOW_JOB_QUEUED. The EVENT patterns are specified as a comma-separated string. For example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull request created, and pull request updated events.

      The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only. The RELEASED, PRERELEASED, and WORKFLOW_JOB_QUEUED work with GitHub only.

  • ACTOR_ACCOUNT_ID

    • A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression pattern.

  • HEAD_REF

    • A webhook event triggers a build when the head reference matches the regular expression pattern. For example, refs/heads/branch-name and refs/tags/tag-name.

      Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.

  • BASE_REF

    • A webhook event triggers a build when the base reference matches the regular expression pattern. For example, refs/heads/branch-name.

      Works with pull request events only.

  • FILE_PATH

    • A webhook triggers a build when the path of a changed file matches the regular expression pattern.

      Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.

  • COMMIT_MESSAGE

    • A webhook triggers a build when the head commit message matches the regular expression pattern.

      Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.

  • TAG_NAME

    • A webhook triggers a build when the tag name of the release matches the regular expression pattern.

      Works with RELEASED and PRERELEASED events only.

  • RELEASE_NAME

    • A webhook triggers a build when the release name matches the regular expression pattern.

      Works with RELEASED and PRERELEASED events only.

  • WORKFLOW_NAME

    • A webhook triggers a build when the workflow name matches the regular expression pattern.

      Works with WORKFLOW_JOB_QUEUED events only.

*/ type?: outputs.awsconnector.WebhookFilterTypeEnumValueResponse; } /** * Definition of WebhookFilterTypeEnumValue */ interface WebhookFilterTypeEnumValueResponse { /** * Property value */ value?: string; } /** * Definition of Webhook */ interface WebhookResponse { /** *

A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

It is recommended that you use filterGroups instead of branchFilter.

*/ branchFilter?: string; /** *

Specifies the type of build this webhook will trigger.

*/ buildType?: outputs.awsconnector.WebhookBuildTypeEnumValueResponse; /** *

An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.

For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.

*/ filterGroups?: outputs.awsconnector.FilterGroupResponse[]; /** *

A timestamp that indicates the last time a repository's secret token was modified.

*/ lastModifiedSecret?: string; /** *

The CodeBuild endpoint where webhook events are sent.

*/ payloadUrl?: string; /** *

The secret token of the associated repository.

A Bitbucket webhook does not support secret.

*/ secret?: string; /** *

The URL to the webhook.

*/ url?: string; } /** * Definition of WebsiteConfiguration */ interface WebsiteConfigurationResponse { /** * The name of the error document for the website. */ errorDocument?: string; /** * The name of the index document for the website. */ indexDocument?: string; /** * The redirect behavior for every request to this bucket's website endpoint. If you specify this property, you can't specify any other property. Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket. */ redirectAllRequestsTo?: outputs.awsconnector.RedirectAllRequestsToResponse; /** * Rules that define when a redirect is applied and the redirect behavior. */ routingRules?: outputs.awsconnector.RoutingRuleResponse[]; } /** * Definition of WindowStartTime */ interface WindowStartTimeResponse { /** *

The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example, 17 refers to 5:00 P.M. UTC.

*/ hours?: number; /** *

The start minute of the window, in UTC.

*/ minutes?: number; } /** * Definition of ZoneAwarenessConfig */ interface ZoneAwarenessConfigResponse { /** *

If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.

*/ availabilityZoneCount?: number; } } export declare namespace azureactivedirectory { /** * SKU properties of the Azure AD B2C tenant. Learn more about Azure AD B2C billing at [aka.ms/b2cBilling](https://aka.ms/b2cBilling). */ interface B2CResourceSKUResponse { /** * The name of the SKU for the tenant. */ name?: string; /** * The tier of the tenant. */ tier?: string; } /** * The billing configuration for the tenant. */ interface B2CTenantResourcePropertiesResponseBillingConfig { /** * The type of billing. Will be MAU for all new customers. If 'Auths', it can be updated to 'MAU'. Cannot be changed if value is 'MAU'. Learn more about Azure AD B2C billing at [aka.ms/b2cBilling](https://aka.ms/b2cbilling). */ billingType?: string; /** * The data from which the billing type took effect */ effectiveStartDateUtc: string; } /** * SKU properties of the Azure AD for customers tenant. Learn more about Azure AD for customers billing at [https://aka.ms/ciambilling](https://aka.ms/ciambilling). */ interface CIAMResourceSKUResponse { /** * The name of the SKU for the tenant. */ name: string; /** * The tier of the tenant. */ tier: string; } /** * These properties are used to create the Azure AD for customers tenant. These properties are not part of the Azure resource. */ interface CreateCIAMTenantPropertiesResponse { /** * Country code of Azure tenant (e.g. 'US'). Refer to [https://aka.ms/ciam-data-location](https://aka.ms/ciam-data-location) to see valid country codes and corresponding data residency locations. If you do not see a country code in an valid data residency location, choose one from the list. */ countryCode: string; /** * The display name of the Azure AD for customers tenant. */ displayName: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace azurearcdata { /** * DNS server details */ interface ActiveDirectoryConnectorDNSDetailsResponse { /** * DNS domain name for which DNS lookups should be forwarded to the Active Directory DNS servers. */ domainName?: string; /** * List of Active Directory DNS server IP addresses. */ nameserverIPAddresses: string[]; /** * Flag indicating whether to prefer Kubernetes DNS server response over AD DNS server response for IP address lookups. */ preferK8sDnsForPtrLookups?: boolean; /** * Replica count for DNS proxy service. Default value is 1. */ replicas?: number; } /** * activeDirectoryConnectorDNSDetailsResponseProvideDefaults sets the appropriate defaults for ActiveDirectoryConnectorDNSDetailsResponse */ function activeDirectoryConnectorDNSDetailsResponseProvideDefaults(val: ActiveDirectoryConnectorDNSDetailsResponse): ActiveDirectoryConnectorDNSDetailsResponse; /** * Active Directory domain details */ interface ActiveDirectoryConnectorDomainDetailsResponse { /** * null */ domainControllers?: outputs.azurearcdata.ActiveDirectoryDomainControllersResponse; /** * NETBIOS name of the Active Directory domain. */ netbiosDomainName?: string; /** * The distinguished name of the Active Directory Organizational Unit. */ ouDistinguishedName?: string; /** * Name (uppercase) of the Active Directory domain that this AD connector will be associated with. */ realm: string; /** * The service account provisioning mode for this Active Directory connector. */ serviceAccountProvisioning?: string; } /** * activeDirectoryConnectorDomainDetailsResponseProvideDefaults sets the appropriate defaults for ActiveDirectoryConnectorDomainDetailsResponse */ function activeDirectoryConnectorDomainDetailsResponseProvideDefaults(val: ActiveDirectoryConnectorDomainDetailsResponse): ActiveDirectoryConnectorDomainDetailsResponse; /** * The properties of an Active Directory connector resource */ interface ActiveDirectoryConnectorPropertiesResponse { /** * Username and password for domain service account authentication. */ domainServiceAccountLoginInformation?: outputs.azurearcdata.BasicLoginInformationResponse; /** * The provisioning state of the Active Directory connector resource. */ provisioningState: string; /** * null */ spec: outputs.azurearcdata.ActiveDirectoryConnectorSpecResponse; /** * null */ status?: outputs.azurearcdata.ActiveDirectoryConnectorStatusResponse; } /** * activeDirectoryConnectorPropertiesResponseProvideDefaults sets the appropriate defaults for ActiveDirectoryConnectorPropertiesResponse */ function activeDirectoryConnectorPropertiesResponseProvideDefaults(val: ActiveDirectoryConnectorPropertiesResponse): ActiveDirectoryConnectorPropertiesResponse; /** * The specifications of the AD Kubernetes resource. */ interface ActiveDirectoryConnectorSpecResponse { /** * null */ activeDirectory: outputs.azurearcdata.ActiveDirectoryConnectorDomainDetailsResponse; /** * null */ dns: outputs.azurearcdata.ActiveDirectoryConnectorDNSDetailsResponse; } /** * activeDirectoryConnectorSpecResponseProvideDefaults sets the appropriate defaults for ActiveDirectoryConnectorSpecResponse */ function activeDirectoryConnectorSpecResponseProvideDefaults(val: ActiveDirectoryConnectorSpecResponse): ActiveDirectoryConnectorSpecResponse; /** * The status of the Kubernetes custom resource. */ interface ActiveDirectoryConnectorStatusResponse { /** * The time that the custom resource was last updated. */ lastUpdateTime?: string; /** * The version of the replicaSet associated with the AD connector custom resource. */ observedGeneration?: number; /** * The state of the AD connector custom resource. */ state?: string; } /** * Information about a domain controller in the AD domain. */ interface ActiveDirectoryDomainControllerResponse { /** * Fully-qualified domain name of a domain controller in the AD domain. */ hostname: string; } /** * Details about the Active Directory domain controllers associated with this AD connector instance */ interface ActiveDirectoryDomainControllersResponse { /** * Information about the Primary Domain Controller (PDC) in the AD domain. */ primaryDomainController?: outputs.azurearcdata.ActiveDirectoryDomainControllerResponse; /** * null */ secondaryDomainControllers?: outputs.azurearcdata.ActiveDirectoryDomainControllerResponse[]; } /** * Authentication related configuration for the SQL Server Instance. */ interface AuthenticationResponse { /** * Mode of authentication in SqlServer. */ mode?: string; /** * Entra Authentication configuration for the SQL Server Instance. */ sqlServerEntraIdentity?: outputs.azurearcdata.EntraAuthenticationResponse[]; } /** * The specifications of the availability group replica configuration */ interface AvailabilityGroupConfigureResponse { /** * Property that determines whether a given availability replica can run in synchronous-commit mode */ availabilityMode?: string; /** * The Availability Synchronization mode of the availability group replica. */ availabilityModeDescription: string; /** * Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group. */ backupPriority?: number; /** * Name of certificate to use for authentication. Required if any CERTIFICATE authentication modes are specified. */ certificateName?: string; /** * Permitted authentication modes for the mirroring endpoint. */ endpointAuthenticationMode?: string; /** * The login which will connect to the mirroring endpoint. */ endpointConnectLogin?: string; /** * Name of the mirroring endpoint URL */ endpointName?: string; /** * Mirroring endpoint URL of availability group replica */ endpointUrl?: string; /** * Property to set the failover mode of the availability group replica */ failoverMode?: string; /** * The failover mode of the availability group replica. */ failoverModeDescription: string; /** * Whether the primary replica should allow all connections or only READ_WRITE connections (disallowing ReadOnly connections) */ primaryAllowConnections?: string; /** * Whether the availability allows all connections or only read-write connections. */ primaryRoleAllowConnectionsDescription: string; /** * Connectivity endpoint (URL) of the read only availability replica. */ readOnlyRoutingUrl?: string; /** * Connectivity endpoint (URL) of the read write availability replica. */ readWriteRoutingUrl?: string; /** * Date that the replica was created. */ replicaCreateDate: string; /** * Date that the replica was modified. */ replicaModifyDate: string; /** * Whether the secondary replica should allow all connections, no connections, or only ReadOnly connections. */ secondaryAllowConnections?: string; /** * Whether an availability replica that is performing the secondary role (that is, a secondary replica) can accept connections from clients. */ secondaryRoleAllowConnectionsDescription: string; /** * Specifies how the secondary replica will be initially seeded. AUTOMATIC enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica. MANUAL specifies manual seeding (default). This method requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica. */ seedingMode?: string; /** * Describes seeding mode. */ seedingModeDescription: string; /** * The time-out period of availability group session replica, in seconds. */ sessionTimeout?: number; } /** * The specifications of the availability group state */ interface AvailabilityGroupInfoResponse { /** * Preferred location for performing backups on the availability databases in this availability group. */ automatedBackupPreferenceDescription: string; /** * Specifies whether this is a basic availability group. */ basicFeatures?: boolean; /** * SQL Server availability group cluster type description */ clusterTypeDescription: string; /** * Specifies whether the availability group supports failover for database health conditions. */ dbFailover?: boolean; /** * Specifies whether DTC support has been enabled for this availability group. */ dtcSupport?: boolean; /** * User-defined failure condition level under which an automatic failover must be triggered. */ failureConditionLevel?: number; /** * Wait time (in milliseconds) for the sp_server_diagnostics system stored procedure to return server-health information, before the server instance is assumed to be slow or not responding. */ healthCheckTimeout?: number; /** * SQL Server availability group contained system databases. */ isContained?: boolean; /** * Specifies whether this is a distributed availability group. */ isDistributed?: boolean; /** * The listener for the sql server availability group */ listener?: outputs.azurearcdata.SqlAvailabilityGroupStaticIPListenerPropertiesResponse; /** * Indicates the recovery health of the primary replica. */ primaryRecoveryHealthDescription: string; /** * Name of the server instance that is hosting the current primary replica. */ primaryReplica: string; replicationPartnerType: string; /** * The number of secondary replicas that must be in a synchronized state for a commit to complete. */ requiredSynchronizedSecondariesToCommit?: number; /** * Indicates the recovery health of a secondary replica. */ secondaryRecoveryHealthDescription: string; /** * Reflects a roll-up of the synchronization health of all availability replicas in the availability group. */ synchronizationHealthDescription: string; /** * SQL Server availability group current version. */ version: number; } /** * The specifications of the availability group state */ interface AvailabilityGroupStateResponse { /** * Current Always On availability groups role of the availability group replica. */ availabilityGroupReplicaRole: string; /** * Whether a secondary replica is currently connected to the primary replica. */ connectedStateDescription: string; /** * Text description of the last connection error of the availability group replica. */ lastConnectErrorDescription: string; /** * Date and time timestamp indicating when the last connect error occurred. */ lastConnectErrorTimestamp: string; /** * Current operational state of the availability group replica */ operationalStateDescription: string; /** * Recovery health of the availability group replica. */ recoveryHealthDescription: string; /** * Reflects a rollup of the database synchronization state (synchronization_state) of all joined availability databases (also known as replicas) and the availability mode of the replica (synchronous-commit or asynchronous-commit mode). The rollup will reflect the least healthy accumulated state the databases on the replica. */ synchronizationHealthDescription: string; } /** * The background job details. */ interface BackgroundJobResponse { /** * The end time of the background job. */ endTime?: string; /** * The execution state of the background job. */ executionState?: string; /** * The last execution status of the background job. */ lastExecutionStatus?: string; /** * The last execution time of the background job. */ lastExecutionTime?: string; /** * The start time of the background job. */ startTime?: string; /** * The state of the background job. */ state?: string; } /** * The backup profile for the SQL server. */ interface BackupPolicyResponse { /** * The differential backup interval in hours. */ differentialBackupHours?: number; /** * The value indicating days between full backups. */ fullBackupDays?: number; /** * The retention period for all the databases in this managed instance. */ retentionPeriodDays?: number; /** * The value indicating minutes between transaction log backups. */ transactionLogBackupMinutes?: number; } /** * Username and password for basic login authentication. */ interface BasicLoginInformationResponse { /** * Login username. */ username?: string; } /** * Client connection related configuration. */ interface ClientConnectionResponse { /** * Indicates if client connection is enabled for this SQL Server instance. */ enabled?: boolean; } /** * Database mirroring endpoint related properties. */ interface DBMEndpointResponse { /** * Name of the certificate. */ certificateName: string; /** * The type of connection authentication required for connections to this endpoint */ connectionAuth: string; /** * Encryption Algorithm */ encryptionAlgorithm: string; /** * Name of the database mirroring endpoint. */ endpointName: string; /** * Listener IP address. */ ipAddress: string; /** * Is the port number dynamically assigned. */ isDynamicPort: boolean; /** * Is Encryption enabled */ isEncryptionEnabled: boolean; /** * The port number that the endpoint is listening on. */ port: number; /** * Mirroring Role */ role: string; } /** * The migration assessment related configuration. */ interface DataBaseMigrationAssessmentResponse { /** * The time when Migration Assessment Report upload was last performed. */ assessmentUploadTime: string; /** * Issues and warnings impacting the migration of Database to particular Azure Migration Target. */ databaseAssessments: outputs.azurearcdata.DataBaseMigrationAssessmentResponseDatabaseAssessments[]; /** * The target readiness for migration for this database. */ targetReadiness: outputs.azurearcdata.TargetReadinessResponse; } interface DataBaseMigrationAssessmentResponseDatabaseAssessments { appliesToMigrationTargetPlatform?: string; featureId?: string; issueCategory?: string; moreInformation?: string; } /** * Migration related configuration. */ interface DataBaseMigrationResponse { /** * Migration assessments related configuration. */ assessment?: outputs.azurearcdata.DataBaseMigrationAssessmentResponse; } /** * The data controller properties. */ interface DataControllerPropertiesResponse { /** * Deprecated. Azure Arc Data Services data controller no longer expose any endpoint. All traffic are exposed through Kubernetes native API. */ basicLoginInformation?: outputs.azurearcdata.BasicLoginInformationResponse; /** * If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. */ clusterId?: string; /** * If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. */ extensionId?: string; /** * The infrastructure the data controller is running on. */ infrastructure?: string; /** * The raw kubernetes information */ k8sRaw?: any; /** * Last uploaded date from Kubernetes cluster. Defaults to current date time */ lastUploadedDate?: string; /** * Log analytics workspace id and primary key */ logAnalyticsWorkspaceConfig?: outputs.azurearcdata.LogAnalyticsWorkspaceConfigResponse; /** * Login credential for logs dashboard on the Kubernetes cluster. */ logsDashboardCredential?: outputs.azurearcdata.BasicLoginInformationResponse; /** * Login credential for metrics dashboard on the Kubernetes cluster. */ metricsDashboardCredential?: outputs.azurearcdata.BasicLoginInformationResponse; /** * Properties from the Kubernetes data controller */ onPremiseProperty?: outputs.azurearcdata.OnPremisePropertyResponse; /** * The provisioning state of the Arc Data Controller resource. */ provisioningState: string; /** * Deprecated. Service principal is deprecated in favor of Arc Kubernetes service extension managed identity. */ uploadServicePrincipal?: outputs.azurearcdata.UploadServicePrincipalResponse; /** * Properties on upload watermark. Mostly timestamp for each upload data type */ uploadWatermark?: outputs.azurearcdata.UploadWatermarkResponse; } /** * dataControllerPropertiesResponseProvideDefaults sets the appropriate defaults for DataControllerPropertiesResponse */ function dataControllerPropertiesResponseProvideDefaults(val: DataControllerPropertiesResponse): DataControllerPropertiesResponse; /** * Entra Authentication configuration. */ interface EntraAuthenticationResponse { /** * The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity. */ clientId?: string; /** * The method used for Entra authentication */ identityType?: string; } /** * The complex type of the extended location. */ interface ExtendedLocationResponse { /** * The name of the extended location. */ name?: string; /** * The type of the extended location. */ type?: string; } /** * Failover Cluster Instance properties. */ interface FailoverClusterResponse { /** * The IP addresses and subnet masks associated with the SQL Failover Cluster Instance on this host. */ hostIPAddresses: outputs.azurearcdata.HostIPAddressInformationResponse[]; /** * The host names which are part of the SQL FCI resource group. */ hostNames: string[]; /** * The GUID of the SQL Server's underlying Failover Cluster. */ id: string; /** * The network name to connect to the SQL FCI. */ networkName: string; /** * The ARM IDs of the Arc SQL Server resources, belonging to the current server's Failover cluster. */ sqlInstanceIds: string[]; } /** * The properties of a failover group resource. */ interface FailoverGroupPropertiesResponse { /** * The resource ID of the partner SQL managed instance. */ partnerManagedInstanceId: string; /** * The provisioning state of the failover group resource. */ provisioningState: string; /** * The specifications of the failover group resource. */ spec: outputs.azurearcdata.FailoverGroupSpecResponse; /** * The status of the failover group custom resource. */ status?: any; } /** * failoverGroupPropertiesResponseProvideDefaults sets the appropriate defaults for FailoverGroupPropertiesResponse */ function failoverGroupPropertiesResponseProvideDefaults(val: FailoverGroupPropertiesResponse): FailoverGroupPropertiesResponse; /** * The specifications of the failover group resource. */ interface FailoverGroupSpecResponse { /** * The name of the partner SQL managed instance. */ partnerMI?: string; /** * The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported. */ partnerMirroringCert?: string; /** * The mirroring endpoint URL of the partner SQL managed instance. */ partnerMirroringURL?: string; /** * The partner sync mode of the SQL managed instance. */ partnerSyncMode?: string; /** * The role of the SQL managed instance in this failover group. */ role: string; /** * The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name. */ sharedName?: string; /** * The name of the SQL managed instance with this failover group role. */ sourceMI?: string; } /** * failoverGroupSpecResponseProvideDefaults sets the appropriate defaults for FailoverGroupSpecResponse */ function failoverGroupSpecResponseProvideDefaults(val: FailoverGroupSpecResponse): FailoverGroupSpecResponse; /** * IP address and subnet mask. */ interface HostIPAddressInformationResponse { /** * IP address */ ipAddress: string; /** * Subnet mask */ subnetMask: string; } /** * The kubernetes active directory information. */ interface K8sActiveDirectoryResponse { /** * Account name for AAD */ accountName?: string; connector?: outputs.azurearcdata.K8sActiveDirectoryResponseConnector; /** * An array of encryption types */ encryptionTypes?: string[]; /** * Keytab secret used to authenticate with Active Directory. */ keytabSecret?: string; } interface K8sActiveDirectoryResponseConnector { /** * Name of the connector */ name?: string; /** * Name space of the connector */ namespace?: string; } /** * The kubernetes network settings information. */ interface K8sNetworkSettingsResponse { /** * If 1, then SQL Server forces all connections to be encrypted. By default, this option is 0 */ forceencryption?: number; /** * Specifies which ciphers are allowed by SQL Server for TLS */ tlsciphers?: string; /** * A comma-separated list of which TLS protocols are allowed by SQL Server */ tlsprotocols?: string; } /** * The kubernetes resource limits and requests used to restrict or reserve resource usage. */ interface K8sResourceRequirementsResponse { /** * Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. */ limits?: { [key: string]: string; }; /** * Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'. */ requests?: { [key: string]: string; }; } /** * The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service */ interface K8sSchedulingOptionsResponse { /** * The kubernetes resource limits and requests used to restrict or reserve resource usage. */ resources?: outputs.azurearcdata.K8sResourceRequirementsResponse; } /** * The kubernetes scheduling information. */ interface K8sSchedulingResponse { /** * The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service */ default?: outputs.azurearcdata.K8sSchedulingOptionsResponse; } /** * The kubernetes security information. */ interface K8sSecurityResponse { /** * The kubernetes active directory information. */ activeDirectory?: outputs.azurearcdata.K8sActiveDirectoryResponse; /** * Admin login secret key */ adminLoginSecret?: string; /** * Service certificate secret used */ serviceCertificateSecret?: string; /** * Transparent data encryption information. */ transparentDataEncryption?: outputs.azurearcdata.K8stransparentDataEncryptionResponse; } /** * The kubernetes settings information. */ interface K8sSettingsResponse { /** * The kubernetes network settings information. */ network?: outputs.azurearcdata.K8sNetworkSettingsResponse; } /** * Transparent data encryption information. */ interface K8stransparentDataEncryptionResponse { /** * Transparent data encryption mode. Can be Service Managed, Customer managed or disabled */ mode?: string; /** * Protector secret for customer managed Transparent data encryption mode */ protectorSecret?: string; } /** * Log analytics workspace id and primary key */ interface LogAnalyticsWorkspaceConfigResponse { /** * Azure Log Analytics workspace ID */ workspaceId?: string; } /** * The migration assessment related configuration. */ interface MigrationAssessmentResponse { /** * The time when Migration Assessment Report upload was last performed. */ assessmentUploadTime: string; /** * Indicates if migration assessment is enabled for this SQL Server instance. */ enabled?: boolean; /** * Issues and warnings impacting the migration of SQL Server instance to particular Azure Migration Target. */ serverAssessments: outputs.azurearcdata.MigrationAssessmentResponseServerAssessments[]; /** * SKU Recommendation results for Azure migration targets for SQL Server. */ skuRecommendationResults: outputs.azurearcdata.SkuRecommendationResultsResponse; } interface MigrationAssessmentResponseImpactedObjects { impactDetail?: string; name?: string; objectType?: string; } interface MigrationAssessmentResponseServerAssessments { appliesToMigrationTargetPlatform?: string; featureId?: string; impactedObjects?: outputs.azurearcdata.MigrationAssessmentResponseImpactedObjects[]; issueCategory?: string; moreInformation?: string; } /** * Migration related configuration. */ interface MigrationResponse { /** * Migration assessments related configuration. */ assessment?: outputs.azurearcdata.MigrationAssessmentResponse; } /** * The monitoring configuration. */ interface MonitoringResponse { /** * Indicates if monitoring is enabled for this SQL Server instance. */ enabled?: boolean; } /** * Properties from the Kubernetes data controller */ interface OnPremisePropertyResponse { /** * A globally unique ID identifying the associated Kubernetes cluster */ id: string; /** * Certificate that contains the Kubernetes cluster public key used to verify signing */ publicSigningKey: string; /** * Unique thumbprint returned to customer to verify the certificate being uploaded */ signingCertificateThumbprint?: string; } /** * Postgres Instance properties. */ interface PostgresInstancePropertiesResponse { /** * The instance admin */ admin?: string; /** * Username and password for basic authentication. */ basicLoginInformation?: outputs.azurearcdata.BasicLoginInformationResponse; /** * The data controller id */ dataControllerId?: string; /** * The raw kubernetes information */ k8sRaw?: any; /** * Last uploaded date from Kubernetes cluster. Defaults to current date time */ lastUploadedDate?: string; /** * The provisioning state of the Azure Arc-enabled PostgreSQL instance. */ provisioningState: string; } /** * The resource model definition representing SKU for Azure Database for PostgresSQL - Azure Arc */ interface PostgresInstanceSkuResponse { /** * If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. */ capacity?: number; /** * Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. */ dev?: boolean; /** * If the service has different generations of hardware, for the same SKU, then that can be captured here. */ family?: string; /** * The name of the SKU. It is typically a letter+number code */ name: string; /** * The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. */ size?: string; /** * This field is required to be implemented by the Resource Provider if the service has more than one tier. */ tier?: string; } /** * postgresInstanceSkuResponseProvideDefaults sets the appropriate defaults for PostgresInstanceSkuResponse */ function postgresInstanceSkuResponseProvideDefaults(val: PostgresInstanceSkuResponse): PostgresInstanceSkuResponse; /** * The sequencer action details. */ interface SequencerActionResponse { /** * The unique identifier of the sequencer action. */ actionId?: string; /** * The result of the sequencer action. */ result?: string; /** * The state of the sequencer action. */ state?: string; } /** * SKU Recommendation results for Azure SQL Database. */ interface SkuRecommendationResultsAzureSqlDatabaseResponse { /** * The Monthly cost of the particular SKU. */ monthlyCost?: outputs.azurearcdata.SkuRecommendationResultsMonthlyCostResponse; /** * Number of blocker issues to fix before migrating to the target platform. */ numberOfServerBlockerIssues?: number; /** * The target recommendation Status for this database. */ recommendationStatus?: string; targetSku?: outputs.azurearcdata.SkuRecommendationResultsAzureSqlDatabaseResponseTargetSku; } interface SkuRecommendationResultsAzureSqlDatabaseResponseCategory { /** * The compute tier of the target SKU. */ computeTier?: string; /** * The hardware type of the target SKU. */ hardwareType?: string; /** * The SQL purchasing model of the target SKU. */ sqlPurchasingModel?: string; /** * The SQL service tier of the target SKU. */ sqlServiceTier?: string; /** * Indicates if zone redundancy is available for the target SKU. */ zoneRedundancyAvailable?: boolean; } interface SkuRecommendationResultsAzureSqlDatabaseResponseTargetSku { category?: outputs.azurearcdata.SkuRecommendationResultsAzureSqlDatabaseResponseCategory; } /** * SKU Recommendation results for Azure SQL Managed Instance. */ interface SkuRecommendationResultsAzureSqlManagedInstanceResponse { /** * The Monthly cost of the particular SKU. */ monthlyCost?: outputs.azurearcdata.SkuRecommendationResultsMonthlyCostResponse; /** * Number of blocker issues to fix before migrating to the target platform. */ numberOfServerBlockerIssues?: number; /** * The target recommendation Status for this database. */ recommendationStatus?: string; targetSku?: outputs.azurearcdata.SkuRecommendationResultsAzureSqlManagedInstanceResponseTargetSku; } interface SkuRecommendationResultsAzureSqlManagedInstanceResponseCategory { /** * The compute tier of the target SKU. */ computeTier?: string; /** * The hardware type of the target SKU. */ hardwareType?: string; /** * The SQL purchasing model of the target SKU. */ sqlPurchasingModel?: string; /** * The SQL service tier of the target SKU. */ sqlServiceTier?: string; /** * Indicates if zone redundancy is available for the target SKU. */ zoneRedundancyAvailable?: boolean; } interface SkuRecommendationResultsAzureSqlManagedInstanceResponseTargetSku { category?: outputs.azurearcdata.SkuRecommendationResultsAzureSqlManagedInstanceResponseCategory; } /** * SKU Recommendation results for Azure SQL Virtual Machine. */ interface SkuRecommendationResultsAzureSqlVirtualMachineResponse { /** * The Monthly cost of the particular SKU. */ monthlyCost?: outputs.azurearcdata.SkuRecommendationResultsMonthlyCostResponse; /** * Number of blocker issues to fix before migrating to the target platform. */ numberOfServerBlockerIssues?: number; /** * The target recommendation Status for this database. */ recommendationStatus?: string; targetSku?: outputs.azurearcdata.SkuRecommendationResultsAzureSqlVirtualMachineResponseTargetSku; } interface SkuRecommendationResultsAzureSqlVirtualMachineResponseCategory { /** * Available VM SKUs for the Azure SQL Virtual Machine. */ availableVmSkus?: string[]; /** * The virtual machine family of the target SKU. */ virtualMachineFamily?: string; } interface SkuRecommendationResultsAzureSqlVirtualMachineResponseTargetSku { category?: outputs.azurearcdata.SkuRecommendationResultsAzureSqlVirtualMachineResponseCategory; } /** * The Monthly cost of the particular SKU. */ interface SkuRecommendationResultsMonthlyCostResponse { /** * Represents the Cost of Compute. */ computeCost?: number; /** * Represents the Cost of Storage. */ storageCost?: number; /** * Represents the Total Cost. */ totalCost?: number; } /** * SKU Recommendation results for Azure migration targets for SQL Server. */ interface SkuRecommendationResultsResponse { /** * SKU Recommendation results for Azure SQL Database. */ azureSqlDatabase?: outputs.azurearcdata.SkuRecommendationResultsAzureSqlDatabaseResponse; /** * SKU Recommendation results for Azure SQL Managed Instance. */ azureSqlManagedInstance?: outputs.azurearcdata.SkuRecommendationResultsAzureSqlManagedInstanceResponse; /** * SKU Recommendation results for Azure SQL Virtual Machine. */ azureSqlVirtualMachine?: outputs.azurearcdata.SkuRecommendationResultsAzureSqlVirtualMachineResponse; } /** * The SKU recommendation summary. */ interface SkuRecommendationSummaryResponse { /** * Number of blocker issues to fix before migrating this database to the target platform. */ numOfBlockerIssues?: number; /** * The target recommendation Status for this database. */ recommendationStatus?: string; } /** * The properties of Arc Sql availability group database replica resource */ interface SqlAvailabilityGroupDatabaseReplicaResourcePropertiesResponse { /** * the database name. */ databaseName?: string; /** * Description of the database state of the availability replica. */ databaseStateDescription: string; /** * Whether this replica is transaction committer. */ isCommitParticipant: boolean; /** * Whether the availability database is local. */ isLocal: boolean; /** * Returns 1 if the replica is primary, or 0 if it is a secondary replica. */ isPrimaryReplica: boolean; /** * Whether this data movement is suspended. */ isSuspended: boolean; /** * the database replica name. */ replicaName: string; /** * Description of the database suspended state reason. */ suspendReasonDescription: string; /** * Description of the health of database. */ synchronizationHealthDescription: string; /** * Description of the data-movement state. */ synchronizationStateDescription: string; } /** * The properties of Arc Sql availability group replica resource */ interface SqlAvailabilityGroupReplicaResourcePropertiesResponse { /** * null */ configure?: outputs.azurearcdata.AvailabilityGroupConfigureResponse; /** * ID GUID of the availability group. */ replicaId: string; /** * The replica name. */ replicaName?: string; /** * Resource id of this replica. This is required for a distributed availability group, in which case it describes the location of the availability group that hosts one replica in the DAG. In a non-distributed availability group this field is optional but can be used to store the Azure resource id for AG. */ replicaResourceId?: string; /** * null */ state?: outputs.azurearcdata.AvailabilityGroupStateResponse; } /** * The properties of a static IP Arc Sql availability group listener */ interface SqlAvailabilityGroupStaticIPListenerPropertiesResponse { /** * the DNS name for the listener. */ dnsName?: string; /** * IP V4 Addresses and masks for the listener. */ ipV4AddressesAndMasks?: outputs.azurearcdata.SqlAvailabilityGroupStaticIPListenerPropertiesResponseIpV4AddressesAndMasks[]; /** * IP V6 Addresses for the listener */ ipV6Addresses?: string[]; /** * Network port for the listener. Default is 1433. */ port?: number; } interface SqlAvailabilityGroupStaticIPListenerPropertiesResponseIpV4AddressesAndMasks { /** * IPV4 address */ ipAddress?: string; /** * IPV4 netmask */ mask?: string; } /** * The raw kubernetes information. */ interface SqlManagedInstanceK8sRawResponse { /** * The kubernetes spec information. */ spec?: outputs.azurearcdata.SqlManagedInstanceK8sSpecResponse; } /** * The kubernetes spec information. */ interface SqlManagedInstanceK8sSpecResponse { /** * This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'. */ replicas?: number; /** * The kubernetes scheduling information. */ scheduling?: outputs.azurearcdata.K8sSchedulingResponse; /** * The kubernetes security information. */ security?: outputs.azurearcdata.K8sSecurityResponse; /** * The kubernetes settings information. */ settings?: outputs.azurearcdata.K8sSettingsResponse; } /** * Properties of sqlManagedInstance. */ interface SqlManagedInstancePropertiesResponse { /** * The instance admin user */ admin?: string; /** * Username and password for basic authentication. */ basicLoginInformation?: outputs.azurearcdata.BasicLoginInformationResponse; /** * If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to. */ clusterId?: string; /** * null */ dataControllerId?: string; /** * The instance end time */ endTime?: string; /** * If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to. */ extensionId?: string; /** * The raw kubernetes information */ k8sRaw?: outputs.azurearcdata.SqlManagedInstanceK8sRawResponse; /** * Last uploaded date from Kubernetes cluster. Defaults to current date time */ lastUploadedDate?: string; /** * The license type to apply for this managed instance. */ licenseType?: string; /** * The provisioning state of the Arc-enabled SQL Managed Instance resource. */ provisioningState: string; /** * The instance start time */ startTime?: string; } /** * sqlManagedInstancePropertiesResponseProvideDefaults sets the appropriate defaults for SqlManagedInstancePropertiesResponse */ function sqlManagedInstancePropertiesResponseProvideDefaults(val: SqlManagedInstancePropertiesResponse): SqlManagedInstancePropertiesResponse; /** * The resource model definition representing SKU for Azure Managed Instance - Azure Arc */ interface SqlManagedInstanceSkuResponse { /** * The SKU capacity */ capacity?: number; /** * Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. */ dev?: boolean; /** * The SKU family */ family?: string; /** * The name of the SKU. */ name: string; /** * The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. */ size?: string; /** * The pricing tier for the instance. */ tier?: string; } /** * sqlManagedInstanceSkuResponseProvideDefaults sets the appropriate defaults for SqlManagedInstanceSkuResponse */ function sqlManagedInstanceSkuResponseProvideDefaults(val: SqlManagedInstanceSkuResponse): SqlManagedInstanceSkuResponse; /** * The properties of Arc Sql Server availability group resource */ interface SqlServerAvailabilityGroupResourcePropertiesResponse { /** * ID GUID of the availability group. */ availabilityGroupId: string; /** * Timestamp for when the data was collected from the client machine. */ collectionTimestamp: string; /** * A list of Availability Group Database Replicas. */ databases?: outputs.azurearcdata.SqlServerAvailabilityGroupResourcePropertiesResponseDatabases; /** * Availability Group Info */ info?: outputs.azurearcdata.AvailabilityGroupInfoResponse; /** * the SQL Server Instance name. */ instanceName: string; /** * The provisioning state of the Arc-enabled SQL Server availability group resource. */ provisioningState: string; /** * A list of Availability Group Replicas. */ replicas?: outputs.azurearcdata.SqlServerAvailabilityGroupResourcePropertiesResponseReplicas; /** * the SQL server name. */ serverName: string; /** * The unique ID of the hybrid machine that this resource belongs to. */ vmId: string; } /** * A list of Availability Group Database Replicas. */ interface SqlServerAvailabilityGroupResourcePropertiesResponseDatabases { /** * Link to retrieve next page of results. */ nextLink: string; /** * Array of Availability Group Database Replicas. */ value?: outputs.azurearcdata.SqlAvailabilityGroupDatabaseReplicaResourcePropertiesResponse[]; } /** * A list of Availability Group Replicas. */ interface SqlServerAvailabilityGroupResourcePropertiesResponseReplicas { /** * Link to retrieve next page of results. */ nextLink: string; /** * Array of Availability Group Replicas. */ value?: outputs.azurearcdata.SqlAvailabilityGroupReplicaResourcePropertiesResponse[]; } /** * The properties of Arc Sql Server database resource */ interface SqlServerDatabaseResourcePropertiesResponse { backupInformation?: outputs.azurearcdata.SqlServerDatabaseResourcePropertiesResponseBackupInformation; /** * The backup profile for the SQL server. */ backupPolicy?: outputs.azurearcdata.BackupPolicyResponse; /** * Collation of the database. */ collationName?: string; /** * Compatibility level of the database */ compatibilityLevel?: number; /** * Database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. sourceDatabaseId and restorePointInTime must be specified. */ createMode?: string; /** * Total size in MB for the data (mdf and ndf) files for this database. */ dataFileSizeMB?: number; /** * Creation date of the database. */ databaseCreationDate?: string; /** * List of features that are enabled for the database */ databaseOptions?: outputs.azurearcdata.SqlServerDatabaseResourcePropertiesResponseDatabaseOptions; /** * This records the earliest start date and time that restore is available for this database (ISO8601 format). */ earliestRestoreDate: string; /** * Whether the database is read only or not. */ isReadOnly?: boolean; /** * The time when last successful database upload was performed. */ lastDatabaseUploadTime: string; /** * Total size in MB for the log (ldf) files for this database. */ logFileSizeMB?: number; /** * Migration related configuration. */ migration?: outputs.azurearcdata.DataBaseMigrationResponse; /** * The provisioning state of the Arc-enabled SQL Server database resource. */ provisioningState: string; /** * Status of the database. */ recoveryMode?: string; /** * Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database. */ restorePointInTime?: string; /** * Size of the database. */ sizeMB?: number; /** * The name of the source database associated with create operation of this database. */ sourceDatabaseId?: string; /** * Space left of the database. */ spaceAvailableMB?: number; /** * State of the database. */ state?: string; /** * The unique ID of the hybrid machine that this resource belongs to. */ vmId: string; } interface SqlServerDatabaseResourcePropertiesResponseBackupInformation { /** * Date time of last full backup. */ lastFullBackup?: string; /** * Date time of last log backup. */ lastLogBackup?: string; } /** * List of features that are enabled for the database */ interface SqlServerDatabaseResourcePropertiesResponseDatabaseOptions { isAutoCloseOn?: boolean; isAutoCreateStatsOn?: boolean; isAutoShrinkOn?: boolean; isAutoUpdateStatsOn?: boolean; isEncrypted?: boolean; isMemoryOptimizationEnabled?: boolean; isRemoteDataArchiveEnabled?: boolean; isTrustworthyOn?: boolean; } /** * Properties of SQL Server ESU license. */ interface SqlServerEsuLicensePropertiesResponse { /** * The timestamp of the activation of the SqlServerEsuLicense in ISO 8601 date-time format. */ activatedAt: string; /** * The activation state of the license. */ activationState: string; /** * SQL Server ESU license type. */ billingPlan: string; /** * The number of total cores of the license covers. */ physicalCores: number; /** * The Azure scope to which the license will apply. */ scopeType: string; /** * The tenantId the SQL Server ESU license resource subscription resides in. */ tenantId: string; /** * The timestamp of the termination of the SqlServerEsuLicense in ISO 8601 date-time format. */ terminatedAt: string; /** * The unique ID of this license. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). */ uniqueId: string; /** * The SQL Server version the license covers. */ version: string; } /** * The status of the job running on the SQL Server instance. */ interface SqlServerInstanceJobStatusResponse { /** * The background job details. */ backgroundJob?: outputs.azurearcdata.BackgroundJobResponse; /** * The unique identifier of the job. */ id?: string; /** * The name of the SQL Server instance. */ instanceName?: string; /** * The exception message if the job failed. */ jobException?: string; /** * The status of the job. */ jobStatus?: string; /** * The list of sequencer actions. */ sequencerActions?: outputs.azurearcdata.SequencerActionResponse[]; } /** * Properties of SqlServerInstance. */ interface SqlServerInstancePropertiesResponse { /** * The role of the SQL Server, based on availability. */ alwaysOnRole: string; /** * Authentication related configuration for the SQL Server Instance. */ authentication?: outputs.azurearcdata.AuthenticationResponse; /** * Status of Azure Defender. */ azureDefenderStatus: string; /** * Timestamp of last Azure Defender status update. */ azureDefenderStatusLastUpdated: string; /** * The backup profile for the SQL server. */ backupPolicy?: outputs.azurearcdata.BackupPolicyResponse; /** * Client connection related configuration. */ clientConnection?: outputs.azurearcdata.ClientConnectionResponse; /** * SQL Server collation. */ collation: string; /** * ARM Resource id of the container resource (Azure Arc for Servers). */ containerResourceId: string; /** * The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance. */ cores?: string; /** * The time when the resource was created. */ createTime: string; /** * SQL Server current version. */ currentVersion: string; /** * Database mirroring endpoint related properties. */ databaseMirroringEndpoint?: outputs.azurearcdata.DBMEndpointResponse; /** * Indicates whether database master key exists in SQL Server. */ dbMasterKeyExists: boolean; /** * SQL Server edition. */ edition?: string; /** * Failover Cluster Instance properties. */ failoverCluster?: outputs.azurearcdata.FailoverClusterResponse; /** * Type of host for Azure Arc SQL Server */ hostType?: string; /** * SQL Server instance name. */ instanceName?: string; /** * Indicates whether DigiCert PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. */ isDigiCertPkiCertTrustConfigured: boolean; /** * Indicates whether always On availability groups is enabled in SQL Server. */ isHadrEnabled: boolean; /** * Indicates whether Microsoft PKI root-authority certificate (trusted by Azure) exists in SQL Server and trusted for Azure database.windows.net domains. */ isMicrosoftPkiCertTrustConfigured: boolean; /** * The time when last successful inventory upload was performed. */ lastInventoryUploadTime: string; /** * The time when last successful usage upload was performed. */ lastUsageUploadTime: string; /** * SQL Server license type. */ licenseType: string; /** * max server memory (MB) value configured for this instance. */ maxServerMemoryMB: number; /** * Migration related configuration. */ migration?: outputs.azurearcdata.MigrationResponse; /** * The monitoring configuration. */ monitoring?: outputs.azurearcdata.MonitoringResponse; /** * SQL Server update level. */ patchLevel: string; /** * SQL Server product ID. */ productId: string; /** * The provisioning state of the Arc-enabled SQL Server resource. */ provisioningState: string; /** * Indicates if the resource represents a SQL Server engine or a SQL Server component service installed on the host. */ serviceType?: string; /** * The cloud connectivity status. */ status: string; /** * Dynamic TCP ports used by SQL Server. */ tcpDynamicPorts: string; /** * Static TCP ports used by SQL Server. */ tcpStaticPorts: string; /** * An array of integers, where each value represents the enabled trace flags in SQL Server. */ traceFlags: number[]; /** * Upgrade Action for this resource is locked until it expires. The Expiration time indicated by this value. It is not locked when it is empty. */ upgradeLockedUntil?: string; /** * The number of logical processors used by the SQL Server instance. */ vCore: string; /** * SQL Server version. */ version?: string; /** * The unique ID of the hybrid machine that this resource belongs to. */ vmId: string; } /** * The telemetry column for the SQL Server instance. */ interface SqlServerInstanceTelemetryColumnResponse { /** * The name of the telemetry column. */ name?: string; /** * The type of the telemetry column. */ type?: string; } /** * Properties of SQL Server License. */ interface SqlServerLicensePropertiesResponse { /** * The activation state of the license. */ activationState: string; /** * SQL Server license type. */ billingPlan: string; /** * The timestamp of the most recent activation of the SqlServerLicense. */ lastActivatedAt: string; /** * The timestamp of the most recent deactivation of the SqlServerLicense. */ lastDeactivatedAt: string; /** * This property represents the choice between SQL Server Core and ESU licenses. */ licenseCategory: string; /** * The number of total cores of the license covers. */ physicalCores: number; /** * The Azure scope to which the license will apply. */ scopeType: string; /** * The tenantId the SQL Server license resource subscription resides in. */ tenantId: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The target readiness for migration for this database. */ interface TargetReadinessResponse { /** * The SKU recommendation summary. */ azureSqlDatabase?: outputs.azurearcdata.SkuRecommendationSummaryResponse; /** * The SKU recommendation summary. */ azureSqlManagedInstance?: outputs.azurearcdata.SkuRecommendationSummaryResponse; /** * The SKU recommendation summary. */ azureSqlVirtualMachine?: outputs.azurearcdata.SkuRecommendationSummaryResponse; } /** * Service principal for uploading billing, metrics and logs. */ interface UploadServicePrincipalResponse { /** * Authority for the service principal. Example: https://login.microsoftonline.com/ */ authority?: string; /** * Client ID of the service principal for uploading data. */ clientId?: string; /** * Tenant ID of the service principal. */ tenantId?: string; } /** * Properties on upload watermark. Mostly timestamp for each upload data type */ interface UploadWatermarkResponse { /** * Last uploaded date for logs from kubernetes cluster. Defaults to current date time */ logs?: string; /** * Last uploaded date for metrics from kubernetes cluster. Defaults to current date time */ metrics?: string; /** * Last uploaded date for usages from kubernetes cluster. Defaults to current date time */ usages?: string; } } export declare namespace azuredata { /** * Read only system data */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC) */ createdAt?: string; /** * An identifier for the identity that created the resource */ createdBy?: string; /** * The type of identity that created the resource */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * An identifier for the identity that last modified the resource */ lastModifiedBy?: string; /** * The type of identity that last modified the resource */ lastModifiedByType?: string; } } export declare namespace azuredatatransfer { /** * Antivirus scanning rules for replicating data. By default, all antivirus scanning solutions are disabled. */ interface AntivirusRulesetResponse { /** * Optional. The list of antiviruses to be used as a scanning solution for replicating data. */ avSolutions?: string[]; } /** * Properties specific to API Flow Type */ interface ApiFlowOptionsResponse { /** * Remote Calling Mode in the Azure Data Transfer API Flow, which describes how the API Flow will be invoked */ apiMode?: string; /** * Optional field to override the audience of the remote endpoint. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. */ audienceOverride?: string; /** * Unique CNAME to represent the Azure Data Transfer API Flow instance */ cname?: string; /** * Determines which identity to use for extracting the user token for Azure Data Transfer API Flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. */ identityTranslation?: string; /** * Remote stub app registration Client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. */ remoteCallingModeClientId?: string; /** * Remote host to which communication needs to be made. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the remoteEndpointSettings.endpoint property instead. */ remoteEndpoint?: string; /** * Sender's app user assigned Manage Identity client ID. The property has reached end of life support starting version 2025-05-30-preview. Please create and use the authentication property instead. */ senderClientId?: string; } /** * Rules for regulating supported archive files (BZip2, Cpio, Deb, GZip, Rpm, Tar, Zip) during data replication. All properties are optional and only the configured options will be applied against archives. As an example, suppose minimumSizeForExpansion is 10 MiB and maximumExpansionSizeLimit is 1 GiB. Then all archives smaller than 10 MiB will be treated as though the archive ruleset is disabled, although other rulesets will apply as usual. Furthermore, all archives at least 10 MiB in size but with a decompressed size greater than 1 GiB will fail the ruleset. All other archives will have their contents extracted and each extracted element will be applied to all rulesets. */ interface ArchiveRulesetResponse { /** * Optional. Provides the multiplication value for an archive in total based on the initial object being validated. This value takes the root object size and multiplies it by this value to create a maximum. Once this maximum is exceeded, the archive is failed. Used to detect and block archives with suspiciously high compression (e.g., zip bombs). */ maximumCompressionRatioLimit?: number; /** * Optional. The maximum depth of nested archives that can be expanded. Limits how many layers of embedded archives will be processed. Archives exceeding the max limit will be denied for replication. */ maximumDepthLimit?: number; /** * Optional. The combined maximum size (in bytes) of all extracted files that an expanded archive is allowed to reach. Archives exceeding the max limit will be denied for replication. */ maximumExpansionSizeLimit?: number; /** * Optional. Default is 0. The minimum archive file size (in bytes) required to trigger expansion during replication. Any archive file size below the configured threshold will skip the rest of the configured rulesets for archives. */ minimumSizeForExpansion?: number; } /** * archiveRulesetResponseProvideDefaults sets the appropriate defaults for ArchiveRulesetResponse */ function archiveRulesetResponseProvideDefaults(val: ArchiveRulesetResponse): ArchiveRulesetResponse; /** * Properties of connection */ interface ConnectionPropertiesResponse { /** * Approver of this connection request */ approver: string; /** * The timestamp that this connection request was submitted at */ dateSubmitted: string; /** * Direction of data movement */ direction?: string; /** * The flow types being requested for this connection */ flowTypes?: string[]; /** * Justification for the connection request */ justification?: string; /** * Link status of the current connection */ linkStatus: string; /** * Resource ID of the linked connection */ linkedConnectionId: string; /** * PIN to link requests together */ pin?: string; /** * Pipeline to use to transfer data */ pipeline: string; /** * The policies for this connection */ policies?: string[]; /** * The primary contact for this connection request */ primaryContact?: string; /** * Provisioning state of the connection */ provisioningState: string; /** * Subscription ID to link cloud subscriptions together */ remoteSubscriptionId?: string; /** * Requirement ID of the connection */ requirementId?: string; /** * The schema URIs for this connection */ schemaUris?: string[]; /** * The schemas for this connection */ schemas?: outputs.azuredatatransfer.SchemaResponse[]; /** * The secondary contacts for this connection request */ secondaryContacts?: string[]; /** * Status of the connection */ status: string; /** * Reason for status */ statusReason: string; } /** * Defines rules that enforce minimum and maximum file size limits for data replication. */ interface DataSizeRulesetResponse { /** * Optional. Specifies the maximum allowed size (in bytes) for files to be replicated. Any file size greater than maximum will be denied replication. */ maximum?: number; /** * Optional. Default is 0. Specifies the minimum required size (in bytes) for a file to be eligible for replication. Any file size less than minimum will be denied replication. */ minimum?: number; } /** * dataSizeRulesetResponseProvideDefaults sets the appropriate defaults for DataSizeRulesetResponse */ function dataSizeRulesetResponseProvideDefaults(val: DataSizeRulesetResponse): DataSizeRulesetResponse; /** * The FlowProfile Metadata used to concisely provide all publicly viewable information. */ interface FlowProfileMetadataResponse { /** * A description of the FlowProfile and its rulesets. The description should describe the flowprofile's purpose and rulesets applied. */ description: string; /** * A guid represented as a string for the FlowProfile resource, assigned by the system. */ flowProfileId: string; /** * The name of the FlowProfile. */ name: string; /** * The name of the parent Pipeline Azure resource associated with this FlowProfile. */ pipeline: string; /** * The data replication scenario handled by this FlowProfile. Please note, that this value cannot be updated after creation. See the FlowProfilePatchProperties to see updateable properties. */ replicationScenario: string; /** * The operational status of the FlowProfile. */ status: string; } /** * Defines the full set of properties for a FlowProfile resource. */ interface FlowProfilePropertiesResponse { /** * A user-defined description of the FlowProfile. */ description: string; /** * A guid represented as a string for the FlowProfile resource, assigned by the system. */ flowProfileId: string; /** * The current provisioning state of the FlowProfile. */ provisioningState: string; /** * The data replication scenario handled by this FlowProfile. Please not, that this value cannot be updated after creation. */ replicationScenario: string; /** * A set of configurable rulesets applied to this FlowProfile. */ rulesets?: outputs.azuredatatransfer.FlowProfileRulesetsResponse; /** * The operational status of the FlowProfile. */ status: string; } /** * flowProfilePropertiesResponseProvideDefaults sets the appropriate defaults for FlowProfilePropertiesResponse */ function flowProfilePropertiesResponseProvideDefaults(val: FlowProfilePropertiesResponse): FlowProfilePropertiesResponse; /** * The allowed set of configurable rulesets for a FlowProfile resource, used during data replication. All rulesets are optional, and any ruleset configured will be applied to every applicable replicating data. Any data that fails a ruleset will be denied replication. If a ruleset is not configured then the ruleset is considered disabled and will not apply towards replicating data. */ interface FlowProfileRulesetsResponse { /** * Antivirus scanning rules for replicated data. */ antivirus?: outputs.azuredatatransfer.AntivirusRulesetResponse; /** * Rules for handling archive files during replication. */ archives?: outputs.azuredatatransfer.ArchiveRulesetResponse; /** * Rules that enforce minimum and maximum data size limits. */ dataSize?: outputs.azuredatatransfer.DataSizeRulesetResponse; /** * Rules for filtering files based on MIME types. */ mimeFilters?: outputs.azuredatatransfer.MimeFilterRulesetResponse; /** * Rules for detecting and blocking specific text patterns. */ textMatching?: outputs.azuredatatransfer.TextMatchingRulesetResponse; /** * Rules for filtering XML content using XSD schemas. */ xmlFilters?: outputs.azuredatatransfer.XmlFilterRulesetResponse; } /** * flowProfileRulesetsResponseProvideDefaults sets the appropriate defaults for FlowProfileRulesetsResponse */ function flowProfileRulesetsResponseProvideDefaults(val: FlowProfileRulesetsResponse): FlowProfileRulesetsResponse; /** * Properties of flow */ interface FlowPropertiesResponse { /** * The connection associated with this flow */ connection?: outputs.azuredatatransfer.SelectedResourceResponse; /** * The URI to the customer managed key for this flow */ customerManagedKeyVaultUri?: string; /** * Transfer Storage Blobs or Tables */ dataType?: string; /** * The destination endpoint ports of the stream */ destinationEndpointPorts?: number[]; /** * The destination endpoints of the stream */ destinationEndpoints?: string[]; /** * Dataflow GUID associated with this flow */ flowId: string; /** * The flow type for this flow */ flowType?: string; /** * AME, PME, or TORUS only! AKV Chain Containing SAS Token */ keyVaultUri?: string; /** * Link status of the current flow */ linkStatus: string; /** * Resource ID of the linked flow */ linkedFlowId: string; /** * The messaging options for this flow */ messagingOptions?: outputs.azuredatatransfer.MessagingOptionsResponse; /** * The passphrase used for SRT streams */ passphrase?: string; /** * The policies for this flow */ policies?: string[]; /** * Provisioning state of the flow */ provisioningState: string; /** * The selected schema for this flow */ schema?: outputs.azuredatatransfer.SchemaResponse; /** * Service Bus Queue ID */ serviceBusQueueId?: string; /** * The source IP address and CIDR ranges of the stream */ sourceAddresses?: outputs.azuredatatransfer.StreamSourceAddressesResponse; /** * Status of the current flow */ status?: string; /** * Storage Account ID */ storageAccountId?: string; /** * Storage Account */ storageAccountName?: string; /** * Storage Container Name */ storageContainerName?: string; /** * The flow stream identifier */ streamId?: string; /** * The latency of the stream in milliseconds */ streamLatency?: number; /** * The protocol of the stream */ streamProtocol?: string; } /** * Properties of flow */ interface FlowPropertieslistListFlowsByPipelineResponse { /** * The API Flow configuration options for Azure Data Transfer API Flow type. */ apiFlowOptions?: outputs.azuredatatransfer.ApiFlowOptionsResponse; /** * The connection associated with this flow */ connection?: outputs.azuredatatransfer.SelectedResourceResponse; /** * Event Hub Consumer Group */ consumerGroup?: string; /** * The URI to the customer managed key for this flow */ customerManagedKeyVaultUri?: string; /** * Type of data to transfer via the flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. */ dataType?: string; /** * The destination endpoint ports of the stream */ destinationEndpointPorts?: number[]; /** * The destination endpoints of the stream */ destinationEndpoints?: string[]; /** * Event Hub ID */ eventHubId?: string; /** * Dataflow GUID associated with this flow */ flowId: string; /** * The flow type for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. */ flowType?: string; /** * Force disablement status of the current flow */ forceDisabledStatus: string[]; /** * URI to a Key Vault Secret containing a SAS token. */ keyVaultUri?: string; /** * Link status of the current flow */ linkStatus: string; /** * Resource ID of the linked flow */ linkedFlowId: string; /** * The messaging options for this flow */ messagingOptions?: outputs.azuredatatransfer.MessagingOptionsResponse; /** * The passphrase used for SRT streams (non-secret) */ passphrase?: string; /** * The policies for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. */ policies?: string[]; /** * Provisioning state of the flow */ provisioningState: string; /** * The selected schema for this flow. The property has reached end of life support starting version 2025-05-30-preview. Please create and use a FlowProfile resource instead. */ schema?: outputs.azuredatatransfer.SchemaResponse; /** * Service Bus Queue ID */ serviceBusQueueId?: string; /** * The source IP address and CIDR ranges of the stream */ sourceAddresses?: outputs.azuredatatransfer.StreamSourceAddressesResponse; /** * Status of the current flow */ status?: string; /** * Storage Account ID */ storageAccountId?: string; /** * Storage Account */ storageAccountName?: string; /** * Storage Container Name */ storageContainerName?: string; /** * Storage Table Name */ storageTableName?: string; /** * The flow stream identifier */ streamId?: string; /** * The latency of the stream in milliseconds */ streamLatency?: number; /** * The protocol of the stream */ streamProtocol?: string; } /** * The flow resource definition. */ interface FlowResponse { /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The managed service identities assigned to this resource. */ identity?: outputs.azuredatatransfer.ManagedServiceIdentityResponse; /** * The geo-location where the resource lives */ location: string; /** * The name of the resource */ name: string; /** * Details of the resource plan. */ plan?: outputs.azuredatatransfer.PlanResponse; /** * Properties of flow */ properties?: outputs.azuredatatransfer.FlowPropertieslistListFlowsByPipelineResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.azuredatatransfer.SystemDataResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Internal metadata of the connection inside pipeline. */ interface InternalMetadataPropertiesResponse { /** * Operation status associated with the last patch request */ operationStatus?: outputs.azuredatatransfer.OperationStatusPropertiesResponse; /** * User that last set the approved status for this connection */ statusSetBy: string; } /** * A connection resource id in addition to all child flow resources under this connection. */ interface ListFlowsByPipelineConnectionResponse { /** * List of flows associated with the connection. */ flows?: outputs.azuredatatransfer.FlowResponse[]; /** * ID of the connection. */ id?: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.azuredatatransfer.UserAssignedIdentityResponse; }; } /** * The option associated with messaging flows. */ interface MessagingOptionsResponse { /** * Billing tier for this messaging flow */ billingTier?: string; } /** * Rules for filtering files based on Media types (f.k.a MIME types). */ interface MimeFilterRulesetResponse { /** * Defines the Media types (f.k.a MIME types) and associated file extensions to be filtered. For more detail, please refer to the MimeTypeFiler model. */ filters?: outputs.azuredatatransfer.MimeTypeFilterResponse[]; /** * Specifies whether the filter is an allow list or deny list. For more detail, please refer to the FilterType model. */ type?: string; } /** * Defines a list of Media types (f.k.a MIME Types) and associated file extensions subject to filtering. */ interface MimeTypeFilterResponse { /** * A list of file extensions associated with the specified Media type (e.g., .json, .png). To specify files with no extension, use an empty string ""." */ extensions?: string[]; /** * The Media Types (f.k.a MIME types), following IANA standards (e.g., application/json, image/png). For a more detailed list of allowed media types please refer to the Tika documentation: https://github.com/apache/tika/blob/main/tika-core/src/main/resources/org/apache/tika/mime/tika-mimetypes.xml */ media?: string; } /** * Operation status associated with the last patch request */ interface OperationStatusPropertiesResponse { /** * Operation status ID of the last patch request for this connection. */ id: string; /** * Message for the operation for the last patch request for this connection. */ message: string; /** * Operation status for the last patch request for this connection. */ status: string; } /** * Pending connection object */ interface PendingConnectionResponse { /** * Approver of this connection request */ approver: string; /** * The timestamp that this connection request was submitted at */ dateSubmitted: string; /** * Direction of data movement */ direction?: string; /** * The flow types being requested for this connection */ flowTypes?: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * Justification for the connection request */ justification?: string; /** * Link status of the current connection */ linkStatus: string; /** * Resource ID of the linked connection */ linkedConnectionId: string; /** * The geo-location where the resource lives */ location: string; /** * The name of the resource */ name: string; /** * PIN to link requests together */ pin?: string; /** * Pipeline to use to transfer data */ pipeline: string; /** * The policies for this connection */ policies?: string[]; /** * The primary contact for this connection request */ primaryContact?: string; /** * Provisioning state of the connection */ provisioningState: string; /** * Subscription ID to link cloud subscriptions together */ remoteSubscriptionId?: string; /** * Requirement ID of the connection */ requirementId?: string; /** * The schema URIs for this connection */ schemaUris?: string[]; /** * The schemas for this connection */ schemas?: outputs.azuredatatransfer.SchemaResponse[]; /** * The secondary contacts for this connection request */ secondaryContacts?: string[]; /** * Status of the connection */ status: string; /** * Reason for status */ statusReason: string; /** * Subscription ID of the pending connection. */ subscriptionId: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.azuredatatransfer.SystemDataResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Pending flow object */ interface PendingFlowResponse { /** * The connection associated with this flow */ connection?: outputs.azuredatatransfer.SelectedResourceResponse; /** * Connection ID of the pending flow. */ connectionId: string; /** * The URI to the customer managed key for this flow */ customerManagedKeyVaultUri?: string; /** * Transfer Storage Blobs or Tables */ dataType?: string; /** * The destination endpoint ports of the stream */ destinationEndpointPorts?: number[]; /** * The destination endpoints of the stream */ destinationEndpoints?: string[]; /** * Dataflow GUID associated with this flow */ flowId: string; /** * The flow type for this flow */ flowType?: string; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * AME, PME, or TORUS only! AKV Chain Containing SAS Token */ keyVaultUri?: string; /** * Link status of the current flow */ linkStatus: string; /** * Resource ID of the linked flow */ linkedFlowId: string; /** * The geo-location where the resource lives */ location: string; /** * The messaging options for this flow */ messagingOptions?: outputs.azuredatatransfer.MessagingOptionsResponse; /** * The name of the resource */ name: string; /** * The passphrase used for SRT streams */ passphrase?: string; /** * The policies for this flow */ policies?: string[]; /** * Provisioning state of the flow */ provisioningState: string; /** * The selected schema for this flow */ schema?: outputs.azuredatatransfer.SchemaResponse; /** * Service Bus Queue ID */ serviceBusQueueId?: string; /** * The source IP address and CIDR ranges of the stream */ sourceAddresses?: outputs.azuredatatransfer.StreamSourceAddressesResponse; /** * Status of the current flow */ status?: string; /** * Storage Account ID */ storageAccountId?: string; /** * Storage Account */ storageAccountName?: string; /** * Storage Container Name */ storageContainerName?: string; /** * The flow stream identifier */ streamId?: string; /** * The latency of the stream in milliseconds */ streamLatency?: number; /** * The protocol of the stream */ streamProtocol?: string; /** * Subscription ID of the pending flow. */ subscriptionId: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.azuredatatransfer.SystemDataResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Connection body inside a pipeline */ interface PipelineConnectionResponse { /** * Connection etag inside pipeline */ etag: string; /** * Connection id inside pipeline */ id: string; /** * Connection location inside pipeline */ location: string; /** * Connection name inside pipeline */ name: string; /** * Connection properties inside pipeline */ properties?: outputs.azuredatatransfer.PipelineConnectionResponseProperties; /** * Metadata pertaining to creation and last modification of the resource. */ systemData: outputs.azuredatatransfer.SystemDataResponse; /** * Connection type inside pipeline */ type: string; } /** * Connection properties inside pipeline */ interface PipelineConnectionResponseProperties { /** * Internal metadata of the connection inside pipeline. */ internalMetadata?: outputs.azuredatatransfer.InternalMetadataPropertiesResponse; } /** * Properties of pipeline */ interface PipelinePropertiesResponse { /** * Connections associated with pipeline */ connections: outputs.azuredatatransfer.PipelineConnectionResponse[]; /** * Display name of this pipeline */ displayName?: string; /** * The flow types allowed for this pipeline */ flowTypes?: string[]; /** * The policies for this pipeline */ policies?: string[]; /** * Provisioning state of the pipeline */ provisioningState: string; /** * Remote cloud of the data to be transferred or received */ remoteCloud: string; /** * Subscribers of this resource */ subscribers?: outputs.azuredatatransfer.SubscriberResponse[]; } /** * Plan for the resource. */ interface PlanResponse { /** * A user defined name of the 3rd Party Artifact that is being procured. */ name: string; /** * The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. */ product: string; /** * A publisher provided promotion code as provisioned in Data Market for the said product/artifact. */ promotionCode?: string; /** * The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic */ publisher: string; /** * The version of the desired product/artifact. */ version?: string; } /** * The schema object. */ interface SchemaResponse { /** * Connection ID associated with this schema */ connectionId?: string; /** * Content of the schema */ content?: string; /** * The direction of the schema. */ direction?: string; /** * ID associated with this schema */ id?: string; /** * Name of the schema */ name?: string; /** * The Schema Type */ schemaType?: string; /** * Uri containing SAS token for the zipped schema */ schemaUri?: string; /** * Status of the schema */ status?: string; } /** * A resource selected from ARM */ interface SelectedResourceResponse { /** * Id of the connection */ id: string; /** * Location of the connection */ location?: string; /** * Name of the connection */ name?: string; /** * Name of the subscription with the connection */ subscriptionName?: string; } /** * The source IP address and CIDR ranges of the stream */ interface StreamSourceAddressesResponse { /** * A source IP address or CIDR range */ sourceAddresses?: string[]; } interface SubscriberResponse { /** * Email of the subscriber */ email?: string; /** * Number specifying what notifications to receive */ notifications?: number; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Configuration options for the text matching ruleset. For example, if the configuration is to deny "hello world" for partial case-insensitive words then "chello worlds" would get detected and the resulting file would be denied. */ interface TextMatchResponse { /** * Specifies the text matching conditions based on casing. For more detail please refer to the Casing model. */ caseSensitivity: string; /** * Specifies the text matching condition for text comparison. For more detail please refer to the MatchType model. */ matchType: string; /** * The word or phrase to match against replicated content. A phrase with spaces will be considered a single substring. */ text: string; } /** * textMatchResponseProvideDefaults sets the appropriate defaults for TextMatchResponse */ function textMatchResponseProvideDefaults(val: TextMatchResponse): TextMatchResponse; /** * Rules for detecting and blocking specific text patterns. If a file contains a text pattern that is part of the configured deny list, the file will be denied. */ interface TextMatchingRulesetResponse { /** * A list of text patterns to block, each with matching rules and case sensitivity options. */ deny?: outputs.azuredatatransfer.TextMatchResponse[]; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Rules for filtering XML content using XSD schemas. */ interface XmlFilterRulesetResponse { /** * The default XML namespace used for schema validation. */ defaultNamespace?: string; /** * Defines the method for referencing the xml schema. */ reference?: string; /** * The inline XSD schema to be used for validation. */ schema?: string; } } export declare namespace azurefleet { /** * AdditionalCapabilities for VM. */ interface AdditionalCapabilitiesResponse { /** * The flag that enables or disables hibernation capability on the VM. */ hibernationEnabled?: boolean; /** * The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. * Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. */ ultraSSDEnabled?: boolean; } /** * Represents the configuration for additional locations where Fleet resources may be deployed. */ interface AdditionalLocationsProfileResponse { /** * The list of location profiles. */ locationProfiles: outputs.azurefleet.LocationProfileResponse[]; } /** * Specifies additional XML formatted information that can be included in the * Unattend.xml file, which is used by Windows Setup. Contents are defined by * setting name, component name, and the pass in which the content is applied. */ interface AdditionalUnattendContentResponse { /** * The component name. Currently, the only allowable value is * Microsoft-Windows-Shell-Setup. */ componentName?: string; /** * The pass name. Currently, the only allowable value is OobeSystem. */ passName?: string; /** * Specifies the name of the setting to which the content applies. Possible values * are: FirstLogonCommands and AutoLogon. */ settingName?: string; } /** * The API entity reference. */ interface ApiEntityReferenceResponse { /** * The ARM resource id in the form of * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... */ id?: string; } /** * Contains the list of gallery applications that should be made available to the * VM/VMSS */ interface ApplicationProfileResponse { /** * Specifies the gallery applications that should be made available to the VM/VMSS */ galleryApplications?: outputs.azurefleet.VMGalleryApplicationResponse[]; } /** * Describes the base virtual machine profile for fleet */ interface BaseVirtualMachineProfileResponse { /** * Specifies the gallery applications that should be made available to the VM/VMSS */ applicationProfile?: outputs.azurefleet.ApplicationProfileResponse; /** * Specifies the capacity reservation related details of a scale set. Minimum * api-version: 2021-04-01. */ capacityReservation?: outputs.azurefleet.CapacityReservationProfileResponse; /** * Specifies the boot diagnostic settings state. */ diagnosticsProfile?: outputs.azurefleet.DiagnosticsProfileResponse; /** * Specifies a collection of settings for extensions installed on virtual machines * in the scale set. */ extensionProfile?: outputs.azurefleet.VirtualMachineScaleSetExtensionProfileResponse; /** * Specifies the hardware profile related details of a scale set. Minimum * api-version: 2021-11-01. */ hardwareProfile?: outputs.azurefleet.VirtualMachineScaleSetHardwareProfileResponse; /** * Specifies that the image or disk that is being used was licensed on-premises. *

Possible values for Windows Server operating system are:

* Windows_Client

Windows_Server

Possible values for Linux * Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS * (for SUSE)

For more information, see [Azure Hybrid Use Benefit for * Windows * Server](https://learn.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing) *

[Azure Hybrid Use Benefit for Linux * Server](https://learn.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux) *

Minimum api-version: 2015-06-15 */ licenseType?: string; /** * Specifies properties of the network interfaces of the virtual machines in the * scale set. */ networkProfile?: outputs.azurefleet.VirtualMachineScaleSetNetworkProfileResponse; /** * Specifies the operating system settings for the virtual machines in the scale * set. */ osProfile?: outputs.azurefleet.VirtualMachineScaleSetOSProfileResponse; /** * Specifies Scheduled Event related configurations. */ scheduledEventsProfile?: outputs.azurefleet.ScheduledEventsProfileResponse; /** * Specifies the security posture to be used for all virtual machines in the scale * set. Minimum api-version: 2023-03-01 */ securityPostureReference?: outputs.azurefleet.SecurityPostureReferenceResponse; /** * Specifies the Security related profile settings for the virtual machines in the * scale set. */ securityProfile?: outputs.azurefleet.SecurityProfileResponse; /** * Specifies the service artifact reference id used to set same image version for * all virtual machines in the scale set when using 'latest' image version. * Minimum api-version: 2022-11-01 */ serviceArtifactReference?: outputs.azurefleet.ServiceArtifactReferenceResponse; /** * Specifies the storage settings for the virtual machine disks. */ storageProfile?: outputs.azurefleet.VirtualMachineScaleSetStorageProfileResponse; /** * Specifies the time in which this VM profile for the Virtual Machine Scale Set * was created. Minimum API version for this property is 2023-09-01. This value * will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile * with minimum api-version 2023-09-01. Examples: "2024-07-01T00:00:01.1234567+00:00" */ timeCreated: string; /** * UserData for the virtual machines in the scale set, which must be base-64 * encoded. Customer should not pass any secrets in here. Minimum api-version: * 2021-03-01. */ userData?: string; } /** * Boot Diagnostics is a debugging feature which allows you to view Console Output * and Screenshot to diagnose VM status. You can easily view the output of your * console log. Azure also enables you to see a screenshot of the VM from the * hypervisor. */ interface BootDiagnosticsResponse { /** * Whether boot diagnostics should be enabled on the Virtual Machine. */ enabled?: boolean; /** * Uri of the storage account to use for placing the console output and * screenshot. If storageUri is not specified while enabling boot diagnostics, * managed storage will be used. */ storageUri?: string; } /** * The parameters of a capacity reservation Profile. */ interface CapacityReservationProfileResponse { /** * Specifies the capacity reservation group resource id that should be used for * allocating the virtual machine or scaleset vm instances provided enough * capacity has been reserved. Please refer to https://aka.ms/CapacityReservation * for more details. */ capacityReservationGroup?: outputs.azurefleet.SubResourceResponse; } /** * Compute Profile to use for running user's workloads. */ interface ComputeProfileResponse { /** * Specifies VMSS and VM API entity models support two additional capabilities as of today: ultraSSDEnabled and hibernationEnabled. * ultraSSDEnabled: Enables UltraSSD_LRS storage account type on the VMSS VMs. * hibernationEnabled: Enables the hibernation capability on the VMSS VMs. * Default value is null if not specified. This property cannot be updated once set. */ additionalVirtualMachineCapabilities?: outputs.azurefleet.AdditionalCapabilitiesResponse; /** * Base Virtual Machine Profile Properties to be specified according to "specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachineScaleSet.json#/definitions/VirtualMachineScaleSetVMProfile" */ baseVirtualMachineProfile: outputs.azurefleet.BaseVirtualMachineProfileResponse; /** * Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machine scale sets and Virtual Machines. * The default value will be the latest supported computeApiVersion by Compute Fleet. */ computeApiVersion?: string; /** * Specifies the number of fault domains to use when creating the underlying VMSS. * A fault domain is a logical group of hardware within an Azure datacenter. * VMs in the same fault domain share a common power source and network switch. * If not specified, defaults to 1, which represents "Max Spreading" (using as many fault domains as possible). * This property cannot be updated. */ platformFaultDomainCount?: number; } /** * Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. */ interface DiagnosticsProfileResponse { /** * Boot Diagnostics is a debugging feature which allows you to view Console Output * and Screenshot to diagnose VM status. **NOTE**: If storageUri is being * specified then ensure that the storage account is in the same region and * subscription as the VM. You can easily view the output of your console log. * Azure also enables you to see a screenshot of the VM from the hypervisor. */ bootDiagnostics?: outputs.azurefleet.BootDiagnosticsResponse; } /** * Describes the parameters of ephemeral disk settings that can be specified for * operating system disk. **Note:** The ephemeral disk settings can only be * specified for managed disk. */ interface DiffDiskSettingsResponse { /** * Specifies the ephemeral disk settings for operating system disk. */ option?: string; /** * Specifies the ephemeral disk placement for operating system disk. Possible * values are: **CacheDisk,** **ResourceDisk.** The defaulting behavior is: * **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** * is used. Refer to the VM size documentation for Windows VM at * https://learn.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at * https://learn.microsoft.com/azure/virtual-machines/linux/sizes to check which VM * sizes exposes a cache disk. */ placement?: string; } /** * Describes the parameter of customer managed disk encryption set resource id * that can be specified for disk. **Note:** The disk encryption set resource id * can only be specified for managed disk. Please refer * https://aka.ms/mdssewithcmkoverview for more details. */ interface DiskEncryptionSetParametersResponse { /** * Resource Id */ id?: string; } /** * Specifies the Managed Identity used by ADE to get access token for keyvault * operations. */ interface EncryptionIdentityResponse { /** * Specifies ARM Resource ID of one of the user identities associated with the VM. */ userAssignedIdentityResourceId?: string; } /** * Specifies information about the image to use. You can specify information about * platform images, marketplace images, or virtual machine images. This element is * required when you want to use a platform image, marketplace image, or virtual * machine image, but is not used in other creation operations. NOTE: Image * reference publisher and offer can only be set when you create the scale set. */ interface ImageReferenceResponse { /** * Specified the community gallery image unique id for vm deployment. This can be * fetched from community gallery image GET call. */ communityGalleryImageId?: string; /** * Specifies in decimal numbers, the version of platform image or marketplace * image used to create the virtual machine. This readonly field differs from 'version', * only if the value specified in 'version' field is 'latest'. */ exactVersion: string; /** * Resource Id */ id?: string; /** * Specifies the offer of the platform image or marketplace image used to create * the virtual machine. */ offer?: string; /** * The image publisher. */ publisher?: string; /** * Specified the shared gallery image unique id for vm deployment. This can be * fetched from shared gallery image GET call. */ sharedGalleryImageId?: string; /** * The image SKU. */ sku?: string; /** * Specifies the version of the platform image or marketplace image used to create * the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. * Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest * version of an image available at deploy time. Even if you use 'latest', the VM * image will not automatically update after deploy time even if a new version * becomes available. Please do not use field 'version' for gallery image * deployment, gallery image should always use 'id' field for deployment, to use 'latest' * version of gallery image, just set * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' * in the 'id' field without version input. */ version?: string; } /** * Describes a reference to Key Vault Secret */ interface KeyVaultSecretReferenceResponse { /** * The URL referencing a secret in a Key Vault. */ secretUrl: string; /** * The relative URL of the Key Vault containing the secret. */ sourceVault: outputs.azurefleet.SubResourceResponse; } /** * Specifies the Linux operating system settings on the virtual machine. For a * list of supported Linux distributions, see [Linux on Azure-Endorsed * Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */ interface LinuxConfigurationResponse { /** * Specifies whether password authentication should be disabled. */ disablePasswordAuthentication?: boolean; /** * Indicates whether VMAgent Platform Updates is enabled for the Linux virtual * machine. Default value is false. */ enableVMAgentPlatformUpdates?: boolean; /** * [Preview Feature] Specifies settings related to VM Guest Patching on Linux. */ patchSettings?: outputs.azurefleet.LinuxPatchSettingsResponse; /** * Indicates whether virtual machine agent should be provisioned on the virtual * machine. When this property is not specified in the request body, default * behavior is to set it to true. This will ensure that VM Agent is installed on * the VM so that extensions can be added to the VM later. */ provisionVMAgent?: boolean; /** * Specifies the ssh key configuration for a Linux OS. */ ssh?: outputs.azurefleet.SshConfigurationResponse; } /** * Specifies settings related to VM Guest Patching on Linux. */ interface LinuxPatchSettingsResponse { /** * Specifies the mode of VM Guest Patch Assessment for the IaaS virtual * machine.

Possible values are:

**ImageDefault** - You * control the timing of patch assessments on a virtual machine.

* **AutomaticByPlatform** - The platform will trigger periodic patch assessments. * The property provisionVMAgent must be true. */ assessmentMode?: string; /** * Specifies additional settings for patch mode AutomaticByPlatform in VM Guest * Patching on Linux. */ automaticByPlatformSettings?: outputs.azurefleet.LinuxVMGuestPatchAutomaticByPlatformSettingsResponse; /** * Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual * machines associated to virtual machine scale set with OrchestrationMode as * Flexible.

Possible values are:

**ImageDefault** - The * virtual machine's default patching configuration is used.

* **AutomaticByPlatform** - The virtual machine will be automatically updated by * the platform. The property provisionVMAgent must be true */ patchMode?: string; } /** * Specifies additional settings to be applied when patch mode AutomaticByPlatform * is selected in Linux patch settings. */ interface LinuxVMGuestPatchAutomaticByPlatformSettingsResponse { /** * Enables customer to schedule patching without accidental upgrades */ bypassPlatformSafetyChecksOnUserSchedule?: boolean; /** * Specifies the reboot setting for all AutomaticByPlatform patch installation * operations. */ rebootSetting?: string; } /** * Represents the profile for a single additional location in the Fleet. The location and the virtualMachineProfileOverride (optional). */ interface LocationProfileResponse { /** * The ARM location name of the additional region. If LocationProfile is specified, then location is required. */ location: string; /** * An override for computeProfile.baseVirtualMachineProfile specific to this region. * This override is merged with the base virtual machine profile to define the final virtual machine profile for the resources deployed in this location. */ virtualMachineProfileOverride?: outputs.azurefleet.BaseVirtualMachineProfileResponse; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.azurefleet.UserAssignedIdentityResponse; }; } /** * Specifies OS Image Scheduled Event related configurations. */ interface OSImageNotificationProfileResponse { /** * Specifies whether the OS Image Scheduled event is enabled or disabled. */ enable?: boolean; /** * Length of time a Virtual Machine being reimaged or having its OS upgraded will * have to potentially approve the OS Image Scheduled Event before the event is * auto approved (timed out). The configuration is specified in ISO 8601 format, * and the value must not exceed 15 minutes (PT15M) */ notBeforeTimeout?: string; } /** * Specifies settings related to VM Guest Patching on Windows. */ interface PatchSettingsResponse { /** * Specifies the mode of VM Guest patch assessment for the IaaS virtual * machine.

Possible values are:

**ImageDefault** - You * control the timing of patch assessments on a virtual machine.

* **AutomaticByPlatform** - The platform will trigger periodic patch assessments. * The property provisionVMAgent must be true. */ assessmentMode?: string; /** * Specifies additional settings for patch mode AutomaticByPlatform in VM Guest * Patching on Windows. */ automaticByPlatformSettings?: outputs.azurefleet.WindowsVMGuestPatchAutomaticByPlatformSettingsResponse; /** * Enables customers to patch their Azure VMs without requiring a reboot. For * enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' * must be set to 'AutomaticByPlatform'. */ enableHotpatching?: boolean; /** * Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual * machines associated to virtual machine scale set with OrchestrationMode as * Flexible.

Possible values are:

**Manual** - You * control the application of patches to a virtual machine. You do this by * applying patches manually inside the VM. In this mode, automatic updates are * disabled; the property WindowsConfiguration.enableAutomaticUpdates must be * false

**AutomaticByOS** - The virtual machine will automatically be * updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates * must be true.

**AutomaticByPlatform** - the virtual machine will * automatically updated by the platform. The properties provisionVMAgent and * WindowsConfiguration.enableAutomaticUpdates must be true */ patchMode?: string; } /** * Plan for the resource. */ interface PlanResponse { /** * A user defined name of the 3rd Party Artifact that is being procured. */ name: string; /** * The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. */ product: string; /** * A publisher provided promotion code as provisioned in Data Market for the said product/artifact. */ promotionCode?: string; /** * The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic */ publisher: string; /** * The version of the desired product/artifact. */ version?: string; } /** * Specifies ProxyAgent settings while creating the virtual machine. Minimum * api-version: 2023-09-01. */ interface ProxyAgentSettingsResponse { /** * Specifies whether ProxyAgent feature should be enabled on the virtual machine * or virtual machine scale set. */ enabled?: boolean; /** * Increase the value of this property allows user to reset the key used for * securing communication channel between guest and host. */ keyIncarnationId?: number; /** * Specifies the mode that ProxyAgent will execute on if the feature is enabled. * ProxyAgent will start to audit or monitor but not enforce access control over * requests to host endpoints in Audit mode, while in Enforce mode it will enforce * access control. The default value is Enforce mode. */ mode?: string; } /** * Describes the public IP Sku. It can only be set with OrchestrationMode as * Flexible. */ interface PublicIPAddressSkuResponse { /** * Specify public IP sku name */ name?: string; /** * Specify public IP sku tier */ tier?: string; } /** * Configuration Options for Regular instances in Compute Fleet. */ interface RegularPriorityProfileResponse { /** * Allocation strategy to follow when determining the VM sizes distribution for Regular VMs. */ allocationStrategy?: string; /** * Total capacity to achieve. It is currently in terms of number of VMs. */ capacity?: number; /** * Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. */ minCapacity?: number; } /** * Specifies Scheduled Event related configurations. */ interface ScheduledEventsProfileResponse { /** * Specifies OS Image Scheduled Event related configurations. */ osImageNotificationProfile?: outputs.azurefleet.OSImageNotificationProfileResponse; /** * Specifies Terminate Scheduled Event related configurations. */ terminateNotificationProfile?: outputs.azurefleet.TerminateNotificationProfileResponse; } /** * Specifies the security posture to be used for all virtual machines in the scale * set. Minimum api-version: 2023-03-01 */ interface SecurityPostureReferenceResponse { /** * List of virtual machine extension names to exclude when applying the security * posture. */ excludeExtensions?: string[]; /** * The security posture reference id in the form of * /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|{major.*}|latest */ id?: string; /** * Whether the security posture can be overridden by the user. */ isOverridable?: boolean; } /** * Specifies the Security profile settings for the virtual machine or virtual * machine scale set. */ interface SecurityProfileResponse { /** * This property can be used by user in the request to enable or disable the Host * Encryption for the virtual machine or virtual machine scale set. This will * enable the encryption for all the disks including Resource/Temp disk at host * itself. The default behavior is: The Encryption at host will be disabled unless * this property is set to true for the resource. */ encryptionAtHost?: boolean; /** * Specifies the Managed Identity used by ADE to get access token for keyvault * operations. */ encryptionIdentity?: outputs.azurefleet.EncryptionIdentityResponse; /** * Specifies ProxyAgent settings while creating the virtual machine. Minimum * api-version: 2023-09-01. */ proxyAgentSettings?: outputs.azurefleet.ProxyAgentSettingsResponse; /** * Specifies the SecurityType of the virtual machine. It has to be set to any * specified value to enable UefiSettings. The default behavior is: UefiSettings * will not be enabled unless this property is set. */ securityType?: string; /** * Specifies the security settings like secure boot and vTPM used while creating * the virtual machine. Minimum api-version: 2020-12-01. */ uefiSettings?: outputs.azurefleet.UefiSettingsResponse; } /** * Specifies the service artifact reference id used to set same image version for * all virtual machines in the scale set when using 'latest' image version. * Minimum api-version: 2022-11-01 */ interface ServiceArtifactReferenceResponse { /** * The service artifact reference id in the form of * /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} */ id?: string; } /** * Configuration Options for Spot instances in Compute Fleet. */ interface SpotPriorityProfileResponse { /** * Allocation strategy to follow when determining the VM sizes distribution for Spot VMs. */ allocationStrategy?: string; /** * Total capacity to achieve. It is currently in terms of number of VMs. */ capacity?: number; /** * Eviction Policy to follow when evicting Spot VMs. */ evictionPolicy?: string; /** * Flag to enable/disable continuous goal seeking for the desired capacity and restoration of evicted Spot VMs. * If maintain is enabled, AzureFleetRP will use all VM sizes in vmSizesProfile to create new VMs (if VMs are evicted deleted) * or update existing VMs with new VM sizes (if VMs are evicted deallocated or failed to allocate due to capacity constraint) in order to achieve the desired capacity. * Maintain is enabled by default. */ maintain?: boolean; /** * Price per hour of each Spot VM will never exceed this. */ maxPricePerVM?: number; /** * Minimum capacity to achieve which cannot be updated. If we will not be able to "guarantee" minimum capacity, we will reject the request in the sync path itself. */ minCapacity?: number; } /** * SSH configuration for Linux based VMs running on Azure */ interface SshConfigurationResponse { /** * The list of SSH public keys used to authenticate with linux based VMs. */ publicKeys?: outputs.azurefleet.SshPublicKeyResponse[]; } /** * Contains information about SSH certificate public key and the path on the Linux * VM where the public key is placed. */ interface SshPublicKeyResponse { /** * SSH public key certificate used to authenticate with the VM through ssh. The * key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, * see [Create SSH keys on Linux and Mac for Linux VMs in * Azure]https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). */ keyData?: string; /** * Specifies the full path on the created VM where ssh public key is stored. If * the file already exists, the specified key is appended to the file. Example: * /home/user/.ssh/authorized_keys */ path?: string; } /** * Describes SubResource */ interface SubResourceResponse { /** * Resource Id */ id?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Specifies Terminate Scheduled Event related configurations. */ interface TerminateNotificationProfileResponse { /** * Specifies whether the Terminate Scheduled event is enabled or disabled. */ enable?: boolean; /** * Configurable length of time a Virtual Machine being deleted will have to * potentially approve the Terminate Scheduled Event before the event is auto * approved (timed out). The configuration must be specified in ISO 8601 format, * the default value is 5 minutes (PT5M) */ notBeforeTimeout?: string; } /** * Specifies the security settings like secure boot and vTPM used while creating * the virtual machine. Minimum api-version: 2020-12-01. */ interface UefiSettingsResponse { /** * Specifies whether secure boot should be enabled on the virtual machine. Minimum * api-version: 2020-12-01. */ secureBootEnabled?: boolean; /** * Specifies whether vTPM should be enabled on the virtual machine. Minimum * api-version: 2020-12-01. */ vTpmEnabled?: boolean; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * VMAttributes using double values. */ interface VMAttributeMinMaxDoubleResponse { /** * Maximum value. Double.MaxValue(1.7976931348623157E+308) */ max?: number; /** * Minimum value. default 0. Double.MinValue() */ min?: number; } /** * While retrieving VMSizes from CRS, Min = 0 (uint.MinValue) if not specified, Max = 4294967295 (uint.MaxValue) if not specified. This allows to filter VMAttributes on all available VMSizes. */ interface VMAttributeMinMaxIntegerResponse { /** * Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. */ max?: number; /** * Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. */ min?: number; } /** * VMAttributes that will be used to filter VMSizes which will be used to build Fleet. */ interface VMAttributesResponse { /** * The range of accelerator count specified from min to max. Optional parameter. Either Min or Max is required if specified. * acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. * If acceleratorSupport is "Excluded", this VMAttribute can not be used. */ acceleratorCount?: outputs.azurefleet.VMAttributeMinMaxIntegerResponse; /** * The accelerator manufacturers specified as a list. * acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. * If acceleratorSupport is "Excluded", this VMAttribute can not be used. */ acceleratorManufacturers?: string[]; /** * Specifies whether the VMSize supporting accelerator should be used to build Fleet or not. * acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. * If acceleratorSupport is "Excluded", this VMAttribute can not be used. */ acceleratorSupport?: string; /** * The accelerator types specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. * If acceleratorSupport is "Excluded", this VMAttribute can not be used. */ acceleratorTypes?: string[]; /** * The VM architecture types specified as a list. Optional parameter. */ architectureTypes?: string[]; /** * Specifies whether the VMSize supporting burstable capability should be used to build Fleet or not. */ burstableSupport?: string; /** * The VM CPU manufacturers specified as a list. Optional parameter. */ cpuManufacturers?: string[]; /** * The range of data disk count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. */ dataDiskCount?: outputs.azurefleet.VMAttributeMinMaxIntegerResponse; /** * Specifies which VMSizes should be excluded while building Fleet. Optional parameter. */ excludedVMSizes?: string[]; /** * The local storage disk types specified as a list. LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. * If localStorageSupport is "Excluded", this VMAttribute can not be used. */ localStorageDiskTypes?: string[]; /** * LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. * If localStorageSupport is "Excluded", this VMAttribute can not be used. */ localStorageInGiB?: outputs.azurefleet.VMAttributeMinMaxDoubleResponse; /** * Specifies whether the VMSize supporting local storage should be used to build Fleet or not. * Included - Default if not specified as most Azure VMs support local storage. */ localStorageSupport?: string; /** * The range of memory specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. */ memoryInGiB: outputs.azurefleet.VMAttributeMinMaxDoubleResponse; /** * The range of memory in GiB per vCPU specified from min to max. Optional parameter. Either Min or Max is required if specified. */ memoryInGiBPerVCpu?: outputs.azurefleet.VMAttributeMinMaxDoubleResponse; /** * The range of network bandwidth in Mbps specified from Min to Max. Optional parameter. Either Min or Max is required if specified. */ networkBandwidthInMbps?: outputs.azurefleet.VMAttributeMinMaxDoubleResponse; /** * The range of network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. */ networkInterfaceCount?: outputs.azurefleet.VMAttributeMinMaxIntegerResponse; /** * The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. * rdmaSupport should be set to "Included" or "Required" to use this VMAttribute. * If rdmaSupport is "Excluded", this VMAttribute can not be used. */ rdmaNetworkInterfaceCount?: outputs.azurefleet.VMAttributeMinMaxIntegerResponse; /** * Specifies whether the VMSize supporting RDMA (Remote Direct Memory Access) should be used to build Fleet or not. */ rdmaSupport?: string; /** * The range of vCpuCount specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. */ vCpuCount: outputs.azurefleet.VMAttributeMinMaxIntegerResponse; /** * The VM category specified as a list. Optional parameter. */ vmCategories?: string[]; } /** * Specifies the security profile settings for the managed disk. **Note:** It can * only be set for Confidential VMs. */ interface VMDiskSecurityProfileResponse { /** * Specifies the customer managed disk encryption set resource id for the managed * disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and * VMGuest blob. */ diskEncryptionSet?: outputs.azurefleet.DiskEncryptionSetParametersResponse; /** * Specifies the EncryptionType of the managed disk. It is set to * DiskWithVMGuestState for encryption of the managed disk along with VMGuestState * blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and * NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. * **Note:** It can be set for only Confidential VMs. */ securityEncryptionType?: string; } /** * Specifies the required information to reference a compute gallery application * version */ interface VMGalleryApplicationResponse { /** * Optional, Specifies the uri to an azure blob that will replace the default * configuration for the package if provided */ configurationReference?: string; /** * If set to true, when a new Gallery Application version is available in PIR/SIG, * it will be automatically updated for the VM/VMSS */ enableAutomaticUpgrade?: boolean; /** * Optional, Specifies the order in which the packages have to be installed */ order?: number; /** * Specifies the GalleryApplicationVersion resource id on the form of * /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} */ packageReferenceId: string; /** * Optional, Specifies a passthrough value for more generic context. */ tags?: string; /** * Optional, If true, any failure for any operation in the VmApplication will fail * the deployment */ treatFailureAsDeploymentFailure?: boolean; } /** * Specifies VM Size Property settings on the virtual machine. */ interface VMSizePropertiesResponse { /** * Specifies the number of vCPUs available for the VM. When this property is not * specified in the request body the default behavior is to set it to the value of * vCPUs available for that VM size exposed in api response of [List all available * virtual machine sizes in a * region](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). */ vCPUsAvailable?: number; /** * Specifies the vCPU to physical core ratio. When this property is not specified * in the request body the default behavior is set to the value of vCPUsPerCore * for the VM Size exposed in api response of [List all available virtual machine * sizes in a * region](https://learn.microsoft.com/en-us/rest/api/compute/resource-skus/list). * **Setting this property to 1 also means that hyper-threading is disabled.** */ vCPUsPerCore?: number; } /** * Describes a single certificate reference in a Key Vault, and where the * certificate should reside on the VM. */ interface VaultCertificateResponse { /** * For Windows VMs, specifies the certificate store on the Virtual Machine to * which the certificate should be added. The specified certificate store is * implicitly in the LocalMachine account. For Linux VMs, the certificate file is * placed under the /var/lib/waagent directory, with the file name * <UppercaseThumbprint>.crt for the X509 certificate file and * <UppercaseThumbprint>.prv for private key. Both of these files are .pem * formatted. */ certificateStore?: string; /** * This is the URL of a certificate that has been uploaded to Key Vault as a * secret. For adding a secret to the Key Vault, see [Add a key or secret to the * key * vault](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). * In this case, your certificate needs to be It is the Base64 encoding of the * following JSON Object which is encoded in UTF-8:

{
* "data":"",
"dataType":"pfx",
* "password":""
}
To install certificates on a virtual * machine it is recommended to use the [Azure Key Vault virtual machine extension * for * Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) * or the [Azure Key Vault virtual machine extension for * Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */ certificateUrl?: string; } /** * Describes a set of certificates which are all in the same Key Vault. */ interface VaultSecretGroupResponse { /** * The relative URL of the Key Vault containing all of the certificates in * VaultCertificates. */ sourceVault?: outputs.azurefleet.SubResourceResponse; /** * The list of key vault references in SourceVault which contain certificates. */ vaultCertificates?: outputs.azurefleet.VaultCertificateResponse[]; } /** * Describes the uri of a disk. */ interface VirtualHardDiskResponse { /** * Specifies the virtual hard disk's uri. */ uri?: string; } /** * Describes a virtual machine scale set data disk. */ interface VirtualMachineScaleSetDataDiskResponse { /** * Specifies the caching requirements. Possible values are: **None,** * **ReadOnly,** **ReadWrite.** The default values are: **None for Standard * storage. ReadOnly for Premium storage.** */ caching?: string; /** * The create option. */ createOption: string; /** * Specifies whether data disk should be deleted or detached upon VMSS Flex * deletion (This feature is available for VMSS with Flexible OrchestrationMode * only).

Possible values:

**Delete** If this value is used, the * data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If * this value is used, the data disk is retained after VMSS Flex VM is * deleted.

The default value is set to **Delete**. */ deleteOption?: string; /** * Specifies the Read-Write IOPS for the managed disk. Should be used only when * StorageAccountType is UltraSSD_LRS. If not specified, a default value would be * assigned based on diskSizeGB. */ diskIOPSReadWrite?: number; /** * Specifies the bandwidth in MB per second for the managed disk. Should be used * only when StorageAccountType is UltraSSD_LRS. If not specified, a default value * would be assigned based on diskSizeGB. */ diskMBpsReadWrite?: number; /** * Specifies the size of an empty data disk in gigabytes. This element can be used * to overwrite the size of the disk in a virtual machine image. The property * diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be * larger than 1023. */ diskSizeGB?: number; /** * Specifies the logical unit number of the data disk. This value is used to * identify data disks within the VM and therefore must be unique for each data * disk attached to a VM. */ lun: number; /** * The managed disk parameters. */ managedDisk?: outputs.azurefleet.VirtualMachineScaleSetManagedDiskParametersResponse; /** * The disk name. */ name?: string; /** * Specifies whether writeAccelerator should be enabled or disabled on the disk. */ writeAcceleratorEnabled?: boolean; } /** * Describes a virtual machine scale set extension profile. */ interface VirtualMachineScaleSetExtensionProfileResponse { /** * The virtual machine scale set child extension resources. */ extensions?: outputs.azurefleet.VirtualMachineScaleSetExtensionResponse[]; /** * Specifies the time alloted for all extensions to start. The time duration * should be between 15 minutes and 120 minutes (inclusive) and should be * specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). * Minimum api-version: 2020-06-01. */ extensionsTimeBudget?: string; } /** * Describes the properties of a Virtual Machine Scale Set Extension. */ interface VirtualMachineScaleSetExtensionPropertiesResponse { /** * Indicates whether the extension should use a newer minor version if one is * available at deployment time. Once deployed, however, the extension will not * upgrade minor versions unless redeployed, even with this property set to true. */ autoUpgradeMinorVersion?: boolean; /** * Indicates whether the extension should be automatically upgraded by the * platform if there is a newer version of the extension available. */ enableAutomaticUpgrade?: boolean; /** * If a value is provided and is different from the previous value, the extension * handler will be forced to update even if the extension configuration has not * changed. */ forceUpdateTag?: string; /** * The extensions protected settings that are passed by reference, and consumed * from key vault */ protectedSettingsFromKeyVault?: outputs.azurefleet.KeyVaultSecretReferenceResponse; /** * Collection of extension names after which this extension needs to be * provisioned. */ provisionAfterExtensions?: string[]; /** * The provisioning state, which only appears in the response. */ provisioningState: string; /** * The name of the extension handler publisher. */ publisher?: string; /** * Json formatted public settings for the extension. */ settings?: any; /** * Indicates whether failures stemming from the extension will be suppressed * (Operational failures such as not connecting to the VM will not be suppressed * regardless of this value). The default is false. */ suppressFailures?: boolean; /** * Specifies the type of the extension; an example is "CustomScriptExtension". */ type?: string; /** * Specifies the version of the script handler. */ typeHandlerVersion?: string; } /** * Describes a Virtual Machine Scale Set Extension. */ interface VirtualMachineScaleSetExtensionResponse { /** * Resource Id */ id: string; /** * The name of the extension. */ name?: string; /** * Describes the properties of a Virtual Machine Scale Set Extension. */ properties?: outputs.azurefleet.VirtualMachineScaleSetExtensionPropertiesResponse; /** * Resource type */ type: string; } /** * Specifies the hardware settings for the virtual machine scale set. */ interface VirtualMachineScaleSetHardwareProfileResponse { /** * Specifies the properties for customizing the size of the virtual machine. * Minimum api-version: 2021-11-01. Please follow the instructions in [VM * Customization](https://aka.ms/vmcustomization) for more details. */ vmSizeProperties?: outputs.azurefleet.VMSizePropertiesResponse; } /** * Describes a virtual machine scale set network profile's IP configuration * properties. */ interface VirtualMachineScaleSetIPConfigurationPropertiesResponse { /** * Specifies an array of references to backend address pools of application * gateways. A scale set can reference backend address pools of multiple * application gateways. Multiple scale sets cannot use the same application * gateway. */ applicationGatewayBackendAddressPools?: outputs.azurefleet.SubResourceResponse[]; /** * Specifies an array of references to application security group. */ applicationSecurityGroups?: outputs.azurefleet.SubResourceResponse[]; /** * Specifies an array of references to backend address pools of load balancers. A * scale set can reference backend address pools of one public and one internal * load balancer. Multiple scale sets cannot use the same basic sku load balancer. */ loadBalancerBackendAddressPools?: outputs.azurefleet.SubResourceResponse[]; /** * Specifies an array of references to inbound Nat pools of the load balancers. A * scale set can reference inbound nat pools of one public and one internal load * balancer. Multiple scale sets cannot use the same basic sku load balancer. */ loadBalancerInboundNatPools?: outputs.azurefleet.SubResourceResponse[]; /** * Specifies the primary network interface in case the virtual machine has more * than 1 network interface. */ primary?: boolean; /** * Available from Api-Version 2017-03-30 onwards, it represents whether the * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible * values are: 'IPv4' and 'IPv6'. */ privateIPAddressVersion?: string; /** * The publicIPAddressConfiguration. */ publicIPAddressConfiguration?: outputs.azurefleet.VirtualMachineScaleSetPublicIPAddressConfigurationResponse; /** * Specifies the identifier of the subnet. */ subnet?: outputs.azurefleet.ApiEntityReferenceResponse; } /** * Describes a virtual machine scale set network profile's IP configuration. */ interface VirtualMachineScaleSetIPConfigurationResponse { /** * The IP configuration name. */ name: string; /** * Describes a virtual machine scale set network profile's IP configuration * properties. */ properties?: outputs.azurefleet.VirtualMachineScaleSetIPConfigurationPropertiesResponse; } /** * Contains the IP tag associated with the public IP address. */ interface VirtualMachineScaleSetIpTagResponse { /** * IP tag type. Example: FirstPartyUsage. */ ipTagType?: string; /** * IP tag associated with the public IP. Example: SQL, Storage etc. */ tag?: string; } /** * Describes the parameters of a ScaleSet managed disk. */ interface VirtualMachineScaleSetManagedDiskParametersResponse { /** * Specifies the customer managed disk encryption set resource id for the managed * disk. */ diskEncryptionSet?: outputs.azurefleet.DiskEncryptionSetParametersResponse; /** * Specifies the security profile for the managed disk. */ securityProfile?: outputs.azurefleet.VMDiskSecurityProfileResponse; /** * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can * only be used with data disks, it cannot be used with OS Disk. */ storageAccountType?: string; } /** * Describes a virtual machines scale sets network configuration's DNS settings. */ interface VirtualMachineScaleSetNetworkConfigurationDnsSettingsResponse { /** * List of DNS servers IP addresses */ dnsServers?: string[]; } /** * Describes a virtual machine scale set network profile's IP configuration. */ interface VirtualMachineScaleSetNetworkConfigurationPropertiesResponse { /** * Specifies whether the Auxiliary mode is enabled for the Network Interface * resource. */ auxiliaryMode?: string; /** * Specifies whether the Auxiliary sku is enabled for the Network Interface * resource. */ auxiliarySku?: string; /** * Specify what happens to the network interface when the VM is deleted */ deleteOption?: string; /** * Specifies whether the network interface is disabled for tcp state tracking. */ disableTcpStateTracking?: boolean; /** * The dns settings to be applied on the network interfaces. */ dnsSettings?: outputs.azurefleet.VirtualMachineScaleSetNetworkConfigurationDnsSettingsResponse; /** * Specifies whether the network interface is accelerated networking-enabled. */ enableAcceleratedNetworking?: boolean; /** * Specifies whether the network interface is FPGA networking-enabled. */ enableFpga?: boolean; /** * Whether IP forwarding enabled on this NIC. */ enableIPForwarding?: boolean; /** * Specifies the IP configurations of the network interface. */ ipConfigurations: outputs.azurefleet.VirtualMachineScaleSetIPConfigurationResponse[]; /** * The network security group. */ networkSecurityGroup?: outputs.azurefleet.SubResourceResponse; /** * Specifies the primary network interface in case the virtual machine has more * than 1 network interface. */ primary?: boolean; } /** * Describes a virtual machine scale set network profile's network configurations. */ interface VirtualMachineScaleSetNetworkConfigurationResponse { /** * The network configuration name. */ name: string; /** * Describes a virtual machine scale set network profile's IP configuration. */ properties?: outputs.azurefleet.VirtualMachineScaleSetNetworkConfigurationPropertiesResponse; } /** * Describes a virtual machine scale set network profile. */ interface VirtualMachineScaleSetNetworkProfileResponse { /** * A reference to a load balancer probe used to determine the health of an * instance in the virtual machine scale set. The reference will be in the form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. */ healthProbe?: outputs.azurefleet.ApiEntityReferenceResponse; /** * specifies the Microsoft.Network API version used when creating networking * resources in the Network Interface Configurations for Virtual Machine Scale Set * with orchestration mode 'Flexible' */ networkApiVersion?: string; /** * The list of network configurations. */ networkInterfaceConfigurations?: outputs.azurefleet.VirtualMachineScaleSetNetworkConfigurationResponse[]; } /** * Describes a virtual machine scale set operating system disk. */ interface VirtualMachineScaleSetOSDiskResponse { /** * Specifies the caching requirements. Possible values are: **None,** * **ReadOnly,** **ReadWrite.** The default values are: **None for Standard * storage. ReadOnly for Premium storage.** */ caching?: string; /** * Specifies how the virtual machines in the scale set should be created. The only * allowed value is: **FromImage.** This value is used when you are using an image * to create the virtual machine. If you are using a platform image, you also use * the imageReference element described above. If you are using a marketplace * image, you also use the plan element previously described. */ createOption: string; /** * Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion * (This feature is available for VMSS with Flexible OrchestrationMode only). *

Possible values:

**Delete** If this value is used, the OS * disk is deleted when VMSS Flex VM is deleted.

**Detach** If this value * is used, the OS disk is retained after VMSS Flex VM is deleted.

The * default value is set to **Delete**. For an Ephemeral OS Disk, the default value * is set to **Delete**. User cannot change the delete option for Ephemeral OS * Disk. */ deleteOption?: string; /** * Specifies the ephemeral disk Settings for the operating system disk used by the * virtual machine scale set. */ diffDiskSettings?: outputs.azurefleet.DiffDiskSettingsResponse; /** * Specifies the size of an empty data disk in gigabytes. This element can be used * to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' * is the number of bytes x 1024^3 for the disk and the value cannot * be larger than 1023. */ diskSizeGB?: number; /** * Specifies information about the unmanaged user image to base the scale set on. */ image?: outputs.azurefleet.VirtualHardDiskResponse; /** * The managed disk parameters. */ managedDisk?: outputs.azurefleet.VirtualMachineScaleSetManagedDiskParametersResponse; /** * The disk name. */ name?: string; /** * This property allows you to specify the type of the OS that is included in the * disk if creating a VM from user-image or a specialized VHD. Possible values * are: **Windows,** **Linux.** */ osType?: string; /** * Specifies the container urls that are used to store operating system disks for * the scale set. */ vhdContainers?: string[]; /** * Specifies whether writeAccelerator should be enabled or disabled on the disk. */ writeAcceleratorEnabled?: boolean; } /** * Describes a virtual machine scale set OS profile. */ interface VirtualMachineScaleSetOSProfileResponse { /** * Specifies the name of the administrator account.

**Windows-only * restriction:** Cannot end in "."

**Disallowed values:** * "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", * "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", * "console", "david", "guest", "john", "owner", "root", "server", "sql", * "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5". *

**Minimum-length (Linux):** 1 character

**Max-length * (Linux):** 64 characters

**Max-length (Windows):** 20 characters */ adminUsername?: string; /** * Specifies whether extension operations should be allowed on the virtual machine * scale set. This may only be set to False when no extensions are present on the * virtual machine scale set. */ allowExtensionOperations?: boolean; /** * Specifies the computer name prefix for all of the virtual machines in the scale * set. Computer name prefixes must be 1 to 15 characters long. */ computerNamePrefix?: string; /** * Specifies the Linux operating system settings on the virtual machine. For a * list of supported Linux distributions, see [Linux on Azure-Endorsed * Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */ linuxConfiguration?: outputs.azurefleet.LinuxConfigurationResponse; /** * Optional property which must either be set to True or omitted. */ requireGuestProvisionSignal?: boolean; /** * Specifies set of certificates that should be installed onto the virtual * machines in the scale set. To install certificates on a virtual machine it is * recommended to use the [Azure Key Vault virtual machine extension for * Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) * or the [Azure Key Vault virtual machine extension for * Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */ secrets?: outputs.azurefleet.VaultSecretGroupResponse[]; /** * Specifies Windows operating system settings on the virtual machine. */ windowsConfiguration?: outputs.azurefleet.WindowsConfigurationResponse; } /** * Describes a virtual machines scale sets network configuration's DNS settings. */ interface VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettingsResponse { /** * The Domain name label.The concatenation of the domain name label and vm index * will be the domain name labels of the PublicIPAddress resources that will be * created */ domainNameLabel: string; /** * The Domain name label scope.The concatenation of the hashed domain name label * that generated according to the policy from domain name label scope and vm * index will be the domain name labels of the PublicIPAddress resources that will * be created */ domainNameLabelScope?: string; } /** * Describes a virtual machines scale set IP Configuration's PublicIPAddress * configuration */ interface VirtualMachineScaleSetPublicIPAddressConfigurationPropertiesResponse { /** * Specify what happens to the public IP when the VM is deleted */ deleteOption?: string; /** * The dns settings to be applied on the publicIP addresses . */ dnsSettings?: outputs.azurefleet.VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettingsResponse; /** * The idle timeout of the public IP address. */ idleTimeoutInMinutes?: number; /** * The list of IP tags associated with the public IP address. */ ipTags?: outputs.azurefleet.VirtualMachineScaleSetIpTagResponse[]; /** * Available from Api-Version 2019-07-01 onwards, it represents whether the * specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible * values are: 'IPv4' and 'IPv6'. */ publicIPAddressVersion?: string; /** * The PublicIPPrefix from which to allocate publicIP addresses. */ publicIPPrefix?: outputs.azurefleet.SubResourceResponse; } /** * Describes a virtual machines scale set IP Configuration's PublicIPAddress * configuration */ interface VirtualMachineScaleSetPublicIPAddressConfigurationResponse { /** * The publicIP address configuration name. */ name: string; /** * Describes a virtual machines scale set IP Configuration's PublicIPAddress * configuration */ properties?: outputs.azurefleet.VirtualMachineScaleSetPublicIPAddressConfigurationPropertiesResponse; /** * Describes the public IP Sku. It can only be set with OrchestrationMode as * Flexible. */ sku?: outputs.azurefleet.PublicIPAddressSkuResponse; } /** * Describes a virtual machine scale set storage profile. */ interface VirtualMachineScaleSetStorageProfileResponse { /** * Specifies the parameters that are used to add data disks to the virtual * machines in the scale set. For more information about disks, see [About disks * and VHDs for Azure virtual * machines](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). */ dataDisks?: outputs.azurefleet.VirtualMachineScaleSetDataDiskResponse[]; /** * Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 */ diskControllerType?: string; /** * Specifies information about the image to use. You can specify information about * platform images, marketplace images, or virtual machine images. This element is * required when you want to use a platform image, marketplace image, or virtual * machine image, but is not used in other creation operations. */ imageReference?: outputs.azurefleet.ImageReferenceResponse; /** * Specifies information about the operating system disk used by the virtual * machines in the scale set. For more information about disks, see [About disks * and VHDs for Azure virtual * machines](https://learn.microsoft.com/azure/virtual-machines/managed-disks-overview). */ osDisk?: outputs.azurefleet.VirtualMachineScaleSetOSDiskResponse; } /** * Specifications about a VM Size. This will also contain the corresponding rank and weight in future. */ interface VmSizeProfileResponse { /** * The Sku name (e.g. 'Standard_DS1_v2') */ name: string; /** * The rank of the VM size. This is used with 'RegularPriorityAllocationStrategy.Prioritized' * The lower the number, the higher the priority. Starting with 0. */ rank?: number; } /** * Describes Windows Remote Management configuration of the VM */ interface WinRMConfigurationResponse { /** * The list of Windows Remote Management listeners */ listeners?: outputs.azurefleet.WinRMListenerResponse[]; } /** * Describes Protocol and thumbprint of Windows Remote Management listener */ interface WinRMListenerResponse { /** * This is the URL of a certificate that has been uploaded to Key Vault as a * secret. For adding a secret to the Key Vault, see [Add a key or secret to the * key * vault](https://learn.microsoft.com/azure/key-vault/key-vault-get-started/#add). * In this case, your certificate needs to be the Base64 encoding of the following * JSON Object which is encoded in UTF-8:

{
* "data":"",
"dataType":"pfx",
* "password":""
}
To install certificates on a virtual * machine it is recommended to use the [Azure Key Vault virtual machine extension * for * Linux](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) * or the [Azure Key Vault virtual machine extension for * Windows](https://learn.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */ certificateUrl?: string; /** * Specifies the protocol of WinRM listener. Possible values are: **http,** * **https.** */ protocol?: string; } /** * Specifies Windows operating system settings on the virtual machine. */ interface WindowsConfigurationResponse { /** * Specifies additional base-64 encoded XML formatted information that can be * included in the Unattend.xml file, which is used by Windows Setup. */ additionalUnattendContent?: outputs.azurefleet.AdditionalUnattendContentResponse[]; /** * Indicates whether Automatic Updates is enabled for the Windows virtual machine. * Default value is true. For virtual machine scale sets, this property can be * updated and updates will take effect on OS reprovisioning. */ enableAutomaticUpdates?: boolean; /** * Indicates whether VMAgent Platform Updates is enabled for the Windows virtual * machine. Default value is false. */ enableVMAgentPlatformUpdates?: boolean; /** * [Preview Feature] Specifies settings related to VM Guest Patching on Windows. */ patchSettings?: outputs.azurefleet.PatchSettingsResponse; /** * Indicates whether virtual machine agent should be provisioned on the virtual * machine. When this property is not specified in the request body, it is set to * true by default. This will ensure that VM Agent is installed on the VM so that * extensions can be added to the VM later. */ provisionVMAgent?: boolean; /** * Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". * Possible values can be * [TimeZoneInfo.Id](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) * value from time zones returned by * [TimeZoneInfo.GetSystemTimeZones](https://learn.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). */ timeZone?: string; /** * Specifies the Windows Remote Management listeners. This enables remote Windows * PowerShell. */ winRM?: outputs.azurefleet.WinRMConfigurationResponse; } /** * Specifies additional settings to be applied when patch mode AutomaticByPlatform * is selected in Windows patch settings. */ interface WindowsVMGuestPatchAutomaticByPlatformSettingsResponse { /** * Enables customer to schedule patching without accidental upgrades */ bypassPlatformSafetyChecksOnUserSchedule?: boolean; /** * Specifies the reboot setting for all AutomaticByPlatform patch installation * operations. */ rebootSetting?: string; } } export declare namespace azurelargeinstance { /** * Specifies the disk information fo the Azure Large Instance */ interface DiskResponse { /** * Specifies the size of an empty data disk in gigabytes. */ diskSizeGB?: number; /** * Specifies the logical unit number of the data disk. This value is used to * identify data disks within the VM and therefore must be unique for each data * disk attached to a VM. */ lun: number; /** * The disk name. */ name?: string; } /** * Specifies the hardware settings for the Azure Large Instance. */ interface HardwareProfileResponse { /** * Specifies the Azure Large Instance SKU. */ azureLargeInstanceSize?: string; /** * Name of the hardware type (vendor and/or their product name) */ hardwareType?: string; } /** * Specifies the IP address of the network interface. */ interface IpAddressResponse { /** * Specifies the IP address of the network interface. */ ipAddress?: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.azurelargeinstance.UserAssignedIdentityResponse; }; } /** * Specifies the network settings for the Azure Large Instance disks. */ interface NetworkProfileResponse { /** * Specifies the circuit id for connecting to express route. */ circuitId?: string; /** * Specifies the network interfaces for the Azure Large Instance. */ networkInterfaces?: outputs.azurelargeinstance.IpAddressResponse[]; } /** * Specifies the operating system settings for the Azure Large Instance. */ interface OsProfileResponse { /** * Specifies the host OS name of the Azure Large Instance. */ computerName?: string; /** * This property allows you to specify the type of the OS. */ osType?: string; /** * Specifies the SSH public key used to access the operating system. */ sshPublicKey?: string; /** * Specifies version of operating system. */ version?: string; } /** * Describes the billing related details of the AzureLargeStorageInstance. */ interface StorageBillingPropertiesResponse { /** * the billing mode for the storage instance */ billingMode?: string; /** * the SKU type that is provisioned */ sku?: string; } /** * Specifies the storage settings for the Azure Large Instance disks. */ interface StorageProfileResponse { /** * IP Address to connect to storage. */ nfsIpAddress?: string; /** * Specifies information about the operating system disk used by Azure Large * Instance. */ osDisks?: outputs.azurelargeinstance.DiskResponse[]; } /** * described the storage properties of the azure large storage instance */ interface StoragePropertiesResponse { /** * the kind of storage instance */ generation?: string; /** * the hardware type of the storage instance */ hardwareType?: string; /** * the offering type for which the resource is getting provisioned */ offeringType?: string; /** * State of provisioning of the AzureLargeStorageInstance */ provisioningState: string; /** * the billing related information for the resource */ storageBillingProperties?: outputs.azurelargeinstance.StorageBillingPropertiesResponse; /** * the storage protocol for which the resource is getting provisioned */ storageType?: string; /** * the workload for which the resource is getting provisioned */ workloadType?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace azureplaywrightservice { /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace azureresiliencemanagement { /** * Drill asset properties. */ interface AssetPropertiesOfDrillResponse { /** * Region where Drill's internal resources will be created. */ region: string; /** * Resource group where Drill's internal resources will be created. If not specified, defaults to 'AzureResilienceManagementDrills'. This value is immutable after drill creation. */ resourceGroup?: string; /** * Subscription where Drill's internal resources will be created. */ subscription: string; } /** * Definition of associated identity linked with the various resources. */ interface AssociatedIdentityResponse { /** * Identity type linked with the resource */ type: string; /** * User assigned identity id linked with the resource */ userAssignedIdentity?: string; } /** * Reason why the Drill is in NeedsAttention state, and not ready to run. */ interface AttentionReasonResponse { /** * User MSI associated with chaos experiment object is deleted. */ chaosExperimentUserMsi?: string; /** * Chaos resource for faulting exists or not. */ chaosResource?: string; /** * Reason for Chaos Resource Creation failure */ chaosResourceCreationFailureReasons?: string[]; /** * User MSI associated with chaos resource object is deleted. */ chaosResourceUserMsi?: string; /** * Errors related to Drill Monitoring resources. */ drillMonitoringErrors?: outputs.azureresiliencemanagement.ErrorDetailsResponse[]; /** * Monitoring Resources created for Drill */ drillMonitoringResources: string; /** * Drill object does not have the necessary RBAC to read the Azure Health Model. */ drillRbacOnAzureHealthModel?: string; /** * Drill object does not have the necessary RBAC to read the Azure Monitoring Workspace account. */ drillRbacOnAzureMonitoringWorkspace?: string; /** * Drill object does not have the necessary RBAC to run the chaos resource. */ drillRbacOnChaosResource?: string; /** * Drill object does not have the necessary RBAC to run the chaos experiment. */ drillRbacOnExperiment?: string; /** * Drill MSI does not have the necessary RBAC to read the Drill Monitoring resources. */ drillRbacOnMonitoringResources?: string; /** * Drill object does not have the necessary RBAC to run the Recovery Plan. */ drillRbacOnRecoveryPlan?: string; /** * Drill object does not have the necessary RBAC to read the SLO object. */ drillRbacOnSlo?: string; /** * User MSI associated with Drill object is deleted. */ drillUserMsi?: string; /** * RBAC required by Experiment MSI not setup on the target resources. */ faultRbacOnTargets?: string; /** * Included resource in Drill. */ includedResourceInDrill?: string; /** * List of required required Azure resource providers that are not registered in the subscription specified for chaos resource. */ missingRequiredResourceProviders?: string[]; /** * Monitoring RBAC required by Drill MSI not setup on the target resources. */ monitoringRbacOnDrillResources?: string; /** * Permissions needed by the Drill MSI to read Azure Health Model. */ rbacNeededForDrillOnAzureHealthModel?: string[]; /** * Permissions needed by the Drill MSI to read Azure Monitoring Workspace account. */ rbacNeededForDrillOnAzureMonitoringWorkspace?: string[]; /** * Permissions needed by the Drill MSI to run the chaos resource. */ rbacNeededForDrillOnChaosResource?: string[]; /** * Permissions needed by the Drill MSI to Upload service group health data for monitoring. */ rbacNeededForDrillOnDrillMonitoringResources?: string[]; /** * Permissions needed by the Drill MSI to read health metrics data for resources in service group. */ rbacNeededForDrillOnDrillResources?: string[]; /** * Permissions needed by the Drill MSI to run the chaos experiment. */ rbacNeededForDrillOnExperiment?: string[]; /** * Permissions needed by the Drill MSI to run the Recovery Plan. */ rbacNeededForDrillOnRecoveryPlan?: string[]; /** * Permissions needed by the Drill MSI to read SLO object. */ rbacNeededForDrillOnSlo?: string[]; /** * RBAC required by Chaos Resource MSI not setup on the target resources. */ rbacOnTargetResources?: string; /** * Resources associated in Recovery Plan and Drill are out of sync. */ recoveryPlanAndDrillResourcesState?: string; /** * Associated RO ready or not. */ roReadiness?: string; /** * RBAC required by AutomationAccount for runbook MSI not setup on the target resources. */ runbookFaultRbacOnTargets?: string; /** * Resources in Service Group and Drill are out of sync. */ serviceGroupAndDrillResourcesState?: string; /** * One or more Target or Capability object is deleted. */ targets?: string; } /** * Chaos Experiment properties. */ interface ChaosExperimentPropertiesOfDrillResponse { /** * Chaos Experiment resource created for this Drill */ chaosExperimentId: string; /** * Identity to be used by the Chaos Experiment for invoking faults on resources. */ chaosExperimentIdentityForFaults?: outputs.azureresiliencemanagement.AssociatedIdentityResponse; /** * Duration of faults. */ faultDurationInMin: number; /** * Identity to use for Chaos Experiment operations. */ identity?: outputs.azureresiliencemanagement.AssociatedIdentityResponse; /** * Region for chaosExperiment resource. */ region?: string; /** * Subscription for chaosExperiment resource. */ subscription?: string; } /** * Chaos Resource properties. */ interface ChaosResourcePropertiesOfDrillResponse { /** * Chaos Resource created for this Drill */ chaosResourceId: string; /** * Identity to be used by the Chaos Resource for invoking faults on resources. */ chaosResourceIdentityForFaults: outputs.azureresiliencemanagement.AssociatedIdentityResponse; /** * Duration of faults. */ faultDurationInMin: number; /** * Identity to use for Chaos Resource operations. */ identity: outputs.azureresiliencemanagement.AssociatedIdentityResponse; } /** * Definition of enrollment properties. */ interface EnrollmentPropertiesResponse { /** * Details of any errors encountered during Enrollment create or update. */ errorDetails: outputs.azureresiliencemanagement.ErrorDetailResponse; /** * Provisioning state of the enrollment. */ provisioningState: string; /** * ARM resource identifier of the service group associated with this usage plan. */ serviceGroupId: string; } /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.azureresiliencemanagement.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.azureresiliencemanagement.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * Errors in T&C / RBAC assignment. */ interface ErrorDetailsResponse { /** * Error code. */ code: string; /** * Error message. */ message: string; /** * A list of recommendations to resolve the error. */ recommendations?: string[]; } /** * Definition of goal assignment property. */ interface GoalAssignmentPropertiesResponse { /** * Details of any errors encountered during the operation. */ errorDetails: outputs.azureresiliencemanagement.ErrorDetailResponse; /** * The type of goal assignment. */ goalAssignmentType: string; /** * Arm id of the goal template. */ goalTemplateId: string; /** * Provisioning state */ provisioningState: string; /** * List of service level resources. */ serviceLevelResources?: outputs.azureresiliencemanagement.ServiceLevelResourceResponse[]; } /** * Definition of goal template property. */ interface GoalTemplatePropertiesResponse { /** * Details of any errors encountered during the operation. */ errorDetails: outputs.azureresiliencemanagement.ErrorDetailResponse; /** * Type of Goal Template created by customer */ goalType: string; /** * Provisioning state */ provisioningState: string; /** * Regional recovery point objective specified by customer. eg, PT15M for 15 minutes */ regionalRecoveryPointObjective?: string; /** * Regional recovery time objective specified by customer. eg, PT15M for 15 minutes */ regionalRecoveryTimeObjective?: string; /** * Option specified by customer under disaster recovery section of goal template */ requireDisasterRecovery?: string; /** * Option specified by customer under high availability section of goal template */ requireHighAvailability?: string; } /** * Health Model properties. */ interface HealthModelPropertiesOfDrillResponse { /** * Full ARM Id of the Health Model. */ healthModelId: string; /** * Identity to use for Health Model operations. */ identity: outputs.azureresiliencemanagement.AssociatedIdentityResponse; } /** * Definition of Last Run properties. */ interface LastRunPropertiesResponse { /** * Attestation state of the last run of this Drill. */ lastRunAttestation: string; /** * Timespan of the last run of this Drill. */ lastRunDuration: string; /** * Status of the last run of this Drill. */ lastRunState: string; /** * Timestamp of the last run of this Drill. */ lastRunTime: string; } /** * Configuration of the managed on behalf of resource. */ interface ManagedOnBehalfOfConfigurationResponse { /** * Associated MoboBrokerResources. */ moboBrokerResources: outputs.azureresiliencemanagement.MoboBrokerResourceResponse[]; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.azureresiliencemanagement.UserAssignedIdentityResponse; }; } /** * Metrics properties. */ interface MetricsPropertiesOfDrillResponse { /** * Identity to use for metrics operations. */ identity: outputs.azureresiliencemanagement.AssociatedIdentityResponse; /** * Metrics associated with this Drill. These will be tracked through the Drill Run. */ metricsToTrack: outputs.azureresiliencemanagement.MetricsToTrackResponse[]; } /** * Metrics object */ interface MetricsToTrackResponse { /** * Destination AMW account where the time-series data of the metric lives. */ destinationAmwAccountUrl: string; /** * Full url of the metric. */ metricId: string; /** * Name of the metric. */ metricName: string; } /** * MoboBroker resource. */ interface MoboBrokerResourceResponse { /** * The fully qualified resource ID of the MoboBroker resource. * Example: `/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}` */ id: string; } /** * Drill monitoring properties. */ interface MonitoringPropertiesOfDrillResponse { /** * Full ARM Id of the Data collection endpoint created by Resiliency service which will route data for service group and its resources. */ dataCollectionEndpointId: string; /** * Identity to use for Drill monitoring operations. */ identity?: outputs.azureresiliencemanagement.AssociatedIdentityResponse; /** * Full ARM Id of the Log analytics workspace created by Resiliency service where health data is collected. */ logAnalyticsWorkspaceId: string; /** * Full ARM Id of the Data collection rule created by Resiliency service which will route data for RAW health data for service group resources. */ rawMetricsDataCollectionRuleId: string; /** * Full ARM Id of the Data collection rule created by Resiliency service which will route data for Aggregate health data of service group. */ serviceGroupMetricsDataCollectionRuleId: string; } /** * Defines a custom runbook action for the recovery orchestration group. */ interface RecoveryGroupCustomRunbookActionResponse { /** * The ARM Resource ID of the resource that includes the actionable script, such as a Runbook in an Automation Account. */ actionResourceId?: string; /** * The identity associated with actionResourceId for RBAC. */ associatedIdentity?: outputs.azureresiliencemanagement.AssociatedIdentityResponse; /** * A description of the recovery orchestration group action, containing the instructions to be performed during this action. */ description?: string; /** * The name of the recovery orchestration group action. */ name: string; /** * Key-value parameters for the operation. */ parameters?: { [key: string]: string; }; /** * The maximum amount of time, in minutes, allowed for the action to complete before it times out. */ timeoutInMinutes: number; /** * Specifies the type of recovery orchestration group actions. * Expected value is 'CustomRunbook'. */ type: "CustomRunbook"; } /** * Defines a manual action for the recovery orchestration group. */ interface RecoveryGroupManualActionResponse { /** * A description of the recovery orchestration group action, containing the instructions to be performed during this action. */ description?: string; /** * The name of the recovery orchestration group action. */ name: string; /** * The maximum amount of time, in minutes, allowed for the action to complete before it times out. */ timeoutInMinutes: number; /** * Specifies the type of recovery orchestration group actions. * Expected value is 'ManualAction'. */ type: "ManualAction"; } /** * Properties of the recovery orchestration group. */ interface RecoveryGroupPropertiesResponse { /** * A description of the recovery orchestration group. */ description: string; /** * A unique id for the recovery orchestration group, which is a GUID. */ groupUniqueId: string; /** * The order ID of the recovery orchestration group. */ orderId: number; /** * Post-actions for the recovery orchestration group. */ postActions?: (outputs.azureresiliencemanagement.RecoveryGroupCustomRunbookActionResponse | outputs.azureresiliencemanagement.RecoveryGroupManualActionResponse)[]; /** * Pre-actions for the recovery orchestration group. */ preActions?: (outputs.azureresiliencemanagement.RecoveryGroupCustomRunbookActionResponse | outputs.azureresiliencemanagement.RecoveryGroupManualActionResponse)[]; } /** * Represents a recovery orchestration group resource in the Azure Resilience Management provider namespace. */ interface RecoveryGroupResponse { /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The resource-specific properties for this resource. */ properties?: outputs.azureresiliencemanagement.RecoveryGroupPropertiesResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.azureresiliencemanagement.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Settings for the recovery orchestration groups. */ interface RecoveryGroupsSettingResponse { /** * Additional recovery orchestration group settings. */ additionalGroups?: outputs.azureresiliencemanagement.RecoveryGroupResponse[]; /** * The default recovery orchestration group setting. Every recovery orchestration plan has a default recovery orchestration group. */ defaultGroup: outputs.azureresiliencemanagement.RecoveryGroupResponse; } /** * Details of the recovery orchestration plan failover operation execution. */ interface RecoveryPlanFailoverOperationStatusResponse { /** * Error details for the most recent execution of the recovery orchestration plan. */ errorDetails: outputs.azureresiliencemanagement.ErrorDetailResponse; /** * The most recent execution time of the recovery orchestration plan in UTC. */ lastExecutedAt: string; /** * The status of the most recent execution of the recovery orchestration plan. */ operationStatus: string; /** * The actual recovery time of the most recent recovery orchestration plan. */ recoveryTimeActual: string; } /** * Details of the recovery orchestration plan operation execution. */ interface RecoveryPlanOperationStatusResponse { /** * Error details for the most recent execution of the recovery orchestration plan. */ errorDetails: outputs.azureresiliencemanagement.ErrorDetailResponse; /** * The most recent execution time of the recovery orchestration plan in UTC. */ lastExecutedAt: string; /** * The status of the most recent execution of the recovery orchestration plan. */ operationStatus: string; } /** * RecoveryPlan properties. */ interface RecoveryPlanPropertiesOfDrillResponse { /** * Identity to use for RecoveryPlan operations. */ identity: outputs.azureresiliencemanagement.AssociatedIdentityResponse; /** * Recovery Orchestration plan associated with this Drill. */ recoveryPlanId: string; /** * Excluded resource count in RecoveryPlan. */ recoveryPlanResourceExcludedCount: number; } /** * Properties of the recovery orchestration plan. */ interface RecoveryPlanPropertiesResponse { /** * Error details associated with the resource. */ errorDetails: outputs.azureresiliencemanagement.ErrorDetailResponse; /** * The status of the most recent failover operation executed. */ latestFailoverStatus: outputs.azureresiliencemanagement.RecoveryPlanFailoverOperationStatusResponse; /** * The status of the most recent validation performed. */ latestValidationStatus: outputs.azureresiliencemanagement.RecoveryPlanOperationStatusResponse; /** * A description of the recovery orchestration plan. */ planDescription: string; /** * The current state of the recovery orchestration plan. */ planState: string; /** * The provisioning state of the recovery orchestration plan. */ provisioningState: string; /** * Settings for the recovery orchestration groups associated with the recovery orchestration plan. */ recoveryGroupsSetting: outputs.azureresiliencemanagement.RecoveryGroupsSettingResponse; } /** * Definition of Regional Drill properties. */ interface RegionalDrillPropertiesResponse { /** * Attention reason if the ReadinessState is 'NeedsAttention'. */ attentionReason: outputs.azureresiliencemanagement.AttentionReasonResponse; /** * Chaos Experiment properties. */ chaosExperimentProperties?: outputs.azureresiliencemanagement.ChaosExperimentPropertiesOfDrillResponse; /** * Chaos Resource properties. */ chaosResourceProperties?: outputs.azureresiliencemanagement.ChaosResourcePropertiesOfDrillResponse; /** * Properties for internal resources that are created for the Drill. */ drillAssetProperties?: outputs.azureresiliencemanagement.AssetPropertiesOfDrillResponse; /** * Enum for Drill type object hierarchy. * Expected value is 'Regional'. */ drillType?: "Regional"; /** * Error details associated with the resource. */ errorDetails: outputs.azureresiliencemanagement.ErrorDetailResponse; /** * Readiness state of the Drill. */ executionReadinessState: string; /** * Execution state of the Drill. Whether it is currently running or not. */ executionState: string; /** * HealthModel properties. */ healthModelProperties?: outputs.azureresiliencemanagement.HealthModelPropertiesOfDrillResponse; /** * Last resync and readiness check time. */ lastResyncReadinessCheckTime: string; /** * Last run properties. */ lastRunProperties: outputs.azureresiliencemanagement.LastRunPropertiesResponse; /** * Last sync time. */ lastSyncTime: string; /** * Managed RG v2 properties. */ managedOnBehalfOfConfiguration: outputs.azureresiliencemanagement.ManagedOnBehalfOfConfigurationResponse; /** * Metric properties. */ metricsProperties?: outputs.azureresiliencemanagement.MetricsPropertiesOfDrillResponse; /** * Monitoring properties of the Drill. */ monitoringProperties?: outputs.azureresiliencemanagement.MonitoringPropertiesOfDrillResponse; /** * Status of the last operation. */ provisioningState: string; /** * RBAC setup mode. */ rbacSetupMode?: string; /** * ROPlan properties. */ recoveryPlanProperties?: outputs.azureresiliencemanagement.RecoveryPlanPropertiesOfDrillResponse; /** * Parent SG resource. */ serviceGroupId: string; /** * Internal System Metadata, to be used by internal components only. */ systemMetadata: outputs.azureresiliencemanagement.SystemMetadataResponse; } /** * The Service level resource model */ interface ServiceLevelResourceResponse { /** * The arm id of the service level indicator resource */ serviceLevelIndicatorResourceId: string; /** * The arm id of the service level object resource */ serviceLevelObjectiveResourceId: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Internal System Metadata, to be used by internal components only. */ interface SystemMetadataResponse { /** * Indicates if the Initial system configuration of the Drill is complete or not. */ initialConfig: string; /** * An indication whether a intrested resource type is present in drill resource. */ resourceTypeCategories: string[]; } /** * Definition of usage plan properties. */ interface UsagePlanPropertiesResponse { /** * Details of any errors encountered during Usage Plan create or update. */ errorDetails: outputs.azureresiliencemanagement.ErrorDetailResponse; /** * The type of the usage plan. */ planType?: string; /** * Provisioning state of the usage plan. */ provisioningState: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Definition of Zonal Drill properties. */ interface ZonalDrillPropertiesResponse { /** * Attention reason if the ReadinessState is 'NeedsAttention'. */ attentionReason: outputs.azureresiliencemanagement.AttentionReasonResponse; /** * Chaos Experiment properties. */ chaosExperimentProperties?: outputs.azureresiliencemanagement.ChaosExperimentPropertiesOfDrillResponse; /** * Chaos Resource properties. */ chaosResourceProperties?: outputs.azureresiliencemanagement.ChaosResourcePropertiesOfDrillResponse; /** * Properties for internal resources that are created for the Drill. */ drillAssetProperties?: outputs.azureresiliencemanagement.AssetPropertiesOfDrillResponse; /** * Enum for Drill type object hierarchy. * Expected value is 'Zonal'. */ drillType?: "Zonal"; /** * Error details associated with the resource. */ errorDetails: outputs.azureresiliencemanagement.ErrorDetailResponse; /** * Readiness state of the Drill. */ executionReadinessState: string; /** * Execution state of the Drill. Whether it is currently running or not. */ executionState: string; /** * HealthModel properties. */ healthModelProperties?: outputs.azureresiliencemanagement.HealthModelPropertiesOfDrillResponse; /** * Last resync and readiness check time. */ lastResyncReadinessCheckTime: string; /** * Last run properties. */ lastRunProperties: outputs.azureresiliencemanagement.LastRunPropertiesResponse; /** * Last sync time. */ lastSyncTime: string; /** * Managed RG v2 properties. */ managedOnBehalfOfConfiguration: outputs.azureresiliencemanagement.ManagedOnBehalfOfConfigurationResponse; /** * Metric properties. */ metricsProperties?: outputs.azureresiliencemanagement.MetricsPropertiesOfDrillResponse; /** * Monitoring properties of the Drill. */ monitoringProperties?: outputs.azureresiliencemanagement.MonitoringPropertiesOfDrillResponse; /** * Status of the last operation. */ provisioningState: string; /** * RBAC setup mode. */ rbacSetupMode?: string; /** * ROPlan properties. */ recoveryPlanProperties?: outputs.azureresiliencemanagement.RecoveryPlanPropertiesOfDrillResponse; /** * Parent SG resource. */ serviceGroupId: string; /** * Internal System Metadata, to be used by internal components only. */ systemMetadata: outputs.azureresiliencemanagement.SystemMetadataResponse; /** * An indication whether a VM is included in this Zonal Drill. If not, RO is not needed. */ vmsPresent: string; } } export declare namespace azuresphere { /** * An deployment resource belonging to a device group resource. */ interface DeploymentResponse { /** * Images deployed */ deployedImages?: outputs.azuresphere.ImageResponse[]; /** * Deployment date UTC */ deploymentDateUtc: string; /** * Deployment ID */ deploymentId?: string; /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * The status of the last operation. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.azuresphere.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * An device group resource belonging to a product resource. */ interface DeviceGroupResponse { /** * Flag to define if the user allows for crash dump collection. */ allowCrashDumpsCollection?: string; /** * Description of the device group. */ description?: string; /** * Deployment status for the device group. */ hasDeployment: boolean; /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * Operating system feed type of the device group. */ osFeedType?: string; /** * The status of the last operation. */ provisioningState: string; /** * Regional data boundary for the device group. */ regionalDataBoundary?: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.azuresphere.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; /** * Update policy of the device group. */ updatePolicy?: string; } /** * Device insight report. */ interface DeviceInsightResponse { /** * Event description */ description: string; /** * Device ID */ deviceId: string; /** * Event end timestamp */ endTimestampUtc: string; /** * Event category */ eventCategory: string; /** * Event class */ eventClass: string; /** * Event count */ eventCount: number; /** * Event type */ eventType: string; /** * Event start timestamp */ startTimestampUtc: string; } /** * An device resource belonging to a device group resource. */ interface DeviceResponse { /** * SKU of the chip */ chipSku: string; /** * Device ID */ deviceId?: string; /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * OS version available for installation when update requested */ lastAvailableOsVersion: string; /** * OS version running on device when update requested */ lastInstalledOsVersion: string; /** * Time when update requested and new OS version available */ lastOsUpdateUtc: string; /** * Time when update was last requested */ lastUpdateRequestUtc: string; /** * The name of the resource */ name: string; /** * The status of the last operation. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.azuresphere.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * An image resource belonging to a catalog resource. */ interface ImageResponse { /** * The image component id. */ componentId: string; /** * The image description. */ description: string; /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads. */ image?: string; /** * Image ID */ imageId?: string; /** * Image name */ imageName: string; /** * The image type. */ imageType: string; /** * The name of the resource */ name: string; /** * The status of the last operation. */ provisioningState: string; /** * Regional data boundary for an image */ regionalDataBoundary?: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.azuresphere.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; /** * Location the image */ uri: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace azurestack { /** * Product compatibility */ interface CompatibilityResponse { /** * Full error message if any compatibility issues are found */ description?: string; /** * Tells if product is compatible with current device */ isCompatible?: boolean; /** * List of all issues found */ issues?: string[]; /** * Short error message if any compatibility issues are found */ message?: string; } /** * Data disk image. */ interface DataDiskImageResponse { /** * The LUN. */ lun: number; /** * SAS key for source blob. */ sourceBlobSasUri: string; } /** * Links to product icons. */ interface IconUrisResponse { /** * URI to hero icon. */ hero?: string; /** * URI to large icon. */ large?: string; /** * URI to medium icon. */ medium?: string; /** * URI to small icon. */ small?: string; /** * URI to wide icon. */ wide?: string; } /** * OS disk image. */ interface OsDiskImageResponse { /** * OS operating system type. */ operatingSystem: string; /** * SAS key for source blob. */ sourceBlobSasUri: string; } /** * Link with additional information about a product. */ interface ProductLinkResponse { /** * The description of the link. */ displayName?: string; /** * The URI corresponding to the link. */ uri?: string; } /** * Additional properties of the product */ interface ProductPropertiesResponse { /** * The version. */ version?: string; } /** * Product information. */ interface ProductResponse { /** * The part number used for billing purposes. */ billingPartNumber?: string; /** * Product compatibility with current device. */ compatibility?: outputs.azurestack.CompatibilityResponse; /** * The description of the product. */ description?: string; /** * The display name of the product. */ displayName?: string; /** * The entity tag used for optimistic concurrency when modifying the resource. */ etag?: string; /** * The identifier of the gallery item corresponding to the product. */ galleryItemIdentity?: string; /** * Additional links available for this product. */ iconUris?: outputs.azurestack.IconUrisResponse; /** * ID of the resource. */ id: string; /** * The legal terms. */ legalTerms?: string; /** * Additional links available for this product. */ links?: outputs.azurestack.ProductLinkResponse[]; /** * Name of the resource. */ name: string; /** * The offer representing the product. */ offer?: string; /** * The version of the product offer. */ offerVersion?: string; /** * The length of product content. */ payloadLength?: number; /** * The privacy policy. */ privacyPolicy?: string; /** * The kind of the product (virtualMachine or virtualMachineExtension) */ productKind?: string; /** * Additional properties for the product. */ productProperties?: outputs.azurestack.ProductPropertiesResponse; /** * The user-friendly name of the product publisher. */ publisherDisplayName?: string; /** * Publisher identifier. */ publisherIdentifier?: string; /** * The product SKU. */ sku?: string; /** * Type of Resource. */ type: string; /** * The type of the Virtual Machine Extension. */ vmExtensionType?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace azurestackhci { /** * The AdapterPropertyOverrides of a cluster. */ interface AdapterPropertyOverridesHciEdgeDeviceResponse { /** * This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. */ jumboPacket: string; /** * This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. */ networkDirect: string; /** * This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE' */ networkDirectTechnology: string; } /** * The AdapterPropertyOverrides of a cluster. */ interface AdapterPropertyOverridesResponse { /** * This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. */ jumboPacket?: string; /** * This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. */ networkDirect?: string; /** * This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. Expected values are 'iWARP', 'RoCEv2', 'RoCE' */ networkDirectTechnology?: string; } /** * Connectivity related configuration required by arc server. */ interface ArcConnectivityPropertiesResponse { /** * True indicates ARC connectivity is enabled */ enabled?: boolean; /** * Service configurations associated with the connectivity resource. They are only processed by the server if 'enabled' property is set to 'true'. */ serviceConfigurations?: outputs.azurestackhci.ServiceConfigurationResponse[]; } /** * Backend address pool for the load balancer. */ interface BackendAddressPoolPropertiesResponse { /** * List of backend addresses for the backend pool */ loadBalancerBackendAddresses?: outputs.azurestackhci.LoadBalancerBackendAddressResponse[]; /** * Reference to the logical network for this backend pool. Mutually exclusive with virtualNetwork */ logicalNetwork?: outputs.azurestackhci.LogicalNetworkArmReferenceResponse; /** * Reference to the virtual network for this backend pool. Mutually exclusive with logicalNetwork */ virtualNetwork?: outputs.azurestackhci.VirtualNetworkArmReferenceResponse; } /** * Backend address pool for the load balancer. */ interface BackendAddressPoolResponse { /** * name of the backend pool. */ name: string; /** * properties for the backend pool */ properties: outputs.azurestackhci.BackendAddressPoolPropertiesResponse; } /** * Desired properties of the cluster. */ interface ClusterDesiredPropertiesResponse { /** * Desired level of diagnostic data emitted by the cluster. */ diagnosticLevel?: string; /** * Desired state of Windows Server Subscription. */ windowsServerSubscription?: string; } /** * Cluster node details. */ interface ClusterNodeResponse { /** * Number of physical cores on the cluster node. */ coreCount: number; /** * Edge Hardware Center Resource Id */ ehcResourceId: string; /** * Id of the node in the cluster. */ id: number; /** * Most recent licensing timestamp. */ lastLicensingTimestamp: string; /** * Manufacturer of the cluster node hardware. */ manufacturer: string; /** * Total available memory on the cluster node (in GiB). */ memoryInGiB: number; /** * Model name of the cluster node hardware. */ model: string; /** * Name of the cluster node. */ name: string; /** * Type of the cluster node hardware. */ nodeType: string; /** * OEM activation status of the node. */ oemActivation: string; /** * Display version of the operating system running on the cluster node. */ osDisplayVersion: string; /** * Operating system running on the cluster node. */ osName: string; /** * Version of the operating system running on the cluster node. */ osVersion: string; /** * Immutable id of the cluster node. */ serialNumber: string; /** * State of Windows Server Subscription. */ windowsServerSubscription: string; } /** * Properties reported by cluster agent. */ interface ClusterReportedPropertiesResponse { /** * Unique id generated by the on-prem cluster. */ clusterId: string; /** * Name of the on-prem cluster connected to this resource. */ clusterName: string; /** * The node type of all the nodes of the cluster. */ clusterType: string; /** * Version of the cluster software. */ clusterVersion: string; /** * Level of diagnostic data emitted by the cluster. */ diagnosticLevel?: string; /** * IMDS attestation status of the cluster. */ imdsAttestation: string; /** * Last time the cluster reported the data. */ lastUpdated: string; /** * The manufacturer of all the nodes of the cluster. */ manufacturer: string; /** * List of nodes reported by the cluster. */ nodes: outputs.azurestackhci.ClusterNodeResponse[]; /** * OEM activation status of the cluster. */ oemActivation: string; /** * Capabilities supported by the cluster. */ supportedCapabilities: string[]; } /** * Data used when creating a disk or snapshot */ interface CreationDataResponse { /** * This enumerates the possible sources of a disk's creation */ createOption: string; /** * ARM ID of the source resource used for disk creation. Required when createOption is Copy */ sourceResourceId?: string; /** * Unique ID of the source resource used for disk creation. Read-only and not required for disk creation. */ sourceUniqueId: string; } /** * Properties for a particular default extension category. */ interface DefaultExtensionDetailsResponse { /** * Default extension category */ category: string; /** * Consent time for extension category */ consentTime: string; } /** * AzureStackHCI Cluster deployment properties. */ interface DeploymentClusterResponse { /** * For Azure blob service endpoint type, select either Default or Custom domain. If you selected **Custom domain, enter the domain for the blob service in this format core.windows.net. */ azureServiceEndpoint?: string; /** * Specify the Azure Storage account name for cloud witness for your Azure Stack HCI cluster. */ cloudAccountName?: string; /** * The cluster name provided when preparing Active Directory. */ name?: string; /** * Specify the fileshare path for the local witness for your Azure Stack HCI cluster. */ witnessPath?: string; /** * Use a cloud witness if you have internet access and if you use an Azure Storage account to provide a vote on cluster quorum. A cloud witness uses Azure Blob Storage to read or write a blob file and then uses it to arbitrate in split-brain resolution. Only allowed values are 'Cloud', 'FileShare'. */ witnessType?: string; } /** * Deployment Configuration */ interface DeploymentConfigurationResponse { /** * Scale units will contains list of deployment data */ scaleUnits: outputs.azurestackhci.ScaleUnitsResponse[]; /** * deployment template version */ version?: string; } /** * The Deployment data of AzureStackHCI Cluster. */ interface DeploymentDataResponse { /** * The path to the Active Directory Organizational Unit container object prepared for the deployment. */ adouPath?: string; /** * Observability config to deploy AzureStackHCI Cluster. */ cluster?: outputs.azurestackhci.DeploymentClusterResponse; /** * FQDN to deploy cluster */ domainFqdn?: string; /** * HostNetwork config to deploy AzureStackHCI Cluster. */ hostNetwork?: outputs.azurestackhci.HostNetworkResponse; /** * InfrastructureNetwork config to deploy AzureStackHCI Cluster. */ infrastructureNetwork?: outputs.azurestackhci.InfrastructureNetworkResponse[]; /** * naming prefix to deploy cluster. */ namingPrefix?: string; /** * Observability config to deploy AzureStackHCI Cluster. */ observability?: outputs.azurestackhci.ObservabilityResponse; /** * OptionalServices config to deploy AzureStackHCI Cluster. */ optionalServices?: outputs.azurestackhci.OptionalServicesResponse; /** * list of physical nodes config to deploy AzureStackHCI Cluster. */ physicalNodes?: outputs.azurestackhci.PhysicalNodesResponse[]; /** * SDN Integration config to deploy AzureStackHCI Cluster. */ sdnIntegration?: outputs.azurestackhci.SdnIntegrationResponse; /** * secrets used for cloud deployment. */ secrets?: outputs.azurestackhci.EceDeploymentSecretsResponse[]; /** * Azure keyvault endpoint. This property is deprecated from 2023-12-01-preview. Please use secrets property instead. */ secretsLocation?: string; /** * SecuritySettings to deploy AzureStackHCI Cluster. */ securitySettings?: outputs.azurestackhci.DeploymentSecuritySettingsResponse; /** * Storage config to deploy AzureStackHCI Cluster. */ storage?: outputs.azurestackhci.StorageResponse; } /** * deploymentDataResponseProvideDefaults sets the appropriate defaults for DeploymentDataResponse */ function deploymentDataResponseProvideDefaults(val: DeploymentDataResponse): DeploymentDataResponse; /** * The SecuritySettings of AzureStackHCI Cluster. */ interface DeploymentSecuritySettingsResponse { /** * When set to true, BitLocker XTS_AES 256-bit encryption is enabled for all data-at-rest on the OS volume of your Azure Stack HCI cluster. This setting is TPM-hardware dependent. */ bitlockerBootVolume?: boolean; /** * When set to true, BitLocker XTS-AES 256-bit encryption is enabled for all data-at-rest on your Azure Stack HCI cluster shared volumes. */ bitlockerDataVolumes?: boolean; /** * When set to true, Credential Guard is enabled. */ credentialGuardEnforced?: boolean; /** * When set to true, the security baseline is re-applied regularly. */ driftControlEnforced?: boolean; /** * By default, Secure Boot is enabled on your Azure HCI cluster. This setting is hardware dependent. */ drtmProtection?: boolean; /** * By default, Hypervisor-protected Code Integrity is enabled on your Azure HCI cluster. */ hvciProtection?: boolean; /** * When set to true, all the side channel mitigations are enabled */ sideChannelMitigationEnforced?: boolean; /** * When set to true, cluster east-west traffic is encrypted. */ smbClusterEncryption?: boolean; /** * When set to true, the SMB default instance requires sign in for the client and server services. */ smbSigningEnforced?: boolean; /** * WDAC is enabled by default and limits the applications and the code that you can run on your Azure Stack HCI cluster. */ wdacEnforced?: boolean; } /** * deploymentSecuritySettingsResponseProvideDefaults sets the appropriate defaults for DeploymentSecuritySettingsResponse */ function deploymentSecuritySettingsResponseProvideDefaults(val: DeploymentSecuritySettingsResponse): DeploymentSecuritySettingsResponse; /** * The Step of AzureStackHCI Cluster. */ interface DeploymentStepResponse { /** * Description of step. */ description: string; /** * End time of step. */ endTimeUtc: string; /** * List of exceptions in AzureStackHCI Cluster Deployment. */ exception: string[]; /** * FullStepIndex of step. */ fullStepIndex: string; /** * Name of step. */ name: string; /** * Start time of step. */ startTimeUtc: string; /** * Status of step. Allowed values are 'Error', 'Success', 'InProgress' */ status: string; /** * List of nested steps of AzureStackHCI Cluster Deployment. */ steps: outputs.azurestackhci.DeploymentStepResponse[]; } /** * The device Configuration for edge device. */ interface DeviceConfigurationResponse { /** * Device metadata details. */ deviceMetadata?: string; /** * NIC Details of device */ nicDetails?: outputs.azurestackhci.NicDetailResponse[]; } /** * Device details. */ interface DeviceDetailResponse { /** * Resource Id of group device belongs to. */ claimedBy: string; /** * Resource Id of the device. */ deviceResourceId?: string; } /** * Properties for device pool. */ interface DevicePoolPropertiesResponse { /** * Unique, immutable resource id. */ cloudId: string; /** * Custom Location Name for the pool, default: -CL */ customLocationName?: string; /** * Custom Location Resource Id for the pool */ customLocationResourceId: string; /** * List of machines in device pool. */ devices?: outputs.azurestackhci.DeviceDetailResponse[]; /** * Managed resource group name for the pool */ managedResourceGroup?: string; /** * operation status details for device pool. */ operationDetails: outputs.azurestackhci.OperationDetailResponse[]; /** * The provisioning state of a resource. */ provisioningState: string; } /** * Represents the properties of Download Os job. */ interface DownloadOsJobPropertiesResponse { /** * Deployment mode to trigger job. */ deploymentMode?: string; /** * Download OS request. */ downloadRequest: outputs.azurestackhci.DownloadRequestResponse; /** * The UTC date and time at which the job completed. */ endTimeUtc: string; /** * error details. */ error: outputs.azurestackhci.ErrorDetailResponse; /** * Unique, immutable job id. */ jobId: string; /** * Job Type supported. * Expected value is 'DownloadOs'. */ jobType: "DownloadOs"; /** * Job provisioning state */ provisioningState: string; /** * Reported Properties for Download Os job */ reportedProperties?: outputs.azurestackhci.ProvisionOsReportedPropertiesResponse; /** * The UTC date and time at which the job started. */ startTimeUtc: string; /** * Status of Edge device job. */ status: string; } /** * Operating system profile. */ interface DownloadOsProfileResponse { /** * GPG Public Key used for package verification */ gpgPubKey?: string; /** * Hash of the OS package downloaded */ imageHash?: string; /** * Location of the operating system image. */ osImageLocation?: string; /** * Name of the operating system. */ osName?: string; /** * Type of the operating system. */ osType?: string; /** * Version of the operating system. */ osVersion?: string; /** * Validated Solution Recipe version to be used for the job */ vsrVersion?: string; } /** * Download Request properties */ interface DownloadRequestResponse { /** * Operating system profile. */ osProfile: outputs.azurestackhci.DownloadOsProfileResponse; /** * Target operating system to support polymorphic resource. */ target: string; } /** * The ECE action plan deployment status for AzureStackHCI Cluster. */ interface EceActionStatusResponse { /** * Status of ECE action AzureStackHCI Cluster Deployment. */ status: string; /** * List of steps of AzureStackHCI Cluster Deployment. */ steps: outputs.azurestackhci.DeploymentStepResponse[]; } /** * Protected parameters list stored in keyvault. */ interface EceDeploymentSecretsResponse { /** * Secret name expected for Enterprise Cloud Engine (ECE) deployment. */ eceSecretName?: string; /** * Secret URI stored in keyvault. */ secretLocation?: string; /** * Secret name stored in keyvault. */ secretName?: string; } /** * The DeploymentStatus of AzureStackHCI Cluster. */ interface EceReportedPropertiesResponse { /** * Deployment status of AzureStackHCI Cluster Deployment. */ deploymentStatus: outputs.azurestackhci.EceActionStatusResponse; /** * validation status of AzureStackHCI Cluster Deployment. */ validationStatus: outputs.azurestackhci.EceActionStatusResponse; } /** * Properties for pausing a server in the cluster. */ interface EdgeMachineCollectLogJobPropertiesResponse { /** * Deployment mode to trigger job. */ deploymentMode?: string; /** * The UTC date and time at which the job completed. */ endTimeUtc: string; /** * error details. */ error: outputs.azurestackhci.ErrorDetailResponse; /** * From date for log collection. */ fromDate: string; /** * Unique, immutable job id. */ jobId: string; /** * Job Type supported. * Expected value is 'CollectLog'. */ jobType: "CollectLog"; /** * To date for log collection. */ lastLogGenerated: string; /** * Job provisioning state */ provisioningState: string; /** * log collection job reported properties. */ reportedProperties: outputs.azurestackhci.EdgeMachineCollectLogJobReportedPropertiesResponse; /** * The UTC date and time at which the job started. */ startTimeUtc: string; /** * Status of Edge device job. */ status: string; /** * To date for log collection. */ toDate: string; } /** * Represents the reported properties of a log collection job. */ interface EdgeMachineCollectLogJobReportedPropertiesResponse { /** * Deployment status of job. */ deploymentStatus: outputs.azurestackhci.EceActionStatusResponse; /** * Details of the log collection session. */ logCollectionSessionDetails: outputs.azurestackhci.LogCollectionJobSessionResponse[]; /** * The percentage of the job that is complete. */ percentComplete: number; /** * Validation status of job. */ validationStatus: outputs.azurestackhci.EceActionStatusResponse; } /** * NetworkProfile of edge machine. */ interface EdgeMachineNetworkProfileResponse { /** * List of Network Interface Card (NIC) Details of edge machine. */ nicDetails: outputs.azurestackhci.EdgeMachineNicDetailResponse[]; /** * List of switch Details of edge machine. */ switchDetails: outputs.azurestackhci.SwitchDetailResponse[]; } /** * Network Interface Card (NIC) Details of edge machine. */ interface EdgeMachineNicDetailResponse { /** * Adapter Name of NIC */ adapterName: string; /** * Component Id of NIC */ componentId: string; /** * Default Gateway of NIC */ defaultGateway: string; /** * Default Isolation of Management NIC */ defaultIsolationId: string; /** * DNS Servers for NIC */ dnsServers: string[]; /** * Driver Version of NIC */ driverVersion: string; /** * Interface Description of NIC */ interfaceDescription: string; /** * Subnet Mask of NIC */ ip4Address: string; /** * MAC address information of NIC. */ macAddress: string; /** * The status of NIC, up, disconnected. */ nicStatus: string; /** * The type of NIC, physical, virtual, management. */ nicType: string; /** * Describes the RDMA capability of the network adapter. */ rdmaCapability: string; /** * The slot attached to the NIC. */ slot: string; /** * Subnet Mask of NIC */ subnetMask: string; /** * The switch attached to the NIC, if any. */ switchName: string; /** * The VLAN ID of the physical NIC. */ vlanId: string; } /** * edgeMachineNicDetailResponseProvideDefaults sets the appropriate defaults for EdgeMachineNicDetailResponse */ function edgeMachineNicDetailResponseProvideDefaults(val: EdgeMachineNicDetailResponse): EdgeMachineNicDetailResponse; /** * Properties for edge machine. */ interface EdgeMachinePropertiesResponse { /** * Link to Arc Gateway ARM resource Id */ arcGatewayResourceId?: string; /** * Optional property to create arc machine in custom resource group. */ arcMachineResourceGroupId?: string; /** * Arc machine instance resource id. */ arcMachineResourceId?: string; /** * Tracks the ID of the consuming resource, setting the machine as in-use. */ claimedBy: string; /** * Unique, immutable resource id. */ cloudId: string; /** * machine connectivity status */ connectivityStatus: string; /** * A machine can only be assigned to single device pool */ devicePoolResourceId: string; /** * Edge Machine type. */ edgeMachineKind?: string; /** * Last time data updated to service. */ lastSyncTimestamp: string; /** * OS configuration status details */ machineState: string; /** * operation status details for edge machine. */ operationDetails: outputs.azurestackhci.OperationDetailResponse[]; /** * Ownership voucher details for provisioned machine. */ ownershipVoucherDetails?: outputs.azurestackhci.OwnershipVoucherDetailsResponse; /** * Details for device provisioning. */ provisioningDetails?: outputs.azurestackhci.ProvisioningDetailsResponse; /** * The provisioning state of a resource. */ provisioningState: string; /** * Reported properties for edge machine. */ reportedProperties: outputs.azurestackhci.EdgeMachineReportedPropertiesResponse; /** * Service fetches common configuration from site. */ siteDetails?: outputs.azurestackhci.SiteDetailsResponse; } /** * edgeMachinePropertiesResponseProvideDefaults sets the appropriate defaults for EdgeMachinePropertiesResponse */ function edgeMachinePropertiesResponseProvideDefaults(val: EdgeMachinePropertiesResponse): EdgeMachinePropertiesResponse; /** * Properties for adding a server in the cluster. */ interface EdgeMachineRemoteSupportJobPropertiesResponse { /** * Remote support access level. */ accessLevel: string; /** * Deployment mode to trigger job. */ deploymentMode?: string; /** * The UTC date and time at which the job completed. */ endTimeUtc: string; /** * error details. */ error: outputs.azurestackhci.ErrorDetailResponse; /** * Remote support expiration timestamp. */ expirationTimestamp: string; /** * Unique, immutable job id. */ jobId: string; /** * Job Type supported. * Expected value is 'RemoteSupport'. */ jobType: "RemoteSupport"; /** * Job provisioning state */ provisioningState: string; /** * log collection job reported properties. */ reportedProperties: outputs.azurestackhci.EdgeMachineRemoteSupportJobReportedPropertiesResponse; /** * The UTC date and time at which the job started. */ startTimeUtc: string; /** * Status of Edge device job. */ status: string; /** * Remote support type. */ type: string; } /** * Represents the reported properties of a remote support job. */ interface EdgeMachineRemoteSupportJobReportedPropertiesResponse { /** * Deployment status of job. */ deploymentStatus: outputs.azurestackhci.EceActionStatusResponse; /** * Optional settings for configuring the node for remote support. */ nodeSettings: outputs.azurestackhci.EdgeMachineRemoteSupportNodeSettingsResponse; /** * The percentage of the job that is complete. */ percentComplete: number; /** * Details of the remote support session. */ sessionDetails: outputs.azurestackhci.RemoteSupportSessionResponse[]; /** * Validation status of job. */ validationStatus: outputs.azurestackhci.EceActionStatusResponse; } /** * Represents the settings of a remote support node. */ interface EdgeMachineRemoteSupportNodeSettingsResponse { /** * The error message, if any, from the last connection attempt. */ connectionErrorMessage: string; /** * The current connection status of the remote support session. */ connectionStatus: string; /** * The timestamp when the node settings were created, in UTC. */ createdAt: string; /** * The state of the remote support node. */ state: string; /** * The timestamp when the node settings were last updated, in UTC. */ updatedAt: string; } /** * Reported properties for edge machine. */ interface EdgeMachineReportedPropertiesResponse { /** * Extension details for edge machine. */ extensionProfile: outputs.azurestackhci.ExtensionProfileEdgeMachineResponse; /** * Hardware related information for edge machine. */ hardwareProfile: outputs.azurestackhci.HardwareProfileResponse; /** * Last time data reported. */ lastUpdated: string; /** * Network details for edge machine. */ networkProfile: outputs.azurestackhci.EdgeMachineNetworkProfileResponse; /** * OS Properties for edge machine. */ osProfile: outputs.azurestackhci.OsProfileResponse; /** * Solution builder extension (SBE) deployment package information. */ sbeDeploymentPackageInfo: outputs.azurestackhci.SbeDeploymentPackageInfoResponse; /** * Storage related information for edge machine. */ storageProfile: outputs.azurestackhci.StorageProfileResponse; } /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * details of validation failure */ interface ErrorDetailHciEdgeDeviceResponse { /** * Exception details while installing extension. */ exception: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.azurestackhci.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.azurestackhci.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * The complex type of the extended location. */ interface ExtendedLocationResponse { /** * The name of the extended location. */ name?: string; /** * The type of the extended location. */ type?: string; } /** * Describes the Extension Instance View. */ interface ExtensionInstanceViewResponse { /** * The extension name. */ name?: string; /** * Instance view status. */ status?: outputs.azurestackhci.ExtensionInstanceViewResponseStatus; /** * Specifies the type of the extension; an example is "MicrosoftMonitoringAgent". */ type?: string; /** * Specifies the version of the script handler. */ typeHandlerVersion?: string; } /** * Instance view status. */ interface ExtensionInstanceViewResponseStatus { /** * The status code. */ code?: string; /** * The short localizable label for the status. */ displayStatus?: string; /** * The level code. */ level?: string; /** * The detailed status message, including for alerts and error messages. */ message?: string; /** * The time of the status. */ time?: string; } /** * Extensions details for edge device. */ interface ExtensionProfileEdgeMachineResponse { /** * List of Arc extensions installed on edge device. */ extensions: outputs.azurestackhci.HciEdgeDeviceArcExtensionResponse[]; } /** * Extensions details for edge device. */ interface ExtensionProfileResponse { /** * List of Arc extensions installed on edge device. */ extensions: outputs.azurestackhci.ExtensionResponse[]; } /** * Arc extension installed on edge device. */ interface ExtensionResponse { /** * Error details while installing Arc extension. */ errorDetails: outputs.azurestackhci.ErrorDetailHciEdgeDeviceResponse[]; /** * Arc extension name installed on edge device. */ extensionName: string; /** * Arc Extension Azure resource id. */ extensionResourceId: string; /** * Extension managed by user or Azure. */ managedBy: string; /** * Arc extension state from arc machine extension. */ state: string; /** * Extension version installed. */ typeHandlerVersion: string; } /** * extensionResponseProvideDefaults sets the appropriate defaults for ExtensionResponse */ function extensionResponseProvideDefaults(val: ExtensionResponse): ExtensionResponse; /** * FrontendIP Configuration object for a load balancer. */ interface FrontendIPConfigurationPropertiesResponse { /** * Private IP Address that was allocated (dynamic) or is to be allocated (static) from the subnet. */ privateIPAddress?: string; /** * privateIPAllocationMethod - set to Static for requesting a specific IP */ privateIPAllocationMethod?: string; /** * Public IP */ publicIPAddress?: outputs.azurestackhci.PublicIPAddressArmReferenceResponse; /** * subnet - the subnet from which to allocate the private IP */ subnet?: outputs.azurestackhci.VirtualNetworkSubnetArmReferenceResponse; } /** * FrontendIP Configuration object for a load balancer. */ interface FrontendIPConfigurationResponse { /** * name for the frontend IP configuration. */ name: string; /** * properties for this frontendIPConfiguration */ properties: outputs.azurestackhci.FrontendIPConfigurationPropertiesResponse; } /** * This is the gallery image definition identifier. */ interface GalleryImageIdentifierResponse { /** * The name of the gallery image definition offer. */ offer: string; /** * The name of the gallery image definition publisher. */ publisher: string; /** * The name of the gallery image definition SKU. */ sku: string; } /** * The download status of the gallery image */ interface GalleryImageStatusDownloadStatusResponse { /** * The downloaded sized of the image in MB */ downloadSizeInMB?: number; } /** * The status of the operation performed on the gallery image */ interface GalleryImageStatusProvisioningStatusResponse { /** * The ID of the operation performed on the gallery image */ operationId?: string; /** * The status of the operation performed on the gallery image [Succeeded, Failed, InProgress] */ status: string; } /** * The observed state of gallery images */ interface GalleryImageStatusResponse { /** * The download status of the gallery image */ downloadStatus?: outputs.azurestackhci.GalleryImageStatusDownloadStatusResponse; /** * GalleryImage provisioning error code */ errorCode?: string; /** * Descriptive error message */ errorMessage?: string; /** * The progress of the operation in percentage */ progressPercentage?: number; /** * provisioning status of the gallery image */ provisioningStatus?: outputs.azurestackhci.GalleryImageStatusProvisioningStatusResponse; } /** * Specifies information about the gallery image version that you want to create or update. */ interface GalleryImageVersionResponse { /** * This is the version of the gallery image. */ name?: string; /** * This is the storage profile of a Gallery Image Version. */ storageProfile: outputs.azurestackhci.GalleryImageVersionStorageProfileResponse; } /** * This is the storage profile of a Gallery Image Version. */ interface GalleryImageVersionStorageProfileResponse { /** * This is the OS disk image. */ osDiskImage?: outputs.azurestackhci.GalleryOSDiskImageResponse; } /** * This is the OS disk image. */ interface GalleryOSDiskImageResponse { /** * This property indicates the size of the VHD to be created. */ sizeInMB: number; } /** * Defines the status of a guest agent installation. */ interface GuestAgentInstallStatusResponse { /** * The hybrid machine agent full version. */ agentVersion: string; /** * Details about the error state. */ errorDetails: outputs.azurestackhci.ErrorDetailResponse[]; /** * The time of the last status change. */ lastStatusChange: string; /** * The installation status of the hybrid machine agent installation. */ status: string; /** * Specifies the VM's unique SMBIOS ID. */ vmUuid: string; } /** * Defines the resource properties. */ interface GuestAgentProfileResponse { /** * The hybrid machine agent full version. */ agentVersion: string; /** * Details about the error state. */ errorDetails: outputs.azurestackhci.ErrorDetailResponse[]; /** * The time of the last status change. */ lastStatusChange: string; /** * The status of the hybrid machine agent. */ status: string; /** * Specifies the VM's unique SMBIOS ID. */ vmUuid: string; } /** * Username / Password Credentials to connect to guest. */ interface GuestCredentialResponse { /** * The username to connect with the guest. */ username?: string; } /** * Hardware profile for the machine */ interface HardwareProfileResponse { /** * Number of cpu cores in the machine */ cpuCores: number; /** * Number of cpu sockets in the machine */ cpuSockets: number; /** * manufacturer info of the machine */ manufacturer: string; /** * Memory capacity of the machine */ memoryCapacityInGb: number; /** * Model info of the machine */ model: string; /** * Process type of the machine */ processorType: string; /** * Serial number of the machine */ serialNumber: string; } /** * Represents the properties of an HCI Collect Log job. */ interface HciCollectLogJobPropertiesResponse { /** * Deployment mode to trigger job. */ deploymentMode?: string; /** * The UTC date and time at which the job completed. */ endTimeUtc: string; /** * From date for log collection. */ fromDate: string; /** * Unique, immutable job id. */ jobId: string; /** * Job Type supported. * Expected value is 'CollectLog'. */ jobType: "CollectLog"; /** * To date for log collection. */ lastLogGenerated: string; /** * Job provisioning state */ provisioningState: string; /** * log collection job reported properties. */ reportedProperties: outputs.azurestackhci.LogCollectionReportedPropertiesResponse; /** * The UTC date and time at which the job started. */ startTimeUtc: string; /** * Status of Edge device job. */ status: string; /** * To date for log collection. */ toDate: string; } /** * Defines the customer's intent for updating confidential VM properties */ interface HciConfigureCvmJobPropertiesResponse { /** * Defines the customer's intent for updating confidential VM properties */ confidentialVmIntent: string; /** * Deployment mode to trigger job. */ deploymentMode?: string; /** * The UTC date and time at which the job completed. */ endTimeUtc: string; /** * Unique, immutable job id. */ jobId: string; /** * ClusterJob Type supported. * Expected value is 'ConfigureCVM'. */ jobType: "ConfigureCVM"; /** * Job provisioning state */ provisioningState: string; /** * Reported properties for job */ reportedProperties: outputs.azurestackhci.JobReportedPropertiesResponse; /** * The UTC date and time at which the job started. */ startTimeUtc: string; /** * Status of Cluster job. */ status: string; } /** * hciConfigureCvmJobPropertiesResponseProvideDefaults sets the appropriate defaults for HciConfigureCvmJobPropertiesResponse */ function hciConfigureCvmJobPropertiesResponseProvideDefaults(val: HciConfigureCvmJobPropertiesResponse): HciConfigureCvmJobPropertiesResponse; /** * Properties for configuring SDN integration intent for the cluster. */ interface HciConfigureSdnIntegrationJobPropertiesResponse { /** * Deployment mode to trigger job. */ deploymentMode?: string; /** * The UTC date and time at which the job completed. */ endTimeUtc: string; /** * Unique, immutable job id. */ jobId: string; /** * ClusterJob Type supported. * Expected value is 'ConfigureSdnIntegration'. */ jobType: "ConfigureSdnIntegration"; /** * Job provisioning state */ provisioningState: string; /** * Reported properties for job */ reportedProperties: outputs.azurestackhci.JobReportedPropertiesResponse; /** * Defines the customer's intent for configuring SDN integration */ sdnIntegrationIntent: string; /** * A string identifier used to construct the Network Controller (NC) REST resource name. This prefix helps group and distinguish SDN-managed network components and must follow specific formatting rules. */ sdnPrefix?: string; /** * The UTC date and time at which the job started. */ startTimeUtc: string; /** * Status of Cluster job. */ status: string; } /** * hciConfigureSdnIntegrationJobPropertiesResponseProvideDefaults sets the appropriate defaults for HciConfigureSdnIntegrationJobPropertiesResponse */ function hciConfigureSdnIntegrationJobPropertiesResponseProvideDefaults(val: HciConfigureSdnIntegrationJobPropertiesResponse): HciConfigureSdnIntegrationJobPropertiesResponse; /** * Arc extension installed on edge device. */ interface HciEdgeDeviceArcExtensionResponse { /** * Error details while installing Arc extension. */ errorDetails: outputs.azurestackhci.HciValidationFailureDetailResponse[]; /** * Arc extension name installed on edge device. */ extensionName: string; /** * Arc Extension Azure resource id. */ extensionResourceId: string; /** * Indicates whether the extension is managed by the user or by Azure. */ managedBy: string; /** * Arc extension state from arc machine extension. */ state: string; /** * Extension version installed. */ typeHandlerVersion: string; } /** * properties for Arc-enabled edge device with HCI OS. */ interface HciEdgeDevicePropertiesResponse { /** * Device Configuration */ deviceConfiguration?: outputs.azurestackhci.DeviceConfigurationResponse; /** * Provisioning state of edgeDevice resource */ provisioningState: string; /** * The instance view of all current configurations on HCI device. */ reportedProperties: outputs.azurestackhci.HciReportedPropertiesResponse; } /** * The network profile of a device. */ interface HciNetworkProfileResponse { /** * HostNetwork config to deploy AzureStackHCI Cluster. */ hostNetwork: outputs.azurestackhci.HostNetworkHciEdgeDeviceResponse; /** * List of NIC Details of device. */ nicDetails: outputs.azurestackhci.HciNicDetailResponse[]; /** * List of switch details for edge device. */ switchDetails: outputs.azurestackhci.SwitchDetailResponse[]; } /** * The NIC Detail of a device. */ interface HciNicDetailResponse { /** * Adapter Name of NIC */ adapterName: string; /** * Component Id of NIC */ componentId: string; /** * Default Gateway of NIC */ defaultGateway: string; /** * Default Isolation of Management NIC */ defaultIsolationId: string; /** * DNS Servers for NIC */ dnsServers: string[]; /** * Driver Version of NIC */ driverVersion: string; /** * Interface Description of NIC */ interfaceDescription: string; /** * Subnet Mask of NIC */ ip4Address: string; /** * MAC address information of NIC. */ macAddress: string; /** * The status of NIC, up, disconnected. */ nicStatus: string; /** * The type of NIC, physical, virtual, management. */ nicType: string; /** * The slot attached to the NIC. */ slot: string; /** * Subnet Mask of NIC */ subnetMask: string; /** * The switch attached to the NIC, if any. */ switchName: string; /** * The VLAN ID of the physical NIC. */ vlanId: string; } /** * OS configurations for HCI device. */ interface HciOsProfileResponse { /** * Version of assembly present on device */ assemblyVersion: string; /** * The boot type of the device. e.g. UEFI, Legacy etc */ bootType: string; } /** * Represents the properties of a remote support job for HCI. */ interface HciRemoteSupportJobPropertiesResponse { /** * Remote support access level. */ accessLevel: string; /** * Deployment mode to trigger job. */ deploymentMode?: string; /** * The UTC date and time at which the job completed. */ endTimeUtc: string; /** * Remote support expiration timestamp. */ expirationTimestamp: string; /** * Unique, immutable job id. */ jobId: string; /** * Job Type supported. * Expected value is 'RemoteSupport'. */ jobType: "RemoteSupport"; /** * Job provisioning state */ provisioningState: string; /** * log collection job reported properties. */ reportedProperties: outputs.azurestackhci.RemoteSupportJobReportedPropertiesResponse; /** * The UTC date and time at which the job started. */ startTimeUtc: string; /** * Status of Edge device job. */ status: string; /** * Remote support type. */ type: string; } /** * The device Configuration for HCI device. */ interface HciReportedPropertiesResponse { /** * edge device state. */ deviceState: string; /** * Extensions details for edge device. */ extensionProfile: outputs.azurestackhci.ExtensionProfileResponse; /** * HCI device network information. */ networkProfile: outputs.azurestackhci.HciNetworkProfileResponse; /** * HCI device OS specific information. */ osProfile: outputs.azurestackhci.HciOsProfileResponse; /** * Solution builder extension (SBE) deployment package information. */ sbeDeploymentPackageInfo: outputs.azurestackhci.SbeDeploymentPackageInfoResponse; } /** * details of validation failure */ interface HciValidationFailureDetailResponse { /** * Exception details while installing extension. */ exception: string; } /** * The HostNetwork of a cluster. */ interface HostNetworkHciEdgeDeviceResponse { /** * Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically. */ enableStorageAutoIp: boolean; /** * The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM. */ intents: outputs.azurestackhci.IntentsHciEdgeDeviceResponse[]; /** * Defines how the storage adapters between nodes are connected either switch or switch less. */ storageConnectivitySwitchless: boolean; /** * List of StorageNetworks config to deploy AzureStackHCI Cluster. */ storageNetworks: outputs.azurestackhci.StorageNetworksHciEdgeDeviceResponse[]; } /** * The HostNetwork of a cluster. */ interface HostNetworkResponse { /** * Optional parameter required only for 3 Nodes Switchless deployments. This allows users to specify IPs and Mask for Storage NICs when Network ATC is not assigning the IPs for storage automatically. */ enableStorageAutoIp?: boolean; /** * The network intents assigned to the network reference pattern used for the deployment. Each intent will define its own name, traffic type, adapter names, and overrides as recommended by your OEM. */ intents?: outputs.azurestackhci.IntentsResponse[]; /** * Defines how the storage adapters between nodes are connected either switch or switch less.. */ storageConnectivitySwitchless?: boolean; /** * List of StorageNetworks config to deploy AzureStackHCI Cluster. */ storageNetworks?: outputs.azurestackhci.StorageNetworksResponse[]; } /** * hostNetworkResponseProvideDefaults sets the appropriate defaults for HostNetworkResponse */ function hostNetworkResponseProvideDefaults(val: HostNetworkResponse): HostNetworkResponse; /** * HTTP Proxy configuration for the VM. */ interface HttpProxyConfigurationResponse { /** * The HTTP proxy server endpoint to use. */ httpProxy?: string; /** * The HTTPS proxy server endpoint to use. */ httpsProxy?: string; /** * The endpoints that should not go through proxy. */ noProxy?: string[]; /** * Alternative CA cert to use for connecting to proxy servers. */ trustedCa?: string; } /** * The Azure Resource ID of an IPConfiguration resource */ interface IPConfigurationArmReferenceResponse { /** * The Azure Resource ID of an IPConfiguration resource */ resourceId?: string; } /** * InterfaceIPConfigurationPropertiesFormat properties of IP configuration. */ interface IPConfigurationPropertiesResponse { /** * Gateway for network interface */ gateway: string; /** * prefixLength for network interface */ prefixLength: string; /** * PrivateIPAddress - Private IP address of the IP configuration. */ privateIPAddress?: string; /** * Subnet - Name of Subnet bound to the IP configuration. */ subnet?: outputs.azurestackhci.LogicalNetworkArmReferenceResponse; } /** * InterfaceIPConfiguration IPConfiguration in a network interface. */ interface IPConfigurationResponse { /** * Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * InterfaceIPConfigurationPropertiesFormat properties of IP configuration. */ properties?: outputs.azurestackhci.IPConfigurationPropertiesResponse; } /** * IP Pool info */ interface IPPoolInfoResponse { /** * Number of IP addresses available in the IP Pool */ available: string; /** * Number of IP addresses allocated from the IP Pool */ used: string; } /** * Describes IPPool */ interface IPPoolResponse { /** * End of the IP address pool */ end?: string; /** * IPPool info */ info?: outputs.azurestackhci.IPPoolInfoResponse; /** * Type of the IP Pool [vm, vippool] */ ipPoolType?: string; /** * Name of the IP-Pool */ name?: string; /** * Start of the IP address pool */ start?: string; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The identity type. */ type?: string; } /** * The Azure Resource ID for a Gallery Image. */ interface ImageArmReferenceResponse { /** * The Azure Resource ID for an image resource used by the virtual machine instance. */ id?: string; } /** * Inbound nat rule properties */ interface InboundNATRulePropertiesResponse { /** * IP configuration for the target backend. */ backendIPConfiguration: outputs.azurestackhci.IPConfigurationArmReferenceResponse; /** * backend Port for the inbound rule */ backendPort: number; /** * Frontend Port for the inbound rule */ frontendPort: number; /** * Protocol for the NAT rule */ protocol: string; /** * Public IP Address for this NAT rule */ publicIPAddress: outputs.azurestackhci.PublicIPAddressArmReferenceResponse; } /** * Inbound nat rule properties */ interface InboundNATRuleResponse { /** * name of the inbound nat rule */ name: string; /** * properties of the inbound nat rule */ properties: outputs.azurestackhci.InboundNATRulePropertiesResponse; } /** * Inbound rule properties - extends InboundNATRuleProperties with additional status tracking */ interface InboundRulePropertiesResponse { /** * IP configuration for the target backend. */ backendIPConfiguration: outputs.azurestackhci.IPConfigurationArmReferenceResponse; /** * backend Port for the inbound rule */ backendPort: number; /** * Frontend Port for the inbound rule */ frontendPort: number; /** * Protocol for the NAT rule */ protocol: string; /** * Provisioning state of the inbound rule */ provisioningState: string; /** * Public IP Address for this NAT rule */ publicIPAddress: outputs.azurestackhci.PublicIPAddressArmReferenceResponse; /** * The observed state of Inbound Rule */ status: outputs.azurestackhci.InboundRuleStatusResponse; } /** * Provisioning status of Inbound Rule */ interface InboundRuleStatusProvisioningStatusResponse { /** * The ID of the operation performed on the inbound rule */ operationId?: string; /** * The status of the operation performed on the inbound rule [Succeeded, Failed, InProgress] */ status: string; } /** * The observed state of inbound rule */ interface InboundRuleStatusResponse { /** * InboundRule provisioning error code */ errorCode?: string; /** * Descriptive error message */ errorMessage?: string; /** * InboundRule provisioning status */ provisioningStatus?: outputs.azurestackhci.InboundRuleStatusProvisioningStatusResponse; } /** * The InfrastructureNetwork of a AzureStackHCI Cluster. */ interface InfrastructureNetworkResponse { /** * IPv4 address of the DNS servers in your environment. */ dnsServers?: string[]; /** * Default gateway that should be used for the provided IP address space. */ gateway?: string; /** * Range of IP addresses from which addresses are allocated for nodes within a subnet. */ ipPools?: outputs.azurestackhci.IpPoolsResponse[]; /** * Subnet mask that matches the provided IP address space. */ subnetMask?: string; /** * Allows customers to use DHCP for Hosts and Cluster IPs. If not declared, the deployment will default to static IPs. When true, GW and DNS servers are not required */ useDhcp?: boolean; } /** * Instance view status. */ interface InstanceViewStatusResponse { /** * The status code. */ code?: string; /** * The short localizable label for the status. */ displayStatus?: string; /** * The level code. */ level?: string; /** * The detailed status message, including for alerts and error messages. */ message?: string; /** * The time of the status. */ time?: string; } /** * The Intents of a cluster. */ interface IntentsHciEdgeDeviceResponse { /** * Set Adapter PropertyOverrides for cluster. */ adapterPropertyOverrides: outputs.azurestackhci.AdapterPropertyOverridesHciEdgeDeviceResponse; /** * Array of adapters used for the network intent. */ intentAdapters: string[]; /** * Name of the network intent you wish to create. */ intentName: string; /** * IntentType for host network intent. */ intentType: number; /** * IsComputeIntentSet for host network intent. */ isComputeIntentSet: boolean; /** * IsManagementIntentSet for host network intent. */ isManagementIntentSet: boolean; /** * IsNetworkIntentType for host network intent. */ isNetworkIntentType: boolean; /** * IntentType for host network intent. */ isOnlyStorage: boolean; /** * IsOnlyStretch for host network intent. */ isOnlyStretch: boolean; /** * IsStorageIntentSet for host network intent. */ isStorageIntentSet: boolean; /** * IsStretchIntentSet for host network intent. */ isStretchIntentSet: boolean; /** * This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. */ overrideAdapterProperty: boolean; /** * This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. */ overrideQosPolicy: boolean; /** * This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. */ overrideVirtualSwitchConfiguration: boolean; /** * Set QoS PolicyOverrides for cluster. */ qosPolicyOverrides: outputs.azurestackhci.QosPolicyOverridesResponse; /** * Scope for host network intent. */ scope: number; /** * Set virtualSwitch ConfigurationOverrides for cluster. */ virtualSwitchConfigurationOverrides: outputs.azurestackhci.VirtualSwitchConfigurationOverridesHciEdgeDeviceResponse; } /** * The Intents of a cluster. */ interface IntentsResponse { /** * Array of network interfaces used for the network intent. */ adapter?: string[]; /** * Set Adapter PropertyOverrides for cluster. */ adapterPropertyOverrides?: outputs.azurestackhci.AdapterPropertyOverridesResponse; /** * Name of the network intent you wish to create. */ name?: string; /** * This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. */ overrideAdapterProperty?: boolean; /** * This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. */ overrideQosPolicy?: boolean; /** * This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. */ overrideVirtualSwitchConfiguration?: boolean; /** * Set QoS PolicyOverrides for cluster. */ qosPolicyOverrides?: outputs.azurestackhci.QosPolicyOverridesResponse; /** * List of network traffic types. Only allowed values are 'Compute', 'Storage', 'Management'. */ trafficType?: string[]; /** * Set virtualSwitch ConfigurationOverrides for cluster. */ virtualSwitchConfigurationOverrides?: outputs.azurestackhci.VirtualSwitchConfigurationOverridesResponse; } /** * intentsResponseProvideDefaults sets the appropriate defaults for IntentsResponse */ function intentsResponseProvideDefaults(val: IntentsResponse): IntentsResponse; /** * DNS Settings of the interface */ interface InterfaceDNSSettingsResponse { /** * List of DNS server IP Addresses for the interface */ dnsServers?: string[]; } /** * IP address range configuration. */ interface IpAddressRangeResponse { /** * End IP address. */ endIp: string; /** * Start IP address. */ startIp: string; } /** * The dnsServers of a device. */ interface IpPoolsResponse { /** * Ending IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. */ endingAddress?: string; /** * Starting IP address for the management network. A minimum of six free, contiguous IPv4 addresses (excluding your host IPs) are needed for infrastructure services such as clustering. */ startingAddress?: string; } /** * Attestation configurations for isolated VM (e.g. TVM, CVM) of the cluster. */ interface IsolatedVmAttestationConfigurationResponse { /** * Fully qualified Azure resource id of the Microsoft Azure attestation resource associated with this cluster. */ attestationResourceId: string; /** * Region specific endpoint for Microsoft Azure Attestation service for the cluster */ attestationServiceEndpoint: string; /** * Region specific endpoint for relying party service. */ relyingPartyServiceEndpoint: string; } /** * Reported Properties for job triggered from cloud. */ interface JobReportedPropertiesResponse { /** * Deployment status of job. */ deploymentStatus: outputs.azurestackhci.EceActionStatusResponse; /** * The percentage of the job that is complete. */ percentComplete: number; /** * Validation status of job. */ validationStatus: outputs.azurestackhci.EceActionStatusResponse; } /** * Reference to a LoadBalancer backend address pool reference */ interface LoadBalancerBackendAddressPoolReferenceResponse { /** * name of the backend address pool */ name: string; } /** * LoadBalancer Backend Address properties */ interface LoadBalancerBackendAddressPropertiesResponse { /** * admin state - if set to false, the address is removed from the pool */ adminState?: string; /** * IP address of the backend target. Populated automatically from the referenced IP configuration. */ ipAddress: string; /** * Reference to the logical network containing this backend address. Populated automatically from the referenced IP configuration. Mutually exclusive with subnet and virtualNetwork. */ logicalNetwork: outputs.azurestackhci.LogicalNetworkArmReferenceResponse; /** * Nic Based backend-ip association */ networkInterfaceIPConfiguration?: outputs.azurestackhci.IPConfigurationArmReferenceResponse; /** * Reference to the subnet containing the backend address. Populated automatically from the referenced IP configuration. Mutually exclusive with logicalNetwork. */ subnet: outputs.azurestackhci.VirtualNetworkSubnetArmReferenceResponse; /** * Reference to the virtual network containing the backend address. Populated automatically from the referenced IP configuration. Mutually exclusive with logicalNetwork. */ virtualNetwork: outputs.azurestackhci.VirtualNetworkArmReferenceResponse; } /** * LoadBalancer Backend Address */ interface LoadBalancerBackendAddressResponse { /** * name of the backend address */ name: string; /** * backend address properties */ properties: outputs.azurestackhci.LoadBalancerBackendAddressPropertiesResponse; } /** * Reference to a LoadBalancer Frontend IPConfiguration */ interface LoadBalancerFrontendIPConfigurationReferenceResponse { /** * name of the frontnedIPConfiguration */ name: string; } /** * Reference to a LoadBalancer health probe */ interface LoadBalancerProbeReferenceResponse { /** * name of the health probe */ name: string; } /** * Load Balancer resource properties */ interface LoadBalancerPropertiesResponse { /** * backendAddressPools for the loadbalancer */ backendAddressPools?: outputs.azurestackhci.BackendAddressPoolResponse[]; /** * Frontend IPs for the loadbalancer. */ frontendIPConfigurations: outputs.azurestackhci.FrontendIPConfigurationResponse[]; /** * load balancer rules */ loadBalancingRules?: outputs.azurestackhci.LoadBalancerRuleResponse[]; /** * load balancer health probes */ probes?: outputs.azurestackhci.ProbeResponse[]; /** * Provisioning state of the Load Balancer */ provisioningState: string; /** * observed state of the load balancer */ status: outputs.azurestackhci.LoadBalancerStatusResponse; } /** * Properties for LoadBalancerRules */ interface LoadBalancerRulePropertiesResponse { /** * arm reference to backend pool being used by ths pool */ backendAddressPool: outputs.azurestackhci.LoadBalancerBackendAddressPoolReferenceResponse; /** * backendPort to forward connections */ backendPort: number; /** * arm reference to frontend IP being used by this LB */ frontendIPConfiguration: outputs.azurestackhci.LoadBalancerFrontendIPConfigurationReferenceResponse; /** * Frontend port to accept connections */ frontendPort: number; /** * Time for which connections are preserved before being torn down. */ idleTimeoutInMinutes?: number; /** * SessionPersistence: Default (5-tuple), SourceIP(2-tuple), sourceIPProtocol(3-tuple) */ loadDistribution?: string; /** * Reference for the health probe for this connection */ probe?: outputs.azurestackhci.LoadBalancerProbeReferenceResponse; /** * IP Protocol that the rule must load-balance */ protocol: string; } /** * loadBalancerRulePropertiesResponseProvideDefaults sets the appropriate defaults for LoadBalancerRulePropertiesResponse */ function loadBalancerRulePropertiesResponseProvideDefaults(val: LoadBalancerRulePropertiesResponse): LoadBalancerRulePropertiesResponse; /** * LoadBalancer Rules */ interface LoadBalancerRuleResponse { /** * name of the load balancer rule */ name: string; /** * load balancer rule properties */ properties: outputs.azurestackhci.LoadBalancerRulePropertiesResponse; } /** * loadBalancerRuleResponseProvideDefaults sets the appropriate defaults for LoadBalancerRuleResponse */ function loadBalancerRuleResponseProvideDefaults(val: LoadBalancerRuleResponse): LoadBalancerRuleResponse; /** * Status of load balancer operations */ interface LoadBalancerStatusProvisioningStatusResponse { /** * The ID of the operation performed on the load balancer */ operationId?: string; /** * The status of the operation performed on the loadbalancer [Succeeded, Failed, InProgress] */ status: string; } /** * The observed status of the virtual network */ interface LoadBalancerStatusResponse { /** * LoadBalancer provisioning error code */ errorCode?: string; /** * Descriptive error message */ errorMessage?: string; /** * virtual network provisioning status */ provisioningStatus?: outputs.azurestackhci.LoadBalancerStatusProvisioningStatusResponse; } /** * Log Collection Error details of the cluster. */ interface LogCollectionErrorResponse { /** * Error Code of the log collection */ errorCode: string; /** * Error Message of the log collection */ errorMessage: string; } /** * Represents a session for collecting logs from an edge device. */ interface LogCollectionJobSessionResponse { /** * A unique identifier for correlating this log collection session with other operations or sessions. */ correlationId: string; /** * The timestamp when log collection ended, in ISO 8601 format. */ endTime: string; /** * The size of the collected logs in bytes. */ logSize: number; /** * The timestamp when log collection started, in ISO 8601 format. */ startTime: string; /** * The status of the log collection session. */ status: string; /** * The total time logs were collected for, in ISO 8601 duration format. */ timeCollected: string; } /** * Log Collection properties of the cluster. */ interface LogCollectionPropertiesResponse { /** * From DateTimeStamp from when logs need to be connected */ fromDate: string; /** * Recent DateTimeStamp where logs are successfully generated */ lastLogGenerated: string; logCollectionSessionDetails: outputs.azurestackhci.LogCollectionSessionResponse[]; /** * To DateTimeStamp till when logs need to be connected */ toDate: string; } /** * Represents the reported properties of a log collection job. */ interface LogCollectionReportedPropertiesResponse { /** * Deployment status of job. */ deploymentStatus: outputs.azurestackhci.EceActionStatusResponse; /** * Details of the log collection session. */ logCollectionSessionDetails: outputs.azurestackhci.LogCollectionJobSessionResponse[]; /** * The percentage of the job that is complete. */ percentComplete: number; /** * Validation status of job. */ validationStatus: outputs.azurestackhci.EceActionStatusResponse; } /** * Log Collection Session details of the cluster. */ interface LogCollectionSessionResponse { /** * CorrelationId of the log collection */ correlationId: string; /** * End Time of the logs when it was collected */ endTimeCollected: string; /** * Log Collection Error details of the cluster. */ logCollectionError: outputs.azurestackhci.LogCollectionErrorResponse; /** * LogCollection job type */ logCollectionJobType: string; /** * LogCollection status */ logCollectionStatus: string; /** * End Time of the logs when it was collected */ logEndTime: string; /** * Size of the logs collected */ logSize: number; /** * Start Time of the logs when it was collected */ logStartTime: string; /** * Duration of logs collected */ timeCollected: string; } /** * The Azure Resource ID for a Logical Network. */ interface LogicalNetworkArmReferenceResponse { /** * The Azure Resource ID for a Logical Network. */ id?: string; } /** * DhcpOptions contains an array of DNS servers available to VMs deployed in the logical network. Standard DHCP option for a subnet overrides logical network DHCP options. */ interface LogicalNetworkPropertiesDhcpOptionsResponse { /** * The list of DNS servers IP addresses. */ dnsServers?: string[]; } /** * Describes the status of the provisioning. */ interface LogicalNetworkStatusProvisioningStatusResponse { /** * The ID of the operation performed on the logical network */ operationId?: string; /** * The status of the operation performed on the logical network [Succeeded, Failed, InProgress] */ status: string; } /** * The observed state of logical networks */ interface LogicalNetworkStatusResponse { /** * LogicalNetwork provisioning error code */ errorCode?: string; /** * Descriptive error message */ errorMessage?: string; /** * Logical network provisioning status */ provisioningStatus?: outputs.azurestackhci.LogicalNetworkStatusProvisioningStatusResponse; } /** * Instance view status. */ interface MachineExtensionInstanceViewResponseStatus { /** * The status code. */ code: string; /** * The short localizable label for the status. */ displayStatus: string; /** * The level code. */ level: string; /** * The detailed status message, including for alerts and error messages. */ message: string; /** * The time of the status. */ time: string; } /** * The machine extension instance view. */ interface MachineExtensionPropertiesResponseInstanceView { /** * The machine extension name. */ name: string; /** * Instance view status. */ status?: outputs.azurestackhci.MachineExtensionInstanceViewResponseStatus; /** * Specifies the type of the extension; an example is "CustomScriptExtension". */ type: string; /** * Specifies the version of the script handler. */ typeHandlerVersion: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.azurestackhci.UserAssignedIdentityResponse; }; } /** * The download status of the gallery image */ interface MarketplaceGalleryImageStatusDownloadStatusResponse { /** * The downloaded sized of the image in MB */ downloadSizeInMB?: number; } /** * Marketplace GalleryImage provisioning status */ interface MarketplaceGalleryImageStatusProvisioningStatusResponse { /** * The ID of the operation performed on the gallery image */ operationId?: string; /** * The status of the operation performed on the gallery image [Succeeded, Failed, InProgress] */ status: string; } /** * The observed state of marketplace gallery images */ interface MarketplaceGalleryImageStatusResponse { /** * The download status of the gallery image */ downloadStatus?: outputs.azurestackhci.MarketplaceGalleryImageStatusDownloadStatusResponse; /** * MarketplaceGalleryImage provisioning error code */ errorCode?: string; /** * Descriptive error message */ errorMessage?: string; /** * The progress of the operation in percentage */ progressPercentage?: number; /** * Provisioning status of marketplace gallery image */ provisioningStatus?: outputs.azurestackhci.MarketplaceGalleryImageStatusProvisioningStatusResponse; } /** * The ARM ID for a Network Security Group. */ interface NatGatewayArmReferenceResponse { /** * The ARM ID for a Network Security Group. */ resourceId?: string; } /** * Nat Gateway resource properties */ interface NatGatewayPropertiesResponse { /** * List of inbound NAT rules. InboundNATRules can only be set after the NAT Gateway has been associated with a vnet. Removed in 2026-04-01-preview; use InboundRule Child resource instead. */ inboundNATRules?: outputs.azurestackhci.InboundNATRuleResponse[]; /** * Provisioning state of the public IP */ provisioningState: string; /** * List of public ip addresses that the gateway can use for NAT. */ publicIPAddresses?: outputs.azurestackhci.PublicIPAddressArmReferenceResponse[]; /** * The observed state of Nat Gateway */ status: outputs.azurestackhci.NatGatewayStatusResponse; /** * List of subnets associated with the nat gateway. These can only be vnet subnets and must be from the same vnet */ subnets: outputs.azurestackhci.VirtualNetworkSubnetArmReferenceResponse[]; } /** * Provisioning status of Nat Gateway */ interface NatGatewayStatusProvisioningStatusResponse { /** * The ID of the operation performed on the nat gateway */ operationId?: string; /** * The status of the operation performed on the nat gateway [Succeeded, Failed, InProgress] */ status: string; } /** * Nat Gateway resource status */ interface NatGatewayStatusResponse { /** * NatGateway provisioning error code */ errorCode?: string; /** * Descriptive error message */ errorMessage?: string; /** * NatGateway provisioning status */ provisioningStatus?: outputs.azurestackhci.NatGatewayStatusProvisioningStatusResponse; } /** * Network adapter configuration. */ interface NetworkAdapterResponse { /** * Adapter Name. */ adapterName?: string; /** * Array of DNS addresses. */ dnsAddressArray?: string[]; /** * Gateway id. */ gateway?: string; /** * IP address. */ ipAddress?: string; /** * IP address range. */ ipAddressRange?: outputs.azurestackhci.IpAddressRangeResponse; /** * Type of IP assignment. */ ipAssignmentType: string; /** * MAC address. */ macAddress?: string; /** * Subnet mask. */ subnetMask?: string; /** * VLAN ID for the network setup. */ vlanId?: string; } /** * Network configuration. */ interface NetworkConfigurationResponse { /** * List of network adapters. */ networkAdapters?: outputs.azurestackhci.NetworkAdapterResponse[]; } /** * network controller config for SDN Integration to deploy AzureStackHCI Cluster. */ interface NetworkControllerResponse { /** * macAddressPoolStart of network controller used for SDN Integration. */ macAddressPoolStart?: string; /** * macAddressPoolStop of network controller used for SDN Integration. */ macAddressPoolStop?: string; /** * NetworkVirtualizationEnabled of network controller used for SDN Integration. */ networkVirtualizationEnabled?: boolean; } /** * The Azure Resource ID for a Network Interface. */ interface NetworkInterfaceArmReferenceResponse { /** * The Azure Resource ID for a Network Interface. */ id?: string; } /** * Network interface provisioning status */ interface NetworkInterfaceStatusProvisioningStatusResponse { /** * The ID of the operation performed on the network interface */ operationId?: string; /** * The status of the operation performed on the network interface [Succeeded, Failed, InProgress] */ status: string; } /** * The observed state of network interfaces */ interface NetworkInterfaceStatusResponse { /** * NetworkInterface provisioning error code */ errorCode?: string; /** * Descriptive error message */ errorMessage?: string; /** * Network interface provisioning status */ provisioningStatus?: outputs.azurestackhci.NetworkInterfaceStatusProvisioningStatusResponse; } /** * The Azure Resource ID for a Network Security Group. */ interface NetworkSecurityGroupArmReferenceResponse { /** * The Azure Resource ID for a Network Security Group. */ id?: string; } /** * network security group provisioning status */ interface NetworkSecurityGroupStatusProvisioningStatusResponse { /** * The ID of the operation performed on the network security group */ operationId?: string; /** * The status of the operation performed on the network security group [Succeeded, Failed, InProgress] */ status: string; } /** * The observed state of network security group */ interface NetworkSecurityGroupStatusResponse { /** * NetworkSecurityGroup provisioning error code */ errorCode?: string; /** * Descriptive error message */ errorMessage?: string; /** * network security group provisioning status */ provisioningStatus?: outputs.azurestackhci.NetworkSecurityGroupStatusProvisioningStatusResponse; } /** * The NIC Detail of a device. */ interface NicDetailResponse { /** * Adapter Name of NIC */ adapterName?: string; /** * Component Id of NIC */ componentId?: string; /** * Default Gateway of NIC */ defaultGateway?: string; /** * Default Isolation of Management NIC */ defaultIsolationId?: string; /** * DNS Servers for NIC */ dnsServers?: string[]; /** * Driver Version of NIC */ driverVersion?: string; /** * Interface Description of NIC */ interfaceDescription?: string; /** * Subnet Mask of NIC */ ip4Address?: string; /** * Subnet Mask of NIC */ subnetMask?: string; } /** * The Observability of AzureStackHCI Cluster. */ interface ObservabilityResponse { /** * When set to true, collects log data to facilitate quicker issue resolution. */ episodicDataUpload?: boolean; /** * Location of your cluster. The log and diagnostic data is sent to the appropriate diagnostics servers depending upon where your cluster resides. Setting this to false results in all data sent to Microsoft to be stored outside of the EU. */ euLocation?: boolean; /** * Enables telemetry data to be sent to Microsoft */ streamingDataClient?: boolean; } /** * observabilityResponseProvideDefaults sets the appropriate defaults for ObservabilityResponse */ function observabilityResponseProvideDefaults(val: ObservabilityResponse): ObservabilityResponse; /** * Onboarding configuration. */ interface OnboardingConfigurationResponse { /** * Azure Arc virtual machine ID. */ arcVirtualMachineId?: string; /** * Location of the resource. */ location?: string; /** * Resource ID. */ resourceId?: string; /** * Tenant ID of the resource. */ tenantId?: string; /** * Type of the onboarding resource to support polymorphic resource. */ type?: string; } /** * operation detail. */ interface OperationDetailResponse { /** * operation description. */ description: string; /** * error details. */ error: outputs.azurestackhci.ErrorDetailResponse; /** * operation id. */ id: string; /** * operation name. */ name: string; /** * operation resource id. */ resourceId: string; /** * operation status. */ status: string; /** * operation type. */ type: string; } /** * The OptionalServices of AzureStackHCI Cluster. */ interface OptionalServicesResponse { /** * The name of custom location. */ customLocation?: string; } /** * OS configurations for HCI device. */ interface OsProfileResponse { /** * Version of assembly present on device */ assemblyVersion: string; /** * OS Base Image Version */ baseImageVersion: string; /** * The boot type of the device. e.g. UEFI, Legacy etc */ bootType: string; /** * OS Build Number */ buildNumber: string; /** * OS Image Version */ imageVersion: string; /** * OS SKU (e.g., “ Microsoft Azure Linux ROE“, “Azure Stack HCI", "Microsoft Azure Linux 3.0") */ osSku: string; /** * OS type (“windows", “linux”) */ osType: string; /** * OS Version */ osVersion: string; } /** * Operating system profile. */ interface OsProvisionProfileResponse { /** * GPG Public Key used for package verification */ gpgPubKey?: string; /** * Hash of the OS package downloaded */ imageHash?: string; /** * Operation sub type of OS Provisioning */ operationType?: string; /** * Location of the operating system image. */ osImageLocation?: string; /** * Name of the operating system. */ osName?: string; /** * Type of the operating system. */ osType?: string; /** * Version of the operating system. */ osVersion?: string; /** * Validated Solution Recipe version to be used for the job */ vsrVersion?: string; } /** * osProvisionProfileResponseProvideDefaults sets the appropriate defaults for OsProvisionProfileResponse */ function osProvisionProfileResponseProvideDefaults(val: OsProvisionProfileResponse): OsProvisionProfileResponse; /** * Details for ownership voucher. */ interface OwnershipVoucherDetailsResponse { /** * Owner key type */ ownerKeyType: string; /** * Ownership voucher in base64 encoded format */ ownershipVoucher: string; } /** * Status of Arc Extension for a particular node in HCI Cluster. */ interface PerNodeExtensionStateResponse { /** * Fully qualified resource ID for the particular Arc Extension on this node. */ extension: string; /** * The extension instance view. */ instanceView: outputs.azurestackhci.ExtensionInstanceViewResponse; /** * Name of the node in HCI Cluster. */ name: string; /** * State of Arc Extension in this node. */ state: string; /** * Specifies the version of the script handler. */ typeHandlerVersion: string; } /** * Remote Support Node Session Details on the Node. */ interface PerNodeRemoteSupportSessionResponse { /** * Remote Support Access Level */ accessLevel: string; /** * Duration of Remote Support Enablement */ duration: number; /** * Name of the node */ nodeName: string; /** * Remote Support Session EndTime on the Node */ sessionEndTime: string; /** * Remote Support Session StartTime on the Node */ sessionStartTime: string; } /** * Status of Arc agent for a particular node in HCI Cluster. */ interface PerNodeStateResponse { /** * Fully qualified resource ID for the Arc agent of this node. */ arcInstance: string; /** * The service principal id of the arc for server node */ arcNodeServicePrincipalObjectId: string; /** * Name of the Node in HCI Cluster */ name: string; /** * State of Arc agent in this node. */ state: string; } /** * The PhysicalNodes of a cluster. */ interface PhysicalNodesResponse { /** * The IPv4 address assigned to each physical server on your Azure Stack HCI cluster. */ ipv4Address?: string; /** * NETBIOS name of each physical server on your Azure Stack HCI cluster. */ name?: string; } /** * properties for LoadBalancer health probes */ interface ProbePropertiesResponse { /** * Probe interval in seconds (5-300) default 15 */ intervalInSeconds?: number; /** * number of consecutive probe failures before marking unhealthy (1-20) default 2 */ numberOfProbes?: number; /** * Port on the backend address to probe */ port: number; /** * Protocol for this probe: Can be Tcp or Http - Diverges from Azure where Https is also an option */ protocol: string; /** * For http probes, specify the request path e.g. /health */ requestPath?: string; } /** * probePropertiesResponseProvideDefaults sets the appropriate defaults for ProbePropertiesResponse */ function probePropertiesResponseProvideDefaults(val: ProbePropertiesResponse): ProbePropertiesResponse; /** * Load balancer health probes */ interface ProbeResponse { /** * name of the load balancer health probe */ name: string; /** * load balancer rule properties */ properties: outputs.azurestackhci.ProbePropertiesResponse; } /** * probeResponseProvideDefaults sets the appropriate defaults for ProbeResponse */ function probeResponseProvideDefaults(val: ProbeResponse): ProbeResponse; /** * Represents the properties of an Azure Linux restricted operating environment Provision Os job. */ interface ProvisionOsJobPropertiesResponse { /** * Deployment mode to trigger job. */ deploymentMode?: string; /** * The UTC date and time at which the job completed. */ endTimeUtc: string; /** * error details. */ error: outputs.azurestackhci.ErrorDetailResponse; /** * Unique, immutable job id. */ jobId: string; /** * Job Type supported. * Expected value is 'ProvisionOs'. */ jobType: "ProvisionOs"; /** * Os Provisioning request. */ provisioningRequest: outputs.azurestackhci.ProvisioningRequestResponse; /** * Job provisioning state */ provisioningState: string; /** * Reported Properties for Provision Os job */ reportedProperties?: outputs.azurestackhci.ProvisionOsReportedPropertiesResponse; /** * The UTC date and time at which the job started. */ startTimeUtc: string; /** * Status of Edge device job. */ status: string; } /** * provisionOsJobPropertiesResponseProvideDefaults sets the appropriate defaults for ProvisionOsJobPropertiesResponse */ function provisionOsJobPropertiesResponseProvideDefaults(val: ProvisionOsJobPropertiesResponse): ProvisionOsJobPropertiesResponse; /** * Reported Properties for Provision Os job */ interface ProvisionOsReportedPropertiesResponse { /** * Deployment status of job. */ deploymentStatus: outputs.azurestackhci.EceActionStatusResponse; /** * The percentage of the job that is complete. */ percentComplete: number; /** * Validation status of job. */ validationStatus: outputs.azurestackhci.EceActionStatusResponse; } /** * Details for device provisioning. */ interface ProvisioningDetailsResponse { /** * Operating system profile. */ osProfile: outputs.azurestackhci.OsProvisionProfileResponse; /** * User configuration. */ userDetails?: outputs.azurestackhci.UserDetailsResponse[]; } /** * provisioningDetailsResponseProvideDefaults sets the appropriate defaults for ProvisioningDetailsResponse */ function provisioningDetailsResponseProvideDefaults(val: ProvisioningDetailsResponse): ProvisioningDetailsResponse; /** * Represents a provisioning request. */ interface ProvisioningRequestResponse { /** * Base64 encoded custom configuration for CAPI to use */ customConfiguration?: string; /** * Device configuration. */ deviceConfiguration?: outputs.azurestackhci.TargetDeviceConfigurationResponse; /** * Onboarding configuration. */ onboardingConfiguration?: outputs.azurestackhci.OnboardingConfigurationResponse; /** * Operating system profile. */ osProfile: outputs.azurestackhci.OsProvisionProfileResponse; /** * Target operating system to support polymorphic resource. */ target: string; /** * User configuration. */ userDetails?: outputs.azurestackhci.UserDetailsResponse[]; } /** * provisioningRequestResponseProvideDefaults sets the appropriate defaults for ProvisioningRequestResponse */ function provisioningRequestResponseProvideDefaults(val: ProvisioningRequestResponse): ProvisioningRequestResponse; /** * The Azure Resource ID of a Public IP resource */ interface PublicIPAddressArmReferenceResponse { /** * The Azure Resource ID of a Public IP resource */ resourceId?: string; } /** * Public IP Properties resource. */ interface PublicIPAddressPropertiesResponse { /** * IP Address. This is static. If the user specifies, we allocate that otherwise allocate from logical network address space. */ ipAddress?: string; /** * ipAllocationScope: Azure Reference to a particular IP Pool (ALM) or a LogicalNetwork (ALL) for allocating public IP */ ipAllocationScope?: string; /** * network interface or LoadBalancer frontendIPconfiguration using this public IP */ ipConfiguration: outputs.azurestackhci.IPConfigurationArmReferenceResponse; /** * natGateway using this public IP */ natGateway: outputs.azurestackhci.NatGatewayArmReferenceResponse; /** * Provisioning state of the public IP */ provisioningState: string; /** * Whether the public IP is v4 or v6. Defaults to IPv4 */ publicIPAddressVersion?: string; } /** * The QoSPolicyOverrides of a cluster. */ interface QosPolicyOverridesResponse { /** * This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. */ bandwidthPercentageSMB?: string; /** * This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. */ priorityValue8021ActionCluster?: string; /** * This parameter should only be modified based on your OEM guidance. Do not modify this parameter without OEM validation. */ priorityValue8021ActionSMB?: string; } /** * Represents the settings of a remote support node. */ interface RemoteSupportJobNodeSettingsResponse { /** * The error message, if any, from the last connection attempt. */ connectionErrorMessage: string; /** * The current connection status of the remote support session. */ connectionStatus: string; /** * The timestamp when the node settings were created, in UTC. */ createdAt: string; /** * The state of the remote support node. */ state: string; /** * The timestamp when the node settings were last updated, in UTC. */ updatedAt: string; } /** * Represents the reported properties of a remote support job. */ interface RemoteSupportJobReportedPropertiesResponse { /** * Deployment status of job. */ deploymentStatus: outputs.azurestackhci.EceActionStatusResponse; /** * Optional settings for configuring the node for remote support. */ nodeSettings: outputs.azurestackhci.RemoteSupportJobNodeSettingsResponse; /** * The percentage of the job that is complete. */ percentComplete: number; /** * Details of the remote support session. */ sessionDetails: outputs.azurestackhci.RemoteSupportSessionResponse[]; /** * Validation status of job. */ validationStatus: outputs.azurestackhci.EceActionStatusResponse; } /** * Remote Support Node Settings of the cluster. */ interface RemoteSupportNodeSettingsResponse { /** * Arc ResourceId of the Node */ arcResourceId: string; /** * Remote Support Access Connection Error Message on the Node */ connectionErrorMessage: string; /** * Remote Support Access Connection Status on the Node */ connectionStatus: string; /** * Remote Support Enablement Request Created TimeStamp on the Node */ createdAt: string; /** * Remote Support Access Connection State on the Node */ state: string; /** * Remote Support Transcript location on the node */ transcriptLocation: string; /** * Remote Support Enablement Request Updated TimeStamp on the Node */ updatedAt: string; } /** * Remote Support properties of the cluster. */ interface RemoteSupportPropertiesResponse { /** * Remote Support Access Level */ accessLevel: string; /** * Expiration DateTimeStamp when Remote Support Access will be expired */ expirationTimeStamp: string; remoteSupportNodeSettings: outputs.azurestackhci.RemoteSupportNodeSettingsResponse[]; remoteSupportSessionDetails: outputs.azurestackhci.PerNodeRemoteSupportSessionResponse[]; /** * Remote Support Type for cluster */ remoteSupportType: string; } /** * Represents a remote support session. */ interface RemoteSupportSessionResponse { /** * The level of access granted during the remote support session. */ accessLevel: string; /** * The end time of the remote support session, in UTC. */ sessionEndTime: string; /** * Unique session Id. */ sessionId: string; /** * The start time of the remote support session, in UTC. */ sessionStartTime: string; /** * The location where the session transcript is stored. */ transcriptLocation: string; } /** * Route - Route resource. */ interface RouteResponse { /** * The destination CIDR to which the route applies. */ addressPrefix?: string; /** * Name - name of the subnet */ name?: string; /** * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. */ nextHopIpAddress?: string; } /** * Route table resource. */ interface RouteTableResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource name. */ name: string; /** * Collection of routes contained within a route table. */ routes?: outputs.azurestackhci.RouteResponse[]; /** * Resource type. */ type: string; } /** * secrets used for solution builder extension (SBE) partner extensibility. */ interface SbeCredentialsResponse { /** * secret name expected for Enterprise Cloud Engine (ECE). */ eceSecretName?: string; /** * secret URI stored in keyvault. */ secretLocation?: string; /** * secret name stored in keyvault. */ secretName?: string; } /** * Solution builder extension (SBE) package and manifest information for the solution builder extension staged for AzureStackHCI cluster deployment. */ interface SbeDeploymentInfoResponse { /** * SBE family name. */ family?: string; /** * SBE manifest publisher. */ publisher?: string; /** * SBE Manifest Creation Date. */ sbeManifestCreationDate?: string; /** * SBE Manifest Source. */ sbeManifestSource?: string; /** * SBE package version. */ version?: string; } /** * Solution builder extension (SBE) deployment package information. */ interface SbeDeploymentPackageInfoResponse { /** * SBE deployment validation code. */ code: string; /** * A detailed message that explains the SBE package validation result. */ message: string; /** * This represents discovered update results for matching updates and store it as SBE manifest. */ sbeManifest: string; } /** * The solution builder extension (SBE) partner deployment info for cluster. */ interface SbePartnerInfoResponse { /** * SBE credentials list for AzureStackHCI cluster deployment. */ credentialList?: outputs.azurestackhci.SbeCredentialsResponse[]; /** * List of SBE partner properties for AzureStackHCI cluster deployment. */ partnerProperties?: outputs.azurestackhci.SbePartnerPropertiesResponse[]; /** * SBE package and manifest information for the solution Builder Extension staged for AzureStackHCI cluster deployment. */ sbeDeploymentInfo?: outputs.azurestackhci.SbeDeploymentInfoResponse; } /** * Solution builder extension (SBE) partner properties object. */ interface SbePartnerPropertiesResponse { /** * SBE partner property name. */ name?: string; /** * SBE partner property value. */ value?: string; } /** * Scale units will contains list of deployment data */ interface ScaleUnitsResponse { /** * Deployment Data to deploy AzureStackHCI Cluster. */ deploymentData: outputs.azurestackhci.DeploymentDataResponse; /** * Solution builder extension (SBE) partner properties */ sbePartnerInfo?: outputs.azurestackhci.SbePartnerInfoResponse; } /** * scaleUnitsResponseProvideDefaults sets the appropriate defaults for ScaleUnitsResponse */ function scaleUnitsResponseProvideDefaults(val: ScaleUnitsResponse): ScaleUnitsResponse; /** * SDN Integration config to deploy AzureStackHCI Cluster. */ interface SdnIntegrationResponse { /** * network controller config for SDN Integration to deploy AzureStackHCI Cluster. */ networkController?: outputs.azurestackhci.NetworkControllerResponse; } /** * Security compliance properties of the resource */ interface SecurityComplianceStatusResponse { /** * Indicates whether data at-rest encryption is enabled on Azure Stack HCI clustered volumes. */ dataAtRestEncrypted: string; /** * Indicates whether HCI cluster has data in-transit protection. */ dataInTransitProtected: string; /** * Time in UTC when compliance status was last updated. */ lastUpdated: string; /** * Indicates whether HCI hosts meets secured-core server requirements. */ securedCoreCompliance: string; /** * Indicates whether HCI hosts have enforced consistent Windows Defender Application Control. */ wdacCompliance: string; } /** * Service configuration details */ interface ServiceConfigurationResponse { /** * The port on which service is enabled. */ port: number; /** * Name of the service. */ serviceName: string; } /** * Site Details consists of common configurations. */ interface SiteDetailsResponse { /** * Edge Device configuration received from site common configuration. */ deviceConfiguration?: outputs.azurestackhci.TargetDeviceConfigurationResponse; /** * Site resource Id to be set during Edge Machine resource creation. */ siteResourceId: string; } /** * Properties under the snapshot resource */ interface SnapshotPropertiesResponse { /** * Data used when creating a snapshot */ creationData?: outputs.azurestackhci.CreationDataResponse; /** * The size of the disk in bytes. */ diskSizeBytes: number; /** * Provisioning state of the snapshot. */ provisioningState: string; /** * The observed state of snapshots */ status: outputs.azurestackhci.SnapshotStatusResponse; /** * The time when the snapshot was created. */ timeCreated: string; /** * Unique identifier for the snapshot. */ uniqueId: string; } /** * Snapshot Status provisioning status */ interface SnapshotStatusProvisioningStatusResponse { /** * The ID of the operation performed on the snapshot */ operationId?: string; /** * The status of the operation performed on the snapshot [Succeeded, Failed, InProgress] */ status: string; } /** * The observed state of snapshots */ interface SnapshotStatusResponse { /** * Snapshot provisioning error code */ errorCode?: string; /** * Descriptive error message */ errorMessage?: string; /** * Provisioning status of the snapshot */ provisioningStatus?: outputs.azurestackhci.SnapshotStatusProvisioningStatusResponse; } /** * Software Assurance properties of the cluster. */ interface SoftwareAssurancePropertiesResponse { /** * TimeStamp denoting the latest SA benefit applicability is validated. */ lastUpdated: string; /** * Customer Intent for Software Assurance Benefit. */ softwareAssuranceIntent?: string; /** * Status of the Software Assurance for the cluster. */ softwareAssuranceStatus: string; } /** * SSH configuration for Linux based VMs running on Azure */ interface SshConfigurationResponse { /** * The list of SSH public keys used to authenticate with linux based VMs. */ publicKeys?: outputs.azurestackhci.SshPublicKeyResponse[]; } /** * Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. */ interface SshPublicKeyResponse { /** * SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). */ keyData?: string; /** * Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys */ path?: string; } /** * Progress representation of the update run steps. */ interface StepResponse { /** * More detailed description of the step. */ description?: string; /** * When the step reached a terminal state. */ endTimeUtc?: string; /** * Error message, specified if the step is in a failed state. */ errorMessage?: string; /** * Expected execution time of a given step. This is optionally authored in the update action plan and can be empty. */ expectedExecutionTime?: string; /** * Completion time of this step or the last completed sub-step. */ lastUpdatedTimeUtc?: string; /** * Name of the step. */ name?: string; /** * When the step started, or empty if it has not started executing. */ startTimeUtc?: string; /** * Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'. */ status?: string; /** * Recursive model for child steps of this step. */ steps?: outputs.azurestackhci.StepResponse[]; } /** * The StorageAdapter physical nodes of a cluster. */ interface StorageAdapterIPInfoHciEdgeDeviceResponse { /** * The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster. */ ipv4Address: string; /** * storage adapter physical node name. */ physicalNode: string; /** * The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster. */ subnetMask: string; } /** * The StorageAdapter physical nodes of a cluster. */ interface StorageAdapterIPInfoResponse { /** * The IPv4 address assigned to each storage adapter physical node on your Azure Stack HCI cluster. */ ipv4Address?: string; /** * storage adapter physical node name. */ physicalNode?: string; /** * The SubnetMask address assigned to each storage adapter physical node on your Azure Stack HCI cluster. */ subnetMask?: string; } /** * Storage configuration. */ interface StorageConfigurationResponse { /** * Partition size. */ partitionSize?: string; } /** * Storage container provisioning status */ interface StorageContainerStatusProvisioningStatusResponse { /** * The ID of the operation performed on the storage container */ operationId?: string; /** * The status of the operation performed on the storage container [Succeeded, Failed, InProgress] */ status: string; } /** * The observed state of storage containers */ interface StorageContainerStatusResponse { /** * Amount of space available on the disk in MB */ availableSizeMB?: number; /** * Total size of the disk in MB */ containerSizeMB?: number; /** * StorageContainer provisioning error code */ errorCode?: string; /** * Descriptive error message */ errorMessage?: string; /** * Storage container's provisioning status */ provisioningStatus?: outputs.azurestackhci.StorageContainerStatusProvisioningStatusResponse; } /** * The StorageNetworks of a cluster. */ interface StorageNetworksHciEdgeDeviceResponse { /** * Name of the storage network. */ name: string; /** * Name of the storage network adapter. */ networkAdapterName: string; /** * List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster. */ storageAdapterIPInfo: outputs.azurestackhci.StorageAdapterIPInfoHciEdgeDeviceResponse[]; /** * ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic. */ storageVlanId: string; } /** * The StorageNetworks of a cluster. */ interface StorageNetworksResponse { /** * Name of the storage network. */ name?: string; /** * Name of the storage network adapter. */ networkAdapterName?: string; /** * List of Storage adapter physical nodes config to deploy AzureStackHCI Cluster. */ storageAdapterIPInfo?: outputs.azurestackhci.StorageAdapterIPInfoResponse[]; /** * ID specified for the VLAN storage network. This setting is applied to the network interfaces that route the storage and VM migration traffic. */ vlanId?: string; } /** * StorageProfile of edge machine. */ interface StorageProfileResponse { /** * Number of storage disks in the device with $CanPool as true. */ poolableDisksCount: number; } /** * The Storage config of AzureStackHCI Cluster. */ interface StorageResponse { /** * By default, this mode is set to Express and your storage is configured as per best practices based on the number of nodes in the cluster. Allowed values are 'Express','InfraOnly', 'KeepStorage' */ configurationMode?: string; } /** * storageResponseProvideDefaults sets the appropriate defaults for StorageResponse */ function storageResponseProvideDefaults(val: StorageResponse): StorageResponse; /** * The Azure Resource ID for a Network Interface. */ interface SubnetIpConfigurationReferenceResponse { /** * The Azure Resource ID for a Network Interface. */ id?: string; } /** * Properties of the subnet. */ interface SubnetResponse { /** * The address prefix for the subnet: Cidr for this subnet - IPv4, IPv6. */ addressPrefix?: string; /** * List of address prefixes for the subnet. */ addressPrefixes?: string[]; /** * IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic' */ ipAllocationMethod?: string; /** * IPConfigurationReferences - list of IPConfigurationReferences */ ipConfigurationReferences?: outputs.azurestackhci.SubnetIpConfigurationReferenceResponse[]; /** * network associated pool of IP Addresses */ ipPools?: outputs.azurestackhci.IPPoolResponse[]; /** * Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * NetworkSecurityGroup - Network Security Group attached to the logical network. */ networkSecurityGroup?: outputs.azurestackhci.NetworkSecurityGroupArmReferenceResponse; /** * Route table resource. */ routeTable?: outputs.azurestackhci.RouteTableResponse; /** * Vlan to use for the subnet */ vlan?: number; } /** * List of switch details for edge device. */ interface SwitchDetailResponse { /** * This represents extensions installed on virtualSwitch. */ extensions: outputs.azurestackhci.SwitchExtensionResponse[]; /** * The name of the switch. */ switchName: string; /** * The type of the switch. e.g. external, internal. */ switchType: string; } /** * This represents extensions installed on virtualSwitch. */ interface SwitchExtensionResponse { /** * This represents whether extension is enabled on virtualSwitch. */ extensionEnabled: boolean; /** * This will show extension name for virtualSwitch. */ extensionName: string; /** * Unique identifier for virtualSwitch. */ switchId: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Device configuration. */ interface TargetDeviceConfigurationResponse { /** * Hostname of the device. */ hostName?: string; /** * Network configuration. */ network?: outputs.azurestackhci.NetworkConfigurationResponse; /** * Storage configuration. */ storage?: outputs.azurestackhci.StorageConfigurationResponse; /** * Time configuration. */ time?: outputs.azurestackhci.TimeConfigurationResponse; /** * Web proxy configuration. */ webProxy?: outputs.azurestackhci.WebProxyConfigurationResponse; } /** * Time configuration. */ interface TimeConfigurationResponse { /** * Primary NTP server. */ primaryTimeServer?: string; /** * Secondary NTP server. */ secondaryTimeServer?: string; /** * Time zone. */ timeZone?: string; } /** * If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty. */ interface UpdatePrerequisiteResponse { /** * Friendly name of the prerequisite. */ packageName?: string; /** * Updatable component type. */ updateType?: string; /** * Version of the prerequisite. */ version?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * User configuration. */ interface UserDetailsResponse { /** * Location of the secret used for authentication. */ secretLocation?: string; /** * Type of the secret used for authentication. */ secretType: string; /** * SSH Public Key for the user. */ sshPubKey?: string[]; /** * Name of the user. */ userName: string; } /** * Specifies the security profile settings for the managed disk. NOTE: It can only be set for Confidential VMs */ interface VMDiskSecurityProfileResponse { /** * Specifies the EncryptionType of the managed disk. It is set to NonPersistedTPM for not persisting firmware state in the VMGuestState blob. NOTE: It can be set for only Confidential VMs. */ securityEncryptionType?: string; } /** * The Azure Resource ID for a Virtual Hard Disk. */ interface VirtualHardDiskArmReferenceResponse { /** * The Azure Resource ID for a Virtual Hard Disk. */ id?: string; } /** * The download status of the virtual hard disk */ interface VirtualHardDiskDownloadStatusResponse { /** * The downloaded sized of the virtual hard disk in MB */ downloadedSizeInMB?: number; /** * The progress of the operation in percentage */ progressPercentage?: number; /** * The status of Uploading virtual hard disk [Succeeded, Failed, InProgress] */ status: string; } /** * VHD Status provisioning status */ interface VirtualHardDiskStatusProvisioningStatusResponse { /** * The ID of the operation performed on the virtual hard disk */ operationId?: string; /** * The status of the operation performed on the virtual hard disk [Succeeded, Failed, InProgress] */ status: string; } /** * The observed state of virtual hard disks */ interface VirtualHardDiskStatusResponse { /** * The download status of the virtual hard disk */ downloadStatus?: outputs.azurestackhci.VirtualHardDiskDownloadStatusResponse; /** * VirtualHardDisk provisioning error code */ errorCode?: string; /** * Descriptive error message */ errorMessage?: string; /** * Provisioning status of the vhd */ provisioningStatus?: outputs.azurestackhci.VirtualHardDiskStatusProvisioningStatusResponse; /** * The upload status of the virtual hard disk */ uploadStatus?: outputs.azurestackhci.VirtualHardDiskUploadStatusResponse; } /** * The upload status of the virtual hard disk */ interface VirtualHardDiskUploadStatusResponse { /** * VirtualHardDisk upload error code */ errorCode?: string; /** * Descriptive upload error message */ errorMessage?: string; /** * The progress of the operation in percentage */ progressPercentage?: number; /** * The status of Uploading virtual hard disk [Succeeded, Failed, InProgress] */ status: string; /** * The uploaded sized of the virtual hard disk in MB */ uploadedSizeInMB?: number; } /** * The instance view of the VM Config Agent running on the virtual machine. */ interface VirtualMachineConfigAgentInstanceViewResponse { /** * The resource status information. */ statuses?: outputs.azurestackhci.InstanceViewStatusResponse[]; /** * The VM Config Agent full version. */ vmConfigAgentVersion?: string; } /** * The parameters of a managed disk. */ interface VirtualMachineInstanceManagedDiskParametersResponse { /** * Specifies the security profile for the managed disk. */ securityProfile?: outputs.azurestackhci.VMDiskSecurityProfileResponse; } /** * Dynamic memory config */ interface VirtualMachineInstancePropertiesHardwareProfileDynamicMemoryConfigResponse { /** * Maximum memory in MB */ maximumMemoryMB?: number; /** * Minimum memory in MB */ minimumMemoryMB?: number; /** * Defines the amount of extra memory that should be reserved for a virtual machine instance at runtime, as a percentage of the total memory that the virtual machine instance is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000. */ targetMemoryBuffer?: number; } /** * HardwareProfile - Specifies the hardware settings for the virtual machine instance. */ interface VirtualMachineInstancePropertiesHardwareProfileResponse { /** * Dynamic memory config */ dynamicMemoryConfig?: outputs.azurestackhci.VirtualMachineInstancePropertiesHardwareProfileDynamicMemoryConfigResponse; /** * RAM in MB for the virtual machine instance */ memoryMB?: number; /** * number of processors for the virtual machine instance */ processors?: number; /** * virtualMachineGPUs - list of gpus to be attached to the virtual machine instance */ virtualMachineGPUs?: outputs.azurestackhci.VirtualMachineInstancePropertiesHardwareProfileVirtualMachineGPUResponse[]; /** * Enum of VM Sizes */ vmSize?: string; } /** * virtualMachineInstancePropertiesHardwareProfileResponseProvideDefaults sets the appropriate defaults for VirtualMachineInstancePropertiesHardwareProfileResponse */ function virtualMachineInstancePropertiesHardwareProfileResponseProvideDefaults(val: VirtualMachineInstancePropertiesHardwareProfileResponse): VirtualMachineInstancePropertiesHardwareProfileResponse; /** * GPU properties - describes the GPU configuration. */ interface VirtualMachineInstancePropertiesHardwareProfileVirtualMachineGPUResponse { /** * GPU assignment type */ assignmentType: string; /** * Name of the GPU */ gpuName?: string; /** * Size of gpu partition in MB for GPU-P */ partitionSizeMB?: number; } /** * NetworkProfile - describes the network configuration the virtual machine instance */ interface VirtualMachineInstancePropertiesNetworkProfileResponse { /** * NetworkInterfaces - list of network interfaces to be attached to the virtual machine instance */ networkInterfaces?: outputs.azurestackhci.NetworkInterfaceArmReferenceResponse[]; } /** * LinuxConfiguration - linux specific configuration values for the virtual machine instance */ interface VirtualMachineInstancePropertiesOsProfileLinuxConfigurationResponse { /** * DisablePasswordAuthentication - whether password authentication should be disabled */ disablePasswordAuthentication?: boolean; /** * Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process. */ provisionVMAgent?: boolean; /** * Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process. */ provisionVMConfigAgent?: boolean; /** * Specifies the ssh key configuration for a Linux OS. */ ssh?: outputs.azurestackhci.SshConfigurationResponse; } /** * virtualMachineInstancePropertiesOsProfileLinuxConfigurationResponseProvideDefaults sets the appropriate defaults for VirtualMachineInstancePropertiesOsProfileLinuxConfigurationResponse */ function virtualMachineInstancePropertiesOsProfileLinuxConfigurationResponseProvideDefaults(val: VirtualMachineInstancePropertiesOsProfileLinuxConfigurationResponse): VirtualMachineInstancePropertiesOsProfileLinuxConfigurationResponse; /** * OsProfile - describes the configuration of the operating system and sets login data */ interface VirtualMachineInstancePropertiesOsProfileResponse { /** * AdminUsername - admin username */ adminUsername?: string; /** * ComputerName - name of the compute */ computerName?: string; /** * LinuxConfiguration - linux specific configuration values for the virtual machine instance */ linuxConfiguration?: outputs.azurestackhci.VirtualMachineInstancePropertiesOsProfileLinuxConfigurationResponse; /** * Windows Configuration for the virtual machine instance */ windowsConfiguration?: outputs.azurestackhci.VirtualMachineInstancePropertiesOsProfileWindowsConfigurationResponse; } /** * virtualMachineInstancePropertiesOsProfileResponseProvideDefaults sets the appropriate defaults for VirtualMachineInstancePropertiesOsProfileResponse */ function virtualMachineInstancePropertiesOsProfileResponseProvideDefaults(val: VirtualMachineInstancePropertiesOsProfileResponse): VirtualMachineInstancePropertiesOsProfileResponse; /** * Windows Configuration for the virtual machine instance */ interface VirtualMachineInstancePropertiesOsProfileWindowsConfigurationResponse { /** * Whether to EnableAutomaticUpdates on the machine */ enableAutomaticUpdates?: boolean; /** * Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine instance creation process. */ provisionVMAgent?: boolean; /** * Used to indicate whether the VM Config Agent should be installed during the virtual machine creation process. */ provisionVMConfigAgent?: boolean; /** * Specifies the ssh key configuration for Windows OS. */ ssh?: outputs.azurestackhci.SshConfigurationResponse; /** * TimeZone for the virtual machine instance */ timeZone?: string; } /** * virtualMachineInstancePropertiesOsProfileWindowsConfigurationResponseProvideDefaults sets the appropriate defaults for VirtualMachineInstancePropertiesOsProfileWindowsConfigurationResponse */ function virtualMachineInstancePropertiesOsProfileWindowsConfigurationResponseProvideDefaults(val: VirtualMachineInstancePropertiesOsProfileWindowsConfigurationResponse): VirtualMachineInstancePropertiesOsProfileWindowsConfigurationResponse; /** * SecurityProfile - Specifies the security settings for the virtual machine instance. */ interface VirtualMachineInstancePropertiesSecurityProfileResponse { /** * Enable TPM flag */ enableTPM?: boolean; /** * Specifies the SecurityType of the virtual machine. EnableTPM and SecureBootEnabled must be set to true for SecurityType to function. */ securityType?: string; /** * Uefi settings of the virtual machine instance */ uefiSettings?: outputs.azurestackhci.VirtualMachineInstancePropertiesSecurityProfileUefiSettingsResponse; } /** * virtualMachineInstancePropertiesSecurityProfileResponseProvideDefaults sets the appropriate defaults for VirtualMachineInstancePropertiesSecurityProfileResponse */ function virtualMachineInstancePropertiesSecurityProfileResponseProvideDefaults(val: VirtualMachineInstancePropertiesSecurityProfileResponse): VirtualMachineInstancePropertiesSecurityProfileResponse; /** * Uefi settings - Specifies whether secure boot should be enabled on the virtual machine instance. */ interface VirtualMachineInstancePropertiesSecurityProfileUefiSettingsResponse { /** * Specifies whether secure boot should be enabled on the virtual machine instance. */ secureBootEnabled?: boolean; } /** * virtualMachineInstancePropertiesSecurityProfileUefiSettingsResponseProvideDefaults sets the appropriate defaults for VirtualMachineInstancePropertiesSecurityProfileUefiSettingsResponse */ function virtualMachineInstancePropertiesSecurityProfileUefiSettingsResponseProvideDefaults(val: VirtualMachineInstancePropertiesSecurityProfileUefiSettingsResponse): VirtualMachineInstancePropertiesSecurityProfileUefiSettingsResponse; /** * VHD to attach as OS disk */ interface VirtualMachineInstancePropertiesStorageProfileOsDiskResponse { /** * The Azure Resource ID for a Virtual Hard Disk. */ id?: string; /** * The managed disk parameters. */ managedDisk?: outputs.azurestackhci.VirtualMachineInstanceManagedDiskParametersResponse; /** * This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux. */ osType?: string; } /** * StorageProfile - contains information about the disks and storage information for the virtual machine instance */ interface VirtualMachineInstancePropertiesStorageProfileResponse { /** * adds data disks to the virtual machine instance */ dataDisks?: outputs.azurestackhci.VirtualHardDiskArmReferenceResponse[]; /** * Which Image to use for the virtual machine instance */ imageReference?: outputs.azurestackhci.ImageArmReferenceResponse; /** * VHD to attach as OS disk */ osDisk?: outputs.azurestackhci.VirtualMachineInstancePropertiesStorageProfileOsDiskResponse; /** * Id of the storage container that hosts the VM configuration file */ vmConfigStoragePathId?: string; } /** * Virtual machine instance provisioning status. */ interface VirtualMachineInstanceStatusProvisioningStatusResponse { /** * The ID of the operation performed on the virtual machine instance */ operationId?: string; /** * The status of the operation performed on the virtual machine instance [Succeeded, Failed, InProgress] */ status: string; } /** * The observed state of virtual machine instances */ interface VirtualMachineInstanceStatusResponse { /** * VirtualMachine provisioning error code */ errorCode?: string; /** * Descriptive error message */ errorMessage?: string; /** * The power state of the virtual machine instance */ powerState?: string; /** * Provisioning status of the virtual machine instance */ provisioningStatus?: outputs.azurestackhci.VirtualMachineInstanceStatusProvisioningStatusResponse; } /** * The instance view of a virtual machine. */ interface VirtualMachineInstanceViewResponse { /** * The VM Config Agent running on the virtual machine. */ vmAgent?: outputs.azurestackhci.VirtualMachineConfigAgentInstanceViewResponse; } interface VirtualMachinePropertiesResponseDataDisks { /** * Resource ID of the data disk */ id?: string; } interface VirtualMachinePropertiesResponseDynamicMemoryConfig { maximumMemoryMB?: number; minimumMemoryMB?: number; /** * Defines the amount of extra memory that should be reserved for a virtual machine at runtime, as a percentage of the total memory that the virtual machine is thought to need. This only applies to virtual systems with dynamic memory enabled. This property can be in the range of 5 to 2000. */ targetMemoryBuffer?: number; } /** * HardwareProfile - Specifies the hardware settings for the virtual machine. */ interface VirtualMachinePropertiesResponseHardwareProfile { dynamicMemoryConfig?: outputs.azurestackhci.VirtualMachinePropertiesResponseDynamicMemoryConfig; /** * RAM in MB for the virtual machine */ memoryMB?: number; /** * number of processors for the virtual machine */ processors?: number; vmSize?: string; } /** * virtualMachinePropertiesResponseHardwareProfileProvideDefaults sets the appropriate defaults for VirtualMachinePropertiesResponseHardwareProfile */ function virtualMachinePropertiesResponseHardwareProfileProvideDefaults(val: VirtualMachinePropertiesResponseHardwareProfile): VirtualMachinePropertiesResponseHardwareProfile; /** * Which Image to use for the virtual machine */ interface VirtualMachinePropertiesResponseImageReference { /** * Resource ID of the image */ id?: string; } /** * LinuxConfiguration - linux specific configuration values for the virtual machine */ interface VirtualMachinePropertiesResponseLinuxConfiguration { /** * DisablePasswordAuthentication - whether password authentication should be disabled */ disablePasswordAuthentication?: boolean; /** * Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine creation process. */ provisionVMAgent?: boolean; /** * SSH - contains settings related to ssh configuration */ ssh?: outputs.azurestackhci.VirtualMachinePropertiesResponseSsh; } interface VirtualMachinePropertiesResponseNetworkInterfaces { /** * ID - Resource Id of the network interface */ id?: string; } /** * NetworkProfile - describes the network configuration the virtual machine */ interface VirtualMachinePropertiesResponseNetworkProfile { /** * NetworkInterfaces - list of network interfaces to be attached to the virtual machine */ networkInterfaces?: outputs.azurestackhci.VirtualMachinePropertiesResponseNetworkInterfaces[]; } /** * VHD to attach as OS disk */ interface VirtualMachinePropertiesResponseOsDisk { /** * Resource ID of the OS disk */ id?: string; } /** * OsProfile - describes the configuration of the operating system and sets login data */ interface VirtualMachinePropertiesResponseOsProfile { /** * AdminUsername - admin username */ adminUsername?: string; /** * ComputerName - name of the compute */ computerName?: string; /** * LinuxConfiguration - linux specific configuration values for the virtual machine */ linuxConfiguration?: outputs.azurestackhci.VirtualMachinePropertiesResponseLinuxConfiguration; /** * OsType - string specifying whether the OS is Linux or Windows */ osType?: string; /** * Windows Configuration for the virtual machine */ windowsConfiguration?: outputs.azurestackhci.VirtualMachinePropertiesResponseWindowsConfiguration; } interface VirtualMachinePropertiesResponsePublicKeys { /** * KeyData - SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Li nux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). */ keyData?: string; /** * Path - Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys */ path?: string; } /** * SecurityProfile - Specifies the security settings for the virtual machine. */ interface VirtualMachinePropertiesResponseSecurityProfile { enableTPM?: boolean; uefiSettings?: outputs.azurestackhci.VirtualMachinePropertiesResponseUefiSettings; } /** * virtualMachinePropertiesResponseSecurityProfileProvideDefaults sets the appropriate defaults for VirtualMachinePropertiesResponseSecurityProfile */ function virtualMachinePropertiesResponseSecurityProfileProvideDefaults(val: VirtualMachinePropertiesResponseSecurityProfile): VirtualMachinePropertiesResponseSecurityProfile; /** * SSH - contains settings related to ssh configuration */ interface VirtualMachinePropertiesResponseSsh { /** * PublicKeys - The list of SSH public keys used to authenticate with linux based VMs. */ publicKeys?: outputs.azurestackhci.VirtualMachinePropertiesResponsePublicKeys[]; } /** * StorageProfile - contains information about the disks and storage information for the virtual machine */ interface VirtualMachinePropertiesResponseStorageProfile { /** * adds data disks to the virtual machine */ dataDisks?: outputs.azurestackhci.VirtualMachinePropertiesResponseDataDisks[]; /** * Which Image to use for the virtual machine */ imageReference?: outputs.azurestackhci.VirtualMachinePropertiesResponseImageReference; /** * VHD to attach as OS disk */ osDisk?: outputs.azurestackhci.VirtualMachinePropertiesResponseOsDisk; /** * Id of the storage container that hosts the VM configuration file */ vmConfigStoragePathId?: string; } interface VirtualMachinePropertiesResponseUefiSettings { /** * Specifies whether secure boot should be enabled on the virtual machine. */ secureBootEnabled?: boolean; } /** * virtualMachinePropertiesResponseUefiSettingsProvideDefaults sets the appropriate defaults for VirtualMachinePropertiesResponseUefiSettings */ function virtualMachinePropertiesResponseUefiSettingsProvideDefaults(val: VirtualMachinePropertiesResponseUefiSettings): VirtualMachinePropertiesResponseUefiSettings; /** * Windows Configuration for the virtual machine */ interface VirtualMachinePropertiesResponseWindowsConfiguration { /** * Whether to EnableAutomaticUpdates on the machine */ enableAutomaticUpdates?: boolean; /** * Used to indicate whether Arc for Servers agent onboarding should be triggered during the virtual machine creation process. */ provisionVMAgent?: boolean; /** * SSH Configuration */ ssh?: outputs.azurestackhci.VirtualMachinePropertiesResponseSsh; /** * TimeZone for the virtual machine */ timeZone?: string; } /** * The observed state of virtual machines */ interface VirtualMachineStatusResponse { /** * VirtualMachine provisioning error code */ errorCode?: string; /** * Descriptive error message */ errorMessage?: string; /** * The power state of the virtual machine */ powerState?: string; provisioningStatus?: outputs.azurestackhci.VirtualMachineStatusResponseProvisioningStatus; } interface VirtualMachineStatusResponseProvisioningStatus { /** * The ID of the operation performed on the virtual machine */ operationId?: string; /** * The status of the operation performed on the virtual machine [Succeeded, Failed, InProgress] */ status?: string; } /** * The Azure Resource ID for a Virtual Network */ interface VirtualNetworkArmReferenceResponse { /** * The Azure Resource ID for a Virtual Network. */ resourceId?: string; } /** * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options. */ interface VirtualNetworkPropertiesResponseDhcpOptions { /** * The list of DNS servers IP addresses. */ dnsServers?: string[]; } /** * IPConfigurationReference - Describes a IPConfiguration under the virtual network */ interface VirtualNetworkPropertiesResponseIpConfigurationReferences { /** * IPConfigurationID */ id?: string; } /** * RouteTable for the subnet */ interface VirtualNetworkPropertiesResponseRouteTable { /** * Etag - Gets a unique read-only string that changes whenever the resource is updated. */ id?: string; /** * Name - READ-ONLY; Resource name. */ name?: string; /** * Routes - Collection of routes contained within a route table. */ routes?: outputs.azurestackhci.VirtualNetworkPropertiesResponseRoutes[]; /** * Type - READ-ONLY; Resource type. */ type?: string; } /** * Route is associated with a subnet. */ interface VirtualNetworkPropertiesResponseRoutes { /** * AddressPrefix - The destination CIDR to which the route applies. */ addressPrefix?: string; /** * Name - name of the subnet */ name?: string; /** * NextHopIPAddress - The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. */ nextHopIpAddress?: string; } /** * Subnet subnet in a virtual network resource. */ interface VirtualNetworkPropertiesResponseSubnets { /** * Cidr for this subnet - IPv4, IPv6 */ addressPrefix?: string; /** * AddressPrefixes - List of address prefixes for the subnet. */ addressPrefixes?: string[]; /** * IPAllocationMethod - The IP address allocation method. Possible values include: 'Static', 'Dynamic' */ ipAllocationMethod?: string; /** * IPConfigurationReferences - list of IPConfigurationReferences */ ipConfigurationReferences?: outputs.azurestackhci.VirtualNetworkPropertiesResponseIpConfigurationReferences[]; /** * Name - The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * RouteTable for the subnet */ routeTable?: outputs.azurestackhci.VirtualNetworkPropertiesResponseRouteTable; /** * Vlan to use for the subnet */ vlan?: number; } /** * The observed state of virtual networks */ interface VirtualNetworkStatusResponse { /** * VirtualNetwork provisioning error code */ errorCode?: string; /** * Descriptive error message */ errorMessage?: string; provisioningStatus?: outputs.azurestackhci.VirtualNetworkStatusResponseProvisioningStatus; } interface VirtualNetworkStatusResponseProvisioningStatus { /** * The ID of the operation performed on the virtual network */ operationId?: string; /** * The status of the operation performed on the virtual network [Succeeded, Failed, InProgress] */ status?: string; } /** * The Azure Resource ID for a Virtual Network subnet */ interface VirtualNetworkSubnetArmReferenceResponse { /** * The Azure Resource ID for a Virtual Network subnet. */ resourceId?: string; } /** * The Azure Resource ID for a resource consuming IP on a subnet */ interface VirtualNetworkSubnetIpConfigurationReferenceResponse { /** * The Azure Resource ID for a Network Interface. */ id?: string; } /** * VirtualNetwork subnet resource */ interface VirtualNetworkSubnetPropertiesResponse { /** * Subnet CIDR */ addressPrefix: string; /** * List of ip configurations for the subnet */ ipConfigurations: outputs.azurestackhci.VirtualNetworkSubnetIpConfigurationReferenceResponse[]; /** * Nat Gateway attached to the subnet for non-vnet traffic. */ natGateway?: outputs.azurestackhci.NatGatewayArmReferenceResponse; /** * Network Security Group attached to the subnet. */ networkSecurityGroup?: outputs.azurestackhci.NetworkSecurityGroupArmReferenceResponse; /** * The provisioning state of the virtual network subnet resource. */ provisioningState: string; /** * RouteTable defining custom routes for the subnet. */ routeTable?: outputs.azurestackhci.RouteTableResponse; /** * The observed status of the virtual network subnet resource. */ status: outputs.azurestackhci.VirtualNetworkSubnetStatusResponse; } /** * Status of virtual network subnet operations */ interface VirtualNetworkSubnetStatusProvisioningStatusResponse { /** * The ID of the operation performed on the virtual network subnet */ operationId?: string; /** * The status of the operation performed on the virtual network subnet [Succeeded, Failed, InProgress] */ status: string; } /** * Status of virtual network subnet operations */ interface VirtualNetworkSubnetStatusResponse { /** * VirtualNetworkSubnet provisioning error code */ errorCode?: string; /** * Descriptive error message */ errorMessage?: string; /** * Public IP provisioning status */ provisioningStatus?: outputs.azurestackhci.VirtualNetworkSubnetStatusProvisioningStatusResponse; } /** * The VirtualSwitchConfigurationOverrides of a cluster. */ interface VirtualSwitchConfigurationOverridesHciEdgeDeviceResponse { /** * Enable IoV for Virtual Switch */ enableIov: string; /** * Load Balancing Algorithm for Virtual Switch */ loadBalancingAlgorithm: string; } /** * The VirtualSwitchConfigurationOverrides of a cluster. */ interface VirtualSwitchConfigurationOverridesResponse { /** * Enable IoV for Virtual Switch */ enableIov?: string; /** * Load Balancing Algorithm for Virtual Switch */ loadBalancingAlgorithm?: string; } /** * Web proxy configuration. */ interface WebProxyConfigurationResponse { /** * Bypass list for the web proxy. */ bypassList?: string[]; /** * Connection URI of the web proxy. */ connectionUri?: string; /** * Port of the web proxy. */ port?: string; } } export declare namespace baremetalinfrastructure { /** * Identity for Azure Bare Metal Storage Instance. */ interface AzureBareMetalStorageInstanceIdentityResponse { /** * The principal ID of Azure Bare Metal Storage Instance identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID associated with the Azure Bare Metal Storage Instance. This property will only be provided for a system assigned identity. */ tenantId: string; /** * The type of identity used for the Azure Bare Metal Storage Instance. The type 'SystemAssigned' refers to an implicitly created identity. The type 'None' will remove any identities from the Azure Bare Metal Storage Instance. */ type?: string; } /** * Specifies the disk information fo the Azure Bare Metal Instance */ interface DiskResponse { /** * Specifies the size of an empty data disk in gigabytes. */ diskSizeGB?: number; /** * Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. */ lun: number; /** * The disk name. */ name?: string; } /** * Specifies the hardware settings for the Azure Bare Metal Instance. */ interface HardwareProfileResponse { /** * Specifies the Azure Bare Metal Instance SKU. */ azureBareMetalInstanceSize?: string; /** * Name of the hardware type (vendor and/or their product name) */ hardwareType?: string; } /** * Specifies the network interfaces of a bare metal resource. */ interface NetworkInterfaceResponse { /** * Specifies the IP address of the network interface. */ ipAddress?: string; } /** * Specifies the network settings for the Azure Bare Metal Instance disks. */ interface NetworkProfileResponse { /** * Specifies the circuit id for connecting to express route. */ circuitId?: string; /** * Specifies the network interfaces for the Azure Bare Metal Instance. */ networkInterfaces?: outputs.baremetalinfrastructure.NetworkInterfaceResponse[]; } /** * Specifies the operating system settings for the Azure Bare Metal instance. */ interface OSProfileResponse { /** * Specifies the host OS name of the Azure Bare Metal instance. */ computerName?: string; /** * This property allows you to specify the type of the OS. */ osType?: string; /** * Specifies the SSH public key used to access the operating system. */ sshPublicKey?: string; /** * Specifies version of operating system. */ version?: string; } /** * Describes the billing related details of the AzureBareMetalStorageInstance. */ interface StorageBillingPropertiesResponse { /** * the SKU type that is provisioned */ azureBareMetalStorageInstanceSize?: string; /** * the billing mode for the storage instance */ billingMode?: string; } /** * Specifies the storage settings for the Azure Bare Metal instance disks. */ interface StorageProfileResponse { /** * IP Address to connect to storage. */ nfsIpAddress?: string; /** * Specifies information about the operating system disk used by bare metal instance. */ osDisks?: outputs.baremetalinfrastructure.DiskResponse[]; } /** * described the storage properties of the azure bare metal storage instance */ interface StoragePropertiesResponse { /** * the kind of storage instance */ generation?: string; /** * the hardware type of the storage instance */ hardwareType?: string; /** * the offering type for which the resource is getting provisioned */ offeringType?: string; /** * State of provisioning of the AzureBareMetalStorageInstance */ provisioningState?: string; /** * the billing related information for the resource */ storageBillingProperties?: outputs.baremetalinfrastructure.StorageBillingPropertiesResponse; /** * the storage protocol for which the resource is getting provisioned */ storageType?: string; /** * the workload for which the resource is getting provisioned */ workloadType?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace batch { /** * Link to an application package inside the batch account */ interface ApplicationPackageReferenceResponse { /** * The ID of the application package to install. This must be inside the same batch account as the pool. This can either be a reference to a specific version or the default version if one exists. */ id: string; /** * If this is omitted, and no default version is specified for this application, the request fails with the error code InvalidApplicationPackageReferences. If you are calling the REST API directly, the HTTP status code is 409. */ version?: string; } /** * An error that occurred when autoscaling a pool. */ interface AutoScaleRunErrorResponse { /** * An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */ code: string; /** * Additional details about the error. */ details?: outputs.batch.AutoScaleRunErrorResponse[]; /** * A message describing the error, intended to be suitable for display in a user interface. */ message: string; } /** * The results and errors from an execution of a pool autoscale formula. */ interface AutoScaleRunResponse { /** * An error that occurred when autoscaling a pool. */ error?: outputs.batch.AutoScaleRunErrorResponse; /** * The time at which the autoscale formula was last evaluated. */ evaluationTime: string; /** * Each variable value is returned in the form $variable=value, and variables are separated by semicolons. */ results?: string; } /** * AutoScale settings for the pool. */ interface AutoScaleSettingsResponse { /** * If omitted, the default value is 15 minutes (PT15M). */ evaluationInterval?: string; /** * A formula for the desired number of compute nodes in the pool. */ formula: string; } /** * Contains information about the auto-storage account associated with a Batch account. */ interface AutoStoragePropertiesResponse { /** * The authentication mode which the Batch service will use to manage the auto-storage account. */ authenticationMode?: string; /** * The UTC time at which storage keys were last synchronized with the Batch account. */ lastKeySync: string; /** * The identity referenced here must be assigned to pools which have compute nodes that need access to auto-storage. */ nodeIdentityReference?: outputs.batch.ComputeNodeIdentityReferenceResponse; /** * The resource ID of the storage account to be used for auto-storage account. */ storageAccountId: string; } /** * autoStoragePropertiesResponseProvideDefaults sets the appropriate defaults for AutoStoragePropertiesResponse */ function autoStoragePropertiesResponseProvideDefaults(val: AutoStoragePropertiesResponse): AutoStoragePropertiesResponse; /** * Specifies the parameters for the auto user that runs a task on the Batch service. */ interface AutoUserSpecificationResponse { /** * The default value is nonAdmin. */ elevationLevel?: string; /** * The default value is Pool. If the pool is running Windows a value of Task should be specified if stricter isolation between tasks is required. For example, if the task mutates the registry in a way which could impact other tasks, or if certificates have been specified on the pool which should not be accessible by normal tasks but should be accessible by start tasks. */ scope?: string; } /** * The configuration parameters used for performing automatic OS upgrade. */ interface AutomaticOSUpgradePolicyResponse { /** * Whether OS image rollback feature should be disabled. */ disableAutomaticRollback?: boolean; /** * Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available.

If this is set to true for Windows based pools, [WindowsConfiguration.enableAutomaticUpdates](https://learn.microsoft.com/rest/api/batchmanagement/pool/create?tabs=HTTP#windowsconfiguration) cannot be set to true. */ enableAutomaticOSUpgrade?: boolean; /** * Defer OS upgrades on the TVMs if they are running tasks. */ osRollingUpgradeDeferral?: boolean; /** * Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. */ useRollingUpgradePolicy?: boolean; } /** * Information used to connect to an Azure Storage Container using Blobfuse. */ interface AzureBlobFileSystemConfigurationResponse { /** * This property is mutually exclusive with both sasKey and identity; exactly one must be specified. */ accountKey?: string; /** * The Azure Storage Account name. */ accountName: string; /** * These are 'net use' options in Windows and 'mount' options in Linux. */ blobfuseOptions?: string; /** * The Azure Blob Storage Container name. */ containerName: string; /** * This property is mutually exclusive with both accountKey and sasKey; exactly one must be specified. */ identityReference?: outputs.batch.ComputeNodeIdentityReferenceResponse; /** * All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. */ relativeMountPath: string; /** * This property is mutually exclusive with both accountKey and identity; exactly one must be specified. */ sasKey?: string; } /** * Information used to connect to an Azure Fileshare. */ interface AzureFileShareConfigurationResponse { /** * The Azure Storage account key. */ accountKey: string; /** * The Azure Storage account name. */ accountName: string; /** * This is of the form 'https://{account}.file.core.windows.net/'. */ azureFileUrl: string; /** * These are 'net use' options in Windows and 'mount' options in Linux. */ mountOptions?: string; /** * All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. */ relativeMountPath: string; } /** * The identity of the Batch account, if configured. This is used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration or when `ManagedIdentity` is selected as the auto-storage authentication mode. */ interface BatchAccountIdentityResponse { /** * The principal id of the Batch account. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant id associated with the Batch account. This property will only be provided for a system assigned identity. */ tenantId: string; /** * The type of identity used for the Batch account. */ type: string; /** * The list of user identities associated with the Batch account. */ userAssignedIdentities?: { [key: string]: outputs.batch.UserAssignedIdentitiesResponse; }; } /** * The identity of the Batch pool, if configured. If the pool identity is updated during update an existing pool, only the new vms which are created after the pool shrinks to 0 will have the updated identities */ interface BatchPoolIdentityResponse { /** * The type of identity used for the Batch Pool. */ type: string; /** * The list of user identities associated with the Batch pool. */ userAssignedIdentities?: { [key: string]: outputs.batch.UserAssignedIdentitiesResponse; }; } /** * Information used to connect to a CIFS file system. */ interface CIFSMountConfigurationResponse { /** * These are 'net use' options in Windows and 'mount' options in Linux. */ mountOptions?: string; /** * The password to use for authentication against the CIFS file system. */ password: string; /** * All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. */ relativeMountPath: string; /** * The URI of the file system to mount. */ source: string; /** * The user to use for authentication against the CIFS file system. */ userName: string; } /** * Warning: This object is deprecated and will be removed after February, 2024. Please use the [Azure KeyVault Extension](https://learn.microsoft.com/azure/batch/batch-certificate-migration-guide) instead. */ interface CertificateReferenceResponse { /** * The fully qualified ID of the certificate to install on the pool. This must be inside the same batch account as the pool. */ id: string; /** * The default value is currentUser. This property is applicable only for pools configured with Windows compute nodes. For Linux compute nodes, the certificates are stored in a directory inside the task working directory and an environment variable AZ_BATCH_CERTIFICATES_DIR is supplied to the task to query for this location. For certificates with visibility of 'remoteUser', a 'certs' directory is created in the user's home directory (e.g., /home/{user-name}/certs) and certificates are placed in that directory. */ storeLocation?: string; /** * This property is applicable only for pools configured with Windows compute nodes. Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My. */ storeName?: string; /** * Which user accounts on the compute node should have access to the private data of the certificate. */ visibility?: string[]; } /** * The reference to a user assigned identity associated with the Batch pool which a compute node will use. */ interface ComputeNodeIdentityReferenceResponse { /** * The ARM resource id of the user assigned identity. */ resourceId?: string; } /** * The configuration for container-enabled pools. */ interface ContainerConfigurationResponse { /** * This is the full image reference, as would be specified to "docker pull". An image will be sourced from the default Docker registry unless the image is fully qualified with an alternative registry. */ containerImageNames?: string[]; /** * If any images must be downloaded from a private registry which requires credentials, then those credentials must be provided here. */ containerRegistries?: outputs.batch.ContainerRegistryResponse[]; /** * The container technology to be used. */ type: string; } /** * The entry of path and mount mode you want to mount into task container. */ interface ContainerHostBatchBindMountEntryResponse { /** * For Linux, if you mount this path as a read/write mode, this does not mean that all users in container have the read/write access for the path, it depends on the access in host VM. If this path is mounted read-only, all users within the container will not be able to modify the path. */ isReadOnly?: boolean; /** * The paths which will be mounted to container task's container. */ source?: string; } /** * A private container registry. */ interface ContainerRegistryResponse { /** * The reference to a user assigned identity associated with the Batch pool which a compute node will use. */ identityReference?: outputs.batch.ComputeNodeIdentityReferenceResponse; /** * The password to log into the registry server. */ password?: string; /** * If omitted, the default is "docker.io". */ registryServer?: string; /** * The user name to log into the registry server. */ userName?: string; } /** * Settings which will be used by the data disks associated to Compute Nodes in the Pool. When using attached data disks, you need to mount and format the disks from within a VM to use them. */ interface DataDiskResponse { /** * Values are: * * none - The caching mode for the disk is not enabled. * readOnly - The caching mode for the disk is read only. * readWrite - The caching mode for the disk is read and write. * * The default value for caching is none. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. */ caching?: string; /** * The initial disk size in GB when creating new data disk. */ diskSizeGB: number; /** * The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. The value must be between 0 and 63, inclusive. */ lun: number; /** * If omitted, the default is "Standard_LRS". Values are: * * Standard_LRS - The data disk should use standard locally redundant storage. * Premium_LRS - The data disk should use premium locally redundant storage. */ storageAccountType?: string; } /** * Deployment configuration properties. */ interface DeploymentConfigurationResponse { /** * The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. */ virtualMachineConfiguration?: outputs.batch.VirtualMachineConfigurationResponse; } /** * Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. */ interface DiffDiskSettingsResponse { /** * This property can be used by user in the request to choose which location the operating system should be in. e.g., cache disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer to Ephemeral OS disk size requirements for Windows VMs at https://learn.microsoft.com/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VMs at https://learn.microsoft.com/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements. */ placement?: string; } /** * The disk encryption configuration applied on compute nodes in the pool. Disk encryption configuration is not supported on Linux pool created with Virtual Machine Image or Azure Compute Gallery Image. */ interface DiskEncryptionConfigurationResponse { /** * On Linux pool, only "TemporaryDisk" is supported; on Windows pool, "OsDisk" and "TemporaryDisk" must be specified. */ targets?: string[]; } /** * Configures how customer data is encrypted inside the Batch account. By default, accounts are encrypted using a Microsoft managed key. For additional control, a customer-managed key can be used instead. */ interface EncryptionPropertiesResponse { /** * Type of the key source. */ keySource?: string; /** * Additional details when using Microsoft.KeyVault */ keyVaultProperties?: outputs.batch.KeyVaultPropertiesResponse; } /** * Network access profile for Batch endpoint. */ interface EndpointAccessProfileResponse { /** * Default action for endpoint access. It is only applicable when publicNetworkAccess is enabled. */ defaultAction: string; /** * Array of IP ranges to filter client IP address. */ ipRules?: outputs.batch.IPRuleResponse[]; } /** * An environment variable to be set on a task process. */ interface EnvironmentSettingResponse { /** * The name of the environment variable. */ name: string; /** * The value of the environment variable. */ value?: string; } /** * Fixed scale settings for the pool. */ interface FixedScaleSettingsResponse { /** * The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). */ resizeTimeout?: string; /** * At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. */ targetDedicatedNodes?: number; /** * At least one of targetDedicatedNodes, targetLowPriorityNodes must be set. */ targetLowPriorityNodes?: number; } /** * fixedScaleSettingsResponseProvideDefaults sets the appropriate defaults for FixedScaleSettingsResponse */ function fixedScaleSettingsResponseProvideDefaults(val: FixedScaleSettingsResponse): FixedScaleSettingsResponse; /** * Rule to filter client IP address. */ interface IPRuleResponse { /** * Action when client IP address is matched. */ action: string; /** * IPv4 address, or IPv4 address range in CIDR format. */ value: string; } /** * A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. */ interface ImageReferenceResponse { /** * This property is mutually exclusive with other properties and can be fetched from community gallery image GET call. */ communityGalleryImageId?: string; /** * This property is mutually exclusive with other properties. The Azure Compute Gallery Image must have replicas in the same region as the Azure Batch account. For information about the firewall settings for the Batch node agent to communicate with the Batch service see https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration. */ id?: string; /** * For example, UbuntuServer or WindowsServer. */ offer?: string; /** * For example, Canonical or MicrosoftWindowsServer. */ publisher?: string; /** * This property is mutually exclusive with other properties and can be fetched from shared gallery image GET call. */ sharedGalleryImageId?: string; /** * For example, 18.04-LTS or 2022-datacenter. */ sku?: string; /** * A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'. */ version?: string; } /** * A inbound NAT pool that can be used to address specific ports on compute nodes in a Batch pool externally. */ interface InboundNatPoolResponse { /** * This must be unique within a Batch pool. Acceptable values are between 1 and 65535 except for 29876 and 29877 as these are reserved. If any reserved values are provided the request fails with HTTP status code 400. */ backendPort: number; /** * Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. */ frontendPortRangeEnd: number; /** * Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved. All ranges within a pool must be distinct and cannot overlap. If any reserved or overlapping values are provided the request fails with HTTP status code 400. */ frontendPortRangeStart: number; /** * The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. If any invalid values are provided the request fails with HTTP status code 400. */ name: string; /** * The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. If the maximum number of network security group rules is exceeded the request fails with HTTP status code 400. */ networkSecurityGroupRules?: outputs.batch.NetworkSecurityGroupRuleResponse[]; /** * The protocol of the endpoint. */ protocol: string; } /** * KeyVault configuration when using an encryption KeySource of Microsoft.KeyVault. */ interface KeyVaultPropertiesResponse { /** * Full path to the secret with or without version. Example https://mykeyvault.vault.azure.net/keys/testkey/6e34a81fef704045975661e297a4c053. or https://mykeyvault.vault.azure.net/keys/testkey. To be usable the following prerequisites must be met: * * The Batch Account has a System Assigned identity * The account identity has been granted Key/Get, Key/Unwrap and Key/Wrap permissions * The KeyVault has soft-delete and purge protection enabled */ keyIdentifier?: string; } /** * Identifies the Azure key vault associated with a Batch account. */ interface KeyVaultReferenceResponse { /** * The resource ID of the Azure key vault associated with the Batch account. */ id: string; /** * The URL of the Azure key vault associated with the Batch account. */ url: string; } /** * Properties used to create a user account on a Linux node. */ interface LinuxUserConfigurationResponse { /** * The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the gid. */ gid?: number; /** * The private key must not be password protected. The private key is used to automatically configure asymmetric-key based authentication for SSH between nodes in a Linux pool when the pool's enableInterNodeCommunication property is true (it is ignored if enableInterNodeCommunication is false). It does this by placing the key pair into the user's .ssh directory. If not specified, password-less SSH is not configured between nodes (no modification of the user's .ssh directory is done). */ sshPrivateKey?: string; /** * The uid and gid properties must be specified together or not at all. If not specified the underlying operating system picks the uid. */ uid?: number; } /** * The managed disk parameters. */ interface ManagedDiskResponse { /** * Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. */ securityProfile?: outputs.batch.VMDiskSecurityProfileResponse; /** * The storage account type for use in creating data disks or OS disk. */ storageAccountType?: string; } /** * The Batch service does not assign any meaning to this metadata; it is solely for the use of user code. */ interface MetadataItemResponse { /** * The name of the metadata item. */ name: string; /** * The value of the metadata item. */ value: string; } /** * The file system to mount on each node. */ interface MountConfigurationResponse { /** * This property is mutually exclusive with all other properties. */ azureBlobFileSystemConfiguration?: outputs.batch.AzureBlobFileSystemConfigurationResponse; /** * This property is mutually exclusive with all other properties. */ azureFileShareConfiguration?: outputs.batch.AzureFileShareConfigurationResponse; /** * This property is mutually exclusive with all other properties. */ cifsMountConfiguration?: outputs.batch.CIFSMountConfigurationResponse; /** * This property is mutually exclusive with all other properties. */ nfsMountConfiguration?: outputs.batch.NFSMountConfigurationResponse; } /** * Information used to connect to an NFS file system. */ interface NFSMountConfigurationResponse { /** * These are 'net use' options in Windows and 'mount' options in Linux. */ mountOptions?: string; /** * All file systems are mounted relative to the Batch mounts directory, accessible via the AZ_BATCH_NODE_MOUNTS_DIR environment variable. */ relativeMountPath: string; /** * The URI of the file system to mount. */ source: string; } /** * The network configuration for a pool. */ interface NetworkConfigurationResponse { /** * The scope of dynamic vnet assignment. */ dynamicVnetAssignmentScope?: string; /** * Accelerated networking enables single root I/O virtualization (SR-IOV) to a VM, which may lead to improved networking performance. For more details, see: https://learn.microsoft.com/azure/virtual-network/accelerated-networking-overview. */ enableAcceleratedNetworking?: boolean; /** * The endpoint configuration for a pool. */ endpointConfiguration?: outputs.batch.PoolEndpointConfigurationResponse; /** * The public IP Address configuration of the networking configuration of a Pool. */ publicIPAddressConfiguration?: outputs.batch.PublicIPAddressConfigurationResponse; /** * The virtual network must be in the same region and subscription as the Azure Batch account. The specified subnet should have enough free IP addresses to accommodate the number of nodes in the pool. If the subnet doesn't have enough free IP addresses, the pool will partially allocate compute nodes and a resize error will occur. The 'MicrosoftAzureBatch' service principal must have the 'Classic Virtual Machine Contributor' Role-Based Access Control (RBAC) role for the specified VNet. The specified subnet must allow communication from the Azure Batch service to be able to schedule tasks on the compute nodes. This can be verified by checking if the specified VNet has any associated Network Security Groups (NSG). If communication to the compute nodes in the specified subnet is denied by an NSG, then the Batch service will set the state of the compute nodes to unusable. If the specified VNet has any associated Network Security Groups (NSG), then a few reserved system ports must be enabled for inbound communication,including ports 29876 and 29877. Also enable outbound connections to Azure Storage on port 443. For more details see: https://learn.microsoft.com/azure/batch/batch-api-basics#virtual-network-vnet-and-firewall-configuration */ subnetId?: string; } /** * networkConfigurationResponseProvideDefaults sets the appropriate defaults for NetworkConfigurationResponse */ function networkConfigurationResponseProvideDefaults(val: NetworkConfigurationResponse): NetworkConfigurationResponse; /** * Network profile for Batch account, which contains network rule settings for each endpoint. */ interface NetworkProfileResponse { /** * Network access profile for batchAccount endpoint (Batch account data plane API). */ accountAccess?: outputs.batch.EndpointAccessProfileResponse; /** * Network access profile for nodeManagement endpoint (Batch service managing compute nodes for Batch pools). */ nodeManagementAccess?: outputs.batch.EndpointAccessProfileResponse; } /** * A network security group rule to apply to an inbound endpoint. */ interface NetworkSecurityGroupRuleResponse { /** * The action that should be taken for a specified IP address, subnet range or tag. */ access: string; /** * Priorities within a pool must be unique and are evaluated in order of priority. The lower the number the higher the priority. For example, rules could be specified with order numbers of 150, 250, and 350. The rule with the order number of 150 takes precedence over the rule that has an order of 250. Allowed priorities are 150 to 4096. If any reserved or duplicate values are provided the request fails with HTTP status code 400. */ priority: number; /** * Valid values are a single IP address (i.e. 10.10.10.10), IP subnet (i.e. 192.168.1.0/24), default tag, or * (for all addresses). If any other values are provided the request fails with HTTP status code 400. */ sourceAddressPrefix: string; /** * Valid values are '*' (for all ports 0 - 65535) or arrays of ports or port ranges (i.e. 100-200). The ports should in the range of 0 to 65535 and the port ranges or ports can't overlap. If any other values are provided the request fails with HTTP status code 400. Default value will be *. */ sourcePortRanges?: string[]; } /** * Allocation configuration used by Batch Service to provision the nodes. */ interface NodePlacementConfigurationResponse { /** * Allocation policy used by Batch Service to provision the nodes. If not specified, Batch will use the regional policy. */ policy?: string; } /** * Settings for the operating system disk of the virtual machine. */ interface OSDiskResponse { /** * The type of caching to enable for the disk. */ caching?: string; /** * The initial disk size in GB when creating new OS disk. */ diskSizeGB?: number; /** * Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. */ ephemeralOSDiskSettings?: outputs.batch.DiffDiskSettingsResponse; /** * The managed disk parameters. */ managedDisk?: outputs.batch.ManagedDiskResponse; /** * Specifies whether writeAccelerator should be enabled or disabled on the disk. */ writeAcceleratorEnabled?: boolean; } /** * The endpoint configuration for a pool. */ interface PoolEndpointConfigurationResponse { /** * The maximum number of inbound NAT pools per Batch pool is 5. If the maximum number of inbound NAT pools is exceeded the request fails with HTTP status code 400. This cannot be specified if the IPAddressProvisioningType is NoPublicIPAddresses. */ inboundNatPools: outputs.batch.InboundNatPoolResponse[]; } /** * Contains information about a private link resource. */ interface PrivateEndpointConnectionResponse { /** * The ETag of the resource, used for concurrency statements. */ etag: string; /** * The value has one and only one group id. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint of the private endpoint connection. */ privateEndpoint: outputs.batch.PrivateEndpointResponse; /** * The private link service connection state of the private endpoint connection. */ privateLinkServiceConnectionState?: outputs.batch.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.batch.SystemDataResponse; /** * The tags of the resource. */ tags?: { [key: string]: string; }; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint of the private endpoint connection. */ interface PrivateEndpointResponse { /** * The ARM resource identifier of the private endpoint. This is of the form /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/privateEndpoints/{privateEndpoint}. */ id: string; } /** * The private link service connection state of the private endpoint connection */ interface PrivateLinkServiceConnectionStateResponse { /** * Action required on the private connection state */ actionsRequired: string; /** * Description of the private Connection state */ description?: string; /** * The status of the Batch private endpoint connection */ status: string; } /** * The public IP Address configuration of the networking configuration of a Pool. */ interface PublicIPAddressConfigurationResponse { /** * The number of IPs specified here limits the maximum size of the Pool - 100 dedicated nodes or 100 Spot/low-priority nodes can be allocated for each public IP. For example, a pool needing 250 dedicated VMs would need at least 3 public IPs specified. Each element of this collection is of the form: /subscriptions/{subscription}/resourceGroups/{group}/providers/Microsoft.Network/publicIPAddresses/{ip}. */ ipAddressIds?: string[]; /** * The default value is BatchManaged */ provision?: string; } /** * An error that occurred when resizing a pool. */ interface ResizeErrorResponse { /** * An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */ code: string; /** * Additional details about the error. */ details?: outputs.batch.ResizeErrorResponse[]; /** * A message describing the error, intended to be suitable for display in a user interface. */ message: string; } /** * Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady). */ interface ResizeOperationStatusResponse { /** * This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady. */ errors?: outputs.batch.ResizeErrorResponse[]; /** * The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). */ resizeTimeout?: string; /** * The time when this resize operation was started. */ startTime?: string; /** * The desired number of dedicated compute nodes in the pool. */ targetDedicatedNodes?: number; /** * The desired number of Spot/low-priority compute nodes in the pool. */ targetLowPriorityNodes?: number; } /** * A single file or multiple files to be downloaded to a compute node. */ interface ResourceFileResponse { /** * The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. */ autoStorageContainerName?: string; /** * The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded. */ blobPrefix?: string; /** * This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file. */ fileMode?: string; /** * If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task's working directory (for example by using '..'). */ filePath?: string; /** * The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. If the URL points to Azure Blob Storage, it must be readable from compute nodes. There are three ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, use a managed identity with read permission, or set the ACL for the blob or its container to allow public access. */ httpUrl?: string; /** * The reference to a user assigned identity associated with the Batch pool which a compute node will use. */ identityReference?: outputs.batch.ComputeNodeIdentityReferenceResponse; /** * The autoStorageContainerName, storageContainerUrl and httpUrl properties are mutually exclusive and one of them must be specified. This URL must be readable and listable from compute nodes. There are three ways to get such a URL for a container in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the container, use a managed identity with read and list permissions, or set the ACL for the container to allow public access. */ storageContainerUrl?: string; } /** * The configuration parameters used while performing a rolling upgrade. */ interface RollingUpgradePolicyResponse { /** * Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. If this field is not set, Azure Azure Batch will not set its default value. The value of enableCrossZoneUpgrade on the created VirtualMachineScaleSet will be decided by the default configurations on VirtualMachineScaleSet. This field is able to be set to true or false only when using NodePlacementConfiguration as Zonal. */ enableCrossZoneUpgrade?: boolean; /** * The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. */ maxBatchInstancePercent?: number; /** * The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The value of this field should be between 5 and 100, inclusive. If both maxBatchInstancePercent and maxUnhealthyInstancePercent are assigned with value, the value of maxBatchInstancePercent should not be more than maxUnhealthyInstancePercent. */ maxUnhealthyInstancePercent?: number; /** * The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The value of this field should be between 0 and 100, inclusive. */ maxUnhealthyUpgradedInstancePercent?: number; /** * The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. */ pauseTimeBetweenBatches?: string; /** * Upgrade all unhealthy instances in a scale set before any healthy instances. */ prioritizeUnhealthyInstances?: boolean; /** * Rollback failed instances to previous model if the Rolling Upgrade policy is violated. */ rollbackFailedInstancesOnPolicyBreach?: boolean; } /** * Defines the desired size of the pool. This can either be 'fixedScale' where the requested targetDedicatedNodes is specified, or 'autoScale' which defines a formula which is periodically reevaluated. If this property is not specified, the pool will have a fixed scale with 0 targetDedicatedNodes. */ interface ScaleSettingsResponse { /** * This property and fixedScale are mutually exclusive and one of the properties must be specified. */ autoScale?: outputs.batch.AutoScaleSettingsResponse; /** * This property and autoScale are mutually exclusive and one of the properties must be specified. */ fixedScale?: outputs.batch.FixedScaleSettingsResponse; } /** * scaleSettingsResponseProvideDefaults sets the appropriate defaults for ScaleSettingsResponse */ function scaleSettingsResponseProvideDefaults(val: ScaleSettingsResponse): ScaleSettingsResponse; /** * Specifies the security profile settings for the virtual machine or virtual machine scale set. */ interface SecurityProfileResponse { /** * This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. */ encryptionAtHost?: boolean; /** * Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. */ securityType?: string; /** * Specifies the security settings like secure boot and vTPM used while creating the virtual machine. */ uefiSettings?: outputs.batch.UefiSettingsResponse; } /** * Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. */ interface ServiceArtifactReferenceResponse { /** * The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} */ id: string; } /** * In some cases the start task may be re-run even though the node was not rebooted. Due to this, start tasks should be idempotent and exit gracefully if the setup they're performing has already been done. Special care should be taken to avoid start tasks which create breakaway process or install/launch services from the start task working directory, as this will block Batch from being able to re-run the start task. */ interface StartTaskResponse { /** * The command line does not run under a shell, and therefore cannot take advantage of shell features such as environment variable expansion. If you want to take advantage of such features, you should invoke the shell in the command line, for example using "cmd /c MyCommand" in Windows or "/bin/sh -c MyCommand" in Linux. Required if any other properties of the startTask are specified. */ commandLine?: string; /** * When this is specified, all directories recursively below the AZ_BATCH_NODE_ROOT_DIR (the root of Azure Batch directories on the node) are mapped into the container, all task environment variables are mapped into the container, and the task command line is executed in the container. */ containerSettings?: outputs.batch.TaskContainerSettingsResponse; /** * A list of environment variable settings for the start task. */ environmentSettings?: outputs.batch.EnvironmentSettingResponse[]; /** * The Batch service retries a task if its exit code is nonzero. Note that this value specifically controls the number of retries. The Batch service will try the task once, and may then retry up to this limit. For example, if the maximum retry count is 3, Batch tries the task up to 4 times (one initial try and 3 retries). If the maximum retry count is 0, the Batch service does not retry the task. If the maximum retry count is -1, the Batch service retries the task without limit. Default is 0 */ maxTaskRetryCount?: number; /** * A list of files that the Batch service will download to the compute node before running the command line. */ resourceFiles?: outputs.batch.ResourceFileResponse[]; /** * If omitted, the task runs as a non-administrative user unique to the task. */ userIdentity?: outputs.batch.UserIdentityResponse; /** * If true and the start task fails on a compute node, the Batch service retries the start task up to its maximum retry count (maxTaskRetryCount). If the task has still not completed successfully after all retries, then the Batch service marks the compute node unusable, and will not schedule tasks to it. This condition can be detected via the node state and scheduling error detail. If false, the Batch service will not wait for the start task to complete. In this case, other tasks can start executing on the compute node while the start task is still running; and even if the start task fails, new tasks will continue to be scheduled on the node. The default is true. */ waitForSuccess?: boolean; } /** * startTaskResponseProvideDefaults sets the appropriate defaults for StartTaskResponse */ function startTaskResponseProvideDefaults(val: StartTaskResponse): StartTaskResponse; /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The container settings for a task. */ interface TaskContainerSettingsResponse { /** * If this array is null or be not present, container task will mount entire temporary disk drive in windows (or AZ_BATCH_NODE_ROOT_DIR in Linux). It won't' mount any data paths into container if this array is set as empty. */ containerHostBatchBindMounts?: outputs.batch.ContainerHostBatchBindMountEntryResponse[]; /** * These additional options are supplied as arguments to the "docker create" command, in addition to those controlled by the Batch Service. */ containerRunOptions?: string; /** * This is the full image reference, as would be specified to "docker pull". If no tag is provided as part of the image name, the tag ":latest" is used as a default. */ imageName: string; /** * This setting can be omitted if was already provided at pool creation. */ registry?: outputs.batch.ContainerRegistryResponse; /** * A flag to indicate where the container task working directory is. The default is 'taskWorkingDirectory'. */ workingDirectory?: string; } /** * Specifies how tasks should be distributed across compute nodes. */ interface TaskSchedulingPolicyResponse { /** * How tasks should be distributed across compute nodes. */ nodeFillType: string; } /** * taskSchedulingPolicyResponseProvideDefaults sets the appropriate defaults for TaskSchedulingPolicyResponse */ function taskSchedulingPolicyResponseProvideDefaults(val: TaskSchedulingPolicyResponse): TaskSchedulingPolicyResponse; /** * Specifies the security settings like secure boot and vTPM used while creating the virtual machine. */ interface UefiSettingsResponse { /** * Specifies whether secure boot should be enabled on the virtual machine. */ secureBootEnabled?: boolean; /** * Specifies whether vTPM should be enabled on the virtual machine. */ vTpmEnabled?: boolean; } /** * Describes an upgrade policy - automatic, manual, or rolling. */ interface UpgradePolicyResponse { /** * The configuration parameters used for performing automatic OS upgrade. */ automaticOSUpgradePolicy?: outputs.batch.AutomaticOSUpgradePolicyResponse; /** * Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time.

**Rolling** - Scale set performs updates in batches with an optional pause time in between. */ mode: string; /** * The configuration parameters used while performing a rolling upgrade. */ rollingUpgradePolicy?: outputs.batch.RollingUpgradePolicyResponse; } /** * Properties used to create a user on an Azure Batch node. */ interface UserAccountResponse { /** * nonAdmin - The auto user is a standard user without elevated access. admin - The auto user is a user with elevated access and operates with full Administrator permissions. The default value is nonAdmin. */ elevationLevel?: string; /** * This property is ignored if specified on a Windows pool. If not specified, the user is created with the default options. */ linuxUserConfiguration?: outputs.batch.LinuxUserConfigurationResponse; /** * The name of the user account. Names can contain any Unicode characters up to a maximum length of 20. */ name: string; /** * The password for the user account. */ password: string; /** * This property can only be specified if the user is on a Windows pool. If not specified and on a Windows pool, the user is created with the default options. */ windowsUserConfiguration?: outputs.batch.WindowsUserConfigurationResponse; } /** * The list of associated user identities. */ interface UserAssignedIdentitiesResponse { /** * The client id of user assigned identity. */ clientId: string; /** * The principal id of user assigned identity. */ principalId: string; } /** * Specify either the userName or autoUser property, but not both. */ interface UserIdentityResponse { /** * The userName and autoUser properties are mutually exclusive; you must specify one but not both. */ autoUser?: outputs.batch.AutoUserSpecificationResponse; /** * The userName and autoUser properties are mutually exclusive; you must specify one but not both. */ userName?: string; } /** * Specifies the security profile settings for the managed disk. **Note**: It can only be set for Confidential VMs and is required when using Confidential VMs. */ interface VMDiskSecurityProfileResponse { /** * Specifies the EncryptionType of the managed disk. It is set to VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob. **Note**: It can be set for only Confidential VMs and required when using Confidential VMs. */ securityEncryptionType?: string; } /** * The configuration for virtual machine extensions. */ interface VMExtensionResponse { /** * Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */ autoUpgradeMinorVersion?: boolean; /** * Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */ enableAutomaticUpgrade?: boolean; /** * The name of the virtual machine extension. */ name: string; /** * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */ protectedSettings?: any; /** * Collection of extension names after which this extension needs to be provisioned. */ provisionAfterExtensions?: string[]; /** * The name of the extension handler publisher. */ publisher: string; /** * JSON formatted public settings for the extension. */ settings?: any; /** * The type of the extensions. */ type: string; /** * The version of script handler. */ typeHandlerVersion?: string; } /** * The configuration for compute nodes in a pool based on the Azure Virtual Machines infrastructure. */ interface VirtualMachineConfigurationResponse { /** * If specified, setup is performed on each node in the pool to allow tasks to run in containers. All regular tasks and job manager tasks run on this pool must specify the containerSettings property, and all other tasks may specify it. */ containerConfiguration?: outputs.batch.ContainerConfigurationResponse; /** * This property must be specified if the compute nodes in the pool need to have empty data disks attached to them. */ dataDisks?: outputs.batch.DataDiskResponse[]; /** * If specified, encryption is performed on each node in the pool during node provisioning. */ diskEncryptionConfiguration?: outputs.batch.DiskEncryptionConfigurationResponse; /** * If specified, the extensions mentioned in this configuration will be installed on each node. */ extensions?: outputs.batch.VMExtensionResponse[]; /** * A reference to an Azure Virtual Machines Marketplace image or the Azure Image resource of a custom Virtual Machine. To get the list of all imageReferences verified by Azure Batch, see the 'List supported node agent SKUs' operation. */ imageReference: outputs.batch.ImageReferenceResponse; /** * This only applies to images that contain the Windows operating system, and should only be used when you hold valid on-premises licenses for the nodes which will be deployed. If omitted, no on-premises licensing discount is applied. Values are: * * Windows_Server - The on-premises license is for Windows Server. * Windows_Client - The on-premises license is for Windows Client. */ licenseType?: string; /** * The Batch node agent is a program that runs on each node in the pool, and provides the command-and-control interface between the node and the Batch service. There are different implementations of the node agent, known as SKUs, for different operating systems. You must specify a node agent SKU which matches the selected image reference. To get the list of supported node agent SKUs along with their list of verified image references, see the 'List supported node agent SKUs' operation. */ nodeAgentSkuId: string; /** * This configuration will specify rules on how nodes in the pool will be physically allocated. */ nodePlacementConfiguration?: outputs.batch.NodePlacementConfigurationResponse; /** * Contains configuration for ephemeral OSDisk settings. */ osDisk?: outputs.batch.OSDiskResponse; /** * Specifies the security profile settings for the virtual machine or virtual machine scale set. */ securityProfile?: outputs.batch.SecurityProfileResponse; /** * The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} */ serviceArtifactReference?: outputs.batch.ServiceArtifactReferenceResponse; /** * This property must not be specified if the imageReference specifies a Linux OS image. */ windowsConfiguration?: outputs.batch.WindowsConfigurationResponse; } /** * A VM Family and its associated core quota for the Batch account. */ interface VirtualMachineFamilyCoreQuotaResponse { /** * The core quota for the VM family for the Batch account. */ coreQuota: number; /** * The Virtual Machine family name. */ name: string; } /** * Windows operating system settings to apply to the virtual machine. */ interface WindowsConfigurationResponse { /** * If omitted, the default value is true. */ enableAutomaticUpdates?: boolean; } /** * Properties used to create a user account on a Windows node. */ interface WindowsUserConfigurationResponse { /** * Specifies login mode for the user. The default value is Interactive. */ loginMode?: string; } } export declare namespace billing { /** * An associated tenant. */ interface AssociatedTenantPropertiesResponse { /** * The state determines whether users from the associated tenant can be assigned roles for commerce activities like viewing and downloading invoices, managing payments, and making purchases. */ billingManagementState?: string; /** * The name of the associated tenant. */ displayName?: string; /** * The unique identifier for the billing request that is created when enabling provisioning for an associated tenant. */ provisioningBillingRequestId: string; /** * The state determines whether subscriptions and licenses can be provisioned in the associated tenant. It can be set to 'Pending' to initiate a billing request. */ provisioningManagementState?: string; /** * The provisioning state of the resource during a long-running operation. */ provisioningState: string; /** * The ID that uniquely identifies a tenant. */ tenantId?: string; } /** * Details of the Azure plan. */ interface AzurePlanResponse { /** * The ID that uniquely identifies a product. */ productId?: string; /** * The sku description. */ skuDescription?: string; /** * The ID that uniquely identifies a sku. */ skuId?: string; } /** * Billing address. */ interface BillingProfilePropertiesBillToResponse { /** * Address line 1. */ addressLine1: string; /** * Address line 2. */ addressLine2?: string; /** * Address line 3. */ addressLine3?: string; /** * Address city. */ city?: string; /** * Company name. Optional for MCA Individual (Pay-as-you-go). */ companyName?: string; /** * Country code uses ISO 3166-1 Alpha-2 format. */ country: string; /** * Address district. */ district?: string; /** * Email address. */ email?: string; /** * First name. Optional for MCA Enterprise. */ firstName?: string; /** * Indicates if the address is incomplete. */ isValidAddress?: boolean; /** * Last name. Optional for MCA Enterprise. */ lastName?: string; /** * Middle name. */ middleName?: string; /** * Phone number. */ phoneNumber?: string; /** * Postal code. */ postalCode?: string; /** * Address region. */ region?: string; } /** * The current payment term of the billing profile. */ interface BillingProfilePropertiesCurrentPaymentTermResponse { /** * The date on when the defined 'Payment Term' will end and is always in UTC. */ endDate?: string; /** * Indicates payment term is the standard payment term. */ isDefault: boolean; /** * The date on when the defined 'Payment Term' will be effective from and is always in UTC. */ startDate?: string; /** * Represents duration in netXX format. Always in days. */ term?: string; } /** * Identifies the billing profile that is linked to another billing profile in indirect purchase motion. */ interface BillingProfilePropertiesIndirectRelationshipInfoResponse { /** * The billing account name of the partner or the customer for an indirect motion. */ billingAccountName?: string; /** * The billing profile name of the partner or the customer for an indirect motion. */ billingProfileName?: string; /** * The display name of the partner or customer for an indirect motion. */ displayName?: string; } /** * A billing profile. */ interface BillingProfilePropertiesResponse { /** * Billing address. */ billTo?: outputs.billing.BillingProfilePropertiesBillToResponse; /** * Identifies the billing relationship represented by the billing profile. The billing relationship may be between Microsoft, the customer, and/or a third-party. */ billingRelationshipType: string; /** * The currency in which the charges for the billing profile are billed. */ currency: string; /** * The current payment term of the billing profile. */ currentPaymentTerm?: outputs.billing.BillingProfilePropertiesCurrentPaymentTermResponse; /** * The name of the billing profile. */ displayName?: string; /** * Information about the enabled azure plans. */ enabledAzurePlans?: outputs.billing.AzurePlanResponse[]; /** * Indicates whether user has read access to the billing profile. */ hasReadAccess: boolean; /** * Identifies the billing profile that is linked to another billing profile in indirect purchase motion. */ indirectRelationshipInfo?: outputs.billing.BillingProfilePropertiesIndirectRelationshipInfoResponse; /** * The day of the month when the invoice for the billing profile is generated. */ invoiceDay: number; /** * Flag controlling whether the invoices for the billing profile are sent through email. */ invoiceEmailOptIn?: boolean; /** * The list of email addresses to receive invoices by email for the billing profile. */ invoiceRecipients?: string[]; /** * The other payment terms of the billing profile. */ otherPaymentTerms: outputs.billing.PaymentTermResponse[]; /** * The default purchase order number that will appear on the invoices generated for the billing profile. */ poNumber?: string; /** * The provisioning state of the resource during a long-running operation. */ provisioningState: string; /** * The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used. */ shipTo?: outputs.billing.BillingProfilePropertiesShipToResponse; /** * The address of the individual or organization that is responsible for the billing account. */ soldTo?: outputs.billing.BillingProfilePropertiesSoldToResponse; /** * The billing profile spending limit. */ spendingLimit: string; /** * The details of billing profile spending limit. */ spendingLimitDetails: outputs.billing.SpendingLimitDetailsResponse[]; /** * The status of the billing profile. */ status: string; /** * Reason for the specified billing profile status. */ statusReasonCode: string; /** * The system generated unique identifier for a billing profile. */ systemId: string; /** * Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / */ tags?: { [key: string]: string; }; /** * Identifies the cloud environments that are associated with a billing profile. This is a system managed optional field and gets updated as the billing profile gets associated with accounts in various clouds. */ targetClouds: string[]; } /** * The default address where the products are shipped, or the services are being used. If a ship to is not specified for a product or a subscription, then this address will be used. */ interface BillingProfilePropertiesShipToResponse { /** * Address line 1. */ addressLine1: string; /** * Address line 2. */ addressLine2?: string; /** * Address line 3. */ addressLine3?: string; /** * Address city. */ city?: string; /** * Company name. Optional for MCA Individual (Pay-as-you-go). */ companyName?: string; /** * Country code uses ISO 3166-1 Alpha-2 format. */ country: string; /** * Address district. */ district?: string; /** * Email address. */ email?: string; /** * First name. Optional for MCA Enterprise. */ firstName?: string; /** * Indicates if the address is incomplete. */ isValidAddress?: boolean; /** * Last name. Optional for MCA Enterprise. */ lastName?: string; /** * Middle name. */ middleName?: string; /** * Phone number. */ phoneNumber?: string; /** * Postal code. */ postalCode?: string; /** * Address region. */ region?: string; } /** * The address of the individual or organization that is responsible for the billing account. */ interface BillingProfilePropertiesSoldToResponse { /** * Address line 1. */ addressLine1: string; /** * Address line 2. */ addressLine2?: string; /** * Address line 3. */ addressLine3?: string; /** * Address city. */ city?: string; /** * Company name. Optional for MCA Individual (Pay-as-you-go). */ companyName?: string; /** * Country code uses ISO 3166-1 Alpha-2 format. */ country: string; /** * Address district. */ district?: string; /** * Email address. */ email?: string; /** * First name. Optional for MCA Enterprise. */ firstName?: string; /** * Indicates if the address is incomplete. */ isValidAddress?: boolean; /** * Last name. Optional for MCA Enterprise. */ lastName?: string; /** * Middle name. */ middleName?: string; /** * Phone number. */ phoneNumber?: string; /** * Postal code. */ postalCode?: string; /** * Address region. */ region?: string; } /** * The properties of the billing role assignment. */ interface BillingRoleAssignmentPropertiesResponse { /** * The name of the billing account. */ billingAccountDisplayName: string; /** * The fully qualified ID that uniquely identifies a billing account. */ billingAccountId: string; /** * The name of the billing profile. */ billingProfileDisplayName: string; /** * The fully qualified ID that uniquely identifies a billing profile. */ billingProfileId: string; /** * The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. */ billingRequestId: string; /** * The object ID of the user who created the role assignment. */ createdByPrincipalId: string; /** * The principal PUID of the user who created the role assignment. */ createdByPrincipalPuid: string; /** * The tenant Id of the user who created the role assignment. */ createdByPrincipalTenantId: string; /** * The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. */ createdByUserEmailAddress: string; /** * The date the role assignment was created. */ createdOn: string; /** * The name of the customer. */ customerDisplayName: string; /** * The fully qualified ID that uniquely identifies a customer. */ customerId: string; /** * The name of the invoice section. */ invoiceSectionDisplayName: string; /** * The fully qualified ID that uniquely identifies an invoice section. */ invoiceSectionId: string; /** * The principal PUID of the user who modified the role assignment. */ modifiedByPrincipalId: string; /** * The principal PUID of the user who modified the role assignment. */ modifiedByPrincipalPuid: string; /** * The tenant Id of the user who modified the role assignment. */ modifiedByPrincipalTenantId: string; /** * The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. */ modifiedByUserEmailAddress: string; /** * The date the role assignment was modified. */ modifiedOn: string; /** * The display name of the principal to whom the role was assigned. */ principalDisplayName: string; /** * The object id of the user to whom the role was assigned. */ principalId?: string; /** * The principal PUID of the user to whom the role was assigned. */ principalPuid?: string; /** * The principal tenant id of the user to whom the role was assigned. */ principalTenantId?: string; /** * The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. */ principalTenantName: string; /** * The type of a role Assignment. */ principalType: string; /** * The provisioning state of the resource during a long-running operation. */ provisioningState: string; /** * The ID of the role definition. */ roleDefinitionId: string; /** * The scope at which the role was assigned. */ scope?: string; /** * The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. */ userAuthenticationType?: string; /** * The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. */ userEmailAddress?: string; } /** * An invoice section. */ interface InvoiceSectionPropertiesResponse { /** * The name of the invoice section. */ displayName?: string; /** * The provisioning state of the resource during a long-running operation. */ provisioningState: string; /** * Reason for the specified invoice section status. */ reasonCode?: string; /** * Identifies the status of an invoice section. */ state?: string; /** * The system generated unique identifier for an invoice section. */ systemId: string; /** * Dictionary of metadata associated with the resource. Maximum key/value length supported of 256 characters. Keys/value should not empty value nor null. Keys can not contain < > % & \ ? / */ tags?: { [key: string]: string; }; /** * Identifies the cloud environments that are associated with an invoice section. This is a system managed optional field and gets updated as the invoice section gets associated with accounts in various clouds. */ targetCloud?: string; } /** * Invoice section properties with create subscription permission. */ interface InvoiceSectionWithCreateSubPermissionResponse { /** * The name of the billing profile. */ billingProfileDisplayName: string; /** * The fully qualified ID that uniquely identifies a billing profile. */ billingProfileId: string; /** * The billing profile spending limit. */ billingProfileSpendingLimit: string; /** * The status of the billing profile. */ billingProfileStatus: string; /** * Reason for the specified billing profile status. */ billingProfileStatusReasonCode: string; /** * The system generated unique identifier for a billing profile. */ billingProfileSystemId: string; /** * Enabled azure plans for the associated billing profile. */ enabledAzurePlans: outputs.billing.AzurePlanResponse[]; /** * The name of the invoice section. */ invoiceSectionDisplayName: string; /** * The fully qualified ID that uniquely identifies an invoice section. */ invoiceSectionId: string; /** * The system generated unique identifier for an invoice section. */ invoiceSectionSystemId: string; } /** * The properties of payment term. */ interface PaymentTermResponse { /** * The date on when the defined 'Payment Term' will end and is always in UTC. */ endDate?: string; /** * Indicates payment term is the standard payment term. */ isDefault: boolean; /** * The date on when the defined 'Payment Term' will be effective from and is always in UTC. */ startDate?: string; /** * Represents duration in netXX format. Always in days. */ term?: string; } /** * The billing profile spending limit. */ interface SpendingLimitDetailsResponse { /** * The initial amount for the billing profile. */ amount?: number; /** * The currency in which the charges for the billing profile are billed. */ currency?: string; /** * The date when this spending limit is no longer in effect. */ endDate?: string; /** * The date when this spending limit goes into effect. */ startDate?: string; /** * The status of current spending limit. */ status?: string; /** * The type of spending limit. */ type?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace billingbenefits { /** * Optional field to record suppression reason for automatic shortfall. */ interface AutomaticShortfallSuppressReasonResponse { /** * Code for the suppression reason. */ code?: string; /** * Message for suppression reason. */ message?: string; } /** * Award details for milestone completion */ interface AwardResponse { /** * Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. */ balanceVersion: number; /** * Credit amount to be awarded */ credit?: outputs.billingbenefits.CommitmentResponse; /** * Duration for which the benefit is active. Will be in format P{int}M or P{int}Y. Any values representing up to 12 years are valid. Upper limit examples: P144M, P12Y. */ duration?: string; /** * End date when the credit expires */ endAt?: string; /** * Resource ID for the awarded credit. */ resourceId: string; /** * Start date when the credit becomes effective */ startAt?: string; /** * This is the globally unique identifier of the credit which will not change for its lifetime. */ systemId: string; } /** * Catalog claim for a discount. */ interface CatalogClaimsItemResponse { catalogClaimsItemType?: string; value?: string; } /** * Commitment towards the benefit. */ interface CommitmentResponse { amount?: number; /** * The ISO 4217 3-letter currency code for the currency used by this purchase record. */ currencyCode?: string; /** * The grain of the commitment. */ grain?: string; } /** * Milestone definition within a conditional credit */ interface ConditionalCreditMilestoneResponse { /** * Award details for this milestone (only present for primary conditional credits) */ award?: outputs.billingbenefits.AwardResponse; /** * End date for this milestone */ endAt?: string; /** * Unique identifier for the milestone */ milestoneId?: string; /** * Display name for the milestone */ name?: string; /** * Spend target for this milestone */ spendTarget?: outputs.billingbenefits.PriceResponse; /** * Current status of the milestone */ status?: string; } /** * Condition for a discount. */ interface ConditionsItemResponse { conditionName?: string; type?: string; /** * These items are open-ended strings. */ value?: string[]; } /** * Milestone definition for contributor conditional credit (excludes award details) */ interface ContributorConditionalCreditMilestoneResponse { /** * Award details for this milestone (only present for primary conditional credits) */ award?: outputs.billingbenefits.AwardResponse; /** * End date for this milestone */ endAt?: string; /** * Unique identifier for the milestone */ milestoneId?: string; /** * Display name for the milestone */ name?: string; /** * Spend target for this milestone */ spendTarget?: outputs.billingbenefits.PriceResponse; /** * Current status of the milestone */ status?: string; } /** * Properties for contributor conditional credit. */ interface ContributorConditionalCreditPropertiesResponse { /** * Fully-qualified identifier of the benefit under applicable benefit list. */ benefitResourceId: string; /** * The billing account resource ID */ billingAccountResourceId?: string; /** * Display name for the conditional credit */ displayName?: string; /** * End date of the conditional credit (derived from last milestone) */ endAt?: string; /** * Type of conditional credit entity * Expected value is 'Contributor'. */ entityType: "Contributor"; /** * List of milestones copied from primary conditional credit (excludes award details) */ milestones: outputs.billingbenefits.ContributorConditionalCreditMilestoneResponse[]; /** * Fully-qualified billing account resource identifier of the primary CACO. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}. */ primaryBillingAccountResourceId?: string; /** * Resource ID of the primary conditional credit (required for contributors) */ primaryResourceId?: string; /** * Product code for the conditional credit */ productCode?: string; /** * The provisioning state of the resource */ provisioningState: string; /** * Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. */ resourceId?: string; /** * Start date of the conditional credit */ startAt?: string; /** * The status of the conditional credit */ status?: string; /** * System identifier shared between primary and contributor conditional credits representing the same conditional credit program */ systemId?: string; } /** * Credit breakdown item representing a milestone, line-item, or no-charge service */ interface CreditBreakdownItemResponse { /** * Allocation details including currency and amount for this breakdown item */ allocation?: outputs.billingbenefits.CommitmentResponse; /** * Key-value pairs for additional parameters and metadata */ dimensions?: outputs.billingbenefits.CreditDimensionResponse[]; /** * End DateTime in UTC. */ endAt?: string; /** * Start DateTime. */ startAt?: string; } /** * Key-value pair for additional credit parameters and metadata */ interface CreditDimensionResponse { /** * The dimension key (e.g., productFamily, description, creditType) */ key: string; /** * The dimension value */ value: string; } /** * Credit breakdown item representing a milestone, line-item, or no-charge service */ interface CreditPoliciesResponse { /** * Expiration policy of the Credit */ expiration?: string; /** * Redemption policy of the Credit */ redemption?: string; } /** * The reason for the credit. Not required if not applicable. */ interface CreditReasonResponse { /** * The reason code for credit. */ code?: string; /** * The free string description of the credit. */ description?: string; } /** * Custom price properties for a given discount. */ interface CustomPricePropertiesResponse { /** * The billing period of the priceable node. Validation: Optional, Maximum length 128 characters. Only allowed if the availability derived by market, product, sku, and claims has terms and at least one of those terms has a billing period. When specified, termUnits must be specified. */ billingPeriod?: string; /** * The set of BigCat claims. Validation: Required. Must contain AgreementType, NationalCloud, and PricingAudience claims. Additionally requires AccessPass claim when creating custom price with action == consume on the pricing instructions. */ catalogClaims: outputs.billingbenefits.CatalogClaimsItemResponse[]; /** * The catalog instance where the priceable node lives. Validation: Required. No defined format, will vary per team. */ catalogId: string; /** * The set of market set prices of the priceable node. Validation: Required. Must contain at least one element. */ marketSetPrices: outputs.billingbenefits.MarketSetPricesItemsResponse[]; /** * Must be present if the market, product, sku, and claims, and optional term information resolves to multiple availabilities that only differ by meter type. Validation: Maximum length 128 characters. */ meterType?: string; /** * The type of the priceable node pricing rule. Validation: Required. Supported values are fixedPriceLock, fixedListPrice, and priceCeiling. */ ruleType: string; /** * The term units for the priceable node. Validation: Optional, Maximum length 128 characters. Must be present if and only if the availability derived by market, product, sku, and claims has terms. */ termUnits?: string; } /** * Discount type properties including product family name, product id, sku, and custom price properties. Allows multiple entries in marketSetPrices. */ interface DiscountCustomPriceMultiCurrencyResponse { /** * The customer action on which the discount is applied. Supported values are Purchase, Consume, and Renew. Validation: Required, one of supported values. */ applyDiscountOn: string; /** * Array of conditions for the discount. Validation: Optional. Maximum length is 1000. */ conditions?: outputs.billingbenefits.ConditionsItemResponse[]; /** * Custom price properties for a given discount. */ customPriceProperties?: outputs.billingbenefits.CustomPricePropertiesResponse; /** * The discount combination rule when there are multiple applicable custom prices. Validation: Required. Supported values are Stackable and BestOf. */ discountCombinationRule?: string; /** * Discount percentage provided for the customer. Validation: Required unless this is a price rule. */ discountPercentage?: number; /** * Defines the type of discount. Supported values are ProductFamily, Product, Sku, CustomPrice, and CustomPriceMultiCurrency. * Expected value is 'CustomPriceMultiCurrency'. */ discountType: "CustomPriceMultiCurrency"; /** * Set only in price guarantee scenario. */ priceGuaranteeProperties?: outputs.billingbenefits.PriceGuaranteePropertiesResponse; /** * Product family for which the discount is given. Validation: Optional */ productFamilyName?: string; /** * Product ID for which the discount is given. Validation: Optional. No specific format, example: DZH318Z09V6F */ productId?: string; /** * ResourceSku for the given discount. Validation: Optional. */ skuId?: string; } /** * Discount type properties including product family name, product id, sku, and custom price properties. Allows a single entry in marketSetPrices. */ interface DiscountCustomPriceResponse { /** * The customer action on which the discount is applied. Supported values are Purchase, Consume, and Renew. Validation: Required, one of supported values. */ applyDiscountOn: string; /** * Array of conditions for the discount. Validation: Optional. Maximum length is 1000. */ conditions?: outputs.billingbenefits.ConditionsItemResponse[]; /** * Custom price properties for a given discount. */ customPriceProperties?: outputs.billingbenefits.CustomPricePropertiesResponse; /** * The discount combination rule when there are multiple applicable custom prices. Validation: Required. Supported values are Stackable and BestOf. */ discountCombinationRule?: string; /** * Discount percentage provided for the customer. Validation: Required unless this is a price rule. */ discountPercentage?: number; /** * Defines the type of discount. Supported values are ProductFamily, Product, Sku, CustomPrice, and CustomPriceMultiCurrency. * Expected value is 'CustomPrice'. */ discountType: "CustomPrice"; /** * Set only in price guarantee scenario. */ priceGuaranteeProperties?: outputs.billingbenefits.PriceGuaranteePropertiesResponse; /** * Product family for which the discount is given. Validation: Optional */ productFamilyName?: string; /** * Product ID for which the discount is given. Validation: Optional. No specific format, example: DZH318Z09V6F */ productId?: string; /** * ResourceSku for the given discount. Validation: Optional. */ skuId?: string; } /** * Discount type properties including product family name */ interface DiscountProductFamilyResponse { /** * The customer action on which the discount is applied. Supported values are Purchase, Consume, and Renew. Validation: Required, one of supported values. */ applyDiscountOn: string; /** * Array of conditions for the discount. Validation: Optional. Maximum length is 1000. */ conditions?: outputs.billingbenefits.ConditionsItemResponse[]; /** * The discount combination rule when there are multiple applicable custom prices. Validation: Required. Supported values are Stackable and BestOf. */ discountCombinationRule?: string; /** * Discount percentage provided for the customer. Validation: Required unless this is a price rule. */ discountPercentage?: number; /** * Defines the type of discount. Supported values are ProductFamily, Product, Sku, CustomPrice, and CustomPriceMultiCurrency. * Expected value is 'ProductFamily'. */ discountType: "ProductFamily"; /** * Set only in price guarantee scenario. */ priceGuaranteeProperties?: outputs.billingbenefits.PriceGuaranteePropertiesResponse; /** * Product family for which the discount is given. Validation: Optional */ productFamilyName?: string; } /** * Discount type properties including product family name and product id. */ interface DiscountProductResponse { /** * The customer action on which the discount is applied. Supported values are Purchase, Consume, and Renew. Validation: Required, one of supported values. */ applyDiscountOn: string; /** * Array of conditions for the discount. Validation: Optional. Maximum length is 1000. */ conditions?: outputs.billingbenefits.ConditionsItemResponse[]; /** * The discount combination rule when there are multiple applicable custom prices. Validation: Required. Supported values are Stackable and BestOf. */ discountCombinationRule?: string; /** * Discount percentage provided for the customer. Validation: Required unless this is a price rule. */ discountPercentage?: number; /** * Defines the type of discount. Supported values are ProductFamily, Product, Sku, CustomPrice, and CustomPriceMultiCurrency. * Expected value is 'Product'. */ discountType: "Product"; /** * Set only in price guarantee scenario. */ priceGuaranteeProperties?: outputs.billingbenefits.PriceGuaranteePropertiesResponse; /** * Product family for which the discount is given. Validation: Optional */ productFamilyName?: string; /** * Product ID for which the discount is given. Validation: Optional. No specific format, example: DZH318Z09V6F */ productId?: string; } /** * Discount type properties including product family name, product id, and sku id. */ interface DiscountTypeProductSkuResponse { /** * The customer action on which the discount is applied. Supported values are Purchase, Consume, and Renew. Validation: Required, one of supported values. */ applyDiscountOn: string; /** * Array of conditions for the discount. Validation: Optional. Maximum length is 1000. */ conditions?: outputs.billingbenefits.ConditionsItemResponse[]; /** * The discount combination rule when there are multiple applicable custom prices. Validation: Required. Supported values are Stackable and BestOf. */ discountCombinationRule?: string; /** * Discount percentage provided for the customer. Validation: Required unless this is a price rule. */ discountPercentage?: number; /** * Defines the type of discount. Supported values are ProductFamily, Product, Sku, CustomPrice, and CustomPriceMultiCurrency. * Expected value is 'Sku'. */ discountType: "Sku"; /** * Set only in price guarantee scenario. */ priceGuaranteeProperties?: outputs.billingbenefits.PriceGuaranteePropertiesResponse; /** * Product family for which the discount is given. Validation: Optional */ productFamilyName?: string; /** * Product ID for which the discount is given. Validation: Optional. No specific format, example: DZH318Z09V6F */ productId?: string; /** * ResourceSku for the given discount. Validation: Optional. */ skuId?: string; } /** * Entity type for affiliate discounts */ interface EntityTypeAffiliateDiscountResponse { /** * List of applied scopes supported for discounts. */ appliedScopeType?: string; /** * Fully-qualified identifier of the benefit under applicable benefit list. */ benefitResourceId: string; /** * Billing account resource id where the discount metadata is present. */ billingAccountResourceId: string; /** * Billing profile resource id where the discount is scoped to. */ billingProfileResourceId: string; /** * Customer resource id where the discount is scoped to. */ customerResourceId: string; /** * This defines a user friendly display name for the discount. */ displayName?: string; /** * End date of the discount. No duration will be supported. Allowed value is any date greater than or equal to startDate. */ endAt: string; /** * This defines whether the entity being created is primary or affiliate. Supported values: primary, affiliate. Validation: Required, must match one of the 2 values. * Expected value is 'Affiliate'. */ entityType: "Affiliate"; /** * This will be present in the response if the primary has a resource ID */ primaryResourceId: string; /** * This is the catalog UPN for the product. */ productCode: string; /** * The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. */ provisioningState: string; /** * Start date of the discount. Value is the date the discount started or will start in the future. */ startAt: string; /** * Represents the current status of the discount. */ status: string; /** * This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. */ systemId?: string; } /** * Entity type for primary discounts */ interface EntityTypePrimaryDiscountResponse { /** * List of applied scopes supported for discounts. */ appliedScopeType?: string; /** * Fully-qualified identifier of the benefit under applicable benefit list. */ benefitResourceId: string; /** * Billing account resource id where the discount metadata is present. */ billingAccountResourceId: string; /** * Billing profile resource id where the discount is scoped to. */ billingProfileResourceId: string; /** * Customer resource id where the discount is scoped to. */ customerResourceId: string; /** * This defines the conditions for a given discount type. */ discountTypeProperties?: outputs.billingbenefits.DiscountCustomPriceResponse | outputs.billingbenefits.DiscountCustomPriceMultiCurrencyResponse | outputs.billingbenefits.DiscountProductResponse | outputs.billingbenefits.DiscountProductFamilyResponse | outputs.billingbenefits.DiscountTypeProductSkuResponse; /** * This defines a user friendly display name for the discount. */ displayName?: string; /** * End date of the discount. No duration will be supported. Allowed value is any date greater than or equal to startDate. */ endAt: string; /** * This defines whether the entity being created is primary or affiliate. Supported values: primary, affiliate. Validation: Required, must match one of the 2 values. * Expected value is 'Primary'. */ entityType: "Primary"; /** * This is the catalog UPN for the product. */ productCode: string; /** * The state of the resource. Supported values are Pending, Failed, Succeeded, Canceled. */ provisioningState: string; /** * Start date of the discount. Value is the date the discount started or will start in the future. */ startAt: string; /** * Represents the current status of the discount. */ status: string; /** * This is the globally unique identifier of the Discount which will not change for the lifetime of the Discount. */ systemId?: string; } /** * MACC milestone represents interim targets within the period of MACC. */ interface MaccMilestoneResponse { /** * Setting this to 'Enable' enables automatic shortfall invoicing when milestone commitment is not met. */ automaticShortfall?: string; /** * Optional field to record suppression reason for automatic shortfall. */ automaticShortfallSuppressReason?: outputs.billingbenefits.AutomaticShortfallSuppressReasonResponse; /** * Commitment associated with this milestone. */ commitment?: outputs.billingbenefits.PriceResponse; /** * End date time for the milestone. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z. */ endAt?: string; /** * Globally unique identifier for the milestone. Format: {guid} */ milestoneId?: string; /** * Details of the shortfall associated with this milestone. */ shortfall?: outputs.billingbenefits.ShortfallResponse; /** * Represents the current status of the Milestone. */ status?: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.billingbenefits.UserAssignedIdentityResponse; }; } /** * Items in the MarketSetPrices array. */ interface MarketSetPricesItemsResponse { /** * The currency of the locked price value. Validation: Required. Must be a valid ISO 4217 3-letter currency code. */ currency: string; markets: string[]; /** * The locked price for the priceable node. Validation: Required. Must be greater than or equal to 0. If the case of billing plans. This represents the price for each cycle charge. */ value: number; } /** * Plan for the resource. */ interface PlanResponse { /** * A user defined name of the 3rd Party Artifact that is being procured. */ name: string; /** * The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. */ product: string; /** * A publisher provided promotion code as provisioned in Data Market for the said product/artifact. */ promotionCode?: string; /** * The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic */ publisher: string; /** * The version of the desired product/artifact. */ version?: string; } /** * Set only in price guarantee scenario. */ interface PriceGuaranteePropertiesResponse { /** * The date on which prices are to be used for guarantee calculation. Validation: expected to be 00 hours, Format: 2024-09-30T00:00:00Z. Must be in UTC. */ priceGuaranteeDate?: string; /** * Supported values: Protected, Locked */ pricingPolicy?: string; } interface PriceResponse { amount?: number; /** * The ISO 4217 3-letter currency code for the currency used by this purchase record. */ currencyCode?: string; } /** * Properties for primary conditional credit. */ interface PrimaryConditionalCreditPropertiesResponse { /** * Whether this conditional credit allows contributor billing accounts */ allowContributors?: string; /** * Fully-qualified identifier of the benefit under applicable benefit list. */ benefitResourceId: string; /** * The billing account resource ID */ billingAccountResourceId?: string; /** * Display name for the conditional credit */ displayName?: string; /** * End date of the conditional credit (derived from last milestone) */ endAt?: string; /** * Type of conditional credit entity * Expected value is 'Primary'. */ entityType: "Primary"; /** * List of milestones for this conditional credit (must include awards) */ milestones?: outputs.billingbenefits.ConditionalCreditMilestoneResponse[]; /** * Product code for the conditional credit */ productCode?: string; /** * The provisioning state of the resource */ provisioningState: string; /** * Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}. */ resourceId?: string; /** * Start date of the conditional credit */ startAt?: string; /** * The status of the conditional credit */ status?: string; /** * System identifier shared between primary and contributor conditional credits representing the same conditional credit program */ systemId?: string; } /** * MACC shortfall */ interface ShortfallResponse { /** * Points to BalanceVersion document that indicates the remaining commitment balance when the credit was created. */ balanceVersion?: number; /** * Shortfall amount with grain. */ charge?: outputs.billingbenefits.CommitmentResponse; /** * End DateTime in UTC. */ endAt?: string; /** * Represents catalog UPN. */ productCode?: string; /** * Fully-qualified resource identifier of the credits associated with the shortfall. */ resourceId?: string; /** * Start DateTime. */ startAt?: string; /** * This is an identifier of the shortfall which will not change for its lifetime. */ systemId?: string; } /** * The resource model definition representing SKU */ interface SkuResponse { /** * If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. */ capacity?: number; /** * If the service has different generations of hardware, for the same SKU, then that can be captured here. */ family?: string; /** * The name of the SKU. E.g. P3. It is typically a letter+number code */ name: string; /** * The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. */ size?: string; /** * This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. */ tier?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace billingtrust { /** * The properties of an Assessment resource */ interface AssessmentPropertiesResponse { /** * The name of the assessment template whose rules will be evaluated (e.g. 'Edu'). Immutable after creation. */ assessmentType: string; /** * Error information when evaluationState is failed */ error: outputs.billingtrust.ErrorDetailResponse; /** * The aggregated evaluation state of all active rules within this assessment */ evaluationState: string; /** * The next scheduled re-evaluation of this assessment. Only present when one or more rules in this assessment have a configured recurrence. */ nextEvaluation: string; /** * The provisioning state of the resource */ provisioningState: string; } /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.billingtrust.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.billingtrust.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace blueprint { /** * Defines how resources deployed by a blueprint assignment are locked. */ interface AssignmentLockSettingsResponse { /** * List of management operations that are excluded from blueprint locks. Up to 200 actions are permitted. If the lock mode is set to 'AllResourcesReadOnly', then the following actions are automatically appended to 'excludedActions': '*/read', 'Microsoft.Network/virtualNetworks/subnets/join/action' and 'Microsoft.Authorization/locks/delete'. If the lock mode is set to 'AllResourcesDoNotDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will get removed. */ excludedActions?: string[]; /** * List of AAD principals excluded from blueprint locks. Up to 5 principals are permitted. */ excludedPrincipals?: string[]; /** * Lock mode. */ mode?: string; } /** * The status of a blueprint assignment. This field is readonly. */ interface AssignmentStatusResponse { /** * Last modified time of this blueprint definition. */ lastModified: string; /** * List of resources that were created by the blueprint assignment. */ managedResources: string[]; /** * Creation time of this blueprint definition. */ timeCreated: string; } /** * The status of the blueprint. This field is readonly. */ interface BlueprintStatusResponse { /** * Last modified time of this blueprint definition. */ lastModified: string; /** * Creation time of this blueprint definition. */ timeCreated: string; } /** * Specifies the link to a Key Vault. */ interface KeyVaultReferenceResponse { /** * Azure resource ID of the Key Vault. */ id: string; } /** * Managed identity generic object. */ interface ManagedServiceIdentityResponse { /** * Azure Active Directory principal ID associated with this Identity. */ principalId?: string; /** * ID of the Azure Active Directory. */ tenantId?: string; /** * Type of the managed identity. */ type: string; /** * The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. */ userAssignedIdentities?: { [key: string]: outputs.blueprint.UserAssignedIdentityResponse; }; } /** * Represent a parameter with constrains and metadata. */ interface ParameterDefinitionResponse { /** * Array of allowed values for this parameter. */ allowedValues?: any[]; /** * Default Value for this parameter. */ defaultValue?: any; /** * Description of this parameter/resourceGroup. */ description?: string; /** * DisplayName of this parameter/resourceGroup. */ displayName?: string; /** * StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location. */ strongType?: string; /** * Allowed data types for Resource Manager template parameters. */ type: string; } /** * Value for the specified parameter. Can be either 'value' or 'reference' but not both. */ interface ParameterValueResponse { /** * Parameter value as reference type. */ reference?: outputs.blueprint.SecretValueReferenceResponse; /** * Parameter value. Any valid JSON value is allowed including objects, arrays, strings, numbers and booleans. */ value?: any; } /** * Represents an Azure resource group in a blueprint definition. */ interface ResourceGroupDefinitionResponse { /** * Artifacts which need to be deployed before this resource group. */ dependsOn?: string[]; /** * Description of this parameter/resourceGroup. */ description?: string; /** * DisplayName of this parameter/resourceGroup. */ displayName?: string; /** * Location of this resourceGroup. Leave empty if the resource group location will be specified during the blueprint assignment. */ location?: string; /** * Name of this resourceGroup. Leave empty if the resource group name will be specified during the blueprint assignment. */ name?: string; /** * StrongType for UI to render rich experience during blueprint assignment. Supported strong types are resourceType, principalId and location. */ strongType?: string; /** * Tags to be assigned to this resource group. */ tags?: { [key: string]: string; }; } /** * Represents an Azure resource group. */ interface ResourceGroupValueResponse { /** * Location of the resource group. */ location?: string; /** * Name of the resource group. */ name?: string; } /** * Reference to a Key Vault secret. */ interface SecretValueReferenceResponse { /** * Specifies the reference to a given Azure Key Vault. */ keyVault: outputs.blueprint.KeyVaultReferenceResponse; /** * Name of the secret. */ secretName: string; /** * The version of the secret to use. If left blank, the latest version of the secret is used. */ secretVersion?: string; } /** * User-assigned managed identity. */ interface UserAssignedIdentityResponse { /** * Client App Id associated with this identity. */ clientId?: string; /** * Azure Active Directory principal ID associated with this Identity. */ principalId?: string; } } export declare namespace botservice { /** * AcsChat channel definition */ interface AcsChatChannelResponse { /** * The channel name * Expected value is 'AcsChatChannel'. */ channelName: "AcsChatChannel"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * Provisioning state of the resource */ provisioningState: string; } /** * acsChatChannelResponseProvideDefaults sets the appropriate defaults for AcsChatChannelResponse */ function acsChatChannelResponseProvideDefaults(val: AcsChatChannelResponse): AcsChatChannelResponse; /** * The parameters to provide for the Alexa channel. */ interface AlexaChannelPropertiesResponse { /** * The Alexa skill Id */ alexaSkillId: string; /** * Whether this channel is enabled for the bot */ isEnabled: boolean; /** * Full Uri used to configured the skill in Alexa */ serviceEndpointUri: string; /** * Url fragment used in part of the Uri configured in Alexa */ urlFragment: string; } /** * Alexa channel definition */ interface AlexaChannelResponse { /** * The channel name * Expected value is 'AlexaChannel'. */ channelName: "AlexaChannel"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * The set of properties specific to Alexa channel resource */ properties?: outputs.botservice.AlexaChannelPropertiesResponse; /** * Provisioning state of the resource */ provisioningState: string; } /** * alexaChannelResponseProvideDefaults sets the appropriate defaults for AlexaChannelResponse */ function alexaChannelResponseProvideDefaults(val: AlexaChannelResponse): AlexaChannelResponse; /** * The parameters to provide for the Bot. */ interface BotPropertiesResponse { /** * Contains resource all settings defined as key/value pairs. */ allSettings?: { [key: string]: string; }; /** * The hint (e.g. keyVault secret resourceId) on how to fetch the app secret */ appPasswordHint?: string; /** * The CMK encryption status */ cmekEncryptionStatus: string; /** * The CMK Url */ cmekKeyVaultUrl?: string; /** * Collection of channels for which the bot is configured */ configuredChannels: string[]; /** * The description of the bot */ description?: string; /** * The Application Insights key */ developerAppInsightKey?: string; /** * The Application Insights Api Key */ developerAppInsightsApiKey?: string; /** * The Application Insights App Id */ developerAppInsightsApplicationId?: string; /** * Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. */ disableLocalAuth?: boolean; /** * The Name of the bot */ displayName: string; /** * Collection of channels for which the bot is enabled */ enabledChannels: string[]; /** * The bot's endpoint */ endpoint: string; /** * The bot's endpoint version */ endpointVersion: string; /** * The Icon Url of the bot */ iconUrl?: string; /** * Whether Cmek is enabled */ isCmekEnabled?: boolean; /** * Whether the bot is developerAppInsightsApiKey set */ isDeveloperAppInsightsApiKeySet: boolean; /** * Whether the bot is streaming supported */ isStreamingSupported?: boolean; /** * Collection of LUIS App Ids */ luisAppIds?: string[]; /** * The LUIS Key */ luisKey?: string; /** * The bot's manifest url */ manifestUrl?: string; /** * Token used to migrate non Azure bot to azure subscription */ migrationToken: string; /** * Microsoft App Id for the bot */ msaAppId: string; /** * Microsoft App Managed Identity Resource Id for the bot */ msaAppMSIResourceId?: string; /** * Microsoft App Tenant Id for the bot */ msaAppTenantId?: string; /** * Microsoft App Type for the bot */ msaAppType?: string; /** * List of Network Security Perimeter configurations for the bot */ networkSecurityPerimeterConfigurations: outputs.botservice.NetworkSecurityPerimeterConfigurationResponse[]; /** * The hint to browser (e.g. protocol handler) on how to open the bot for authoring */ openWithHint?: string; /** * Contains resource parameters defined as key/value pairs. */ parameters?: { [key: string]: string; }; /** * List of Private Endpoint Connections configured for the bot */ privateEndpointConnections: outputs.botservice.PrivateEndpointConnectionResponse[]; /** * Provisioning state of the resource */ provisioningState: string; /** * Whether the bot is in an isolated network */ publicNetworkAccess?: string; /** * Publishing credentials of the resource */ publishingCredentials?: string; /** * The channel schema transformation version for the bot */ schemaTransformationVersion?: string; /** * The storage resourceId for the bot */ storageResourceId?: string; /** * The Tenant Id for the bot */ tenantId?: string; } /** * botPropertiesResponseProvideDefaults sets the appropriate defaults for BotPropertiesResponse */ function botPropertiesResponseProvideDefaults(val: BotPropertiesResponse): BotPropertiesResponse; /** * Channel settings definition */ interface ChannelSettingsResponse { /** * The bot icon url */ botIconUrl?: string; /** * The bot id */ botId?: string; /** * The channel display name */ channelDisplayName?: string; /** * The channel id */ channelId?: string; /** * Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. */ disableLocalAuth?: boolean; /** * The extensionKey1 */ extensionKey1?: string; /** * The extensionKey2 */ extensionKey2?: string; /** * Whether this channel is enabled for the bot */ isEnabled?: boolean; /** * Whether customer needs to agree to new terms. */ requireTermsAgreement?: boolean; /** * The list of sites */ sites?: outputs.botservice.SiteResponse[]; } /** * channelSettingsResponseProvideDefaults sets the appropriate defaults for ChannelSettingsResponse */ function channelSettingsResponseProvideDefaults(val: ChannelSettingsResponse): ChannelSettingsResponse; /** * Extra Parameter in a Connection Setting Properties to indicate service provider specific properties */ interface ConnectionSettingParameterResponse { /** * Key for the Connection Setting Parameter. */ key?: string; /** * Value associated with the Connection Setting Parameter. */ value?: string; } /** * Properties for a Connection Setting Item */ interface ConnectionSettingPropertiesResponse { /** * Client Id associated with the Connection Setting. */ clientId?: string; /** * Client Secret associated with the Connection Setting */ clientSecret?: string; /** * Id of the Connection Setting. */ id?: string; /** * Name of the Connection Setting. */ name?: string; /** * Service Provider Parameters associated with the Connection Setting */ parameters?: outputs.botservice.ConnectionSettingParameterResponse[]; /** * Provisioning state of the resource */ provisioningState?: string; /** * Scopes associated with the Connection Setting */ scopes?: string; /** * Service Provider Display Name associated with the Connection Setting */ serviceProviderDisplayName?: string; /** * Service Provider Id associated with the Connection Setting */ serviceProviderId?: string; /** * Setting Id set by the service for the Connection Setting. */ settingId: string; } /** * connectionSettingPropertiesResponseProvideDefaults sets the appropriate defaults for ConnectionSettingPropertiesResponse */ function connectionSettingPropertiesResponseProvideDefaults(val: ConnectionSettingPropertiesResponse): ConnectionSettingPropertiesResponse; /** * The parameters to provide for the Direct Line channel. */ interface DirectLineChannelPropertiesResponse { /** * Direct Line embed code of the resource */ directLineEmbedCode?: string; /** * The extensionKey1 */ extensionKey1?: string; /** * The extensionKey2 */ extensionKey2?: string; /** * The list of Direct Line sites */ sites?: outputs.botservice.DirectLineSiteResponse[]; } /** * directLineChannelPropertiesResponseProvideDefaults sets the appropriate defaults for DirectLineChannelPropertiesResponse */ function directLineChannelPropertiesResponseProvideDefaults(val: DirectLineChannelPropertiesResponse): DirectLineChannelPropertiesResponse; /** * Direct Line channel definition */ interface DirectLineChannelResponse { /** * The channel name * Expected value is 'DirectLineChannel'. */ channelName: "DirectLineChannel"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * The set of properties specific to Direct Line channel resource */ properties?: outputs.botservice.DirectLineChannelPropertiesResponse; /** * Provisioning state of the resource */ provisioningState: string; } /** * directLineChannelResponseProvideDefaults sets the appropriate defaults for DirectLineChannelResponse */ function directLineChannelResponseProvideDefaults(val: DirectLineChannelResponse): DirectLineChannelResponse; /** * A site for the Direct Line channel */ interface DirectLineSiteResponse { /** * DirectLine application id */ appId?: string; /** * Entity Tag */ eTag?: string; /** * Whether this site is enabled for block user upload. */ isBlockUserUploadEnabled?: boolean; /** * Whether this site is disabled detailed logging for */ isDetailedLoggingEnabled?: boolean; /** * Whether this site is enabled for DirectLine channel */ isEnabled: boolean; /** * Whether this site is EndpointParameters enabled for channel */ isEndpointParametersEnabled?: boolean; /** * Whether this no-storage site is disabled detailed logging for */ isNoStorageEnabled?: boolean; /** * Whether this site is enabled for authentication with Bot Framework. */ isSecureSiteEnabled?: boolean; /** * Whether this site is token enabled for channel */ isTokenEnabled: boolean; /** * Whether this site is enabled for Bot Framework V1 protocol. */ isV1Enabled?: boolean; /** * Whether this site is enabled for Bot Framework V3 protocol. */ isV3Enabled?: boolean; /** * Whether this site is enabled for Webchat Speech */ isWebChatSpeechEnabled?: boolean; /** * Whether this site is enabled for preview versions of Webchat */ isWebchatPreviewEnabled?: boolean; /** * Primary key. Value only returned through POST to the action Channel List API, otherwise empty. */ key: string; /** * Secondary key. Value only returned through POST to the action Channel List API, otherwise empty. */ key2: string; /** * Site Id */ siteId: string; /** * Site name */ siteName: string; /** * Tenant Id */ tenantId?: string; /** * List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True. */ trustedOrigins?: string[]; } /** * directLineSiteResponseProvideDefaults sets the appropriate defaults for DirectLineSiteResponse */ function directLineSiteResponseProvideDefaults(val: DirectLineSiteResponse): DirectLineSiteResponse; /** * The parameters to provide for the DirectLine Speech channel. */ interface DirectLineSpeechChannelPropertiesResponse { /** * The cognitive service region with this channel registration. */ cognitiveServiceRegion?: string; /** * The cognitive service id with this channel registration. */ cognitiveServiceResourceId?: string; /** * The cognitive service subscription key to use with this channel registration. */ cognitiveServiceSubscriptionKey?: string; /** * Custom voice deployment id (optional). */ customSpeechModelId?: string; /** * Custom speech model id (optional). */ customVoiceDeploymentId?: string; /** * Make this a default bot for chosen cognitive service account. */ isDefaultBotForCogSvcAccount?: boolean; /** * Whether this channel is enabled or not. */ isEnabled?: boolean; } /** * DirectLine Speech channel definition */ interface DirectLineSpeechChannelResponse { /** * The channel name * Expected value is 'DirectLineSpeechChannel'. */ channelName: "DirectLineSpeechChannel"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * The set of properties specific to DirectLine Speech channel resource */ properties?: outputs.botservice.DirectLineSpeechChannelPropertiesResponse; /** * Provisioning state of the resource */ provisioningState: string; } /** * directLineSpeechChannelResponseProvideDefaults sets the appropriate defaults for DirectLineSpeechChannelResponse */ function directLineSpeechChannelResponseProvideDefaults(val: DirectLineSpeechChannelResponse): DirectLineSpeechChannelResponse; /** * The parameters to provide for the Email channel. */ interface EmailChannelPropertiesResponse { /** * Email channel auth method. 0 Password (Default); 1 Graph. */ authMethod?: number; /** * The email address */ emailAddress: string; /** * Whether this channel is enabled for the bot */ isEnabled: boolean; /** * The magic code for setting up the modern authentication. */ magicCode?: string; /** * The password for the email address. Value only returned through POST to the action Channel List API, otherwise empty. */ password?: string; } /** * Email channel definition */ interface EmailChannelResponse { /** * The channel name * Expected value is 'EmailChannel'. */ channelName: "EmailChannel"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * The set of properties specific to email channel resource */ properties?: outputs.botservice.EmailChannelPropertiesResponse; /** * Provisioning state of the resource */ provisioningState: string; } /** * emailChannelResponseProvideDefaults sets the appropriate defaults for EmailChannelResponse */ function emailChannelResponseProvideDefaults(val: EmailChannelResponse): EmailChannelResponse; /** * The parameters to provide for the Facebook channel. */ interface FacebookChannelPropertiesResponse { /** * Facebook application id */ appId: string; /** * Facebook application secret. Value only returned through POST to the action Channel List API, otherwise empty. */ appSecret?: string; /** * Callback Url */ callbackUrl: string; /** * Whether this channel is enabled for the bot */ isEnabled: boolean; /** * The list of Facebook pages */ pages?: outputs.botservice.FacebookPageResponse[]; /** * Verify token. Value only returned through POST to the action Channel List API, otherwise empty. */ verifyToken: string; } /** * Facebook channel definition */ interface FacebookChannelResponse { /** * The channel name * Expected value is 'FacebookChannel'. */ channelName: "FacebookChannel"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * The set of properties specific to bot facebook channel */ properties?: outputs.botservice.FacebookChannelPropertiesResponse; /** * Provisioning state of the resource */ provisioningState: string; } /** * facebookChannelResponseProvideDefaults sets the appropriate defaults for FacebookChannelResponse */ function facebookChannelResponseProvideDefaults(val: FacebookChannelResponse): FacebookChannelResponse; /** * A Facebook page for Facebook channel registration */ interface FacebookPageResponse { /** * Facebook application access token. Value only returned through POST to the action Channel List API, otherwise empty. */ accessToken?: string; /** * Page id */ id: string; } /** * The parameters to provide for the Kik channel. */ interface KikChannelPropertiesResponse { /** * Kik API key. Value only returned through POST to the action Channel List API, otherwise empty. */ apiKey?: string; /** * Whether this channel is enabled for the bot */ isEnabled: boolean; /** * Whether this channel is validated for the bot */ isValidated?: boolean; /** * The Kik user name */ userName: string; } /** * Kik channel definition */ interface KikChannelResponse { /** * The channel name * Expected value is 'KikChannel'. */ channelName: "KikChannel"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * The set of properties specific to Kik channel resource */ properties?: outputs.botservice.KikChannelPropertiesResponse; /** * Provisioning state of the resource */ provisioningState: string; } /** * kikChannelResponseProvideDefaults sets the appropriate defaults for KikChannelResponse */ function kikChannelResponseProvideDefaults(val: KikChannelResponse): KikChannelResponse; /** * The parameters to provide for the Line channel. */ interface LineChannelPropertiesResponse { /** * Callback Url to enter in line registration. */ callbackUrl: string; /** * Whether this channel is validated for the bot */ isValidated: boolean; /** * The list of line channel registrations */ lineRegistrations: outputs.botservice.LineRegistrationResponse[]; } /** * Line channel definition */ interface LineChannelResponse { /** * The channel name * Expected value is 'LineChannel'. */ channelName: "LineChannel"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * The set of properties specific to line channel resource */ properties?: outputs.botservice.LineChannelPropertiesResponse; /** * Provisioning state of the resource */ provisioningState: string; } /** * lineChannelResponseProvideDefaults sets the appropriate defaults for LineChannelResponse */ function lineChannelResponseProvideDefaults(val: LineChannelResponse): LineChannelResponse; /** * The properties corresponding to a line channel registration */ interface LineRegistrationResponse { /** * Access token for the line channel registration */ channelAccessToken?: string; /** * Secret for the line channel registration */ channelSecret?: string; /** * Id generated for the line channel registration */ generatedId: string; } /** * M365 Extensions definition */ interface M365ExtensionsResponse { /** * The channel name * Expected value is 'M365Extensions'. */ channelName: "M365Extensions"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * Provisioning state of the resource */ provisioningState: string; } /** * m365extensionsResponseProvideDefaults sets the appropriate defaults for M365ExtensionsResponse */ function m365extensionsResponseProvideDefaults(val: M365ExtensionsResponse): M365ExtensionsResponse; /** * The parameters to provide for the Microsoft Teams channel. */ interface MsTeamsChannelPropertiesResponse { /** * Whether this channel accepted terms */ acceptedTerms?: boolean; /** * Webhook for Microsoft Teams channel calls */ callingWebhook?: string; /** * Deployment environment for Microsoft Teams channel calls */ deploymentEnvironment?: string; /** * Enable calling for Microsoft Teams channel */ enableCalling?: boolean; /** * Webhook for Microsoft Teams channel calls */ incomingCallRoute?: string; /** * Whether this channel is enabled for the bot */ isEnabled: boolean; } /** * msTeamsChannelPropertiesResponseProvideDefaults sets the appropriate defaults for MsTeamsChannelPropertiesResponse */ function msTeamsChannelPropertiesResponseProvideDefaults(val: MsTeamsChannelPropertiesResponse): MsTeamsChannelPropertiesResponse; /** * Microsoft Teams channel definition */ interface MsTeamsChannelResponse { /** * The channel name * Expected value is 'MsTeamsChannel'. */ channelName: "MsTeamsChannel"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * The set of properties specific to Microsoft Teams channel resource */ properties?: outputs.botservice.MsTeamsChannelPropertiesResponse; /** * Provisioning state of the resource */ provisioningState: string; } /** * msTeamsChannelResponseProvideDefaults sets the appropriate defaults for MsTeamsChannelResponse */ function msTeamsChannelResponseProvideDefaults(val: MsTeamsChannelResponse): MsTeamsChannelResponse; /** * Properties of Network Security Perimeter configuration */ interface NetworkSecurityPerimeterConfigurationPropertiesResponse { /** * Information about Network Security Perimeter */ networkSecurityPerimeter: outputs.botservice.NetworkSecurityPerimeterResponse; /** * Information about profile */ profile: outputs.botservice.ProfileResponse; /** * List of Provisioning Issues if any */ provisioningIssues?: outputs.botservice.ProvisioningIssueResponse[]; provisioningState?: string; /** * Information about resource association */ resourceAssociation: outputs.botservice.ResourceAssociationResponse; } /** * networkSecurityPerimeterConfigurationPropertiesResponseProvideDefaults sets the appropriate defaults for NetworkSecurityPerimeterConfigurationPropertiesResponse */ function networkSecurityPerimeterConfigurationPropertiesResponseProvideDefaults(val: NetworkSecurityPerimeterConfigurationPropertiesResponse): NetworkSecurityPerimeterConfigurationPropertiesResponse; /** * Network Security Perimeter configuration */ interface NetworkSecurityPerimeterConfigurationResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * Properties of the Network Security Perimeter configuration */ properties?: outputs.botservice.NetworkSecurityPerimeterConfigurationPropertiesResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.botservice.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * networkSecurityPerimeterConfigurationResponseProvideDefaults sets the appropriate defaults for NetworkSecurityPerimeterConfigurationResponse */ function networkSecurityPerimeterConfigurationResponseProvideDefaults(val: NetworkSecurityPerimeterConfigurationResponse): NetworkSecurityPerimeterConfigurationResponse; /** * Information about Network Security Perimeter */ interface NetworkSecurityPerimeterResponse { /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * Location of the Network Security Perimeter */ location?: string; /** * Guid of the Network Security Perimeter */ perimeterGuid?: string; } /** * Properties of Access Rule */ interface NspAccessRulePropertiesResponse { /** * Address prefixes in the CIDR format for inbound rules */ addressPrefixes?: string[]; /** * Direction of Access Rule */ direction?: string; /** * Email addresses for outbound rules */ emailAddresses: string[]; /** * FQDN for outbound rules */ fullyQualifiedDomainNames: string[]; /** * NetworkSecurityPerimeters for inbound rules */ networkSecurityPerimeters: outputs.botservice.NetworkSecurityPerimeterResponse[]; /** * Phone numbers for outbound rules */ phoneNumbers: string[]; /** * Subscriptions for inbound rules */ subscriptions?: outputs.botservice.NspAccessRulePropertiesSubscriptionsItemResponse[]; } /** * Subscription for inbound rule */ interface NspAccessRulePropertiesSubscriptionsItemResponse { /** * Fully qualified identifier of subscription */ id?: string; } /** * Information of Access Rule in a profile */ interface NspAccessRuleResponse { /** * Name of the access rule */ name?: string; /** * Properties of Access Rule */ properties: outputs.botservice.NspAccessRulePropertiesResponse; } /** * Omnichannel channel definition */ interface OmnichannelResponse { /** * The channel name * Expected value is 'Omnichannel'. */ channelName: "Omnichannel"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * Provisioning state of the resource */ provisioningState: string; } /** * omnichannelResponseProvideDefaults sets the appropriate defaults for OmnichannelResponse */ function omnichannelResponseProvideDefaults(val: OmnichannelResponse): OmnichannelResponse; /** * Outlook channel definition */ interface OutlookChannelResponse { /** * The channel name * Expected value is 'OutlookChannel'. */ channelName: "OutlookChannel"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * Provisioning state of the resource */ provisioningState: string; } /** * outlookChannelResponseProvideDefaults sets the appropriate defaults for OutlookChannelResponse */ function outlookChannelResponseProvideDefaults(val: OutlookChannelResponse): OutlookChannelResponse; /** * The Private Endpoint Connection resource. */ interface PrivateEndpointConnectionResponse { /** * Group ids */ groupIds?: string[]; /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * The resource of private end point. */ privateEndpoint?: outputs.botservice.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.botservice.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.botservice.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The Private Endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Information about profile */ interface ProfileResponse { /** * List of Access Rules */ accessRules?: outputs.botservice.NspAccessRuleResponse[]; /** * Current access rules version */ accessRulesVersion?: number; /** * Current diagnostic settings version */ diagnosticSettingsVersion?: number; /** * List of log categories */ enabledLogCategories: string[]; /** * Name of the profile */ name?: string; } /** * Properties of Provisioning Issue */ interface ProvisioningIssuePropertiesResponse { /** * Description of the issue */ description?: string; /** * Type of Issue */ issueType?: string; /** * Provisioning state of Network Security Perimeter configuration propagation */ severity?: string; /** * Access rules that can be added to the same profile to remediate the issue. */ suggestedAccessRules?: outputs.botservice.NspAccessRuleResponse[]; /** * ARM IDs of resources that can be associated to the same perimeter to remediate the issue. */ suggestedResourceIds: string[]; } /** * Describes Provisioning issue for given Network Security Perimeter configuration */ interface ProvisioningIssueResponse { /** * Name of the issue */ name?: string; /** * Properties of Provisioning Issue */ properties: outputs.botservice.ProvisioningIssuePropertiesResponse; } /** * Information about resource association */ interface ResourceAssociationResponse { /** * Access Mode of the resource association */ accessMode?: string; /** * Name of the resource association */ name?: string; } /** * SearchAssistant definition */ interface SearchAssistantResponse { /** * The channel name * Expected value is 'SearchAssistant'. */ channelName: "SearchAssistant"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * Provisioning state of the resource */ provisioningState: string; } /** * searchAssistantResponseProvideDefaults sets the appropriate defaults for SearchAssistantResponse */ function searchAssistantResponseProvideDefaults(val: SearchAssistantResponse): SearchAssistantResponse; /** * the constraints of the bot meta data. */ interface ServiceProviderParameterMetadataConstraintsResponse { /** * Whether required the constraints of the bot meta data. */ required?: boolean; } /** * Meta data for the Service Provider */ interface ServiceProviderParameterMetadataResponse { /** * the constraints of the bot meta data. */ constraints?: outputs.botservice.ServiceProviderParameterMetadataConstraintsResponse; } /** * Extra Parameters specific to each Service Provider */ interface ServiceProviderParameterResponse { /** * Default Name for the Service Provider */ default: string; /** * Description of the Service Provider */ description: string; /** * Display Name of the Service Provider */ displayName: string; /** * Help Url for the Service Provider */ helpUrl: string; /** * Meta data for the Service Provider */ metadata: outputs.botservice.ServiceProviderParameterMetadataResponse; /** * Name of the Service Provider */ name: string; /** * Type of the Service Provider */ type: string; } /** * The Object used to describe a Service Provider supported by Bot Service */ interface ServiceProviderPropertiesResponse { /** * URL of Dev Portal */ devPortalUrl: string; /** * Display Name of the Service Provider */ displayName: string; /** * The URL of icon */ iconUrl?: string; /** * Id for Service Provider */ id: string; /** * The list of parameters for the Service Provider */ parameters?: outputs.botservice.ServiceProviderParameterResponse[]; /** * Name of the Service Provider */ serviceProviderName: string; } /** * serviceProviderPropertiesResponseProvideDefaults sets the appropriate defaults for ServiceProviderPropertiesResponse */ function serviceProviderPropertiesResponseProvideDefaults(val: ServiceProviderPropertiesResponse): ServiceProviderPropertiesResponse; /** * Service Provider Definition */ interface ServiceProviderResponse { /** * The Properties of a Service Provider Object */ properties?: outputs.botservice.ServiceProviderPropertiesResponse; } /** * serviceProviderResponseProvideDefaults sets the appropriate defaults for ServiceProviderResponse */ function serviceProviderResponseProvideDefaults(val: ServiceProviderResponse): ServiceProviderResponse; /** * A site for the channel */ interface SiteResponse { /** * DirectLine application id */ appId?: string; /** * Entity Tag */ eTag?: string; /** * Whether this site is enabled for block user upload. */ isBlockUserUploadEnabled?: boolean; /** * Whether this site is disabled detailed logging for */ isDetailedLoggingEnabled?: boolean; /** * Whether this site is enabled for DirectLine channel */ isEnabled: boolean; /** * Whether this site is EndpointParameters enabled for channel */ isEndpointParametersEnabled?: boolean; /** * Whether this no-storage site is disabled detailed logging for */ isNoStorageEnabled?: boolean; /** * Whether this site is enabled for authentication with Bot Framework. */ isSecureSiteEnabled?: boolean; /** * Whether this site is token enabled for channel */ isTokenEnabled: boolean; /** * Whether this site is enabled for Bot Framework V1 protocol. */ isV1Enabled?: boolean; /** * Whether this site is enabled for Bot Framework V3 protocol. */ isV3Enabled?: boolean; /** * Whether this site is enabled for Webchat Speech */ isWebChatSpeechEnabled?: boolean; /** * Whether this site is enabled for preview versions of Webchat */ isWebchatPreviewEnabled?: boolean; /** * Primary key. Value only returned through POST to the action Channel List API, otherwise empty. */ key: string; /** * Secondary key. Value only returned through POST to the action Channel List API, otherwise empty. */ key2: string; /** * Site Id */ siteId: string; /** * Site name */ siteName: string; /** * Tenant Id */ tenantId?: string; /** * List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True. */ trustedOrigins?: string[]; } /** * siteResponseProvideDefaults sets the appropriate defaults for SiteResponse */ function siteResponseProvideDefaults(val: SiteResponse): SiteResponse; /** * The SKU of the cognitive services account. */ interface SkuResponse { /** * The sku name */ name: string; /** * Gets the sku tier. This is based on the SKU name. */ tier: string; } /** * The parameters to provide for the Microsoft Teams channel. */ interface SkypeChannelPropertiesResponse { /** * Calling web hook for Skype channel */ callingWebHook?: string; /** * Enable calling for Skype channel */ enableCalling?: boolean; /** * Enable groups for Skype channel */ enableGroups?: boolean; /** * Enable media cards for Skype channel */ enableMediaCards?: boolean; /** * Enable messaging for Skype channel */ enableMessaging?: boolean; /** * Enable screen sharing for Skype channel */ enableScreenSharing?: boolean; /** * Enable video for Skype channel */ enableVideo?: boolean; /** * Group mode for Skype channel */ groupsMode?: string; /** * Incoming call route for Skype channel */ incomingCallRoute?: string; /** * Whether this channel is enabled for the bot */ isEnabled: boolean; } /** * skypeChannelPropertiesResponseProvideDefaults sets the appropriate defaults for SkypeChannelPropertiesResponse */ function skypeChannelPropertiesResponseProvideDefaults(val: SkypeChannelPropertiesResponse): SkypeChannelPropertiesResponse; /** * Skype channel definition */ interface SkypeChannelResponse { /** * The channel name * Expected value is 'SkypeChannel'. */ channelName: "SkypeChannel"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * The set of properties specific to Skype channel resource */ properties?: outputs.botservice.SkypeChannelPropertiesResponse; /** * Provisioning state of the resource */ provisioningState: string; } /** * skypeChannelResponseProvideDefaults sets the appropriate defaults for SkypeChannelResponse */ function skypeChannelResponseProvideDefaults(val: SkypeChannelResponse): SkypeChannelResponse; /** * The parameters to provide for the Slack channel. */ interface SlackChannelPropertiesResponse { /** * The Slack client id */ clientId?: string; /** * The Slack client secret. Value only returned through POST to the action Channel List API, otherwise empty. */ clientSecret?: string; /** * Whether this channel is enabled for the bot */ isEnabled: boolean; /** * Whether this channel is validated for the bot */ isValidated: boolean; /** * The Slack landing page Url */ landingPageUrl?: string; /** * The Sms auth token */ lastSubmissionId: string; /** * The Slack redirect action */ redirectAction: string; /** * Whether to register the settings before OAuth validation is performed. Recommended to True. */ registerBeforeOAuthFlow?: boolean; /** * The Slack permission scopes. */ scopes?: string; /** * The Slack signing secret. */ signingSecret?: string; /** * The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty. */ verificationToken?: string; } /** * Slack channel definition */ interface SlackChannelResponse { /** * The channel name * Expected value is 'SlackChannel'. */ channelName: "SlackChannel"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * The set of properties specific to Slack channel resource */ properties?: outputs.botservice.SlackChannelPropertiesResponse; /** * Provisioning state of the resource */ provisioningState: string; } /** * slackChannelResponseProvideDefaults sets the appropriate defaults for SlackChannelResponse */ function slackChannelResponseProvideDefaults(val: SlackChannelResponse): SlackChannelResponse; /** * The parameters to provide for the Sms channel. */ interface SmsChannelPropertiesResponse { /** * The Sms account SID. Value only returned through POST to the action Channel List API, otherwise empty. */ accountSID: string; /** * The Sms auth token. Value only returned through POST to the action Channel List API, otherwise empty. */ authToken?: string; /** * Whether this channel is enabled for the bot */ isEnabled: boolean; /** * Whether this channel is validated for the bot */ isValidated?: boolean; /** * The Sms phone */ phone: string; } /** * Sms channel definition */ interface SmsChannelResponse { /** * The channel name * Expected value is 'SmsChannel'. */ channelName: "SmsChannel"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * The set of properties specific to Sms channel resource */ properties?: outputs.botservice.SmsChannelPropertiesResponse; /** * Provisioning state of the resource */ provisioningState: string; } /** * smsChannelResponseProvideDefaults sets the appropriate defaults for SmsChannelResponse */ function smsChannelResponseProvideDefaults(val: SmsChannelResponse): SmsChannelResponse; /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The parameters to provide for the Telegram channel. */ interface TelegramChannelPropertiesResponse { /** * The Telegram access token. Value only returned through POST to the action Channel List API, otherwise empty. */ accessToken?: string; /** * Whether this channel is enabled for the bot */ isEnabled: boolean; /** * Whether this channel is validated for the bot */ isValidated?: boolean; } /** * Telegram channel definition */ interface TelegramChannelResponse { /** * The channel name * Expected value is 'TelegramChannel'. */ channelName: "TelegramChannel"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * The set of properties specific to Telegram channel resource */ properties?: outputs.botservice.TelegramChannelPropertiesResponse; /** * Provisioning state of the resource */ provisioningState: string; } /** * telegramChannelResponseProvideDefaults sets the appropriate defaults for TelegramChannelResponse */ function telegramChannelResponseProvideDefaults(val: TelegramChannelResponse): TelegramChannelResponse; /** * The parameters to provide for the Direct Line channel. */ interface TelephonyChannelPropertiesResponse { /** * The list of Telephony api configuration */ apiConfigurations?: outputs.botservice.TelephonyChannelResourceApiConfigurationResponse[]; /** * The extensionKey2 */ cognitiveServiceRegion?: string; /** * The extensionKey1 */ cognitiveServiceSubscriptionKey?: string; /** * The default locale of the channel */ defaultLocale?: string; /** * Whether the channel is enabled */ isEnabled?: boolean; /** * The list of Telephony phone numbers */ phoneNumbers?: outputs.botservice.TelephonyPhoneNumbersResponse[]; /** * The premium SKU applied to the channel */ premiumSKU?: string; } /** * A resource Api configuration for the Telephony channel */ interface TelephonyChannelResourceApiConfigurationResponse { /** * The cognitive service region. */ cognitiveServiceRegion?: string; /** * The cognitive service resourceId. */ cognitiveServiceResourceId?: string; /** * The cognitive service subscription key. */ cognitiveServiceSubscriptionKey?: string; /** * The default locale. */ defaultLocale?: string; /** * The id of config. */ id?: string; /** * The provider name. */ providerName?: string; } /** * Telephony channel definition */ interface TelephonyChannelResponse { /** * The channel name * Expected value is 'TelephonyChannel'. */ channelName: "TelephonyChannel"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * The set of properties specific to Telephony channel resource */ properties?: outputs.botservice.TelephonyChannelPropertiesResponse; /** * Provisioning state of the resource */ provisioningState: string; } /** * telephonyChannelResponseProvideDefaults sets the appropriate defaults for TelephonyChannelResponse */ function telephonyChannelResponseProvideDefaults(val: TelephonyChannelResponse): TelephonyChannelResponse; /** * A telephone number for the Telephony channel */ interface TelephonyPhoneNumbersResponse { /** * The endpoint of ACS. */ acsEndpoint?: string; /** * The resource id of ACS. */ acsResourceId?: string; /** * The secret of ACS. */ acsSecret?: string; /** * The service region of cognitive service. */ cognitiveServiceRegion?: string; /** * The resource id of cognitive service. */ cognitiveServiceResourceId?: string; /** * The subscription key of cognitive service. */ cognitiveServiceSubscriptionKey?: string; /** * The default locale of the phone number. */ defaultLocale?: string; /** * The element id. */ id?: string; /** * Optional Property that will determine the offering type of the phone. */ offerType?: string; /** * The phone number. */ phoneNumber?: string; } /** * The parameters to provide for the Web Chat channel. */ interface WebChatChannelPropertiesResponse { /** * The list of Web Chat sites */ sites?: outputs.botservice.WebChatSiteResponse[]; /** * Web chat control embed code */ webChatEmbedCode: string; } /** * Web Chat channel definition */ interface WebChatChannelResponse { /** * The channel name * Expected value is 'WebChatChannel'. */ channelName: "WebChatChannel"; /** * Entity Tag of the resource */ etag?: string; /** * Specifies the location of the resource. */ location?: string; /** * The set of properties specific to Web Chat channel resource */ properties?: outputs.botservice.WebChatChannelPropertiesResponse; /** * Provisioning state of the resource */ provisioningState: string; } /** * webChatChannelResponseProvideDefaults sets the appropriate defaults for WebChatChannelResponse */ function webChatChannelResponseProvideDefaults(val: WebChatChannelResponse): WebChatChannelResponse; /** * A site for the Webchat channel */ interface WebChatSiteResponse { /** * DirectLine application id */ appId?: string; /** * Entity Tag */ eTag?: string; /** * Whether this site is enabled for block user upload. */ isBlockUserUploadEnabled?: boolean; /** * Whether this site is disabled detailed logging for */ isDetailedLoggingEnabled?: boolean; /** * Whether this site is enabled for DirectLine channel */ isEnabled: boolean; /** * Whether this site is EndpointParameters enabled for channel */ isEndpointParametersEnabled?: boolean; /** * Whether this no-storage site is disabled detailed logging for */ isNoStorageEnabled?: boolean; /** * Whether this site is enabled for authentication with Bot Framework. */ isSecureSiteEnabled?: boolean; /** * Whether this site is token enabled for channel */ isTokenEnabled: boolean; /** * Whether this site is enabled for Bot Framework V1 protocol. */ isV1Enabled?: boolean; /** * Whether this site is enabled for Bot Framework V3 protocol. */ isV3Enabled?: boolean; /** * Whether this site is enabled for Webchat Speech */ isWebChatSpeechEnabled?: boolean; /** * Whether this site is enabled for preview versions of Webchat */ isWebchatPreviewEnabled?: boolean; /** * Primary key. Value only returned through POST to the action Channel List API, otherwise empty. */ key: string; /** * Secondary key. Value only returned through POST to the action Channel List API, otherwise empty. */ key2: string; /** * Site Id */ siteId: string; /** * Site name */ siteName: string; /** * Tenant Id */ tenantId?: string; /** * List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True. */ trustedOrigins?: string[]; } /** * webChatSiteResponseProvideDefaults sets the appropriate defaults for WebChatSiteResponse */ function webChatSiteResponseProvideDefaults(val: WebChatSiteResponse): WebChatSiteResponse; } export declare namespace cdn { /** * Customized cipher suite set object that will be used for Https when cipherSuiteSetType is Customized. */ interface AFDDomainHttpsCustomizedCipherSuiteSetResponse { /** * Cipher suites for TLS 1.2. Required at least one in minimumTlsVersion TLS 1.2. */ cipherSuiteSetForTls12?: string[]; /** * Cipher suites for TLS 1.3. Required at least one in minimumTlsVersion TLS 1.2, TLS 1.3. */ cipherSuiteSetForTls13?: string[]; } /** * The JSON object that contains the properties to secure a domain. */ interface AFDDomainHttpsParametersResponse { /** * Defines the source of the SSL certificate. */ certificateType: string; /** * cipher suite set type that will be used for Https */ cipherSuiteSetType?: string; /** * Customized cipher suites object that will be used for Https when cipherSuiteSetType is Customized. */ customizedCipherSuiteSet?: outputs.cdn.AFDDomainHttpsCustomizedCipherSuiteSetResponse; /** * TLS protocol version that will be used for Https when cipherSuiteSetType is Customized. */ minimumTlsVersion?: string; /** * Resource reference to the secret. ie. subs/rg/profile/secret */ secret?: outputs.cdn.ResourceReferenceResponse; } /** * Reference to another resource along with its state. */ interface ActivatedResourceReferenceResponse { /** * Resource ID. */ id?: string; /** * Whether the resource is active or inactive */ isActive: boolean; } /** * Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object. */ interface AfdRouteCacheConfigurationResponse { /** * compression settings. */ compressionSettings?: outputs.cdn.CompressionSettingsResponse; /** * query parameters to include or exclude (comma separated). */ queryParameters?: string; /** * Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. */ queryStringCachingBehavior?: string; } /** * Defines a path configuration for a web agent. */ interface AgentPathResponse { /** * The actual path value. */ path: string; /** * The type of the path. */ type: string; } /** * Azure FirstParty Managed Certificate provided by other first party resource providers to enable HTTPS. */ interface AzureFirstPartyManagedCertificateParametersResponse { /** * Certificate issuing authority. */ certificateAuthority: string; /** * Certificate expiration date. */ expirationDate: string; /** * Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/secrets/{certificateName} */ secretSource: outputs.cdn.ResourceReferenceResponse; /** * Subject name in the certificate. */ subject: string; /** * The list of SANs. */ subjectAlternativeNames?: string[]; /** * Certificate thumbprint. */ thumbprint: string; /** * The type of the secret resource. * Expected value is 'AzureFirstPartyManagedCertificate'. */ type: "AzureFirstPartyManagedCertificate"; } /** * Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object. */ interface CacheConfigurationResponse { /** * Caching behavior for the requests */ cacheBehavior?: string; /** * The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss */ cacheDuration?: string; /** * Indicates whether content compression is enabled. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. */ isCompressionEnabled?: string; /** * query parameters to include or exclude (comma separated). */ queryParameters?: string; /** * Defines how Frontdoor caches requests that include query strings. You can ignore any query strings when caching, ignore specific query strings, cache every request with a unique URL, or cache specific query strings. */ queryStringCachingBehavior?: string; } /** * Defines the parameters for the cache expiration action. */ interface CacheExpirationActionParametersResponse { /** * Caching behavior for the requests */ cacheBehavior: string; /** * The duration for which the content needs to be cached. Allowed format is [d.]hh:mm:ss */ cacheDuration?: string; /** * The level at which the content needs to be cached. */ cacheType: string; /** * Expected value is 'DeliveryRuleCacheExpirationActionParameters'. */ typeName: "DeliveryRuleCacheExpirationActionParameters"; } /** * Defines the parameters for the cache-key query string action. */ interface CacheKeyQueryStringActionParametersResponse { /** * query parameters to include or exclude (comma separated). */ queryParameters?: string; /** * Caching behavior for the requests */ queryStringBehavior: string; /** * Expected value is 'DeliveryRuleCacheKeyQueryStringBehaviorActionParameters'. */ typeName: "DeliveryRuleCacheKeyQueryStringBehaviorActionParameters"; } /** * Defines the parameters for using CDN managed certificate for securing custom domain. */ interface CdnCertificateSourceParametersResponse { /** * Type of certificate used */ certificateType: string; /** * Expected value is 'CdnCertificateSourceParameters'. */ typeName: "CdnCertificateSourceParameters"; } /** * Defines the ARM Resource ID for the linked endpoints */ interface CdnEndpointResponse { /** * ARM Resource ID string. */ id?: string; } /** * Defines the certificate source parameters using CDN managed certificate for enabling SSL. */ interface CdnManagedHttpsParametersResponse { /** * Defines the source of the SSL certificate. * Expected value is 'Cdn'. */ certificateSource: "Cdn"; /** * Defines the certificate source parameters using CDN managed certificate for enabling SSL. */ certificateSourceParameters: outputs.cdn.CdnCertificateSourceParametersResponse; /** * TLS protocol version that will be used for Https */ minimumTlsVersion?: string; /** * Defines the TLS extension protocol that is used for secure delivery. */ protocolType: string; } /** * Defines the parameters for ClientPort match conditions */ interface ClientPortMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleClientPortConditionParameters'. */ typeName: "DeliveryRuleClientPortConditionParameters"; } /** * clientPortMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for ClientPortMatchConditionParametersResponse */ function clientPortMatchConditionParametersResponseProvideDefaults(val: ClientPortMatchConditionParametersResponse): ClientPortMatchConditionParametersResponse; /** * settings for compression. */ interface CompressionSettingsResponse { /** * List of content types on which compression applies. The value should be a valid MIME type. */ contentTypesToCompress?: string[]; /** * Indicates whether content compression is enabled on AzureFrontDoor. Default value is false. If compression is enabled, content will be served as compressed if user requests for a compressed version. Content won't be compressed on AzureFrontDoor when requested content is smaller than 1 byte or larger than 1 MB. */ isCompressionEnabled?: boolean; } /** * Defines the parameters for Cookies match conditions */ interface CookiesMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * Name of Cookies to be matched */ selector?: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleCookiesConditionParameters'. */ typeName: "DeliveryRuleCookiesConditionParameters"; } /** * cookiesMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for CookiesMatchConditionParametersResponse */ function cookiesMatchConditionParametersResponseProvideDefaults(val: CookiesMatchConditionParametersResponse): CookiesMatchConditionParametersResponse; /** * Defines contents of custom rules */ interface CustomRuleListResponse { /** * List of rules */ rules?: outputs.cdn.CustomRuleResponse[]; } /** * Defines the common attributes for a custom rule that can be included in a waf policy */ interface CustomRuleResponse { /** * Describes what action to be applied when rule matches */ action: string; /** * Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. */ enabledState?: string; /** * List of match conditions. */ matchConditions: outputs.cdn.MatchConditionResponse[]; /** * Defines the name of the custom rule */ name: string; /** * Defines in what order this rule be evaluated in the overall list of custom rules */ priority: number; } /** * Customer Certificate used for https */ interface CustomerCertificateParametersResponse { /** * Certificate issuing authority. */ certificateAuthority: string; /** * Certificate expiration date. */ expirationDate: string; /** * Resource reference to the Azure Key Vault certificate. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{certificateName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ */ secretSource: outputs.cdn.ResourceReferenceResponse; /** * Version of the secret to be used */ secretVersion?: string; /** * Subject name in the certificate. */ subject: string; /** * The list of SANs. */ subjectAlternativeNames: string[]; /** * Certificate thumbprint. */ thumbprint: string; /** * The type of the secret resource. * Expected value is 'CustomerCertificate'. */ type: "CustomerCertificate"; /** * Whether to use the latest version for the certificate */ useLatestVersion?: boolean; } /** * Custom domains created on the CDN endpoint. */ interface DeepCreatedCustomDomainResponse { /** * The host name of the custom domain. Must be a domain name. */ hostName: string; /** * Custom domain name. */ name: string; /** * Special validation or data may be required when delivering CDN to some regions due to local compliance reasons. E.g. ICP license number of a custom domain is required to deliver content in China. */ validationData?: string; } /** * The origin group for CDN content which is added when creating a CDN endpoint. Traffic is sent to the origins within the origin group based on origin health. */ interface DeepCreatedOriginGroupResponse { /** * Health probe settings to the origin that is used to determine the health of the origin. */ healthProbeSettings?: outputs.cdn.HealthProbeParametersResponse; /** * Origin group name which must be unique within the endpoint. */ name: string; /** * The source of the content being delivered via CDN within given origin group. */ origins: outputs.cdn.ResourceReferenceResponse[]; /** * The JSON object that contains the properties to determine origin health using real requests/responses.This property is currently not supported. */ responseBasedOriginErrorDetectionSettings?: outputs.cdn.ResponseBasedOriginErrorDetectionParametersResponse; /** * Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported. */ trafficRestorationTimeToHealedOrNewEndpointsInMinutes?: number; } /** * The main origin of CDN content which is added when creating a CDN endpoint. */ interface DeepCreatedOriginResponse { /** * Origin is enabled for load balancing or not. By default, origin is always enabled. */ enabled?: boolean; /** * The address of the origin. It can be a domain name, IPv4 address, or IPv6 address. This should be unique across all origins in an endpoint. */ hostName: string; /** * The value of the HTTP port. Must be between 1 and 65535. */ httpPort?: number; /** * The value of the HTTPS port. Must be between 1 and 65535. */ httpsPort?: number; /** * Origin name which must be unique within the endpoint. */ name: string; /** * The host header value sent to the origin with each request. If you leave this blank, the request hostname determines this value. Azure CDN origins, such as Web Apps, Blob Storage, and Cloud Services require this host header value to match the origin hostname by default. */ originHostHeader?: string; /** * Priority of origin in given origin group for load balancing. Higher priorities will not be used for load balancing if any lower priority origin is healthy.Must be between 1 and 5. */ priority?: number; /** * The approval status for the connection to the Private Link */ privateEndpointStatus: string; /** * The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private' */ privateLinkAlias?: string; /** * A custom message to be included in the approval request to connect to the Private Link. */ privateLinkApprovalMessage?: string; /** * The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated */ privateLinkLocation?: string; /** * The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' */ privateLinkResourceId?: string; /** * Weight of the origin in given origin group for load balancing. Must be between 1 and 1000 */ weight?: number; } /** * Defines the cache expiration action for the delivery rule. */ interface DeliveryRuleCacheExpirationActionResponse { /** * The name of the action for the delivery rule. * Expected value is 'CacheExpiration'. */ name: "CacheExpiration"; /** * Defines the parameters for the action. */ parameters: outputs.cdn.CacheExpirationActionParametersResponse; } /** * Defines the cache-key query string action for the delivery rule. */ interface DeliveryRuleCacheKeyQueryStringActionResponse { /** * The name of the action for the delivery rule. * Expected value is 'CacheKeyQueryString'. */ name: "CacheKeyQueryString"; /** * Defines the parameters for the action. */ parameters: outputs.cdn.CacheKeyQueryStringActionParametersResponse; } /** * Defines the ClientPort condition for the delivery rule. */ interface DeliveryRuleClientPortConditionResponse { /** * Request variable to compare with. * Expected value is 'ClientPort'. */ name: "ClientPort"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.ClientPortMatchConditionParametersResponse; } /** * deliveryRuleClientPortConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleClientPortConditionResponse */ function deliveryRuleClientPortConditionResponseProvideDefaults(val: DeliveryRuleClientPortConditionResponse): DeliveryRuleClientPortConditionResponse; /** * Defines the Cookies condition for the delivery rule. */ interface DeliveryRuleCookiesConditionResponse { /** * Request variable to compare with. * Expected value is 'Cookies'. */ name: "Cookies"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.CookiesMatchConditionParametersResponse; } /** * deliveryRuleCookiesConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleCookiesConditionResponse */ function deliveryRuleCookiesConditionResponseProvideDefaults(val: DeliveryRuleCookiesConditionResponse): DeliveryRuleCookiesConditionResponse; /** * Defines the HostName condition for the delivery rule. */ interface DeliveryRuleHostNameConditionResponse { /** * Request variable to compare with. * Expected value is 'HostName'. */ name: "HostName"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.HostNameMatchConditionParametersResponse; } /** * deliveryRuleHostNameConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleHostNameConditionResponse */ function deliveryRuleHostNameConditionResponseProvideDefaults(val: DeliveryRuleHostNameConditionResponse): DeliveryRuleHostNameConditionResponse; /** * Defines the HttpVersion condition for the delivery rule. */ interface DeliveryRuleHttpVersionConditionResponse { /** * Request variable to compare with. * Expected value is 'HttpVersion'. */ name: "HttpVersion"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.HttpVersionMatchConditionParametersResponse; } /** * deliveryRuleHttpVersionConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleHttpVersionConditionResponse */ function deliveryRuleHttpVersionConditionResponseProvideDefaults(val: DeliveryRuleHttpVersionConditionResponse): DeliveryRuleHttpVersionConditionResponse; /** * Defines the IsDevice condition for the delivery rule. */ interface DeliveryRuleIsDeviceConditionResponse { /** * Request variable to compare with. * Expected value is 'IsDevice'. */ name: "IsDevice"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.IsDeviceMatchConditionParametersResponse; } /** * deliveryRuleIsDeviceConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleIsDeviceConditionResponse */ function deliveryRuleIsDeviceConditionResponseProvideDefaults(val: DeliveryRuleIsDeviceConditionResponse): DeliveryRuleIsDeviceConditionResponse; /** * Defines the PostArgs condition for the delivery rule. */ interface DeliveryRulePostArgsConditionResponse { /** * Request variable to compare with. * Expected value is 'PostArgs'. */ name: "PostArgs"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.PostArgsMatchConditionParametersResponse; } /** * deliveryRulePostArgsConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRulePostArgsConditionResponse */ function deliveryRulePostArgsConditionResponseProvideDefaults(val: DeliveryRulePostArgsConditionResponse): DeliveryRulePostArgsConditionResponse; /** * Defines the QueryString condition for the delivery rule. */ interface DeliveryRuleQueryStringConditionResponse { /** * Request variable to compare with. * Expected value is 'QueryString'. */ name: "QueryString"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.QueryStringMatchConditionParametersResponse; } /** * deliveryRuleQueryStringConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleQueryStringConditionResponse */ function deliveryRuleQueryStringConditionResponseProvideDefaults(val: DeliveryRuleQueryStringConditionResponse): DeliveryRuleQueryStringConditionResponse; /** * Defines the RemoteAddress condition for the delivery rule. */ interface DeliveryRuleRemoteAddressConditionResponse { /** * Request variable to compare with. * Expected value is 'RemoteAddress'. */ name: "RemoteAddress"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.RemoteAddressMatchConditionParametersResponse; } /** * deliveryRuleRemoteAddressConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleRemoteAddressConditionResponse */ function deliveryRuleRemoteAddressConditionResponseProvideDefaults(val: DeliveryRuleRemoteAddressConditionResponse): DeliveryRuleRemoteAddressConditionResponse; /** * Defines the RequestBody condition for the delivery rule. */ interface DeliveryRuleRequestBodyConditionResponse { /** * Request variable to compare with. * Expected value is 'RequestBody'. */ name: "RequestBody"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.RequestBodyMatchConditionParametersResponse; } /** * deliveryRuleRequestBodyConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleRequestBodyConditionResponse */ function deliveryRuleRequestBodyConditionResponseProvideDefaults(val: DeliveryRuleRequestBodyConditionResponse): DeliveryRuleRequestBodyConditionResponse; /** * Defines the request header action for the delivery rule. */ interface DeliveryRuleRequestHeaderActionResponse { /** * The name of the action for the delivery rule. * Expected value is 'ModifyRequestHeader'. */ name: "ModifyRequestHeader"; /** * Defines the parameters for the action. */ parameters: outputs.cdn.HeaderActionParametersResponse; } /** * Defines the RequestHeader condition for the delivery rule. */ interface DeliveryRuleRequestHeaderConditionResponse { /** * Request variable to compare with. * Expected value is 'RequestHeader'. */ name: "RequestHeader"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.RequestHeaderMatchConditionParametersResponse; } /** * deliveryRuleRequestHeaderConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleRequestHeaderConditionResponse */ function deliveryRuleRequestHeaderConditionResponseProvideDefaults(val: DeliveryRuleRequestHeaderConditionResponse): DeliveryRuleRequestHeaderConditionResponse; /** * Defines the RequestMethod condition for the delivery rule. */ interface DeliveryRuleRequestMethodConditionResponse { /** * Request variable to compare with. * Expected value is 'RequestMethod'. */ name: "RequestMethod"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.RequestMethodMatchConditionParametersResponse; } /** * deliveryRuleRequestMethodConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleRequestMethodConditionResponse */ function deliveryRuleRequestMethodConditionResponseProvideDefaults(val: DeliveryRuleRequestMethodConditionResponse): DeliveryRuleRequestMethodConditionResponse; /** * Defines the RequestScheme condition for the delivery rule. */ interface DeliveryRuleRequestSchemeConditionResponse { /** * Request variable to compare with. * Expected value is 'RequestScheme'. */ name: "RequestScheme"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.RequestSchemeMatchConditionParametersResponse; } /** * deliveryRuleRequestSchemeConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleRequestSchemeConditionResponse */ function deliveryRuleRequestSchemeConditionResponseProvideDefaults(val: DeliveryRuleRequestSchemeConditionResponse): DeliveryRuleRequestSchemeConditionResponse; /** * Defines the RequestUri condition for the delivery rule. */ interface DeliveryRuleRequestUriConditionResponse { /** * Request variable to compare with. * Expected value is 'RequestUri'. */ name: "RequestUri"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.RequestUriMatchConditionParametersResponse; } /** * deliveryRuleRequestUriConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleRequestUriConditionResponse */ function deliveryRuleRequestUriConditionResponseProvideDefaults(val: DeliveryRuleRequestUriConditionResponse): DeliveryRuleRequestUriConditionResponse; /** * A rule that specifies a set of actions and conditions */ interface DeliveryRuleResponse { /** * A list of actions that are executed when all the conditions of a rule are satisfied. */ actions: (outputs.cdn.DeliveryRuleCacheExpirationActionResponse | outputs.cdn.DeliveryRuleCacheKeyQueryStringActionResponse | outputs.cdn.DeliveryRuleRequestHeaderActionResponse | outputs.cdn.DeliveryRuleResponseHeaderActionResponse | outputs.cdn.DeliveryRuleRouteConfigurationOverrideActionResponse | outputs.cdn.OriginGroupOverrideActionResponse | outputs.cdn.UrlRedirectActionResponse | outputs.cdn.UrlRewriteActionResponse | outputs.cdn.UrlSigningActionResponse)[]; /** * A list of conditions that must be matched for the actions to be executed */ conditions?: (outputs.cdn.DeliveryRuleClientPortConditionResponse | outputs.cdn.DeliveryRuleCookiesConditionResponse | outputs.cdn.DeliveryRuleHostNameConditionResponse | outputs.cdn.DeliveryRuleHttpVersionConditionResponse | outputs.cdn.DeliveryRuleIsDeviceConditionResponse | outputs.cdn.DeliveryRulePostArgsConditionResponse | outputs.cdn.DeliveryRuleQueryStringConditionResponse | outputs.cdn.DeliveryRuleRemoteAddressConditionResponse | outputs.cdn.DeliveryRuleRequestBodyConditionResponse | outputs.cdn.DeliveryRuleRequestHeaderConditionResponse | outputs.cdn.DeliveryRuleRequestMethodConditionResponse | outputs.cdn.DeliveryRuleRequestSchemeConditionResponse | outputs.cdn.DeliveryRuleRequestUriConditionResponse | outputs.cdn.DeliveryRuleServerPortConditionResponse | outputs.cdn.DeliveryRuleSocketAddrConditionResponse | outputs.cdn.DeliveryRuleSslProtocolConditionResponse | outputs.cdn.DeliveryRuleUrlFileExtensionConditionResponse | outputs.cdn.DeliveryRuleUrlFileNameConditionResponse | outputs.cdn.DeliveryRuleUrlPathConditionResponse)[]; /** * Name of the rule */ name?: string; /** * The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied. */ order: number; } /** * Defines the response header action for the delivery rule. */ interface DeliveryRuleResponseHeaderActionResponse { /** * The name of the action for the delivery rule. * Expected value is 'ModifyResponseHeader'. */ name: "ModifyResponseHeader"; /** * Defines the parameters for the action. */ parameters: outputs.cdn.HeaderActionParametersResponse; } /** * Defines the route configuration override action for the delivery rule. Only applicable to Frontdoor Standard/Premium Profiles. */ interface DeliveryRuleRouteConfigurationOverrideActionResponse { /** * The name of the action for the delivery rule. * Expected value is 'RouteConfigurationOverride'. */ name: "RouteConfigurationOverride"; /** * Defines the parameters for the action. */ parameters: outputs.cdn.RouteConfigurationOverrideActionParametersResponse; } /** * Defines the ServerPort condition for the delivery rule. */ interface DeliveryRuleServerPortConditionResponse { /** * Request variable to compare with. * Expected value is 'ServerPort'. */ name: "ServerPort"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.ServerPortMatchConditionParametersResponse; } /** * deliveryRuleServerPortConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleServerPortConditionResponse */ function deliveryRuleServerPortConditionResponseProvideDefaults(val: DeliveryRuleServerPortConditionResponse): DeliveryRuleServerPortConditionResponse; /** * Defines the SocketAddress condition for the delivery rule. */ interface DeliveryRuleSocketAddrConditionResponse { /** * Request variable to compare with. * Expected value is 'SocketAddr'. */ name: "SocketAddr"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.SocketAddrMatchConditionParametersResponse; } /** * deliveryRuleSocketAddrConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleSocketAddrConditionResponse */ function deliveryRuleSocketAddrConditionResponseProvideDefaults(val: DeliveryRuleSocketAddrConditionResponse): DeliveryRuleSocketAddrConditionResponse; /** * Defines the SslProtocol condition for the delivery rule. */ interface DeliveryRuleSslProtocolConditionResponse { /** * Request variable to compare with. * Expected value is 'SslProtocol'. */ name: "SslProtocol"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.SslProtocolMatchConditionParametersResponse; } /** * deliveryRuleSslProtocolConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleSslProtocolConditionResponse */ function deliveryRuleSslProtocolConditionResponseProvideDefaults(val: DeliveryRuleSslProtocolConditionResponse): DeliveryRuleSslProtocolConditionResponse; /** * Defines the UrlFileExtension condition for the delivery rule. */ interface DeliveryRuleUrlFileExtensionConditionResponse { /** * Request variable to compare with. * Expected value is 'UrlFileExtension'. */ name: "UrlFileExtension"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.UrlFileExtensionMatchConditionParametersResponse; } /** * deliveryRuleUrlFileExtensionConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleUrlFileExtensionConditionResponse */ function deliveryRuleUrlFileExtensionConditionResponseProvideDefaults(val: DeliveryRuleUrlFileExtensionConditionResponse): DeliveryRuleUrlFileExtensionConditionResponse; /** * Defines the UrlFileName condition for the delivery rule. */ interface DeliveryRuleUrlFileNameConditionResponse { /** * Request variable to compare with. * Expected value is 'UrlFileName'. */ name: "UrlFileName"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.UrlFileNameMatchConditionParametersResponse; } /** * deliveryRuleUrlFileNameConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleUrlFileNameConditionResponse */ function deliveryRuleUrlFileNameConditionResponseProvideDefaults(val: DeliveryRuleUrlFileNameConditionResponse): DeliveryRuleUrlFileNameConditionResponse; /** * Defines the UrlPath condition for the delivery rule. */ interface DeliveryRuleUrlPathConditionResponse { /** * Request variable to compare with. * Expected value is 'UrlPath'. */ name: "UrlPath"; /** * Defines the parameters for the condition. */ parameters: outputs.cdn.UrlPathMatchConditionParametersResponse; } /** * deliveryRuleUrlPathConditionResponseProvideDefaults sets the appropriate defaults for DeliveryRuleUrlPathConditionResponse */ function deliveryRuleUrlPathConditionResponseProvideDefaults(val: DeliveryRuleUrlPathConditionResponse): DeliveryRuleUrlPathConditionResponse; /** * The JSON object that contains the properties to validate a domain. */ interface DomainValidationPropertiesResponse { /** * The date time that the token expires */ expirationDate: string; /** * Challenge used for DNS TXT record or file based validation */ validationToken: string; } /** * Edge action attachment information */ interface EdgeActionAttachmentResponse { /** * The attached resource Id */ attachedResourceId: string; /** * The edge action attachment id */ id: string; } /** * A policy that specifies the delivery rules to be used for an endpoint. */ interface EndpointPropertiesUpdateParametersDeliveryPolicyResponse { /** * User-friendly description of the policy. */ description?: string; /** * A list of the delivery rules. */ rules: outputs.cdn.DeliveryRuleResponse[]; } /** * Defines the Web Application Firewall policy for the endpoint (if applicable) */ interface EndpointPropertiesUpdateParametersWebApplicationFirewallPolicyLinkResponse { /** * Resource ID. */ id?: string; } /** * Rules defining user's geo access within a CDN endpoint. */ interface GeoFilterResponse { /** * Action of the geo filter, i.e. allow or block access. */ action: string; /** * Two letter country or region codes defining user country or region access in a geo filter, e.g. AU, MX, US. */ countryCodes: string[]; /** * Relative path applicable to geo filter. (e.g. '/mypictures', '/mypicture/kitty.jpg', and etc.) */ relativePath: string; } /** * Defines the parameters for the request header action. */ interface HeaderActionParametersResponse { /** * Action to perform */ headerAction: string; /** * Name of the header to modify */ headerName: string; /** * Expected value is 'DeliveryRuleHeaderActionParameters'. */ typeName: "DeliveryRuleHeaderActionParameters"; /** * Value for the specified action */ value?: string; } /** * The JSON object that contains the properties to send health probes to origin. */ interface HealthProbeParametersResponse { /** * The number of seconds between health probes.Default is 240sec. */ probeIntervalInSeconds?: number; /** * The path relative to the origin that is used to determine the health of the origin. */ probePath?: string; /** * Protocol to use for health probe. */ probeProtocol?: string; /** * The type of health probe request that is made. */ probeRequestType?: string; } /** * Defines the parameters for HostName match conditions */ interface HostNameMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleHostNameConditionParameters'. */ typeName: "DeliveryRuleHostNameConditionParameters"; } /** * hostNameMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for HostNameMatchConditionParametersResponse */ function hostNameMatchConditionParametersResponseProvideDefaults(val: HostNameMatchConditionParametersResponse): HostNameMatchConditionParametersResponse; /** * The JSON object that represents the range for http status codes */ interface HttpErrorRangeParametersResponse { /** * The inclusive start of the http status code range. */ begin?: number; /** * The inclusive end of the http status code range. */ end?: number; } /** * Defines the parameters for HttpVersion match conditions */ interface HttpVersionMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleHttpVersionConditionParameters'. */ typeName: "DeliveryRuleHttpVersionConditionParameters"; } /** * httpVersionMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for HttpVersionMatchConditionParametersResponse */ function httpVersionMatchConditionParametersResponseProvideDefaults(val: HttpVersionMatchConditionParametersResponse): HttpVersionMatchConditionParametersResponse; /** * Defines the parameters for IsDevice match conditions */ interface IsDeviceMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleIsDeviceConditionParameters'. */ typeName: "DeliveryRuleIsDeviceConditionParameters"; } /** * isDeviceMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for IsDeviceMatchConditionParametersResponse */ function isDeviceMatchConditionParametersResponseProvideDefaults(val: IsDeviceMatchConditionParametersResponse): IsDeviceMatchConditionParametersResponse; /** * Describes the parameters for using a user's KeyVault certificate for securing custom domain. */ interface KeyVaultCertificateSourceParametersResponse { /** * Describes the action that shall be taken when the certificate is removed from Key Vault. */ deleteRule: string; /** * Resource group of the user's Key Vault containing the SSL certificate */ resourceGroupName: string; /** * The name of Key Vault Secret (representing the full certificate PFX) in Key Vault. */ secretName: string; /** * The version(GUID) of Key Vault Secret in Key Vault. */ secretVersion?: string; /** * Subscription Id of the user's Key Vault containing the SSL certificate */ subscriptionId: string; /** * Expected value is 'KeyVaultCertificateSourceParameters'. */ typeName: "KeyVaultCertificateSourceParameters"; /** * Describes the action that shall be taken when the certificate is updated in Key Vault. */ updateRule: string; /** * The name of the user's Key Vault containing the SSL certificate */ vaultName: string; } /** * Describes the parameters for using a user's KeyVault for URL Signing Key. */ interface KeyVaultSigningKeyParametersResponse { /** * Resource group of the user's Key Vault containing the secret */ resourceGroupName: string; /** * The name of secret in Key Vault. */ secretName: string; /** * The version(GUID) of secret in Key Vault. */ secretVersion: string; /** * Subscription Id of the user's Key Vault containing the secret */ subscriptionId: string; typeName: string; /** * The name of the user's Key Vault containing the secret */ vaultName: string; } /** * Round-Robin load balancing settings for a backend pool */ interface LoadBalancingSettingsParametersResponse { /** * The additional latency in milliseconds for probes to fall into the lowest latency bucket */ additionalLatencyInMilliseconds?: number; /** * The number of samples to consider for load balancing decisions */ sampleSize?: number; /** * The number of samples within the sample period that must succeed */ successfulSamplesRequired?: number; } /** * Managed Certificate used for https */ interface ManagedCertificateParametersResponse { /** * Certificate expiration date. */ expirationDate: string; /** * Subject name in the certificate. */ subject: string; /** * The type of the secret resource. * Expected value is 'ManagedCertificate'. */ type: "ManagedCertificate"; } /** * Defines a managed rule group override setting. */ interface ManagedRuleGroupOverrideResponse { /** * Describes the managed rule group within the rule set to override */ ruleGroupName: string; /** * List of rules that will be enabled. If none specified, all rules in the group will be disabled. */ rules?: outputs.cdn.ManagedRuleOverrideResponse[]; } /** * Defines a managed rule group override setting. */ interface ManagedRuleOverrideResponse { /** * Describes the override action to be applied when rule matches. */ action?: string; /** * Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. */ enabledState?: string; /** * Identifier for the managed rule. */ ruleId: string; } /** * Defines the list of managed rule sets for the policy. */ interface ManagedRuleSetListResponse { /** * List of rule sets. */ managedRuleSets?: outputs.cdn.ManagedRuleSetResponse[]; } /** * Defines a managed rule set. */ interface ManagedRuleSetResponse { /** * Verizon only : If the rule set supports anomaly detection mode, this describes the threshold for blocking requests. */ anomalyScore?: number; /** * Defines the rule overrides to apply to the rule set. */ ruleGroupOverrides?: outputs.cdn.ManagedRuleGroupOverrideResponse[]; /** * Defines the rule set type to use. */ ruleSetType: string; /** * Defines the version of the rule set to use. */ ruleSetVersion: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.cdn.UserAssignedIdentityResponse; }; } /** * Define match conditions */ interface MatchConditionResponse { /** * List of possible match values. */ matchValue: string[]; /** * Match variable to compare against. */ matchVariable: string; /** * Describes if the result of this condition should be negated. */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * Selector can used to match a specific key for QueryString, Cookies, RequestHeader or PostArgs. */ selector?: string; /** * List of transforms. */ transforms?: string[]; } /** * The JSON object that contains the properties of the origin authentication settings. */ interface OriginAuthenticationPropertiesResponse { /** * The scope used when requesting token from Microsoft Entra. For example, for Azure Blob Storage, scope could be "https://storage.azure.com/.default". */ scope?: string; /** * The type of the authentication for the origin. */ type?: string; /** * The user assigned managed identity to use for the origin authentication if type is UserAssignedIdentity. */ userAssignedIdentity?: outputs.cdn.ResourceReferenceResponse; } /** * Defines the parameters for the origin group override action. */ interface OriginGroupOverrideActionParametersResponse { /** * defines the OriginGroup that would override the DefaultOriginGroup. */ originGroup: outputs.cdn.ResourceReferenceResponse; /** * Expected value is 'DeliveryRuleOriginGroupOverrideActionParameters'. */ typeName: "DeliveryRuleOriginGroupOverrideActionParameters"; } /** * Defines the origin group override action for the delivery rule. */ interface OriginGroupOverrideActionResponse { /** * The name of the action for the delivery rule. * Expected value is 'OriginGroupOverride'. */ name: "OriginGroupOverride"; /** * Defines the parameters for the action. */ parameters: outputs.cdn.OriginGroupOverrideActionParametersResponse; } /** * Defines the parameters for the origin group override configuration. */ interface OriginGroupOverrideResponse { /** * Protocol this rule will use when forwarding traffic to backends. */ forwardingProtocol?: string; /** * defines the OriginGroup that would override the DefaultOriginGroup on route. */ originGroup?: outputs.cdn.ResourceReferenceResponse; } /** * Defines contents of a web application firewall global configuration */ interface PolicySettingsResponse { /** * If the action type is block, customer can override the response body. The body must be specified in base64 encoding. */ defaultCustomBlockResponseBody?: string; /** * If the action type is block, this field defines the default customer overridable http response status code. */ defaultCustomBlockResponseStatusCode?: number; /** * If action type is redirect, this field represents the default redirect URL for the client. */ defaultRedirectUrl?: string; /** * describes if the policy is in enabled state or disabled state */ enabledState?: string; /** * Describes if it is in detection mode or prevention mode at policy level. */ mode?: string; } /** * Defines the parameters for PostArgs match conditions */ interface PostArgsMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * Name of PostArg to be matched */ selector?: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRulePostArgsConditionParameters'. */ typeName: "DeliveryRulePostArgsConditionParameters"; } /** * postArgsMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for PostArgsMatchConditionParametersResponse */ function postArgsMatchConditionParametersResponseProvideDefaults(val: PostArgsMatchConditionParametersResponse): PostArgsMatchConditionParametersResponse; /** * Defines rules that scrub sensitive fields in the Azure Front Door profile logs. */ interface ProfileLogScrubbingResponse { /** * List of log scrubbing rules applied to the Azure Front Door profile logs. */ scrubbingRules?: outputs.cdn.ProfileScrubbingRulesResponse[]; /** * State of the log scrubbing config. Default value is Enabled. */ state?: string; } /** * Defines the contents of the log scrubbing rules. */ interface ProfileScrubbingRulesResponse { /** * The variable to be scrubbed from the logs. */ matchVariable: string; /** * When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. */ selector?: string; /** * When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. */ selectorMatchOperator: string; /** * Defines the state of a log scrubbing rule. Default value is enabled. */ state?: string; } /** * Defines the parameters for QueryString match conditions */ interface QueryStringMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleQueryStringConditionParameters'. */ typeName: "DeliveryRuleQueryStringConditionParameters"; } /** * queryStringMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for QueryStringMatchConditionParametersResponse */ function queryStringMatchConditionParametersResponseProvideDefaults(val: QueryStringMatchConditionParametersResponse): QueryStringMatchConditionParametersResponse; /** * Defines contents of rate limit rules */ interface RateLimitRuleListResponse { /** * List of rules */ rules?: outputs.cdn.RateLimitRuleResponse[]; } /** * Defines a rate limiting rule that can be included in a waf policy */ interface RateLimitRuleResponse { /** * Describes what action to be applied when rule matches */ action: string; /** * Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. */ enabledState?: string; /** * List of match conditions. */ matchConditions: outputs.cdn.MatchConditionResponse[]; /** * Defines the name of the custom rule */ name: string; /** * Defines in what order this rule be evaluated in the overall list of custom rules */ priority: number; /** * Defines rate limit duration. Default is 1 minute. */ rateLimitDurationInMinutes: number; /** * Defines rate limit threshold. */ rateLimitThreshold: number; } /** * Defines the parameters for RemoteAddress match conditions */ interface RemoteAddressMatchConditionParametersResponse { /** * Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match. */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleRemoteAddressConditionParameters'. */ typeName: "DeliveryRuleRemoteAddressConditionParameters"; } /** * remoteAddressMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for RemoteAddressMatchConditionParametersResponse */ function remoteAddressMatchConditionParametersResponseProvideDefaults(val: RemoteAddressMatchConditionParametersResponse): RemoteAddressMatchConditionParametersResponse; /** * Defines the parameters for RequestBody match conditions */ interface RequestBodyMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleRequestBodyConditionParameters'. */ typeName: "DeliveryRuleRequestBodyConditionParameters"; } /** * requestBodyMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for RequestBodyMatchConditionParametersResponse */ function requestBodyMatchConditionParametersResponseProvideDefaults(val: RequestBodyMatchConditionParametersResponse): RequestBodyMatchConditionParametersResponse; /** * Defines the parameters for RequestHeader match conditions */ interface RequestHeaderMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * Name of Header to be matched */ selector?: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleRequestHeaderConditionParameters'. */ typeName: "DeliveryRuleRequestHeaderConditionParameters"; } /** * requestHeaderMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for RequestHeaderMatchConditionParametersResponse */ function requestHeaderMatchConditionParametersResponseProvideDefaults(val: RequestHeaderMatchConditionParametersResponse): RequestHeaderMatchConditionParametersResponse; /** * Defines the parameters for RequestMethod match conditions */ interface RequestMethodMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleRequestMethodConditionParameters'. */ typeName: "DeliveryRuleRequestMethodConditionParameters"; } /** * requestMethodMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for RequestMethodMatchConditionParametersResponse */ function requestMethodMatchConditionParametersResponseProvideDefaults(val: RequestMethodMatchConditionParametersResponse): RequestMethodMatchConditionParametersResponse; /** * Defines the parameters for RequestScheme match conditions */ interface RequestSchemeMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleRequestSchemeConditionParameters'. */ typeName: "DeliveryRuleRequestSchemeConditionParameters"; } /** * requestSchemeMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for RequestSchemeMatchConditionParametersResponse */ function requestSchemeMatchConditionParametersResponseProvideDefaults(val: RequestSchemeMatchConditionParametersResponse): RequestSchemeMatchConditionParametersResponse; /** * Defines the parameters for RequestUri match conditions */ interface RequestUriMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleRequestUriConditionParameters'. */ typeName: "DeliveryRuleRequestUriConditionParameters"; } /** * requestUriMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for RequestUriMatchConditionParametersResponse */ function requestUriMatchConditionParametersResponseProvideDefaults(val: RequestUriMatchConditionParametersResponse): RequestUriMatchConditionParametersResponse; /** * Reference to another resource. */ interface ResourceReferenceResponse { /** * Resource ID. */ id?: string; } /** * The JSON object that contains the properties to determine origin health using real requests/responses. */ interface ResponseBasedOriginErrorDetectionParametersResponse { /** * The list of Http status code ranges that are considered as server errors for origin and it is marked as unhealthy. */ httpErrorRanges?: outputs.cdn.HttpErrorRangeParametersResponse[]; /** * Type of response errors for real user requests for which origin will be deemed unhealthy */ responseBasedDetectedErrorTypes?: string; /** * The percentage of failed requests in the sample where failover should trigger. */ responseBasedFailoverThresholdPercentage?: number; } /** * Defines the parameters for the route configuration override action. */ interface RouteConfigurationOverrideActionParametersResponse { /** * The caching configuration associated with this rule. To disable caching, do not provide a cacheConfiguration object. */ cacheConfiguration?: outputs.cdn.CacheConfigurationResponse; /** * A reference to the origin group override configuration. Leave empty to use the default origin group on route. */ originGroupOverride?: outputs.cdn.OriginGroupOverrideResponse; /** * Expected value is 'DeliveryRuleRouteConfigurationOverrideActionParameters'. */ typeName: "DeliveryRuleRouteConfigurationOverrideActionParameters"; } /** * settings for security policy patterns to match */ interface SecurityPolicyWebApplicationFirewallAssociationResponse { /** * List of domains. */ domains?: outputs.cdn.ActivatedResourceReferenceResponse[]; /** * List of paths */ patternsToMatch?: string[]; } /** * The json object containing security policy waf parameters */ interface SecurityPolicyWebApplicationFirewallParametersResponse { /** * Waf associations */ associations?: outputs.cdn.SecurityPolicyWebApplicationFirewallAssociationResponse[]; /** * The type of the Security policy to create. * Expected value is 'WebApplicationFirewall'. */ type: "WebApplicationFirewall"; /** * Resource ID. */ wafPolicy?: outputs.cdn.ResourceReferenceResponse; } /** * Defines the parameters for ServerPort match conditions */ interface ServerPortMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleServerPortConditionParameters'. */ typeName: "DeliveryRuleServerPortConditionParameters"; } /** * serverPortMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for ServerPortMatchConditionParametersResponse */ function serverPortMatchConditionParametersResponseProvideDefaults(val: ServerPortMatchConditionParametersResponse): ServerPortMatchConditionParametersResponse; /** * Describes the properties of an existing Shared Private Link Resource to use when connecting to a private origin. */ interface SharedPrivateLinkResourcePropertiesResponse { /** * The group id from the provider of resource the shared private link resource is for. */ groupId?: string; /** * The resource id of the resource the shared private link resource is for. */ privateLink?: outputs.cdn.ResourceReferenceResponse; /** * The location of the shared private link resource */ privateLinkLocation?: string; /** * The request message for requesting approval of the shared private link resource. */ requestMessage?: string; /** * Status of the shared private link resource. Can be Pending, Approved, Rejected, Disconnected, or Timeout. */ status?: string; } /** * Standard_Verizon = The SKU name for a Standard Verizon CDN profile. * Premium_Verizon = The SKU name for a Premium Verizon CDN profile. * Custom_Verizon = The SKU name for a Custom Verizon CDN profile. * Standard_Akamai = The SKU name for an Akamai CDN profile. * Standard_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using GB based billing model. * Standard_Microsoft = The SKU name for a Standard Microsoft CDN profile. * Standard_AzureFrontDoor = The SKU name for an Azure Front Door Standard profile. * Premium_AzureFrontDoor = The SKU name for an Azure Front Door Premium profile. * Standard_955BandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using 95-5 peak bandwidth billing model. * Standard_AvgBandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using monthly average peak bandwidth billing model. * StandardPlus_ChinaCdn = The SKU name for a China CDN profile for live-streaming using GB based billing model. * StandardPlus_955BandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using 95-5 peak bandwidth billing model. * StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using monthly average peak bandwidth billing model. */ interface SkuResponse { /** * Name of the pricing tier. */ name?: string; } /** * The SKU type for the edge action */ interface SkuTypeResponse { /** * The name of the SKU */ name: string; /** * The tier of the SKU */ tier: string; } /** * Defines the parameters for SocketAddress match conditions */ interface SocketAddrMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleSocketAddrConditionParameters'. */ typeName: "DeliveryRuleSocketAddrConditionParameters"; } /** * socketAddrMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for SocketAddrMatchConditionParametersResponse */ function socketAddrMatchConditionParametersResponseProvideDefaults(val: SocketAddrMatchConditionParametersResponse): SocketAddrMatchConditionParametersResponse; /** * Defines the parameters for SslProtocol match conditions */ interface SslProtocolMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleSslProtocolConditionParameters'. */ typeName: "DeliveryRuleSslProtocolConditionParameters"; } /** * sslProtocolMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for SslProtocolMatchConditionParametersResponse */ function sslProtocolMatchConditionParametersResponseProvideDefaults(val: SslProtocolMatchConditionParametersResponse): SslProtocolMatchConditionParametersResponse; /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * TargetEndpoint object that forms a traffic endpoint. */ interface TargetEndpointResponse { /** * The Ports to be allowed for the FQDN. */ ports?: number[]; /** * The FQDN for traffic endpoint. */ targetFqdn?: string; } /** * Defines the parameters for UrlFileExtension match conditions */ interface UrlFileExtensionMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleUrlFileExtensionMatchConditionParameters'. */ typeName: "DeliveryRuleUrlFileExtensionMatchConditionParameters"; } /** * urlFileExtensionMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for UrlFileExtensionMatchConditionParametersResponse */ function urlFileExtensionMatchConditionParametersResponseProvideDefaults(val: UrlFileExtensionMatchConditionParametersResponse): UrlFileExtensionMatchConditionParametersResponse; /** * Defines the parameters for UrlFilename match conditions */ interface UrlFileNameMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleUrlFilenameConditionParameters'. */ typeName: "DeliveryRuleUrlFilenameConditionParameters"; } /** * urlFileNameMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for UrlFileNameMatchConditionParametersResponse */ function urlFileNameMatchConditionParametersResponseProvideDefaults(val: UrlFileNameMatchConditionParametersResponse): UrlFileNameMatchConditionParametersResponse; /** * Defines the parameters for UrlPath match conditions */ interface UrlPathMatchConditionParametersResponse { /** * The match value for the condition of the delivery rule */ matchValues?: string[]; /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Describes operator to be matched */ operator: string; /** * List of transforms */ transforms?: string[]; /** * Expected value is 'DeliveryRuleUrlPathMatchConditionParameters'. */ typeName: "DeliveryRuleUrlPathMatchConditionParameters"; } /** * urlPathMatchConditionParametersResponseProvideDefaults sets the appropriate defaults for UrlPathMatchConditionParametersResponse */ function urlPathMatchConditionParametersResponseProvideDefaults(val: UrlPathMatchConditionParametersResponse): UrlPathMatchConditionParametersResponse; /** * Defines the parameters for the url redirect action. */ interface UrlRedirectActionParametersResponse { /** * Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. */ customFragment?: string; /** * Host to redirect. Leave empty to use the incoming host as the destination host. */ customHostname?: string; /** * The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. */ customPath?: string; /** * The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. ? and & will be added automatically so do not include them. */ customQueryString?: string; /** * Protocol to use for the redirect. The default value is MatchRequest */ destinationProtocol?: string; /** * The redirect type the rule will use when redirecting traffic. */ redirectType: string; /** * Expected value is 'DeliveryRuleUrlRedirectActionParameters'. */ typeName: "DeliveryRuleUrlRedirectActionParameters"; } /** * Defines the url redirect action for the delivery rule. */ interface UrlRedirectActionResponse { /** * The name of the action for the delivery rule. * Expected value is 'UrlRedirect'. */ name: "UrlRedirect"; /** * Defines the parameters for the action. */ parameters: outputs.cdn.UrlRedirectActionParametersResponse; } /** * Defines the parameters for the url rewrite action. */ interface UrlRewriteActionParametersResponse { /** * Define the relative URL to which the above requests will be rewritten by. */ destination: string; /** * Whether to preserve unmatched path. Default value is true. */ preserveUnmatchedPath?: boolean; /** * define a request URI pattern that identifies the type of requests that may be rewritten. If value is blank, all strings are matched. */ sourcePattern: string; /** * Expected value is 'DeliveryRuleUrlRewriteActionParameters'. */ typeName: "DeliveryRuleUrlRewriteActionParameters"; } /** * Defines the url rewrite action for the delivery rule. */ interface UrlRewriteActionResponse { /** * The name of the action for the delivery rule. * Expected value is 'UrlRewrite'. */ name: "UrlRewrite"; /** * Defines the parameters for the action. */ parameters: outputs.cdn.UrlRewriteActionParametersResponse; } /** * Defines the parameters for the Url Signing action. */ interface UrlSigningActionParametersResponse { /** * Algorithm to use for URL signing */ algorithm?: string; /** * Defines which query string parameters in the url to be considered for expires, key id etc. */ parameterNameOverride?: outputs.cdn.UrlSigningParamIdentifierResponse[]; /** * Expected value is 'DeliveryRuleUrlSigningActionParameters'. */ typeName: "DeliveryRuleUrlSigningActionParameters"; } /** * Defines the url signing action for the delivery rule. */ interface UrlSigningActionResponse { /** * The name of the action for the delivery rule. * Expected value is 'UrlSigning'. */ name: "UrlSigning"; /** * Defines the parameters for the action. */ parameters: outputs.cdn.UrlSigningActionParametersResponse; } /** * Url signing key parameters */ interface UrlSigningKeyParametersResponse { /** * Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. */ keyId: string; /** * Resource reference to the Azure Key Vault secret. Expected to be in format of /subscriptions/{​​​​​​​​​subscriptionId}​​​​​​​​​/resourceGroups/{​​​​​​​​​resourceGroupName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/providers/Microsoft.KeyVault/vaults/{vaultName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​/secrets/{secretName}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ */ secretSource: outputs.cdn.ResourceReferenceResponse; /** * Version of the secret to be used */ secretVersion: string; /** * The type of the secret resource. * Expected value is 'UrlSigningKey'. */ type: "UrlSigningKey"; } /** * Url signing key */ interface UrlSigningKeyResponse { /** * Defines the customer defined key Id. This id will exist in the incoming request to indicate the key used to form the hash. */ keyId: string; /** * Defines the parameters for using customer key vault for Url Signing Key. */ keySourceParameters: outputs.cdn.KeyVaultSigningKeyParametersResponse; } /** * Defines how to identify a parameter for a specific purpose e.g. expires */ interface UrlSigningParamIdentifierResponse { /** * Indicates the purpose of the parameter */ paramIndicator: string; /** * Parameter name */ paramName: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Defines the certificate source parameters using user's keyvault certificate for enabling SSL. */ interface UserManagedHttpsParametersResponse { /** * Defines the source of the SSL certificate. * Expected value is 'AzureKeyVault'. */ certificateSource: "AzureKeyVault"; /** * Defines the certificate source parameters using user's keyvault certificate for enabling SSL. */ certificateSourceParameters: outputs.cdn.KeyVaultCertificateSourceParametersResponse; /** * TLS protocol version that will be used for Https */ minimumTlsVersion?: string; /** * Defines the TLS extension protocol that is used for secure delivery. */ protocolType: string; } } export declare namespace certificateregistration { /** * Key Vault container for a certificate that is purchased through Azure. */ interface AppServiceCertificateResponse { /** * Key Vault resource Id. */ keyVaultId?: string; /** * Key Vault secret name. */ keyVaultSecretName?: string; /** * Status of the Key Vault secret. */ provisioningState: string; } /** * SSL certificate details. */ interface CertificateDetailsResponse { /** * Certificate Issuer. */ issuer: string; /** * Date Certificate is valid to. */ notAfter: string; /** * Date Certificate is valid from. */ notBefore: string; /** * Raw certificate data. */ rawData: string; /** * Certificate Serial Number. */ serialNumber: string; /** * Certificate Signature algorithm. */ signatureAlgorithm: string; /** * Certificate Subject. */ subject: string; /** * Certificate Thumbprint. */ thumbprint: string; /** * Certificate Version. */ version: number; } interface CertificateOrderContactResponse { email?: string; nameFirst?: string; nameLast?: string; phone?: string; } } export declare namespace chaos { /** * Model that represents the an action and its status. */ interface ActionStatusResponse { /** * The id of the action status. */ actionId: string; /** * The name of the action status. */ actionName: string; /** * String that represents the end time of the action. */ endTime: string; /** * String that represents the start time of the action. */ startTime: string; /** * The status of the action. */ status: string; /** * The array of targets. */ targets: outputs.chaos.ExperimentExecutionActionTargetDetailsPropertiesResponse[]; } /** * Model that represents a branch in the step. 9 total per experiment. */ interface BranchResponse { /** * List of actions. */ actions: (outputs.chaos.ContinuousActionResponse | outputs.chaos.DelayActionResponse | outputs.chaos.DiscreteActionResponse)[]; /** * String of the branch name. */ name: string; } /** * Model that represents the a list of actions and action statuses. */ interface BranchStatusResponse { /** * The array of actions. */ actions: outputs.chaos.ActionStatusResponse[]; /** * The id of the branch status. */ branchId: string; /** * The name of the branch status. */ branchName: string; /** * The status of the branch. */ status: string; } /** * Model that represents the Capability properties model. */ interface CapabilityPropertiesResponse { /** * Localized string of the description. */ description: string; /** * URL to retrieve JSON schema of the Capability parameters. */ parametersSchema: string; /** * String of the Publisher that this Capability extends. */ publisher: string; /** * String of the Target Type that this Capability extends. */ targetType: string; /** * String of the URN for this Capability Type. */ urn: string; } /** * Model that represents a continuous action. */ interface ContinuousActionResponse { /** * ISO8601 formatted string that represents a duration. */ duration: string; /** * String that represents a Capability URN. */ name: string; /** * List of key value pairs. */ parameters: outputs.chaos.KeyValuePairResponse[]; /** * String that represents a selector. */ selectorId: string; /** * Enum that discriminates between action models. * Expected value is 'continuous'. */ type: "continuous"; } /** * Model that represents the Customer Managed Storage for an Experiment. */ interface CustomerDataStoragePropertiesResponse { /** * Name of the Azure Blob Storage container to use or create. */ blobContainerName?: string; /** * ARM Resource ID of the Storage account to use for Customer Data storage. */ storageAccountResourceId?: string; } /** * Model that represents a delay action. */ interface DelayActionResponse { /** * ISO8601 formatted string that represents a duration. */ duration: string; /** * String that represents a Capability URN. */ name: string; /** * Enum that discriminates between action models. * Expected value is 'delay'. */ type: "delay"; } /** * Model that represents a discrete action. */ interface DiscreteActionResponse { /** * String that represents a Capability URN. */ name: string; /** * List of key value pairs. */ parameters: outputs.chaos.KeyValuePairResponse[]; /** * String that represents a selector. */ selectorId: string; /** * Enum that discriminates between action models. * Expected value is 'discrete'. */ type: "discrete"; } /** * Model that represents the Experiment action target details error model. */ interface ExperimentExecutionActionTargetDetailsErrorResponse { /** * The error code. */ code: string; /** * The error message */ message: string; } /** * Model that represents the Experiment action target details properties model. */ interface ExperimentExecutionActionTargetDetailsPropertiesResponse { /** * The error of the action. */ error: outputs.chaos.ExperimentExecutionActionTargetDetailsErrorResponse; /** * The status of the execution. */ status: string; /** * The target for the action. */ target: string; /** * String that represents the completed date time. */ targetCompletedTime: string; /** * String that represents the failed date time. */ targetFailedTime: string; } /** * The information of the experiment run. */ interface ExperimentExecutionDetailsPropertiesResponseRunInformation { /** * The steps of the experiment run. */ steps: outputs.chaos.StepStatusResponse[]; } /** * The identity of the experiment resource. */ interface ExperimentIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.chaos.UserAssignedIdentityResponse; }; } /** * Model that represents the Experiment properties model. */ interface ExperimentPropertiesResponse { /** * Optional customer-managed Storage account where Experiment schema will be stored. */ customerDataStorage?: outputs.chaos.CustomerDataStoragePropertiesResponse; /** * Most recent provisioning state for the given experiment resource. */ provisioningState: string; /** * List of selectors. */ selectors: (outputs.chaos.ListSelectorResponse | outputs.chaos.QuerySelectorResponse)[]; /** * List of steps. */ steps: outputs.chaos.StepResponse[]; } /** * A map to describe the settings of an action. */ interface KeyValuePairResponse { /** * The name of the setting for the action. */ key: string; /** * The value of the setting for the action. */ value: string; } /** * Model that represents a list selector. */ interface ListSelectorResponse { /** * Model that represents available filter types that can be applied to a targets list. */ filter?: outputs.chaos.SimpleFilterResponse; /** * String of the selector ID. */ id: string; /** * List of Target references. */ targets: outputs.chaos.TargetReferenceResponse[]; /** * Enum of the selector type. * Expected value is 'List'. */ type: "List"; } /** * The private endpoint connection resource. */ interface PrivateEndpointConnectionResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint resource. */ privateEndpoint?: outputs.chaos.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.chaos.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.chaos.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Model that represents a query selector. */ interface QuerySelectorResponse { /** * Model that represents available filter types that can be applied to a targets list. */ filter?: outputs.chaos.SimpleFilterResponse; /** * String of the selector ID. */ id: string; /** * Azure Resource Graph (ARG) Query Language query for target resources. */ queryString: string; /** * Subscription id list to scope resource query. */ subscriptionIds: string[]; /** * Enum of the selector type. * Expected value is 'Query'. */ type: "Query"; } /** * Model that represents the Simple filter parameters. */ interface SimpleFilterParametersResponse { /** * List of Azure availability zones to filter targets by. */ zones?: string[]; } /** * Model that represents a simple target filter. */ interface SimpleFilterResponse { /** * Model that represents the Simple filter parameters. */ parameters?: outputs.chaos.SimpleFilterParametersResponse; /** * Enum that discriminates between filter types. Currently only `Simple` type is supported. * Expected value is 'Simple'. */ type: "Simple"; } /** * Model that represents a step in the Experiment resource. */ interface StepResponse { /** * List of branches. */ branches: outputs.chaos.BranchResponse[]; /** * String of the step name. */ name: string; } /** * Model that represents the a list of branches and branch statuses. */ interface StepStatusResponse { /** * The array of branches. */ branches: outputs.chaos.BranchStatusResponse[]; /** * The value of the status of the step. */ status: string; /** * The id of the step. */ stepId: string; /** * The name of the step. */ stepName: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Model that represents a reference to a Target in the selector. */ interface TargetReferenceResponse { /** * String of the resource ID of a Target resource. */ id: string; /** * Enum of the Target reference type. */ type: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace cloudhealth { /** * Alert configuration details */ interface AlertConfigurationResponse { /** * Optional list of action group resource IDs to be notified when the alert is triggered. */ actionGroupIds?: string[]; /** * The alert rule description. */ description?: string; /** * The severity of triggered alert. */ severity: string; } /** * A grouping of signal assignments for a Azure Monitor Workspace */ interface AzureMonitorWorkspaceSignalGroupResponse { /** * Reference to the name of the authentication setting which is used for querying the data source */ authenticationSetting: string; /** * Azure Monitor workspace resource ID */ azureMonitorWorkspaceResourceId: string; /** * Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. */ signalAssignments?: outputs.cloudhealth.SignalAssignmentResponse[]; } /** * A grouping of signal assignments for an Azure resource */ interface AzureResourceSignalGroupResponse { /** * Reference to the name of the authentication setting which is used for querying the data source */ authenticationSetting: string; /** * Azure resource ID */ azureResourceId: string; /** * Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. */ signalAssignments?: outputs.cloudhealth.SignalAssignmentResponse[]; } /** * Properties for dependent entities, i.e. child entities */ interface DependenciesSignalGroupResponse { /** * Aggregation type for child dependencies. */ aggregationType: string; /** * Degraded threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered degraded when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is 'Thresholds'. */ degradedThreshold?: string; /** * Unhealthy threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered unhealthy when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is 'Thresholds'. */ unhealthyThreshold?: string; } /** * dependenciesSignalGroupResponseProvideDefaults sets the appropriate defaults for DependenciesSignalGroupResponse */ function dependenciesSignalGroupResponseProvideDefaults(val: DependenciesSignalGroupResponse): DependenciesSignalGroupResponse; /** * Discovery rule properties */ interface DiscoveryRulePropertiesResponse { /** * Whether to add all recommended signals to the discovered entities. */ addRecommendedSignals: string; /** * Reference to the name of the authentication setting which is used for querying Azure Resource Graph. The same authentication setting will also be assigned to any discovered entities. */ authenticationSetting: string; /** * Date when the discovery rule was (soft-)deleted. */ deletionDate: string; /** * Whether to create relationships between the discovered entities based on a set of built-in rules. These relationships cannot be manually deleted. */ discoverRelationships: string; /** * Display name */ displayName?: string; /** * Name of the entity which represents the discovery rule. Note: It might take a few minutes after creating the discovery rule until the entity is created. */ entityName: string; /** * Error message if the last discovery operation failed. */ errorMessage: string; /** * Number of discovered entities in the last discovery operation. */ numberOfDiscoveredEntities: number; /** * The status of the last operation. */ provisioningState: string; /** * Azure Resource Graph query text in KQL syntax. The query must return at least a column named 'id' which contains the resource ID of the discovered resources. */ resourceGraphQuery: string; } /** * ML-based evaluation rule for a signal definition */ interface DynamicDetectionRuleResponse { /** * Threshold direction */ dynamicThresholdDirection: string; /** * ML model to use for dynamic thresholds */ dynamicThresholdModel: string; /** * ML model sensitivity. Lowest value = high sensitivity. Supported step size = 0.5 */ modelSensitivity: number; /** * Start time of the training in UTC. */ trainingStartTime?: string; } /** * Alert configuration for an entity */ interface EntityAlertsResponse { /** * Alert to be triggered on state change to degraded */ degraded?: outputs.cloudhealth.AlertConfigurationResponse; /** * Alert to be triggered on state change to unhealthy */ unhealthy?: outputs.cloudhealth.AlertConfigurationResponse; } /** * Visual position of the entity */ interface EntityCoordinatesResponse { /** * X Coordinate */ x: number; /** * Y Coordinate */ y: number; } /** * Properties which are common across all kinds of entities */ interface EntityPropertiesResponse { /** * Alert configuration for this entity */ alerts?: outputs.cloudhealth.EntityAlertsResponse; /** * Positioning of the entity on the model canvas */ canvasPosition?: outputs.cloudhealth.EntityCoordinatesResponse; /** * Date when the entity was (soft-)deleted */ deletionDate: string; /** * Discovered by which discovery rule. If set, the entity cannot be deleted manually. */ discoveredBy: string; /** * Display name */ displayName?: string; /** * Health objective as a percentage of time the entity should be healthy. */ healthObjective?: number; /** * Health state of this entity */ healthState: string; /** * Visual icon definition. If not set, a default icon is used. */ icon?: outputs.cloudhealth.IconDefinitionResponse; /** * Impact of the entity in health state propagation */ impact?: string; /** * Entity kind */ kind?: string; /** * Optional set of labels (key-value pairs) */ labels?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Signal groups which are assigned to this entity */ signals?: outputs.cloudhealth.SignalGroupResponse; } /** * entityPropertiesResponseProvideDefaults sets the appropriate defaults for EntityPropertiesResponse */ function entityPropertiesResponseProvideDefaults(val: EntityPropertiesResponse): EntityPropertiesResponse; /** * Evaluation rule for a signal definition */ interface EvaluationRuleResponse { /** * Degraded rule with static threshold. */ degradedRule?: outputs.cloudhealth.ThresholdRuleResponse; /** * Configure to use ML-based dynamic thresholds. When used, degradedRule and unhealthyRule must not be set. */ dynamicDetectionRule?: outputs.cloudhealth.DynamicDetectionRuleResponse; /** * Unhealthy rule with static threshold. */ unhealthyRule?: outputs.cloudhealth.ThresholdRuleResponse; } /** * HealthModel properties */ interface HealthModelPropertiesResponse { /** * The data plane endpoint for interacting with health data */ dataplaneEndpoint: string; /** * Configure to automatically discover entities from a given scope, such as a Service Group. The discovered entities will be linked to the root entity of the health model. */ discovery?: outputs.cloudhealth.ModelDiscoverySettingsResponse; /** * The status of the last operation. */ provisioningState: string; } /** * A health state transition record */ interface HealthStateTransitionResponse { /** * New health state after the transition */ newState: string; /** * Timestamp when the transition occurred */ occurredAt: string; /** * Previous health state before the transition */ previousState: string; /** * Reason of the transition */ reason?: string; } /** * Visual icon definition of an entity */ interface IconDefinitionResponse { /** * Custom data. Base64-encoded SVG data. If set, this overrides the built-in icon. */ customData?: string; /** * Name of the built-in icon, or 'Custom' to use customData */ iconName: string; } /** * Log Analytics Query Signal Definition properties */ interface LogAnalyticsQuerySignalDefinitionPropertiesResponse { /** * Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count)) */ dataUnit?: string; /** * Date when the signal definition was (soft-)deleted */ deletionDate: string; /** * Display name */ displayName?: string; /** * Evaluation rules for the signal definition */ evaluationRules: outputs.cloudhealth.EvaluationRuleResponse; /** * Optional set of labels (key-value pairs) */ labels?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Query text in KQL syntax */ queryText: string; /** * Interval in which the signal is being evaluated. Defaults to PT1M (1 minute). */ refreshInterval?: string; /** * Supported signal kinds as discriminator * Expected value is 'LogAnalyticsQuery'. */ signalKind: "LogAnalyticsQuery"; /** * Time range of signal. ISO duration format like PT10M. If not specified, the KQL query must define a time range. */ timeGrain?: string; /** * Name of the column in the result set to evaluate against the thresholds. Defaults to the first column in the result set if not specified. The column must be numeric. */ valueColumnName?: string; } /** * logAnalyticsQuerySignalDefinitionPropertiesResponseProvideDefaults sets the appropriate defaults for LogAnalyticsQuerySignalDefinitionPropertiesResponse */ function logAnalyticsQuerySignalDefinitionPropertiesResponseProvideDefaults(val: LogAnalyticsQuerySignalDefinitionPropertiesResponse): LogAnalyticsQuerySignalDefinitionPropertiesResponse; /** * A grouping of signal assignments for a Log Analytics Workspace */ interface LogAnalyticsSignalGroupResponse { /** * Reference to the name of the authentication setting which is used for querying the data source */ authenticationSetting: string; /** * Log Analytics Workspace resource ID */ logAnalyticsWorkspaceResourceId: string; /** * Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. */ signalAssignments?: outputs.cloudhealth.SignalAssignmentResponse[]; } /** * Authentication setting properties for Azure Managed Identity */ interface ManagedIdentityAuthenticationSettingPropertiesResponse { /** * Supported kinds of authentication settings as discriminator * Expected value is 'ManagedIdentity'. */ authenticationKind: "ManagedIdentity"; /** * Display name */ displayName?: string; /** * Name of the managed identity to use. Either 'SystemAssigned' or the resourceId of a user-assigned identity. */ managedIdentityName: string; /** * The status of the last operation. */ provisioningState: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.cloudhealth.UserAssignedIdentityResponse; }; } /** * Settings for automatically discovering entities for the health model. */ interface ModelDiscoverySettingsResponse { /** * Whether to add all recommended signals to the discovered entities. */ addRecommendedSignals: string; /** * Which Managed Identity of the health model to use for discovery. Defaults to SystemAssigned, if not set. Can be set to 'SystemAssigned' or to the resource id of a user-assigned managed identity which is linked to the health model. */ identity?: string; /** * The scope from which entities should be automatically discovered. For example, the resource id of a Service Group. */ scope: string; } /** * Prometheus Metrics Signal Definition properties */ interface PrometheusMetricsSignalDefinitionPropertiesResponse { /** * Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count)) */ dataUnit?: string; /** * Date when the signal definition was (soft-)deleted */ deletionDate: string; /** * Display name */ displayName?: string; /** * Evaluation rules for the signal definition */ evaluationRules: outputs.cloudhealth.EvaluationRuleResponse; /** * Optional set of labels (key-value pairs) */ labels?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * Query text in PromQL syntax */ queryText: string; /** * Interval in which the signal is being evaluated. Defaults to PT1M (1 minute). */ refreshInterval?: string; /** * Supported signal kinds as discriminator * Expected value is 'PrometheusMetricsQuery'. */ signalKind: "PrometheusMetricsQuery"; /** * Time range of signal. ISO duration format like PT10M. */ timeGrain?: string; } /** * prometheusMetricsSignalDefinitionPropertiesResponseProvideDefaults sets the appropriate defaults for PrometheusMetricsSignalDefinitionPropertiesResponse */ function prometheusMetricsSignalDefinitionPropertiesResponseProvideDefaults(val: PrometheusMetricsSignalDefinitionPropertiesResponse): PrometheusMetricsSignalDefinitionPropertiesResponse; /** * Relationship properties */ interface RelationshipPropertiesResponse { /** * Resource name of the child entity */ childEntityName: string; /** * Date when the relationship was (soft-)deleted */ deletionDate: string; /** * Discovered by which discovery rule. If set, the relationship cannot be deleted manually. */ discoveredBy: string; /** * Display name */ displayName?: string; /** * Optional set of labels (key-value pairs) */ labels?: { [key: string]: string; }; /** * Resource name of the parent entity */ parentEntityName: string; /** * The status of the last operation. */ provisioningState: string; } /** * Azure Resource Metric Signal Definition properties */ interface ResourceMetricSignalDefinitionPropertiesResponse { /** * Type of aggregation to apply to the metric */ aggregationType: string; /** * Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count)) */ dataUnit?: string; /** * Date when the signal definition was (soft-)deleted */ deletionDate: string; /** * Optional: Dimension to split by */ dimension?: string; /** * Optional: Dimension filter to apply to the dimension. Must only be set if also Dimension is set. */ dimensionFilter?: string; /** * Display name */ displayName?: string; /** * Evaluation rules for the signal definition */ evaluationRules: outputs.cloudhealth.EvaluationRuleResponse; /** * Optional set of labels (key-value pairs) */ labels?: { [key: string]: string; }; /** * Name of the metric */ metricName: string; /** * Metric namespace */ metricNamespace: string; /** * The status of the last operation. */ provisioningState: string; /** * Interval in which the signal is being evaluated. Defaults to PT1M (1 minute). */ refreshInterval?: string; /** * Supported signal kinds as discriminator * Expected value is 'AzureResourceMetric'. */ signalKind: "AzureResourceMetric"; /** * Time range of signal. ISO duration format like PT10M. */ timeGrain: string; } /** * resourceMetricSignalDefinitionPropertiesResponseProvideDefaults sets the appropriate defaults for ResourceMetricSignalDefinitionPropertiesResponse */ function resourceMetricSignalDefinitionPropertiesResponseProvideDefaults(val: ResourceMetricSignalDefinitionPropertiesResponse): ResourceMetricSignalDefinitionPropertiesResponse; /** * Group of signal definition assignments */ interface SignalAssignmentResponse { /** * Signal definitions referenced by their names. All definitions are combined with an AND operator. */ signalDefinitions: string[]; } /** * Contains various signal groups that can be assigned to an entity */ interface SignalGroupResponse { /** * Log Analytics Signal Group */ azureLogAnalytics?: outputs.cloudhealth.LogAnalyticsSignalGroupResponse; /** * Azure Monitor Workspace Signal Group */ azureMonitorWorkspace?: outputs.cloudhealth.AzureMonitorWorkspaceSignalGroupResponse; /** * Azure Resource Signal Group */ azureResource?: outputs.cloudhealth.AzureResourceSignalGroupResponse; /** * Settings for dependency signals to control how the health state of child entities influences the health state of the parent entity. */ dependencies?: outputs.cloudhealth.DependenciesSignalGroupResponse; } /** * signalGroupResponseProvideDefaults sets the appropriate defaults for SignalGroupResponse */ function signalGroupResponseProvideDefaults(val: SignalGroupResponse): SignalGroupResponse; /** * A data point in the signal time series */ interface SignalHistoryDataPointResponse { /** * Additional context as provided by the submitter */ additionalContext?: string; /** * Health state at this point in time */ healthState: string; /** * Timestamp of the data point */ occurredAt: string; /** * Signal value at this point in time */ value?: number; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Threshold-based evaluation rule for a signal definition */ interface ThresholdRuleResponse { /** * Operator how to compare the signal value with the threshold */ operator: string; /** * Threshold value */ threshold: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace cloudngfw { /** * List of custom and predefined url category */ interface AdvSecurityObjectModelResponse { /** * URL entry */ entry: outputs.cloudngfw.NameDescriptionObjectResponse[]; /** * type of object */ type?: string; } /** * Data Type for App Seen */ interface AppSeenDataResponse { /** * array of appSeen */ appSeenList: outputs.cloudngfw.AppSeenInfoResponse[]; /** * number of rows */ count: number; } /** * Definition for App Seen */ interface AppSeenInfoResponse { /** * category */ category: string; /** * risk */ risk: string; /** * standardPorts */ standardPorts: string; /** * subCategory */ subCategory: string; /** * tag */ tag: string; /** * technology */ technology: string; /** * title */ title: string; } /** * Application Insights key */ interface ApplicationInsightsResponse { /** * Resource id for Application Insights */ id?: string; /** * Application Insights key */ key?: string; } /** * URL/EDL to match */ interface CategoryResponse { /** * feed list */ feeds: string[]; /** * custom URL */ urlCustom: string[]; } /** * Country Description */ interface CountryResponse { /** * country code */ code: string; /** * code description */ description?: string; } /** * DNS Proxy settings for Firewall */ interface DNSSettingsResponse { /** * List of IPs associated with the Firewall */ dnsServers?: outputs.cloudngfw.IPAddressResponse[]; /** * Enable DNS proxy, disabled by default */ enableDnsProxy?: string; /** * Enabled DNS proxy type, disabled by default */ enabledDnsType?: string; } /** * destination address */ interface DestinationAddrResponse { /** * special value 'any' */ cidrs?: string[]; /** * list of countries */ countries?: string[]; /** * list of feeds */ feeds?: string[]; /** * fqdn list */ fqdnLists?: string[]; /** * prefix list */ prefixLists?: string[]; } /** * Endpoint Configuration for frontend and backend */ interface EndpointConfigurationResponse { /** * Address Space */ address: outputs.cloudngfw.IPAddressResponse; /** * port ID */ port: string; } /** * EventHub configurations */ interface EventHubResponse { /** * Resource ID of EventHub */ id?: string; /** * EventHub name */ name?: string; /** * EventHub namespace */ nameSpace?: string; /** * EventHub policy name */ policyName?: string; /** * Subscription Id */ subscriptionId?: string; } /** * Frontend setting for Firewall */ interface FrontendSettingResponse { /** * Backend configurations */ backendConfiguration: outputs.cloudngfw.EndpointConfigurationResponse; /** * Frontend configurations */ frontendConfiguration: outputs.cloudngfw.EndpointConfigurationResponse; /** * Settings name */ name: string; /** * Protocol Type */ protocol: string; } /** * IP Address */ interface IPAddressResponse { /** * Address value */ address?: string; /** * Resource Id */ resourceId?: string; } /** * IP Address Space */ interface IPAddressSpaceResponse { /** * Address Space */ addressSpace?: string; /** * Resource Id */ resourceId?: string; } /** * Log Destination */ interface LogDestinationResponse { /** * Event Hub configurations */ eventHubConfigurations?: outputs.cloudngfw.EventHubResponse; /** * Monitor Log configurations */ monitorConfigurations?: outputs.cloudngfw.MonitorLogResponse; /** * Storage account configurations */ storageConfigurations?: outputs.cloudngfw.StorageAccountResponse; } /** * The properties of the managed service identities assigned to this resource. */ interface ManagedIdentityPropertiesResponse { /** * The active directory identifier of this principal. */ principalId: string; /** * The Active Directory tenant id of the principal. */ tenantId: string; /** * The type of managed identity assigned to this resource. */ type: string; /** * The identities assigned to this resource by the user. */ userAssignedIdentities?: { [key: string]: outputs.cloudngfw.UserAssignedIdentityResponse; }; } /** * MarketplaceDetails of PAN Firewall resource */ interface MarketplaceDetailsResponse { /** * Marketplace Subscription Id */ marketplaceSubscriptionId: string; /** * Marketplace Subscription Status */ marketplaceSubscriptionStatus?: string; /** * Offer Id */ offerId: string; /** * Publisher Id */ publisherId: string; } /** * MonitorLog configurations */ interface MonitorLogResponse { /** * Resource ID of MonitorLog */ id?: string; /** * Primary Key value for Monitor */ primaryKey?: string; /** * Secondary Key value for Monitor */ secondaryKey?: string; /** * Subscription Id */ subscriptionId?: string; /** * MonitorLog workspace */ workspace?: string; } /** * object type info */ interface NameDescriptionObjectResponse { /** * description value */ description?: string; /** * name value */ name: string; } /** * Network settings for Firewall */ interface NetworkProfileResponse { /** * Egress nat IP to use */ egressNatIp?: outputs.cloudngfw.IPAddressResponse[]; /** * Enable egress NAT, enabled by default */ enableEgressNat: string; /** * vnet or vwan, cannot be updated */ networkType: string; /** * Array of ipv4 destination address for which source NAT is to be performed */ privateSourceNatRulesDestination?: string[]; /** * List of IPs associated with the Firewall */ publicIps: outputs.cloudngfw.IPAddressResponse[]; /** * Non-RFC 1918 address */ trustedRanges?: string[]; /** * Vnet configurations */ vnetConfiguration?: outputs.cloudngfw.VnetConfigurationResponse; /** * Vwan configurations */ vwanConfiguration?: outputs.cloudngfw.VwanConfigurationResponse; } /** * Panorama Config */ interface PanoramaConfigResponse { /** * Panorama Collector Group to join - (Once configured we can not edit the value) */ cgName: string; /** * Base64 encoded string representing Panorama parameters to be used by Firewall to connect to Panorama. This string is generated via azure plugin in Panorama */ configString: string; /** * Panorama Device Group to join */ dgName: string; /** * Resource name(may be unique) for PN admin */ hostName: string; /** * Primary Panorama Server IP address value in dotted format for IPv4 */ panoramaServer: string; /** * Secondary Panorama Server IP address value in dotted format for IPv4 */ panoramaServer2: string; /** * Panorama Template Stack to join - (Once configured we can not edit the value) */ tplName: string; /** * VM auth key for panorama connectivity */ vmAuthKey: string; } /** * Billing plan information. */ interface PlanDataResponse { /** * different billing cycles like MONTHLY/WEEKLY */ billingCycle: string; /** * date when plan was applied */ effectiveDate: string; /** * plan id as published by Liftr.PAN */ planId: string; /** * different usage type like PAYG/COMMITTED */ usageType?: string; } /** * Predefined URL category object */ interface PredefinedUrlCategoryResponse { action: string; name: string; } /** * Associated rulestack details */ interface RulestackDetailsResponse { /** * Rulestack location */ location?: string; /** * Resource Id */ resourceId?: string; /** * Associated rulestack Id */ rulestackId?: string; } /** * security services */ interface SecurityServicesResponse { /** * Anti spyware Profile data */ antiSpywareProfile?: string; /** * anti virus profile data */ antiVirusProfile?: string; /** * DNS Subscription profile data */ dnsSubscription?: string; /** * File blocking profile data */ fileBlockingProfile?: string; /** * Trusted Egress Decryption profile data */ outboundTrustCertificate?: string; /** * Untrusted Egress Decryption profile data */ outboundUnTrustCertificate?: string; /** * URL filtering profile data */ urlFilteringProfile?: string; /** * IPs Vulnerability Profile Data */ vulnerabilityProfile?: string; } /** * Security services type list */ interface SecurityServicesTypeListResponse { /** * list */ entry: outputs.cloudngfw.NameDescriptionObjectResponse[]; /** * security services type */ type?: string; } /** * Address properties */ interface SourceAddrResponse { /** * special value 'any' */ cidrs?: string[]; /** * list of countries */ countries?: string[]; /** * list of feeds */ feeds?: string[]; /** * prefix list */ prefixLists?: string[]; } /** * Storage Account configurations */ interface StorageAccountResponse { /** * Storage account name */ accountName?: string; /** * Resource ID of storage account */ id?: string; /** * Subscription Id */ subscriptionId?: string; } /** * This field is only present if Strata Cloud Manager is managing the policy for this firewall */ interface StrataCloudManagerConfigResponse { /** * Strata Cloud Manager name which is intended to manage the policy for this firewall. */ cloudManagerName: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Tag */ interface TagInfoResponse { /** * tag name */ key: string; /** * tag value */ value: string; } /** * A managed identity assigned by the user. */ interface UserAssignedIdentityResponse { /** * The active directory client identifier for this principal. */ clientId?: string; /** * The active directory identifier for this principal. */ principalId?: string; } /** * VnetInfo for Firewall Networking */ interface VnetConfigurationResponse { /** * IP of trust subnet for UDR */ ipOfTrustSubnetForUdr?: outputs.cloudngfw.IPAddressResponse; /** * Trust Subnet */ trustSubnet: outputs.cloudngfw.IPAddressSpaceResponse; /** * Untrust Subnet */ unTrustSubnet: outputs.cloudngfw.IPAddressSpaceResponse; /** * Azure Virtual Network */ vnet: outputs.cloudngfw.IPAddressSpaceResponse; } /** * VwanInfo for Firewall Networking */ interface VwanConfigurationResponse { /** * IP of trust subnet for UDR */ ipOfTrustSubnetForUdr?: outputs.cloudngfw.IPAddressResponse; /** * Network Virtual Appliance resource ID */ networkVirtualApplianceId?: string; /** * Trust Subnet */ trustSubnet?: outputs.cloudngfw.IPAddressSpaceResponse; /** * Untrust Subnet */ unTrustSubnet?: outputs.cloudngfw.IPAddressSpaceResponse; /** * vHub Address */ vHub: outputs.cloudngfw.IPAddressSpaceResponse; } } export declare namespace codesigning { /** * SKU of the artifact signing account. */ interface AccountSkuResponse { /** * Name of the SKU. */ name: string; } /** * Properties of the certificate. */ interface CertificateResponse { /** * Certificate created date. */ createdDate?: string; /** * The timestamp when the revocation is effective. */ effectiveAt?: string; /** * Enhanced key usage of the certificate. */ enhancedKeyUsage?: string; /** * Certificate expiry date. */ expiryDate?: string; /** * Reason for the revocation failure. */ failureReason?: string; /** * Reason for revocation. */ reason?: string; /** * Remarks for the revocation. */ remarks?: string; /** * The timestamp when the revocation is requested. */ requestedAt?: string; /** * Serial number of the certificate. */ serialNumber?: string; /** * Status of the certificate. */ status: string; /** * Subject name of the certificate. */ subjectName?: string; /** * Thumbprint of the certificate. */ thumbprint?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace cognitiveservices { /** * This connection type covers the AAD auth for any applicable Azure service */ interface AADAuthTypeConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'AAD'. */ authType: "AAD"; /** * Category of the connection */ category?: string; createdByWorkspaceArmId: string; /** * Provides the error message if the connection fails */ error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; /** * Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'. */ peRequirement?: string; /** * Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'. */ peStatus?: string; sharedUserList?: string[]; /** * The connection URL to be used. */ target?: string; useWorkspaceManagedIdentity?: boolean; } /** * The abuse penalty. */ interface AbusePenaltyResponse { /** * The action of AbusePenalty. */ action?: string; /** * The datetime of expiration of the AbusePenalty. */ expiration?: string; /** * The percentage of rate limit. */ rateLimitPercentage?: number; } interface AccessKeyAuthTypeConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'AccessKey'. */ authType: "AccessKey"; /** * Category of the connection */ category?: string; createdByWorkspaceArmId: string; credentials?: outputs.cognitiveservices.ConnectionAccessKeyResponse; /** * Provides the error message if the connection fails */ error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; /** * Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'. */ peRequirement?: string; /** * Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'. */ peStatus?: string; sharedUserList?: string[]; /** * The connection URL to be used. */ target?: string; useWorkspaceManagedIdentity?: boolean; } /** * This connection type covers the account key connection for Azure storage */ interface AccountKeyAuthTypeConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'AccountKey'. */ authType: "AccountKey"; /** * Category of the connection */ category?: string; createdByWorkspaceArmId: string; /** * Account key object for connection credential. */ credentials?: outputs.cognitiveservices.ConnectionAccountKeyResponse; /** * Provides the error message if the connection fails */ error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; /** * Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'. */ peRequirement?: string; /** * Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'. */ peStatus?: string; sharedUserList?: string[]; /** * The connection URL to be used. */ target?: string; useWorkspaceManagedIdentity?: boolean; } /** * Properties of Cognitive Services account. */ interface AccountPropertiesResponse { /** * The abuse penalty. */ abusePenalty: outputs.cognitiveservices.AbusePenaltyResponse; /** * Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry. */ allowProjectManagement?: boolean; allowedFqdnList?: string[]; /** * The user owned AML account properties. */ amlWorkspace?: outputs.cognitiveservices.UserOwnedAmlWorkspaceResponse; /** * The api properties for special APIs. */ apiProperties?: outputs.cognitiveservices.ApiPropertiesResponse; /** * Specifies the projects, by project name, that are associated with this resource. */ associatedProjects?: string[]; /** * The call rate limit Cognitive Services account. */ callRateLimit: outputs.cognitiveservices.CallRateLimitResponse; /** * Gets the capabilities of the cognitive services account. Each item indicates the capability of a specific feature. The values are read-only and for reference only. */ capabilities: outputs.cognitiveservices.SkuCapabilityResponse[]; /** * The commitment plan associations of Cognitive Services account. */ commitmentPlanAssociations: outputs.cognitiveservices.CommitmentPlanAssociationResponse[]; /** * Optional subdomain name used for token-based authentication. */ customSubDomainName?: string; /** * Gets the date of cognitive services account creation. */ dateCreated: string; /** * Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter. */ defaultProject?: string; /** * The deletion date, only available for deleted account. */ deletionDate: string; disableLocalAuth?: boolean; /** * The flag to enable dynamic throttling. */ dynamicThrottlingEnabled?: boolean; /** * The encryption properties for this resource. */ encryption?: outputs.cognitiveservices.EncryptionResponse; /** * Endpoint of the created account. */ endpoint: string; endpoints: { [key: string]: string; }; /** * The internal identifier (deprecated, do not use this property). */ internalId: string; /** * If the resource is migrated from an existing key. */ isMigrated: boolean; /** * The multiregion settings of Cognitive Services account. */ locations?: outputs.cognitiveservices.MultiRegionSettingsResponse; /** * Resource migration token. */ migrationToken?: string; /** * A collection of rules governing the accessibility from specific network locations. */ networkAcls?: outputs.cognitiveservices.NetworkRuleSetResponse; networkInjections?: outputs.cognitiveservices.NetworkInjectionResponse[]; /** * The private endpoint connection associated with the Cognitive Services account. */ privateEndpointConnections: outputs.cognitiveservices.PrivateEndpointConnectionResponse[]; /** * Gets the status of the cognitive services account at the time the operation was called. */ provisioningState: string; /** * Whether or not public endpoint access is allowed for this account. */ publicNetworkAccess?: string; quotaLimit: outputs.cognitiveservices.QuotaLimitResponse; /** * Cognitive Services Rai Monitor Config. */ raiMonitorConfig?: outputs.cognitiveservices.RaiMonitorConfigResponse; restrictOutboundNetworkAccess?: boolean; /** * The scheduled purge date, only available for deleted account. */ scheduledPurgeDate: string; /** * Sku change info of account. */ skuChangeInfo: outputs.cognitiveservices.SkuChangeInfoResponse; /** * The storage accounts for this resource. */ userOwnedStorage?: outputs.cognitiveservices.UserOwnedStorageResponse[]; } /** * accountPropertiesResponseProvideDefaults sets the appropriate defaults for AccountPropertiesResponse */ function accountPropertiesResponseProvideDefaults(val: AccountPropertiesResponse): AccountPropertiesResponse; /** * Type modeling the protocol and version used by an agent/exposed by a deployment. */ interface AgentProtocolVersionResponse { /** * The protocol used by the agent/exposed by a deployment. */ protocol?: string; /** * The version of the protocol. */ version?: string; } /** * Type modeling a reference to a version of an agent definition. */ interface AgentReferencePropertiesResponse { /** * Gets the agent's unique identifier within the organization (subscription). */ agentId?: string; /** * Gets the agent's name (unique within the project/app). */ agentName?: string; } /** * Agent Reference resource */ interface AgentReferenceResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * [Required] Additional attributes of the entity. */ properties: outputs.cognitiveservices.AgentReferencePropertiesResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.cognitiveservices.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Resource type representing an agentic application as a management construct. */ interface AgenticApplicationPropertiesResponse { /** * The EntraId Agentic Blueprint of the application. */ agentIdentityBlueprint?: outputs.cognitiveservices.AssignedIdentityResponse; /** * The list of agent definitions comprising this application, returned as references to the objects under the parent project; use this to obtain a flat list of all agent-version pairs represented by this application. */ agents?: outputs.cognitiveservices.AgentReferencePropertiesResponse[]; /** * Gets or sets the authorization policy associated with this agentic application instance. */ authorizationPolicy?: outputs.cognitiveservices.ChannelsBuiltInAuthorizationPolicyResponse | outputs.cognitiveservices.OrganizationSharedBuiltInAuthorizationPolicyResponse | outputs.cognitiveservices.RoleBasedBuiltInAuthorizationPolicyResponse; /** * The application's dedicated invocation endpoint. */ baseUrl?: string; /** * The (default) agent instance identity of the application. */ defaultInstanceIdentity?: outputs.cognitiveservices.AssignedIdentityResponse; /** * The asset description text. */ description?: string; /** * The display name of the application. */ displayName?: string; /** * Enabledstate of the application. */ isEnabled: boolean; /** * Provisioning state of the application. */ provisioningState: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; /** * Gets or sets the traffic routing policy for the application's deployments. */ trafficRoutingPolicy?: outputs.cognitiveservices.ApplicationTrafficRoutingPolicyResponse; } /** * This connection type covers the generic ApiKey auth connection categories, for examples: * AzureOpenAI: * Category:= AzureOpenAI * AuthType:= ApiKey (as type discriminator) * Credentials:= {ApiKey} as .ApiKey * Target:= {ApiBase} * * CognitiveService: * Category:= CognitiveService * AuthType:= ApiKey (as type discriminator) * Credentials:= {SubscriptionKey} as ApiKey * Target:= ServiceRegion={serviceRegion} * * CognitiveSearch: * Category:= CognitiveSearch * AuthType:= ApiKey (as type discriminator) * Credentials:= {Key} as ApiKey * Target:= {Endpoint} * * Use Metadata property bag for ApiType, ApiVersion, Kind and other metadata fields */ interface ApiKeyAuthConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'ApiKey'. */ authType: "ApiKey"; /** * Category of the connection */ category?: string; createdByWorkspaceArmId: string; /** * Api key object for connection credential. */ credentials?: outputs.cognitiveservices.ConnectionApiKeyResponse; /** * Provides the error message if the connection fails */ error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; /** * Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'. */ peRequirement?: string; /** * Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'. */ peStatus?: string; sharedUserList?: string[]; /** * The connection URL to be used. */ target?: string; useWorkspaceManagedIdentity?: boolean; } /** * The api properties for special APIs. */ interface ApiPropertiesResponse { /** * (Metrics Advisor Only) The Azure AD Client Id (Application Id). */ aadClientId?: string; /** * (Metrics Advisor Only) The Azure AD Tenant Id. */ aadTenantId?: string; /** * (Personalization Only) The flag to enable statistics of Bing Search. */ eventHubConnectionString?: string; /** * (QnAMaker Only) The Azure Search endpoint id of QnAMaker. */ qnaAzureSearchEndpointId?: string; /** * (QnAMaker Only) The Azure Search endpoint key of QnAMaker. */ qnaAzureSearchEndpointKey?: string; /** * (QnAMaker Only) The runtime endpoint of QnAMaker. */ qnaRuntimeEndpoint?: string; /** * (Bing Search Only) The flag to enable statistics of Bing Search. */ statisticsEnabled?: boolean; /** * (Personalization Only) The storage account connection string. */ storageAccountConnectionString?: string; /** * (Metrics Advisor Only) The super user of Metrics Advisor. */ superUser?: string; /** * (Metrics Advisor Only) The website name of Metrics Advisor. */ websiteName?: string; } /** * Type representing an application traffic policy as a property of an agentic application. */ interface ApplicationTrafficRoutingPolicyResponse { /** * Methodology used to route traffic to the application's deployments. */ protocol?: string; /** * Gets or sets the collection of traffic routing rules. */ rules?: outputs.cognitiveservices.TrafficRoutingRuleResponse[]; } /** * Type representing an identity assignment */ interface AssignedIdentityResponse { /** * The client ID of the identity. */ clientId: string; /** * Specifies the kind of Entra identity described by this object. */ kind: string; /** * The principal ID of the identity. */ principalId: string; /** * Represents the provisioning state of an identity resource. */ provisioningState: string; /** * The subject of this identity assignment. */ subject?: string; /** * The tenant ID of the identity. */ tenantId: string; /** * Enumeration of identity types, from the perspective of management. */ type: string; } /** * The call rate limit Cognitive Services account. */ interface CallRateLimitResponse { /** * The count value of Call Rate Limit. */ count?: number; /** * The renewal period in seconds of Call Rate Limit. */ renewalPeriod?: number; rules?: outputs.cognitiveservices.ThrottlingRuleResponse[]; } interface CapabilityHostResponse { /** * List of AI services connections. */ aiServicesConnections?: string[]; /** * Kind of this capability host. */ capabilityHostKind?: string; /** * Customer subnet info to help set up this capability host. */ customerSubnet?: string; /** * The asset description text. */ description?: string; /** * Provisioning state for the CapabilityHost. */ provisioningState: string; /** * List of connection names from those available in the account or project to be used as a storage resource. */ storageConnections?: string[]; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; /** * List of connection names from those available in the account or project to be used for Thread storage. */ threadStorageConnections?: string[]; /** * List of connection names from those available in the account or project to be used for vector database (e.g. CosmosDB). */ vectorStoreConnections?: string[]; } /** * Represents a built-in authorization policy specific to Azure Bot Service/Channels authentication. */ interface ChannelsBuiltInAuthorizationPolicyResponse { /** * Authorization scheme type. * Expected value is 'Channels'. */ type: "Channels"; } /** * Cognitive Services account commitment period. */ interface CommitmentPeriodResponse { /** * Commitment period commitment count. */ count?: number; /** * Commitment period end date. */ endDate: string; /** * Cognitive Services account commitment quota. */ quota: outputs.cognitiveservices.CommitmentQuotaResponse; /** * Commitment period start date. */ startDate: string; /** * Commitment period commitment tier. */ tier?: string; } /** * The commitment plan association. */ interface CommitmentPlanAssociationResponse { /** * The Azure resource id of the commitment plan. */ commitmentPlanId?: string; /** * The location of of the commitment plan. */ commitmentPlanLocation?: string; } /** * Properties of Cognitive Services account commitment plan. */ interface CommitmentPlanPropertiesResponse { /** * AutoRenew commitment plan. */ autoRenew?: boolean; /** * Commitment plan guid. */ commitmentPlanGuid?: string; /** * Cognitive Services account commitment period. */ current?: outputs.cognitiveservices.CommitmentPeriodResponse; /** * Account hosting model. */ hostingModel?: string; /** * Cognitive Services account commitment period. */ last: outputs.cognitiveservices.CommitmentPeriodResponse; /** * Cognitive Services account commitment period. */ next?: outputs.cognitiveservices.CommitmentPeriodResponse; /** * Commitment plan type. */ planType?: string; /** * The list of ProvisioningIssue. */ provisioningIssues: string[]; /** * Gets the status of the resource at the time the operation was called. */ provisioningState: string; } /** * Cognitive Services account commitment quota. */ interface CommitmentQuotaResponse { /** * Commitment quota quantity. */ quantity?: number; /** * Commitment quota unit. */ unit?: string; } interface ConnectionAccessKeyResponse { accessKeyId?: string; secretAccessKey?: string; } /** * Account key object for connection credential. */ interface ConnectionAccountKeyResponse { key?: string; } /** * Api key object for connection credential. */ interface ConnectionApiKeyResponse { key?: string; } interface ConnectionManagedIdentityResponse { clientId?: string; resourceId?: string; } /** * ClientId and ClientSecret are required. Other properties are optional * depending on each OAuth2 provider's implementation. */ interface ConnectionOAuth2Response { /** * Required by Concur connection category */ authUrl?: string; /** * Client id in the format of UUID */ clientId?: string; clientSecret?: string; /** * Required by GoogleAdWords connection category */ developerToken?: string; password?: string; /** * Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho * where user needs to get RefreshToken offline */ refreshToken?: string; /** * Required by QuickBooks and Xero connection categories */ tenantId?: string; /** * Concur, ServiceNow auth server AccessToken grant type is 'Password' * which requires UsernamePassword */ username?: string; } interface ConnectionPersonalAccessTokenResponse { pat?: string; } interface ConnectionServicePrincipalResponse { clientId?: string; clientSecret?: string; tenantId?: string; } interface ConnectionSharedAccessSignatureResponse { sas?: string; } interface ConnectionUsernamePasswordResponse { password?: string; /** * Optional, required by connections like SalesForce for extra security in addition to UsernamePassword */ securityToken?: string; username?: string; } /** * Gets or sets the source to which filter applies. */ interface CustomBlocklistConfigResponse { /** * If blocking would occur. */ blocking?: boolean; /** * Name of ContentFilter. */ blocklistName?: string; /** * Content source to apply the Content Filters. */ source?: string; } /** * Category:= CustomKeys * AuthType:= CustomKeys (as type discriminator) * Credentials:= {CustomKeys} as CustomKeys * Target:= {any value} * Use Metadata property bag for ApiVersion and other metadata fields */ interface CustomKeysConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'CustomKeys'. */ authType: "CustomKeys"; /** * Category of the connection */ category?: string; createdByWorkspaceArmId: string; /** * Custom Keys credential object */ credentials?: outputs.cognitiveservices.CustomKeysResponse; /** * Provides the error message if the connection fails */ error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; /** * Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'. */ peRequirement?: string; /** * Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'. */ peStatus?: string; sharedUserList?: string[]; /** * The connection URL to be used. */ target?: string; useWorkspaceManagedIdentity?: boolean; } /** * Custom Keys credential object */ interface CustomKeysResponse { keys?: { [key: string]: string; }; } /** * Internal use only. */ interface DeploymentCapacitySettingsResponse { /** * The designated capacity. */ designatedCapacity?: number; /** * The priority of this capacity setting. */ priority?: number; } /** * Properties of Cognitive Services account deployment model. */ interface DeploymentModelResponse { /** * The call rate limit Cognitive Services account. */ callRateLimit: outputs.cognitiveservices.CallRateLimitResponse; /** * Deployment model format. */ format?: string; /** * Deployment model name. */ name?: string; /** * Deployment model publisher. */ publisher?: string; /** * Optional. Deployment model source ARM resource ID. */ source?: string; /** * Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID. */ sourceAccount?: string; /** * Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API. */ version?: string; } /** * Properties of Cognitive Services account deployment. */ interface DeploymentPropertiesResponse { /** * The call rate limit Cognitive Services account. */ callRateLimit: outputs.cognitiveservices.CallRateLimitResponse; /** * The capabilities. */ capabilities: { [key: string]: string; }; /** * Internal use only. */ capacitySettings?: outputs.cognitiveservices.DeploymentCapacitySettingsResponse; /** * The current capacity. */ currentCapacity?: number; /** * If the dynamic throttling is enabled. */ dynamicThrottlingEnabled: boolean; /** * Properties of Cognitive Services account deployment model. */ model?: outputs.cognitiveservices.DeploymentModelResponse; /** * The name of parent deployment. */ parentDeploymentName?: string; /** * Gets the status of the resource at the time the operation was called. */ provisioningState: string; /** * The name of RAI policy. */ raiPolicyName?: string; rateLimits: outputs.cognitiveservices.ThrottlingRuleResponse[]; /** * Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.) */ scaleSettings?: outputs.cognitiveservices.DeploymentScaleSettingsResponse; /** * Specifies the deployment name that should serve requests when the request would have otherwise been throttled due to reaching current deployment throughput limit. */ spilloverDeploymentName?: string; /** * Deployment model version upgrade option. */ versionUpgradeOption?: string; } /** * Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.) */ interface DeploymentScaleSettingsResponse { /** * Deployment active capacity. This value might be different from `capacity` if customer recently updated `capacity`. */ activeCapacity: number; /** * Deployment capacity. */ capacity?: number; /** * Deployment scale type. */ scaleType?: string; } /** * Properties to configure Encryption */ interface EncryptionResponse { /** * Enumerates the possible value of keySource for Encryption */ keySource?: string; /** * Properties of KeyVault */ keyVaultProperties?: outputs.cognitiveservices.KeyVaultPropertiesResponse; } /** * encryptionResponseProvideDefaults sets the appropriate defaults for EncryptionResponse */ function encryptionResponseProvideDefaults(val: EncryptionResponse): EncryptionResponse; /** * Properties to EncryptionScope */ interface EncryptionScopePropertiesResponse { /** * Enumerates the possible value of keySource for Encryption */ keySource?: string; /** * Properties of KeyVault */ keyVaultProperties?: outputs.cognitiveservices.KeyVaultPropertiesResponse; /** * Gets the status of the resource at the time the operation was called. */ provisioningState: string; /** * The encryptionScope state. */ state?: string; } /** * encryptionScopePropertiesResponseProvideDefaults sets the appropriate defaults for EncryptionScopePropertiesResponse */ function encryptionScopePropertiesResponseProvideDefaults(val: EncryptionScopePropertiesResponse): EncryptionScopePropertiesResponse; /** * FQDN Outbound Rule for the managed network of a cognitive services account. */ interface FqdnOutboundRuleResponse { /** * Category of a managed network Outbound Rule of a cognitive services account. */ category?: string; destination?: string; /** * Error information about an outbound rule of a cognitive services account if RuleStatus is failed. */ errorInformation: string; parentRuleNames: string[]; /** * Type of a managed network Outbound Rule of a cognitive services account. */ status?: string; /** * Type of a managed network Outbound Rule of a cognitive services account. * Expected value is 'FQDN'. */ type: "FQDN"; } /** * Represents a hosted agent deployment where the underlying infrastructure is owned by the platform. */ interface HostedAgentDeploymentResponse { /** * Returns a flat list of agent:version deployed in this deployment. */ agents?: outputs.cognitiveservices.VersionedAgentReferenceResponse[]; /** * Gets or sets the unique identifier of the deployment. */ deploymentId?: string; /** * Specifies the type of deployment for an agent, indicating how the underlying compute and network infrastructure is managed. * Expected value is 'Hosted'. */ deploymentType: "Hosted"; /** * The asset description text. */ description?: string; /** * Gets or sets the display name of the deployment. */ displayName?: string; /** * Gets or sets the maximum number of replicas for this hosted deployment. */ maxReplicas?: number; /** * Gets or sets the minimum number of replicas for this hosted deployment. */ minReplicas?: number; /** * Gets or sets the supported protocol types and versions exposed by this deployment. */ protocols?: outputs.cognitiveservices.AgentProtocolVersionResponse[]; /** * Gets or sets the provisioning state of the agent deployment. */ provisioningState: string; /** * Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents). */ state?: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The identity type. */ type?: string; /** * The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} */ userAssignedIdentities?: { [key: string]: outputs.cognitiveservices.UserAssignedIdentityResponse; }; } /** * A rule governing the accessibility from a specific ip address or ip range. */ interface IpRuleResponse { /** * An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78). */ value: string; } /** * Properties to configure keyVault Properties */ interface KeyVaultPropertiesResponse { identityClientId?: string; /** * Name of the Key from KeyVault */ keyName?: string; /** * Uri of KeyVault */ keyVaultUri?: string; /** * Version of the Key from KeyVault */ keyVersion?: string; } /** * Represents a managed agent deployment where the underlying infrastructure is managed by the platform in the deployer's subscription. */ interface ManagedAgentDeploymentResponse { /** * Returns a flat list of agent:version deployed in this deployment. */ agents?: outputs.cognitiveservices.VersionedAgentReferenceResponse[]; /** * Gets or sets the unique identifier of the deployment. */ deploymentId?: string; /** * Specifies the type of deployment for an agent, indicating how the underlying compute and network infrastructure is managed. * Expected value is 'Managed'. */ deploymentType: "Managed"; /** * The asset description text. */ description?: string; /** * Gets or sets the display name of the deployment. */ displayName?: string; /** * Gets or sets the supported protocol types and versions exposed by this deployment. */ protocols?: outputs.cognitiveservices.AgentProtocolVersionResponse[]; /** * Gets or sets the provisioning state of the agent deployment. */ provisioningState: string; /** * Gets or sets the current operational state of the deployment (and, intrinsically, of the comprising agents). */ state?: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } interface ManagedIdentityAuthTypeConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'ManagedIdentity'. */ authType: "ManagedIdentity"; /** * Category of the connection */ category?: string; createdByWorkspaceArmId: string; credentials?: outputs.cognitiveservices.ConnectionManagedIdentityResponse; /** * Provides the error message if the connection fails */ error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; /** * Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'. */ peRequirement?: string; /** * Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'. */ peStatus?: string; sharedUserList?: string[]; /** * The connection URL to be used. */ target?: string; useWorkspaceManagedIdentity?: boolean; } /** * Status of the Provisioning for the managed network of a cognitive services account. */ interface ManagedNetworkProvisionStatusResponse { /** * Status for the managed network of a cognitive services account. */ status?: string; } interface ManagedNetworkSettingsExResponse { changeableIsolationModes: string[]; /** * Public IP address assigned to the Azure Firewall. */ firewallPublicIpAddress: string; /** * Firewall Sku used for FQDN Rules */ firewallSku?: string; /** * Isolation mode for the managed network of a cognitive services account. */ isolationMode?: string; /** * The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled. */ managedNetworkKind?: string; networkId: string; /** * Dictionary of */ outboundRules?: { [key: string]: outputs.cognitiveservices.FqdnOutboundRuleResponse | outputs.cognitiveservices.PrivateEndpointOutboundRuleResponse | outputs.cognitiveservices.ServiceTagOutboundRuleResponse; }; /** * The provisioning state of the managed network settings. */ provisioningState: string; /** * Status of the Provisioning for the managed network of a cognitive services account. */ status?: outputs.cognitiveservices.ManagedNetworkProvisionStatusResponse; } /** * The properties of the managed network settings of a cognitive services account. */ interface ManagedNetworkSettingsPropertiesResponse { /** * Managed Network settings for a cognitive services account. */ managedNetwork?: outputs.cognitiveservices.ManagedNetworkSettingsExResponse; /** * The current deployment state of the managed network resource. The provisioningState is to indicate states for resource provisioning. */ provisioningState: string; } /** * The multiregion settings Cognitive Services account. */ interface MultiRegionSettingsResponse { regions?: outputs.cognitiveservices.RegionSettingResponse[]; /** * Multiregion routing methods. */ routingMethod?: string; } /** * Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources. */ interface NetworkInjectionResponse { /** * Specifies what features in AI Foundry network injection applies to. Currently only supports 'agent' for agent scenarios. 'none' means no network injection. */ scenario?: string; /** * Specify the subnet for which your Agent Client is injected into. */ subnetArmId?: string; /** * Boolean to enable Microsoft Managed Network for subnet delegation */ useMicrosoftManagedNetwork?: boolean; } /** * A set of rules governing the network accessibility. */ interface NetworkRuleSetResponse { /** * Setting for trusted services. */ bypass?: string; /** * The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. */ defaultAction?: string; /** * The list of IP address rules. */ ipRules?: outputs.cognitiveservices.IpRuleResponse[]; /** * The list of virtual network rules. */ virtualNetworkRules?: outputs.cognitiveservices.VirtualNetworkRuleResponse[]; } interface NoneAuthTypeConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'None'. */ authType: "None"; /** * Category of the connection */ category?: string; createdByWorkspaceArmId: string; /** * Provides the error message if the connection fails */ error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; /** * Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'. */ peRequirement?: string; /** * Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'. */ peStatus?: string; sharedUserList?: string[]; /** * The connection URL to be used. */ target?: string; useWorkspaceManagedIdentity?: boolean; } interface OAuth2AuthTypeConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'OAuth2'. */ authType: "OAuth2"; /** * Category of the connection */ category?: string; createdByWorkspaceArmId: string; /** * ClientId and ClientSecret are required. Other properties are optional * depending on each OAuth2 provider's implementation. */ credentials?: outputs.cognitiveservices.ConnectionOAuth2Response; /** * Provides the error message if the connection fails */ error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; /** * Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'. */ peRequirement?: string; /** * Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'. */ peStatus?: string; sharedUserList?: string[]; /** * The connection URL to be used. */ target?: string; useWorkspaceManagedIdentity?: boolean; } /** * Built-in authorization policy scoped to organization/tenant. */ interface OrganizationSharedBuiltInAuthorizationPolicyResponse { /** * Authorization scheme type. * Expected value is 'OrganizationScope'. */ type: "OrganizationScope"; } interface PATAuthTypeConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'PAT'. */ authType: "PAT"; /** * Category of the connection */ category?: string; createdByWorkspaceArmId: string; credentials?: outputs.cognitiveservices.ConnectionPersonalAccessTokenResponse; /** * Provides the error message if the connection fails */ error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; /** * Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'. */ peRequirement?: string; /** * Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'. */ peStatus?: string; sharedUserList?: string[]; /** * The connection URL to be used. */ target?: string; useWorkspaceManagedIdentity?: boolean; } /** * Properties of the PrivateEndpointConnectProperties. */ interface PrivateEndpointConnectionPropertiesResponse { /** * The private link resource group ids. */ groupIds?: string[]; /** * The resource of private end point. */ privateEndpoint?: outputs.cognitiveservices.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.cognitiveservices.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; } /** * The Private Endpoint Connection resource. */ interface PrivateEndpointConnectionResponse { /** * Resource Etag. */ etag: string; /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The location of the private endpoint connection */ location?: string; /** * The name of the resource */ name: string; /** * Resource properties. */ properties?: outputs.cognitiveservices.PrivateEndpointConnectionPropertiesResponse; /** * Metadata pertaining to creation and last modification of the resource. */ systemData: outputs.cognitiveservices.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Private Endpoint destination for an outbound rule. */ interface PrivateEndpointOutboundRuleDestinationResponse { /** * The Azure resource ID of the target private endpoint service. */ serviceResourceId?: string; /** * The subresource of the target service to connect to. */ subresourceTarget?: string; } /** * Private Endpoint outbound rule for the managed network of a cognitive services account. */ interface PrivateEndpointOutboundRuleResponse { /** * Category of a managed network Outbound Rule of a cognitive services account. */ category?: string; /** * Private Endpoint destination. */ destination?: outputs.cognitiveservices.PrivateEndpointOutboundRuleDestinationResponse; /** * Error information about an outbound rule of a cognitive services account if RuleStatus is failed. */ errorInformation: string; /** * List of FQDNs associated with the private endpoint outbound rule. */ fqdns?: string[]; parentRuleNames: string[]; /** * Type of a managed network Outbound Rule of a cognitive services account. */ status?: string; /** * Type of a managed network Outbound Rule of a cognitive services account. * Expected value is 'PrivateEndpoint'. */ type: "PrivateEndpoint"; } /** * The Private Endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } interface ProjectCapabilityHostResponse { /** * List of AI services connections. */ aiServicesConnections?: string[]; /** * Provisioning state for the CapabilityHost. */ provisioningState: string; /** * List of connection names from those available in the account or project to be used as a storage resource. */ storageConnections?: string[]; /** * List of connection names from those available in the account or project to be used for Thread storage. */ threadStorageConnections?: string[]; /** * List of connection names from those available in the account or project to be used for vector database (e.g. CosmosDB). */ vectorStoreConnections?: string[]; } /** * Properties of Cognitive Services Project'. */ interface ProjectPropertiesResponse { /** * The description of the Cognitive Services Project. */ description?: string; /** * The display name of the Cognitive Services Project. */ displayName?: string; /** * The list of endpoint for this Cognitive Services Project. */ endpoints: { [key: string]: string; }; /** * Indicates whether the project is the default project for the account. */ isDefault: boolean; /** * Gets the status of the cognitive services project at the time the operation was called. */ provisioningState: string; } interface QuotaLimitResponse { count?: number; renewalPeriod?: number; rules?: outputs.cognitiveservices.ThrottlingRuleResponse[]; } /** * RAI Custom Blocklist Item properties. */ interface RaiBlocklistItemPropertiesResponse { /** * If the pattern is a regex pattern. */ isRegex?: boolean; /** * Pattern to match against. */ pattern?: string; } /** * RAI Custom Blocklist properties. */ interface RaiBlocklistPropertiesResponse { /** * Description of the block list. */ description?: string; } /** * RAI External SafetyProvider schema properties. */ interface RaiExternalSafetyProviderSchemaPropertiesResponse { /** * Creation time of the safety provider. */ createdAt: string; /** * The Key Vault URI that contains the api key for safety provider urls. */ keyVaultUri?: string; /** * Last modified time of the safety provider. */ lastModifiedAt: string; /** * The managed identity to access the Key Vault. */ managedIdentity?: string; /** * Safety provider mode sync/async. */ mode?: string; /** * The unique identifier of the safety provider. */ providerId?: string; /** * Name of the safety provider. */ providerName?: string; /** * The name of the secret in Key Vault that contains the api key to access the webhook. */ secretName?: string; /** * Webhook URL for the safety provider. */ url?: string; } /** * Cognitive Services Rai Monitor Config. */ interface RaiMonitorConfigResponse { /** * The storage resource Id. */ adxStorageResourceId?: string; /** * The identity client Id to access the storage. */ identityClientId?: string; } /** * Azure OpenAI Content Filter. */ interface RaiPolicyContentFilterResponse { /** * If blocking would occur. */ blocking?: boolean; /** * If the ContentFilter is enabled. */ enabled?: boolean; /** * Name of ContentFilter. */ name?: string; /** * Level at which content is filtered. */ severityThreshold?: string; /** * Content source to apply the Content Filters. */ source?: string; } /** * Azure OpenAI Content Filter. */ interface RaiPolicyContentFilterSubscriptionRaiPolicyResponse { /** * The action types to apply to the content filters */ action?: string; /** * If blocking would occur. */ blocking?: boolean; /** * If the ContentFilter is enabled. */ enabled?: boolean; /** * Name of ContentFilter. */ name?: string; /** * Level at which content is filtered. */ severityThreshold?: string; /** * Content source to apply the Content Filters. */ source?: string; } /** * Azure OpenAI Content Filters properties. */ interface RaiPolicyPropertiesResponse { /** * Name of Rai policy. */ basePolicyName?: string; /** * The list of Content Filters. */ contentFilters?: outputs.cognitiveservices.RaiPolicyContentFilterResponse[]; /** * The list of custom Blocklist. */ customBlocklists?: outputs.cognitiveservices.CustomBlocklistConfigResponse[]; /** * Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2025-06-01. It is the same as 'Deferred' in previous version. */ mode?: string; /** * Content Filters policy type. */ type: string; } /** * Azure OpenAI Content Filters properties. */ interface RaiPolicyPropertiesSubscriptionRaiPolicyResponse { /** * Name of Rai policy. */ basePolicyName?: string; /** * The list of Content Filters. */ contentFilters?: outputs.cognitiveservices.RaiPolicyContentFilterSubscriptionRaiPolicyResponse[]; /** * The list of custom Blocklist. */ customBlocklists?: outputs.cognitiveservices.CustomBlocklistConfigResponse[]; /** * Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2025-06-01. It is the same as 'Deferred' in previous version. */ mode?: string; /** * The list of Safety Providers. */ safetyProviders?: outputs.cognitiveservices.SafetyProviderConfigResponse[]; /** * Content Filters policy type. */ type: string; } /** * Account-level tool label definition. */ interface RaiToolLabelPropertiesAccountScopeResponse { /** * Dictionary of label key-value pairs for the account scope. */ labelValues?: { [key: string]: string; }; } interface RaiToolLabelPropertiesProjectScopesItemResponse { /** * Dictionary of label key-value pairs for the project scope. */ labelValues: { [key: string]: string; }; /** * Project name to which this scope applies. */ project: string; } /** * RAI Tool Label properties. */ interface RaiToolLabelPropertiesResponse { /** * Account-level tool label definition. */ accountScope?: outputs.cognitiveservices.RaiToolLabelPropertiesAccountScopeResponse; /** * List of project-level tool label definitions. */ projectScopes?: outputs.cognitiveservices.RaiToolLabelPropertiesProjectScopesItemResponse[]; /** * The unique tool connection name, e.g., 'Web_Search'. */ toolConnectionName: string; } /** * RAI Custom Topic properties. */ interface RaiTopicPropertiesResponse { /** * Creation time of the custom topic. */ createdAt?: string; /** * Description of the custom topic. */ description?: string; /** * Failed reason if the status is Failed. */ failedReason?: string; /** * Last modified time of the custom topic. */ lastModifiedAt?: string; /** * Sample blob url for the custom topic. */ sampleBlobUrl?: string; /** * Status of the custom topic. */ status?: string; /** * The unique identifier of the custom topic. */ topicId?: string; /** * The name of the custom topic. */ topicName?: string; } /** * The call rate limit Cognitive Services account. */ interface RegionSettingResponse { /** * Maps the region to the regional custom subdomain. */ customsubdomain?: string; /** * Name of the region. */ name?: string; /** * A value for priority or weighted routing methods. */ value?: number; } interface RequestMatchPatternResponse { method?: string; path?: string; } /** * Built-in role-based authorization policy. */ interface RoleBasedBuiltInAuthorizationPolicyResponse { /** * Authorization scheme type. * Expected value is 'Default'. */ type: "Default"; } interface SASAuthTypeConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'SAS'. */ authType: "SAS"; /** * Category of the connection */ category?: string; createdByWorkspaceArmId: string; credentials?: outputs.cognitiveservices.ConnectionSharedAccessSignatureResponse; /** * Provides the error message if the connection fails */ error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; /** * Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'. */ peRequirement?: string; /** * Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'. */ peStatus?: string; sharedUserList?: string[]; /** * The connection URL to be used. */ target?: string; useWorkspaceManagedIdentity?: boolean; } /** * Gets or sets the source to which safety providers applies. */ interface SafetyProviderConfigResponse { /** * If blocking would occur. */ blocking?: boolean; /** * Name of RAI Safety Provider. */ safetyProviderName?: string; /** * Content source to apply the Content Filters. */ source?: string; } interface ServicePrincipalAuthTypeConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'ServicePrincipal'. */ authType: "ServicePrincipal"; /** * Category of the connection */ category?: string; createdByWorkspaceArmId: string; credentials?: outputs.cognitiveservices.ConnectionServicePrincipalResponse; /** * Provides the error message if the connection fails */ error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; /** * Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'. */ peRequirement?: string; /** * Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'. */ peStatus?: string; sharedUserList?: string[]; /** * The connection URL to be used. */ target?: string; useWorkspaceManagedIdentity?: boolean; } /** * Service Tag destination for an outbound rule. */ interface ServiceTagOutboundRuleDestinationResponse { /** * The action for the service tag outbound rule. */ action?: string; /** * Optional address prefixes. If provided, the serviceTag property will be ignored. */ addressPrefixes?: string[]; /** * Destination port ranges. */ portRanges?: string; /** * Network protocol used by the service tag rule. */ protocol?: string; /** * Name of the Azure service tag to target. */ serviceTag?: string; } /** * Service Tag outbound rule for the managed network of a cognitive services account. */ interface ServiceTagOutboundRuleResponse { /** * Category of a managed network Outbound Rule of a cognitive services account. */ category?: string; /** * Service Tag destination. */ destination?: outputs.cognitiveservices.ServiceTagOutboundRuleDestinationResponse; /** * Error information about an outbound rule of a cognitive services account if RuleStatus is failed. */ errorInformation: string; parentRuleNames: string[]; /** * Type of a managed network Outbound Rule of a cognitive services account. */ status?: string; /** * Type of a managed network Outbound Rule of a cognitive services account. * Expected value is 'ServiceTag'. */ type: "ServiceTag"; } /** * SkuCapability indicates the capability of a certain feature. */ interface SkuCapabilityResponse { /** * The name of the SkuCapability. */ name?: string; /** * The value of the SkuCapability. */ value?: string; } /** * Sku change info of account. */ interface SkuChangeInfoResponse { /** * Gets the count of downgrades. */ countOfDowngrades?: number; /** * Gets the count of upgrades after downgrades. */ countOfUpgradesAfterDowngrades?: number; /** * Gets the last change date. */ lastChangeDate?: string; } /** * The resource model definition representing SKU */ interface SkuResponse { /** * If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. */ capacity?: number; /** * If the service has different generations of hardware, for the same SKU, then that can be captured here. */ family?: string; /** * The name of the SKU. Ex - P3. It is typically a letter+number code */ name: string; /** * The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. */ size?: string; /** * This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. */ tier?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } interface ThrottlingRuleResponse { count?: number; dynamicThrottlingEnabled?: boolean; key?: string; matchPatterns?: outputs.cognitiveservices.RequestMatchPatternResponse[]; minCount?: number; renewalPeriod?: number; } /** * Represents a rule for routing traffic to a specific deployment. */ interface TrafficRoutingRuleResponse { /** * The unique identifier of the deployment to which traffic is routed by this rule. */ deploymentId?: string; /** * A user-provided description for this traffic routing rule. */ description?: string; /** * The identifier of this traffic routing rule. */ ruleId?: string; /** * Gets or sets the percentage of traffic allocated to this instance. */ trafficPercentage?: number; } /** * User-assigned managed identity. */ interface UserAssignedIdentityResponse { /** * Client App Id associated with this identity. */ clientId: string; /** * Azure Active Directory principal ID associated with this Identity. */ principalId: string; } /** * The user owned AML account for Cognitive Services account. */ interface UserOwnedAmlWorkspaceResponse { /** * Identity Client id of a AML account resource. */ identityClientId?: string; /** * Full resource id of a AML account resource. */ resourceId?: string; } /** * The user owned storage for Cognitive Services account. */ interface UserOwnedStorageResponse { identityClientId?: string; /** * Full resource id of a Microsoft.Storage resource. */ resourceId?: string; } interface UsernamePasswordAuthTypeConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'UsernamePassword'. */ authType: "UsernamePassword"; /** * Category of the connection */ category?: string; createdByWorkspaceArmId: string; credentials?: outputs.cognitiveservices.ConnectionUsernamePasswordResponse; /** * Provides the error message if the connection fails */ error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; /** * Specifies how private endpoints are used with this connection: 'Required', 'NotRequired', or 'NotApplicable'. */ peRequirement?: string; /** * Specifies the status of private endpoints for this connection: 'Inactive', 'Active', or 'NotApplicable'. */ peStatus?: string; sharedUserList?: string[]; /** * The connection URL to be used. */ target?: string; useWorkspaceManagedIdentity?: boolean; } /** * Type modeling a reference to a version of an agent definition. */ interface VersionedAgentReferenceResponse { /** * Gets the agent's unique identifier within the organization (subscription). */ agentId?: string; /** * Gets the agent's name (unique within the project/app). */ agentName?: string; /** * Gets the agent's version (unique for each agent lineage). */ agentVersion?: string; } /** * A rule governing the accessibility from a specific virtual network. */ interface VirtualNetworkRuleResponse { /** * Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. */ id: string; /** * Ignore missing vnet service endpoint or not. */ ignoreMissingVnetServiceEndpoint?: boolean; /** * Gets the state of virtual network rule. */ state?: string; } } export declare namespace communication { /** * A class that represents a VerificationStatus record. */ interface DnsRecordResponse { /** * Name of the DNS record. */ name: string; /** * Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec. */ ttl: number; /** * Type of the DNS record. Example: TXT */ type: string; /** * Value of the DNS record. */ value: string; } /** * List of DnsRecord */ interface DomainPropertiesVerificationRecordsResponse { /** * A class that represents a VerificationStatus record. */ dKIM?: outputs.communication.DnsRecordResponse; /** * A class that represents a VerificationStatus record. */ dKIM2?: outputs.communication.DnsRecordResponse; /** * A class that represents a VerificationStatus record. */ dMARC?: outputs.communication.DnsRecordResponse; /** * A class that represents a VerificationStatus record. */ domain?: outputs.communication.DnsRecordResponse; /** * A class that represents a VerificationStatus record. */ sPF?: outputs.communication.DnsRecordResponse; } /** * List of VerificationStatusRecord */ interface DomainPropertiesVerificationStatesResponse { /** * A class that represents a VerificationStatus record. */ dKIM?: outputs.communication.VerificationStatusRecordResponse; /** * A class that represents a VerificationStatus record. */ dKIM2?: outputs.communication.VerificationStatusRecordResponse; /** * A class that represents a VerificationStatus record. */ dMARC?: outputs.communication.VerificationStatusRecordResponse; /** * A class that represents a VerificationStatus record. */ domain?: outputs.communication.VerificationStatusRecordResponse; /** * A class that represents a VerificationStatus record. */ sPF?: outputs.communication.VerificationStatusRecordResponse; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.communication.UserAssignedIdentityResponse; }; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * A class that represents a VerificationStatus record. */ interface VerificationStatusRecordResponse { /** * Error code. This property will only be present if the status is UnableToVerify. */ errorCode: string; /** * Status of the verification operation. */ status: string; } } export declare namespace community { /** * Details of the Community CommunityTraining Identity Configuration */ interface IdentityConfigurationPropertiesResponse { /** * The name of the authentication policy registered in ADB2C for the Community Training Resource */ b2cAuthenticationPolicy?: string; /** * The name of the password reset policy registered in ADB2C for the Community Training Resource */ b2cPasswordResetPolicy?: string; /** * The clientId of the application registered in the selected identity provider for the Community Training Resource */ clientId: string; /** * The client secret of the application registered in the selected identity provider for the Community Training Resource */ clientSecret: string; /** * The custom login parameters for the Community Training Resource */ customLoginParameters?: string; /** * The domain name of the selected identity provider for the Community Training Resource */ domainName: string; /** * The identity type of the Community Training Resource */ identityType: string; /** * To indicate whether the Community Training Resource has Teams enabled */ teamsEnabled?: boolean; /** * The tenantId of the selected identity provider for the Community Training Resource */ tenantId: string; } /** * identityConfigurationPropertiesResponseProvideDefaults sets the appropriate defaults for IdentityConfigurationPropertiesResponse */ function identityConfigurationPropertiesResponseProvideDefaults(val: IdentityConfigurationPropertiesResponse): IdentityConfigurationPropertiesResponse; /** * The resource model definition representing SKU */ interface SkuResponse { /** * If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. */ capacity?: number; /** * If the service has different generations of hardware, for the same SKU, then that can be captured here. */ family?: string; /** * The name of the SKU. Ex - P3. It is typically a letter+number code */ name: string; /** * The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. */ size?: string; /** * This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. */ tier?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace compute { /** * The properties of an Access Control Rule Identity. */ interface AccessControlRulesIdentityResponse { /** * The path to the executable. */ exePath?: string; /** * The groupName corresponding to this identity. */ groupName?: string; /** * The name of the identity. */ name: string; /** * The process name of the executable. */ processName?: string; /** * The username corresponding to this identity. */ userName?: string; } /** * The properties of an Access Control Rule Privilege. */ interface AccessControlRulesPrivilegeResponse { /** * The name of the privilege. */ name: string; /** * The HTTP path corresponding to the privilege. */ path: string; /** * The query parameters to match in the path. */ queryParameters?: { [key: string]: string; }; } /** * This is the Access Control Rules specification for an inVMAccessControlProfile version. */ interface AccessControlRulesResponse { /** * A list of identities. */ identities?: outputs.compute.AccessControlRulesIdentityResponse[]; /** * A list of privileges. */ privileges?: outputs.compute.AccessControlRulesPrivilegeResponse[]; /** * A list of role assignments. */ roleAssignments?: outputs.compute.AccessControlRulesRoleAssignmentResponse[]; /** * A list of roles. */ roles?: outputs.compute.AccessControlRulesRoleResponse[]; } /** * The properties of an Access Control Rule RoleAssignment. */ interface AccessControlRulesRoleAssignmentResponse { /** * A list of identities that can access the privileges defined by the role. */ identities: string[]; /** * The name of the role. */ role: string; } /** * The properties of an Access Control Rule Role. */ interface AccessControlRulesRoleResponse { /** * The name of the role. */ name: string; /** * A list of privileges needed by this role. */ privileges: string[]; } /** * Enables or disables a capability on the virtual machine or virtual machine scale set. */ interface AdditionalCapabilitiesResponse { /** * The flag that enables or disables hibernation capability on the VM. */ hibernationEnabled?: boolean; /** * The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. */ ultraSSDEnabled?: boolean; } /** * Describes the additional replica set information. */ interface AdditionalReplicaSetResponse { /** * The number of direct drive replicas of the Image Version to be created.This Property is updatable */ regionalReplicaCount?: number; /** * Specifies the storage account type to be used to create the direct drive replicas */ storageAccountType?: string; } /** * Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied. */ interface AdditionalUnattendContentResponse { /** * The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. */ componentName?: string; /** * Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. */ content?: string; /** * The pass name. Currently, the only allowable value is OobeSystem. */ passName?: string; /** * Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. */ settingName?: string; } /** * The API entity reference. */ interface ApiEntityReferenceResponse { /** * The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... */ id?: string; } /** * Api error base. */ interface ApiErrorBaseResponse { /** * The error code. */ code?: string; /** * The error message. */ message?: string; /** * The target of the particular error. */ target?: string; } /** * Api error. */ interface ApiErrorResponse { /** * The error code. */ code?: string; /** * The Api error details */ details?: outputs.compute.ApiErrorBaseResponse[]; /** * The Api inner error */ innererror?: outputs.compute.InnerErrorResponse; /** * The error message. */ message?: string; /** * The target of the particular error. */ target?: string; } /** * Contains the list of gallery applications that should be made available to the VM/VMSS */ interface ApplicationProfileResponse { /** * Specifies the gallery applications that should be made available to the VM/VMSS */ galleryApplications?: outputs.compute.VMGalleryApplicationResponse[]; } /** * The configuration parameters used for performing automatic OS upgrade. */ interface AutomaticOSUpgradePolicyResponse { /** * Whether OS image rollback feature should be disabled. Default value is false. */ disableAutomaticRollback?: boolean; /** * Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false. If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true. */ enableAutomaticOSUpgrade?: boolean; /** * Indicates whether Auto OS Upgrade should undergo deferral. Deferred OS upgrades will send advanced notifications on a per-VM basis that an OS upgrade from rolling upgrades is incoming, via the IMDS tag 'Platform.PendingOSUpgrade'. The upgrade then defers until the upgrade is approved via an ApproveRollingUpgrade call. */ osRollingUpgradeDeferral?: boolean; /** * Indicates whether rolling upgrade policy should be used during Auto OS Upgrade. Default value is false. Auto OS Upgrade will fallback to the default policy if no policy is defined on the VMSS. */ useRollingUpgradePolicy?: boolean; } /** * Specifies the configuration parameters for automatic repairs on the virtual machine scale set. */ interface AutomaticRepairsPolicyResponse { /** * Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false. */ enabled?: boolean; /** * The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 10 minutes (PT10M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M). */ gracePeriod?: string; /** * Type of repair action (replace, restart, reimage) that will be used for repairing unhealthy virtual machines in the scale set. Default value is replace. */ repairAction?: string; } /** * The configuration parameters used while performing automatic AZ balancing. */ interface AutomaticZoneRebalancingPolicyResponse { /** * Specifies whether Automatic AZ Balancing should be enabled on the virtual machine scale set. The default value is false. */ enabled?: boolean; /** * Type of rebalance behavior that will be used for recreating virtual machines in the scale set across availability zones. Default and only supported value for now is CreateBeforeDelete. */ rebalanceBehavior?: string; /** * Type of rebalance strategy that will be used for rebalancing virtual machines in the scale set across availability zones. Default and only supported value for now is Recreate. */ rebalanceStrategy?: string; } /** * Describes the properties of an virtual machine instance view for available patch summary. */ interface AvailablePatchSummaryResponse { /** * The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. */ assessmentActivityId: string; /** * The number of critical or security patches that have been detected as available and not yet installed. */ criticalAndSecurityPatchCount: number; /** * The errors that were encountered during execution of the operation. The details array contains the list of them. */ error: outputs.compute.ApiErrorResponse; /** * The UTC timestamp when the operation began. */ lastModifiedTime: string; /** * The number of all available patches excluding critical and security. */ otherPatchCount: number; /** * The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. */ rebootPending: boolean; /** * The UTC timestamp when the operation began. */ startTime: string; /** * The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." */ status: string; } /** * Specifies the billing related details of a Azure Spot VM or VMSS. Minimum api-version: 2019-03-01. */ interface BillingProfileResponse { /** * Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

Possible values are:

- Any decimal value greater than zero. Example: 0.01538

-1 – indicates default price to be up-to on-demand.

You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

Minimum api-version: 2019-03-01. */ maxPrice?: number; } /** * The instance view of a virtual machine boot diagnostics. */ interface BootDiagnosticsInstanceViewResponse { /** * The console screenshot blob URI. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. */ consoleScreenshotBlobUri: string; /** * The serial console log blob Uri. **Note:** This will **not** be set if boot diagnostics is currently enabled with managed storage. */ serialConsoleLogBlobUri: string; /** * The boot diagnostics status information for the VM. **Note:** It will be set only if there are errors encountered in enabling boot diagnostics. */ status: outputs.compute.InstanceViewStatusResponse; } /** * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. */ interface BootDiagnosticsResponse { /** * Whether boot diagnostics should be enabled on the Virtual Machine. */ enabled?: boolean; /** * Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. */ storageUri?: string; } interface CapacityReservationGroupInstanceViewResponse { /** * List of instance view of the capacity reservations under the capacity reservation group. */ capacityReservations: outputs.compute.CapacityReservationInstanceViewWithNameResponse[]; /** * List of the subscriptions that the capacity reservation group is shared with. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. */ sharedSubscriptionIds: outputs.compute.SubResourceReadOnlyResponse[]; } /** * The instance view of a capacity reservation that provides as snapshot of the runtime properties of the capacity reservation that is managed by the platform and can change outside of control plane operations. */ interface CapacityReservationInstanceViewResponse { /** * The resource status information. */ statuses?: outputs.compute.InstanceViewStatusResponse[]; /** * Unutilized capacity of the capacity reservation. */ utilizationInfo?: outputs.compute.CapacityReservationUtilizationResponse; } /** * The instance view of a capacity reservation that includes the name of the capacity reservation. It is used for the response to the instance view of a capacity reservation group. */ interface CapacityReservationInstanceViewWithNameResponse { /** * The name of the capacity reservation. */ name: string; /** * The resource status information. */ statuses?: outputs.compute.InstanceViewStatusResponse[]; /** * Unutilized capacity of the capacity reservation. */ utilizationInfo?: outputs.compute.CapacityReservationUtilizationResponse; } /** * The parameters of a capacity reservation Profile. */ interface CapacityReservationProfileResponse { /** * Specifies the capacity reservation group resource id that should be used for allocating the virtual machine or scaleset vm instances provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. */ capacityReservationGroup?: outputs.compute.SubResourceResponse; } /** * Represents the capacity reservation utilization in terms of resources allocated. */ interface CapacityReservationUtilizationResponse { /** * The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01. */ currentCapacity: number; /** * A list of all virtual machines resource ids allocated against the capacity reservation. */ virtualMachinesAllocated: outputs.compute.SubResourceReadOnlyResponse[]; } /** * Information of community gallery if current gallery is shared to community */ interface CommunityGalleryInfoResponse { /** * Contains info about whether community gallery sharing is enabled. */ communityGalleryEnabled: boolean; /** * End-user license agreement for community gallery image. */ eula?: string; /** * The prefix of the gallery name that will be displayed publicly. Visible to all users. */ publicNamePrefix?: string; /** * Community gallery public name list. */ publicNames: string[]; /** * Community gallery publisher support email. The email address of the publisher. Visible to all users. */ publisherContact?: string; /** * The link to the publisher website. Visible to all users. */ publisherUri?: string; } /** * Indicates the error details if the background copy of a resource created via the CopyStart operation fails. */ interface CopyCompletionErrorResponse { /** * Indicates the error code if the background copy of a resource created via the CopyStart operation fails. */ errorCode: string; /** * Indicates the error message if the background copy of a resource created via the CopyStart operation fails. */ errorMessage: string; } /** * Data used when creating a disk. */ interface CreationDataResponse { /** * This enumerates the possible sources of a disk's creation. */ createOption: string; /** * Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot. */ elasticSanResourceId?: string; /** * Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk. */ galleryImageReference?: outputs.compute.ImageDiskReferenceResponse; /** * Disk source information for PIR or user images. */ imageReference?: outputs.compute.ImageDiskReferenceResponse; /** * Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default. */ logicalSectorSize?: number; /** * Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled. */ performancePlus?: boolean; /** * If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed. */ provisionedBandwidthCopySpeed?: string; /** * If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state. */ securityDataUri?: string; /** * If createOption is Copy, this is the ARM id of the source snapshot or disk. */ sourceResourceId?: string; /** * If this field is set, this is the unique id identifying the source of this resource. */ sourceUniqueId: string; /** * If createOption is Import, this is the URI of a blob to be imported into a managed disk. */ sourceUri?: string; /** * Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk. */ storageAccountId?: string; /** * If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer). */ uploadSizeBytes?: number; } /** * Contains encryption settings for a data disk image. */ interface DataDiskImageEncryptionResponse { /** * A relative URI containing the resource ID of the disk encryption set. */ diskEncryptionSetId?: string; /** * This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. */ lun: number; } /** * Describes a data disk. */ interface DataDiskResponse { /** * Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** */ caching?: string; /** * Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine data disk. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. **Empty:** This value is used when creating an empty data disk. **Copy:** This value is used to create a data disk from a snapshot or another disk. **Restore:** This value is used to create a data disk from a disk restore point. */ createOption: string; /** * Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the data disk is deleted when VM is deleted. **Detach.** If this value is used, the data disk is retained after VM is deleted. The default value is set to **Detach**. */ deleteOption?: string; /** * Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: **ForceDetach.** detachOption: **ForceDetach** is applicable only for managed data disks. If a previous detachment attempt of the data disk did not complete due to an unexpected failure from the virtual machine and the disk is still not released then use force-detach as a last resort option to detach the disk forcibly from the VM. All writes might not have been flushed when using this detach behavior. **This feature is still in preview**. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. */ detachOption?: string; /** * Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. */ diskIOPSReadWrite: number; /** * Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set. */ diskMBpsReadWrite: number; /** * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. */ diskSizeGB?: number; /** * The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. */ image?: outputs.compute.VirtualHardDiskResponse; /** * Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. */ lun: number; /** * The managed disk parameters. */ managedDisk?: outputs.compute.ManagedDiskParametersResponse; /** * The disk name. */ name?: string; /** * The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. */ sourceResource?: outputs.compute.ApiEntityReferenceResponse; /** * Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset */ toBeDetached?: boolean; /** * The virtual hard disk. */ vhd?: outputs.compute.VirtualHardDiskResponse; /** * Specifies whether writeAccelerator should be enabled or disabled on the disk. */ writeAcceleratorEnabled?: boolean; } /** * Represents the dedicated host unutilized capacity in terms of a specific VM size. */ interface DedicatedHostAllocatableVMResponse { /** * Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity. */ count?: number; /** * VM size in terms of which the unutilized capacity is represented. */ vmSize?: string; } /** * Dedicated host unutilized capacity. */ interface DedicatedHostAvailableCapacityResponse { /** * The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host. */ allocatableVMs?: outputs.compute.DedicatedHostAllocatableVMResponse[]; } interface DedicatedHostGroupInstanceViewResponse { /** * List of instance view of the dedicated hosts under the dedicated host group. */ hosts?: outputs.compute.DedicatedHostInstanceViewWithNameResponse[]; } /** * Enables or disables a capability on the dedicated host group. Minimum api-version: 2022-03-01. */ interface DedicatedHostGroupPropertiesAdditionalCapabilitiesResponse { /** * The flag that enables or disables a capability to have UltraSSD Enabled Virtual Machines on Dedicated Hosts of the Dedicated Host Group. For the Virtual Machines to be UltraSSD Enabled, UltraSSDEnabled flag for the resource needs to be set true as well. The value is defaulted to 'false' when not provided. Please refer to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-enable-ultra-ssd for more details on Ultra SSD feature. **Note:** The ultraSSDEnabled setting can only be enabled for Host Groups that are created as zonal. Minimum api-version: 2022-03-01. */ ultraSSDEnabled?: boolean; } /** * The instance view of a dedicated host. */ interface DedicatedHostInstanceViewResponse { /** * Specifies the unique id of the dedicated physical machine on which the dedicated host resides. */ assetId: string; /** * Unutilized capacity of the dedicated host. */ availableCapacity?: outputs.compute.DedicatedHostAvailableCapacityResponse; /** * The resource status information. */ statuses?: outputs.compute.InstanceViewStatusResponse[]; } /** * The instance view of a dedicated host that includes the name of the dedicated host. It is used for the response to the instance view of a dedicated host group. */ interface DedicatedHostInstanceViewWithNameResponse { /** * Specifies the unique id of the dedicated physical machine on which the dedicated host resides. */ assetId: string; /** * Unutilized capacity of the dedicated host. */ availableCapacity?: outputs.compute.DedicatedHostAvailableCapacityResponse; /** * The name of the dedicated host. */ name: string; /** * The resource status information. */ statuses?: outputs.compute.InstanceViewStatusResponse[]; } /** * Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API. */ interface DefaultVirtualMachineScaleSetInfoResponse { /** * Indicates if the the maximum capacity of the default migrated Virtual Machine Scale Set after its migration will be constrained to a limited number of VMs. */ constrainedMaximumCapacity: boolean; /** * The default Virtual Machine ScaleSet Uri that the Availability Set will be moved to upon triggering a seamless migration via the ConvertToVirtualMachineScaleSet API. */ defaultVirtualMachineScaleSet: outputs.compute.SubResourceResponse; } /** * Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. */ interface DiagnosticsProfileResponse { /** * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. **NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. */ bootDiagnostics?: outputs.compute.BootDiagnosticsResponse; } /** * Describes the parameters of ephemeral disk settings that can be specified for operating system disk. **Note:** The ephemeral disk settings can only be specified for managed disk. */ interface DiffDiskSettingsResponse { /** * Specifies the ephemeral disk settings for operating system disk. */ option?: string; /** * Specifies the ephemeral disk placement for operating system disk. Possible values are: **CacheDisk,** **ResourceDisk,** **NvmeDisk.** The defaulting behavior is: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** or **NvmeDisk** is used. Refer to the VM size documentation for Windows VM at https://docs.microsoft.com/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk. Minimum api-version for NvmeDisk: 2024-03-01. */ placement?: string; } /** * Describes the disallowed disk types. */ interface DisallowedResponse { /** * A list of disk types. */ diskTypes?: string[]; } /** * Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. */ interface DiskEncryptionSetParametersResponse { /** * Resource Id */ id?: string; } /** * Describes a Encryption Settings for a Disk */ interface DiskEncryptionSettingsResponse { /** * Specifies the location of the disk encryption key, which is a Key Vault Secret. */ diskEncryptionKey?: outputs.compute.KeyVaultSecretReferenceResponse; /** * Specifies whether disk encryption should be enabled on the virtual machine. */ enabled?: boolean; /** * Specifies the location of the key encryption key in Key Vault. */ keyEncryptionKey?: outputs.compute.KeyVaultKeyReferenceResponse; } /** * The instance view of the disk. */ interface DiskInstanceViewResponse { /** * Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15 */ encryptionSettings?: outputs.compute.DiskEncryptionSettingsResponse[]; /** * The disk name. */ name?: string; /** * The resource status information. */ statuses?: outputs.compute.InstanceViewStatusResponse[]; } /** * Used for establishing the purchase context of any 3rd Party artifact through MarketPlace. */ interface DiskPurchasePlanResponse { /** * The plan ID. */ name: string; /** * Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. */ product: string; /** * The Offer Promotion Code. */ promotionCode?: string; /** * The publisher ID. */ publisher: string; } /** * Disk Restore Point details. */ interface DiskRestorePointAttributesResponse { /** * Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. */ encryption?: outputs.compute.RestorePointEncryptionResponse; /** * Resource Id */ id: string; /** * Resource Id of the source disk restore point. */ sourceDiskRestorePoint?: outputs.compute.ApiEntityReferenceResponse; } /** * The instance view of a disk restore point. */ interface DiskRestorePointInstanceViewResponse { /** * Disk restore point Id. */ id?: string; /** * The disk restore point replication status information. */ replicationStatus?: outputs.compute.DiskRestorePointReplicationStatusResponse; } /** * The instance view of a disk restore point. */ interface DiskRestorePointReplicationStatusResponse { /** * Replication completion percentage. */ completionPercent?: number; /** * The resource status information. */ status?: outputs.compute.InstanceViewStatusResponse; } /** * Contains the security related information for the resource. */ interface DiskSecurityProfileResponse { /** * ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key */ secureVMDiskEncryptionSetId?: string; /** * Specifies the SecurityType of the VM. Applicable for OS disks only. */ securityType?: string; } /** * The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, UltraSSD_LRS, Premium_ZRS, StandardSSD_ZRS, or PremiumV2_LRS. */ interface DiskSkuResponse { /** * The sku name. */ name?: string; /** * The sku tier. */ tier: string; } /** * Specifies the Managed Identity used by ADE to get access token for keyvault operations. */ interface EncryptionIdentityResponse { /** * Specifies ARM Resource ID of one of the user identities associated with the VM. */ userAssignedIdentityResourceId?: string; } /** * Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. */ interface EncryptionImagesResponse { /** * A list of encryption specifications for data disk images. */ dataDiskImages?: outputs.compute.DataDiskImageEncryptionResponse[]; /** * Contains encryption settings for an OS disk image. */ osDiskImage?: outputs.compute.OSDiskImageEncryptionResponse; } /** * Encryption at rest settings for disk or snapshot */ interface EncryptionResponse { /** * ResourceId of the disk encryption set to use for enabling encryption at rest. */ diskEncryptionSetId?: string; /** * The type of key used to encrypt the data of the disk. */ type?: string; } /** * The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks. */ interface EncryptionSetIdentityResponse { /** * The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity */ principalId: string; /** * The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity */ tenantId: string; /** * The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported for new creations. Disk Encryption Sets can be updated with Identity type None during migration of subscription to a new Azure Active Directory tenant; it will cause the encrypted resources to lose access to the keys. */ type?: string; /** * The list of user identities associated with the disk encryption set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.compute.UserAssignedIdentitiesValueResponse; }; } /** * Encryption settings for disk or snapshot */ interface EncryptionSettingsCollectionResponse { /** * Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged. */ enabled: boolean; /** * A collection of encryption settings, one for each disk volume. */ encryptionSettings?: outputs.compute.EncryptionSettingsElementResponse[]; /** * Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption. */ encryptionSettingsVersion?: string; } /** * Encryption settings for one disk volume. */ interface EncryptionSettingsElementResponse { /** * Key Vault Secret Url and vault id of the disk encryption key */ diskEncryptionKey?: outputs.compute.KeyVaultAndSecretReferenceResponse; /** * Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key. */ keyEncryptionKey?: outputs.compute.KeyVaultAndKeyReferenceResponse; } /** * Specifies eventGridAndResourceGraph related Scheduled Event related configurations. */ interface EventGridAndResourceGraphResponse { /** * Specifies if event grid and resource graph is enabled for Scheduled event related configurations. */ enable?: boolean; } /** * This is the executed Validation. */ interface ExecutedValidationResponse { /** * This property specifies the starting timestamp. */ executionTime?: string; /** * This property specifies the status of the validationProfile of the image version. */ status: string; /** * This property specifies the type of image version validation. */ type?: string; /** * This property specifies the valid version of the validation. */ version?: string; } /** * The complex type of the extended location. */ interface ExtendedLocationResponse { /** * The name of the extended location. */ name?: string; /** * The type of the extended location. */ type?: string; } /** * The definition of a parameter that can be passed to a custom action of a Gallery Application Version. */ interface GalleryApplicationCustomActionParameterResponse { /** * The default value of the parameter. Only applies to string types */ defaultValue?: string; /** * A description to help users understand what this parameter means */ description?: string; /** * The name of the custom action. Must be unique within the Gallery Application Version. */ name: string; /** * Indicates whether this parameter must be passed when running the custom action. */ required?: boolean; /** * Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob */ type?: string; } /** * A custom action that can be performed with a Gallery Application Version. */ interface GalleryApplicationCustomActionResponse { /** * Description to help the users understand what this custom action does. */ description?: string; /** * The name of the custom action. Must be unique within the Gallery Application Version. */ name: string; /** * The parameters that this custom action uses */ parameters?: outputs.compute.GalleryApplicationCustomActionParameterResponse[]; /** * The script to run when executing this custom action. */ script: string; } /** * The publishing profile of a gallery image version. */ interface GalleryApplicationVersionPublishingProfileResponse { /** * Optional. Additional settings to pass to the vm-application-manager extension. For advanced use only. */ advancedSettings?: { [key: string]: string; }; /** * A list of custom actions that can be performed with this Gallery Application Version. */ customActions?: outputs.compute.GalleryApplicationCustomActionResponse[]; /** * Optional. Whether or not this application reports health. */ enableHealthCheck?: boolean; /** * The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable. */ endOfLifeDate?: string; /** * If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. */ excludeFromLatest?: boolean; manageActions?: outputs.compute.UserArtifactManageResponse; /** * The timestamp for when the gallery image version is published. */ publishedDate: string; /** * The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable. */ replicaCount?: number; /** * Optional parameter which specifies the mode to be used for replication. This property is not updatable. */ replicationMode?: string; /** * Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. */ settings?: outputs.compute.UserArtifactSettingsResponse; /** * The source image from which the Image Version is going to be created. */ source: outputs.compute.UserArtifactSourceResponse; /** * Specifies the storage account type to be used to store the image. Cannot be specified along with storageAccountStrategy. This property is not updatable. */ storageAccountType?: string; /** * The target extended locations where the Image Version is going to be replicated to. This property is updatable. */ targetExtendedLocations?: outputs.compute.GalleryTargetExtendedLocationResponse[]; /** * The target regions where the Image Version is going to be replicated to. This property is updatable. */ targetRegions?: outputs.compute.TargetRegionResponse[]; } /** * The safety profile of the Gallery Application Version. */ interface GalleryApplicationVersionSafetyProfileResponse { /** * Indicates whether or not removing this Gallery Image Version from replicated regions is allowed. */ allowDeletionOfReplicatedLocations?: boolean; } /** * The source of the gallery artifact version. */ interface GalleryArtifactVersionFullSourceResponse { /** * The resource Id of the source Community Gallery Image. Only required when using Community Gallery Image as a source. */ communityGalleryImageId?: string; /** * The id of the gallery artifact version source. */ id?: string; /** * The resource Id of the source virtual machine. Only required when capturing a virtual machine to source this Gallery Image Version. */ virtualMachineId?: string; } /** * This is the data disk image. */ interface GalleryDataDiskImageResponse { /** * The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' */ hostCaching?: string; /** * This property specifies the logical unit number of the data disk. This value is used to identify data disks within the Virtual Machine and therefore must be unique for each data disk attached to the Virtual Machine. */ lun: number; /** * This property indicates the size of the VHD to be created. */ sizeInGB: number; /** * The source for the disk image. */ source?: outputs.compute.GalleryDiskImageSourceResponse; } /** * The source for the disk image. */ interface GalleryDiskImageSourceResponse { /** * The id of the gallery artifact version source. */ id?: string; /** * The Storage Account Id that contains the vhd blob being used as a source for this artifact version. */ storageAccountId?: string; /** * The uri of the gallery artifact version source. Currently used to specify vhd/blob source. */ uri?: string; } /** * The name of the extended location. */ interface GalleryExtendedLocationResponse { name?: string; /** * It is type of the extended location. */ type?: string; } /** * Describes the gallery unique name. */ interface GalleryIdentifierResponse { /** * The unique name of the Shared Image Gallery. This name is generated automatically by Azure. */ uniqueName: string; } /** * Identity for the virtual machine. */ interface GalleryIdentityResponse { /** * The principal id of the gallery identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The AAD tenant id of the gallery identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * The type of identity used for the gallery. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove all identities from the gallery. */ type?: string; /** * The list of user identities associated with the gallery. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.compute.UserAssignedIdentitiesValueResponse; }; } /** * A feature for gallery image. */ interface GalleryImageFeatureResponse { /** * The name of the gallery image feature. */ name?: string; /** * The minimum gallery image version which supports this feature. */ startsAtVersion?: string; /** * The value of the gallery image feature. */ value?: string; } /** * This is the gallery image definition identifier. */ interface GalleryImageIdentifierResponse { /** * The name of the gallery image definition offer. */ offer: string; /** * The name of the gallery image definition publisher. */ publisher: string; /** * The name of the gallery image definition SKU. */ sku: string; } /** * The publishing profile of a gallery image Version. */ interface GalleryImageVersionPublishingProfileResponse { /** * The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable. */ endOfLifeDate?: string; /** * If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. */ excludeFromLatest?: boolean; /** * The timestamp for when the gallery image version is published. */ publishedDate: string; /** * The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable. */ replicaCount?: number; /** * Optional parameter which specifies the mode to be used for replication. This property is not updatable. */ replicationMode?: string; /** * Specifies the storage account type to be used to store the image. Cannot be specified along with storageAccountStrategy. This property is not updatable. */ storageAccountType?: string; /** * The target extended locations where the Image Version is going to be replicated to. This property is updatable. */ targetExtendedLocations?: outputs.compute.GalleryTargetExtendedLocationResponse[]; /** * The target regions where the Image Version is going to be replicated to. This property is updatable. */ targetRegions?: outputs.compute.TargetRegionResponse[]; } /** * This is the safety profile of the Gallery Image Version. */ interface GalleryImageVersionSafetyProfileResponse { /** * Indicates whether or not removing this Gallery Image Version from replicated regions is allowed. */ allowDeletionOfReplicatedLocations?: boolean; /** * Indicates whether or not the deletion is blocked for this Gallery Image Version if its End Of Life has not expired. */ blockDeletionBeforeEndOfLife?: boolean; /** * A list of Policy Violations that have been reported for this Gallery Image Version. */ policyViolations: outputs.compute.PolicyViolationResponse[]; /** * Indicates whether this image has been reported as violating Microsoft's policies. */ reportedForPolicyViolation: boolean; } /** * This is the storage profile of a Gallery Image Version. */ interface GalleryImageVersionStorageProfileResponse { /** * A list of data disk images. */ dataDiskImages?: outputs.compute.GalleryDataDiskImageResponse[]; /** * This is the OS disk image. */ osDiskImage?: outputs.compute.GalleryOSDiskImageResponse; /** * The source of the gallery artifact version. */ source?: outputs.compute.GalleryArtifactVersionFullSourceResponse; } /** * Contains UEFI settings for the image version. */ interface GalleryImageVersionUefiSettingsResponse { /** * Additional UEFI key signatures that will be added to the image in addition to the signature templates */ additionalSignatures?: outputs.compute.UefiKeySignaturesResponse; /** * The name of the template(s) that contains default UEFI key signatures that will be added to the image. */ signatureTemplateNames?: string[]; } /** * Describes the properties of a gallery inVMAccessControlProfile. */ interface GalleryInVMAccessControlProfilePropertiesResponse { /** * This property allows you to specify the Endpoint type for which this profile is defining the access control for. Possible values are: 'WireServer' or 'IMDS' */ applicableHostEndpoint: string; /** * The description of this gallery inVMAccessControlProfile resources. This property is updatable. */ description?: string; /** * This property allows you to specify the OS type of the VMs/VMSS for which this profile can be used against. Possible values are: 'Windows' or 'Linux' */ osType: string; /** * The provisioning state, which only appears in the response. */ provisioningState: string; } /** * This is the OS disk image. */ interface GalleryOSDiskImageResponse { /** * The host caching of the disk. Valid values are 'None', 'ReadOnly', and 'ReadWrite' */ hostCaching?: string; /** * This property indicates the size of the VHD to be created. */ sizeInGB: number; /** * The source for the disk image. */ source?: outputs.compute.GalleryDiskImageSourceResponse; } /** * The definition of a parameter that can be passed to a script of a Gallery Script Version. */ interface GalleryScriptParameterResponse { /** * The default value of the parameter, only applies to string types. */ defaultValue?: string; /** * A description to help users understand what this parameter means */ description?: string; /** * A list of permissible values. Only applicable values are from 'enum' values defined in 'GalleryScriptParameter'. */ enumValues?: string[]; /** * The minimum value of parameter. */ maxValue?: string; /** * The minimum value of parameter. */ minValue?: string; /** * The name of the parameter. */ name: string; /** * Indicates whether this parameter must be passed. */ required?: boolean; /** * Specifies the type of the Gallery Script parameter. Possible values are: String, Int, Double, Boolean, Enum */ type?: string; } /** * Describes the properties of a gallery script definition. */ interface GalleryScriptPropertiesResponse { /** * The description of this gallery script definition resource. This property is updatable. */ description?: string; /** * The end of life date of the gallery Script Definition. This property can be used for decommissioning purposes. This property is updatable. */ endOfLifeDate?: string; /** * The Eula agreement (End User License Agreement) for the gallery Script Definition. */ eula?: string; /** * The privacy statement uri. */ privacyStatementUri?: string; /** * The provisioning state, which only appears in the response. */ provisioningState: string; /** * The release note uri. */ releaseNoteUri?: string; /** * This property allows you to specify the supported type of the OS that application is built for. Possible values are: **Windows,** **Linux.** */ supportedOSType: string; } /** * Describes the properties of a gallery script version. */ interface GalleryScriptVersionPropertiesResponse { /** * The provisioning state, which only appears in the response. */ provisioningState: string; /** * The publishing profile of a gallery image version. */ publishingProfile: outputs.compute.GalleryScriptVersionPublishingProfileResponse; /** * This is the replication status of the gallery image version. */ replicationStatus: outputs.compute.ReplicationStatusResponse; /** * The safety profile of the Gallery Script Version. */ safetyProfile?: outputs.compute.GalleryScriptVersionSafetyProfileResponse; } /** * The publishing profile of a gallery image version. */ interface GalleryScriptVersionPublishingProfileResponse { /** * The end of life date of the gallery image version. This property can be used for decommissioning purposes. This property is updatable. */ endOfLifeDate?: string; /** * If set to true, Virtual Machines deployed from the latest version of the Image Definition won't use this Image Version. */ excludeFromLatest?: boolean; /** * The timestamp for when the gallery image version is published. */ publishedDate: string; /** * The number of replicas of the Image Version to be created per region. This property would take effect for a region when regionalReplicaCount is not specified. This property is updatable. */ replicaCount?: number; /** * Optional parameter which specifies the mode to be used for replication. This property is not updatable. */ replicationMode?: string; /** * The source script from which the Script Version is going to be created. */ source: outputs.compute.ScriptSourceResponse; /** * Specifies the strategy to be used when selecting the storage account type. Cannot be specified along with storageAccountType, but can be overridden per region by specifying targetRegions[].storageAccountType. This property is not updatable. */ storageAccountStrategy?: string; /** * Specifies the storage account type to be used to store the image. Cannot be specified along with storageAccountStrategy. This property is not updatable. */ storageAccountType?: string; /** * The target extended locations where the Image Version is going to be replicated to. This property is updatable. */ targetExtendedLocations?: outputs.compute.GalleryTargetExtendedLocationResponse[]; /** * The target regions where the Image Version is going to be replicated to. This property is updatable. */ targetRegions?: outputs.compute.TargetRegionResponse[]; } /** * The safety profile of the Gallery Script Version. */ interface GalleryScriptVersionSafetyProfileResponse { /** * Indicates whether or not removing this Gallery Image Version from replicated regions is allowed. */ allowDeletionOfReplicatedLocations?: boolean; } interface GalleryTargetExtendedLocationResponse { /** * Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. */ encryption?: outputs.compute.EncryptionImagesResponse; /** * The name of the extended location. */ extendedLocation?: outputs.compute.GalleryExtendedLocationResponse; /** * The number of replicas of the Image Version to be created per extended location. This property is updatable. */ extendedLocationReplicaCount?: number; /** * The name of the region. */ name?: string; /** * Specifies the storage account type to be used to store the image. This property is not updatable. */ storageAccountType?: string; } /** * Specifies the hardware settings for the virtual machine. */ interface HardwareProfileResponse { /** * Specifies the size of the virtual machine. The enum data type is currently deprecated and will be removed by December 23rd 2023. The recommended way to get the list of available sizes is using these APIs: [List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes), [List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/resourceskus/list), [List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes). For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/sizes). The available VM sizes depend on region and availability set. */ vmSize?: string; /** * Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-07-01. This feature is still in preview mode and is not supported for VirtualMachineScaleSet. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. */ vmSizeProperties?: outputs.compute.VMSizePropertiesResponse; } /** * Specifies particular host endpoint settings. */ interface HostEndpointSettingsResponse { /** * Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} */ inVMAccessControlProfileReferenceId?: string; /** * Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. */ mode?: string; } /** * Describes a data disk. */ interface ImageDataDiskResponse { /** * The Virtual Hard Disk. */ blobUri?: string; /** * Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** */ caching?: string; /** * Specifies the customer managed disk encryption set resource id for the managed image disk. */ diskEncryptionSet?: outputs.compute.DiskEncryptionSetParametersResponse; /** * Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB. */ diskSizeGB?: number; /** * Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. */ lun: number; /** * The managedDisk. */ managedDisk?: outputs.compute.SubResourceResponse; /** * The snapshot. */ snapshot?: outputs.compute.SubResourceResponse; /** * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. */ storageAccountType?: string; } /** * The source image used for creating the disk. */ interface ImageDiskReferenceResponse { /** * A relative uri containing a community Azure Compute Gallery image reference. */ communityGalleryImageId?: string; /** * A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference. */ id?: string; /** * If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null. */ lun?: number; /** * A relative uri containing a direct shared Azure Compute Gallery image reference. */ sharedGalleryImageId?: string; } /** * Describes an Operating System disk. */ interface ImageOSDiskResponse { /** * The Virtual Hard Disk. */ blobUri?: string; /** * Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** */ caching?: string; /** * Specifies the customer managed disk encryption set resource id for the managed image disk. */ diskEncryptionSet?: outputs.compute.DiskEncryptionSetParametersResponse; /** * Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image. This value cannot be larger than 1023 GB. */ diskSizeGB?: number; /** * The managedDisk. */ managedDisk?: outputs.compute.SubResourceResponse; /** * The OS State. For managed images, use Generalized. */ osState: string; /** * This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image. Possible values are: **Windows,** **Linux.** */ osType: string; /** * The snapshot. */ snapshot?: outputs.compute.SubResourceResponse; /** * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. */ storageAccountType?: string; } /** * Describes the gallery image definition purchase plan. This is used by marketplace images. */ interface ImagePurchasePlanResponse { /** * The plan ID. */ name?: string; /** * The product ID. */ product?: string; /** * The publisher ID. */ publisher?: string; } /** * Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set. */ interface ImageReferenceResponse { /** * Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. */ communityGalleryImageId?: string; /** * Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. */ exactVersion: string; /** * Resource Id */ id?: string; /** * Specifies the offer of the platform image or marketplace image used to create the virtual machine. */ offer?: string; /** * The image publisher. */ publisher?: string; /** * Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. */ sharedGalleryImageId?: string; /** * The image SKU. */ sku?: string; /** * Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. */ version?: string; } /** * Describes a storage profile. */ interface ImageStorageProfileResponse { /** * Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */ dataDisks?: outputs.compute.ImageDataDiskResponse[]; /** * Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */ osDisk?: outputs.compute.ImageOSDiskResponse; /** * Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS). */ zoneResilient?: boolean; } /** * The security profile of a gallery image version */ interface ImageVersionSecurityProfileResponse { /** * Contains UEFI settings for the image version. */ uefiSettings?: outputs.compute.GalleryImageVersionUefiSettingsResponse; } /** * Inner error details. */ interface InnerErrorResponse { /** * The internal error message or exception dump. */ errordetail?: string; /** * The exception type. */ exceptiontype?: string; } /** * Instance view status. */ interface InstanceViewStatusResponse { /** * The status code. */ code?: string; /** * The short localizable label for the status. */ displayStatus?: string; /** * The level code. */ level?: string; /** * The detailed status message, including for alerts and error messages. */ message?: string; /** * The time of the status. */ time?: string; } /** * Key Vault Key Url to be used for server side encryption of Managed Disks and Snapshots */ interface KeyForDiskEncryptionSetResponse { /** * Fully versioned Key Url pointing to a key in KeyVault. Version segment of the Url is required regardless of rotationToLatestKeyVersionEnabled value. */ keyUrl: string; /** * Resource id of the KeyVault containing the key or secret. This property is optional and cannot be used if the KeyVault subscription is not the same as the Disk Encryption Set subscription. */ sourceVault?: outputs.compute.SourceVaultResponse; } /** * Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey */ interface KeyVaultAndKeyReferenceResponse { /** * Url pointing to a key or secret in KeyVault */ keyUrl: string; /** * Resource id of the KeyVault containing the key or secret */ sourceVault: outputs.compute.SourceVaultResponse; } /** * Key Vault Secret Url and vault id of the encryption key */ interface KeyVaultAndSecretReferenceResponse { /** * Url pointing to a key or secret in KeyVault */ secretUrl: string; /** * Resource id of the KeyVault containing the key or secret */ sourceVault: outputs.compute.SourceVaultResponse; } /** * Describes a reference to Key Vault Key */ interface KeyVaultKeyReferenceResponse { /** * The URL referencing a key encryption key in Key Vault. */ keyUrl: string; /** * The relative URL of the Key Vault containing the key. */ sourceVault: outputs.compute.SubResourceResponse; } /** * Describes a reference to Key Vault Secret */ interface KeyVaultSecretReferenceResponse { /** * The URL referencing a secret in a Key Vault. */ secretUrl: string; /** * The relative URL of the Key Vault containing the secret. */ sourceVault: outputs.compute.SubResourceResponse; } /** * Describes the properties of the last installed patch summary. */ interface LastPatchInstallationSummaryResponse { /** * The errors that were encountered during execution of the operation. The details array contains the list of them. */ error: outputs.compute.ApiErrorResponse; /** * The number of all available patches but excluded explicitly by a customer-specified exclusion list match. */ excludedPatchCount: number; /** * The count of patches that failed installation. */ failedPatchCount: number; /** * The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. */ installationActivityId: string; /** * The count of patches that successfully installed. */ installedPatchCount: number; /** * The UTC timestamp when the operation began. */ lastModifiedTime: string; /** * Describes whether the operation ran out of time before it completed all its intended actions */ maintenanceWindowExceeded: boolean; /** * The number of all available patches but not going to be installed because it didn't match a classification or inclusion list entry. */ notSelectedPatchCount: number; /** * The number of all available patches expected to be installed over the course of the patch installation operation. */ pendingPatchCount: number; /** * The UTC timestamp when the operation began. */ startTime: string; /** * The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." */ status: string; } /** * Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */ interface LinuxConfigurationResponse { /** * Specifies whether password authentication should be disabled. */ disablePasswordAuthentication?: boolean; /** * Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. */ enableVMAgentPlatformUpdates?: boolean; /** * [Preview Feature] Specifies settings related to VM Guest Patching on Linux. */ patchSettings?: outputs.compute.LinuxPatchSettingsResponse; /** * Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. */ provisionVMAgent?: boolean; /** * Specifies the ssh key configuration for a Linux OS. */ ssh?: outputs.compute.SshConfigurationResponse; } /** * Specifies settings related to VM Guest Patching on Linux. */ interface LinuxPatchSettingsResponse { /** * Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. */ assessmentMode?: string; /** * Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. */ automaticByPlatformSettings?: outputs.compute.LinuxVMGuestPatchAutomaticByPlatformSettingsResponse; /** * Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**ImageDefault** - The virtual machine's default patching configuration is used.

**AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true */ patchMode?: string; } /** * Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings. */ interface LinuxVMGuestPatchAutomaticByPlatformSettingsResponse { /** * Enables customer to schedule patching without accidental upgrades */ bypassPlatformSafetyChecksOnUserSchedule?: boolean; /** * Specifies the reboot setting for all AutomaticByPlatform patch installation operations. */ rebootSetting?: string; } /** * LogAnalytics output properties */ interface LogAnalyticsOutputResponse { /** * Output file Uri path to blob container. */ output: string; } /** * Maintenance Operation Status. */ interface MaintenanceRedeployStatusResponse { /** * True, if customer is allowed to perform Maintenance. */ isCustomerInitiatedMaintenanceAllowed?: boolean; /** * Message returned for the last Maintenance Operation. */ lastOperationMessage?: string; /** * The Last Maintenance Operation Result Code. */ lastOperationResultCode?: string; /** * End Time for the Maintenance Window. */ maintenanceWindowEndTime?: string; /** * Start Time for the Maintenance Window. */ maintenanceWindowStartTime?: string; /** * End Time for the Pre Maintenance Window. */ preMaintenanceWindowEndTime?: string; /** * Start Time for the Pre Maintenance Window. */ preMaintenanceWindowStartTime?: string; } /** * The parameters of a managed disk. */ interface ManagedDiskParametersResponse { /** * Specifies the customer managed disk encryption set resource id for the managed disk. */ diskEncryptionSet?: outputs.compute.DiskEncryptionSetParametersResponse; /** * Resource Id */ id?: string; /** * Specifies the security profile for the managed disk. */ securityProfile?: outputs.compute.VMDiskSecurityProfileResponse; /** * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. */ storageAccountType?: string; } /** * Describes a network interface reference. */ interface NetworkInterfaceReferenceResponse { /** * Specify what happens to the network interface when the VM is deleted */ deleteOption?: string; /** * Resource Id */ id?: string; /** * Specifies the primary network interface in case the virtual machine has more than 1 network interface. */ primary?: boolean; } /** * Specifies the network interfaces or the networking configuration of the virtual machine. */ interface NetworkProfileResponse { /** * specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations */ networkApiVersion?: string; /** * Specifies the networking configurations that will be used to create the virtual machine networking resources. */ networkInterfaceConfigurations?: outputs.compute.VirtualMachineNetworkInterfaceConfigurationResponse[]; /** * Specifies the list of resource Ids for the network interfaces associated with the virtual machine. */ networkInterfaces?: outputs.compute.NetworkInterfaceReferenceResponse[]; } /** * Contains encryption settings for an OS disk image. */ interface OSDiskImageEncryptionResponse { /** * A relative URI containing the resource ID of the disk encryption set. */ diskEncryptionSetId?: string; /** * This property specifies the security profile of an OS disk image. */ securityProfile?: outputs.compute.OSDiskImageSecurityProfileResponse; } /** * Contains security profile for an OS disk image. */ interface OSDiskImageSecurityProfileResponse { /** * confidential VM encryption types */ confidentialVMEncryptionType?: string; /** * secure VM disk encryption set id */ secureVMDiskEncryptionSetId?: string; } /** * Specifies information about the operating system disk used by the virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */ interface OSDiskResponse { /** * Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The defaulting behavior is: **None for Standard storage. ReadOnly for Premium storage.** */ caching?: string; /** * Specifies how the virtual machine disk should be created. Possible values are **Attach:** This value is used when you are using a specialized disk to create the virtual machine. **FromImage:** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. */ createOption: string; /** * Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: **Delete.** If this value is used, the OS disk is deleted when VM is deleted. **Detach.** If this value is used, the os disk is retained after VM is deleted. The default value is set to **Detach**. For an ephemeral OS Disk, the default value is set to **Delete**. The user cannot change the delete option for an ephemeral OS Disk. */ deleteOption?: string; /** * Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. */ diffDiskSettings?: outputs.compute.DiffDiskSettingsResponse; /** * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. */ diskSizeGB?: number; /** * Specifies the encryption settings for the OS Disk. Minimum api-version: 2015-06-15. */ encryptionSettings?: outputs.compute.DiskEncryptionSettingsResponse; /** * The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. */ image?: outputs.compute.VirtualHardDiskResponse; /** * The managed disk parameters. */ managedDisk?: outputs.compute.ManagedDiskParametersResponse; /** * The disk name. */ name?: string; /** * This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** */ osType?: string; /** * The virtual hard disk. */ vhd?: outputs.compute.VirtualHardDiskResponse; /** * Specifies whether writeAccelerator should be enabled or disabled on the disk. */ writeAcceleratorEnabled?: boolean; } interface OSImageNotificationProfileResponse { /** * Specifies whether the OS Image Scheduled event is enabled or disabled. */ enable?: boolean; /** * Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) */ notBeforeTimeout?: string; } /** * Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. */ interface OSProfileResponse { /** * Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) */ adminPassword?: string; /** * Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters. */ adminUsername?: string; /** * Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. */ allowExtensionOperations?: boolean; /** * Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters. **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules). */ computerName?: string; /** * Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init). */ customData?: string; /** * Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */ linuxConfiguration?: outputs.compute.LinuxConfigurationResponse; /** * Optional property which must either be set to True or omitted. */ requireGuestProvisionSignal?: boolean; /** * Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */ secrets?: outputs.compute.VaultSecretGroupResponse[]; /** * Specifies Windows operating system settings on the virtual machine. */ windowsConfiguration?: outputs.compute.WindowsConfigurationResponse; } /** * Specifies settings related to VM Guest Patching on Windows. */ interface PatchSettingsResponse { /** * Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. */ assessmentMode?: string; /** * Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. */ automaticByPlatformSettings?: outputs.compute.WindowsVMGuestPatchAutomaticByPlatformSettingsResponse; /** * Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. */ enableHotpatching?: boolean; /** * Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

**AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

**AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true */ patchMode?: string; } /** * Describes the user-defined constraints for resource hardware placement. */ interface PlacementResponse { /** * This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', availability zone selected by the system must not be present in the list of availability zones passed with 'excludeZones'. If 'excludeZones' is not provided, all availability zones in region will be considered for selection. */ excludeZones?: string[]; /** * This property supplements the 'zonePlacementPolicy' property. If 'zonePlacementPolicy' is set to 'Any'/'Auto', availability zone selected by the system must be present in the list of availability zones passed with 'includeZones'. If 'includeZones' is not provided, all availability zones in region will be considered for selection. */ includeZones?: string[]; /** * Specifies the policy for resource's placement in availability zone. Possible values are: **Any** (used for Virtual Machines), **Auto** (used for Virtual Machine Scale Sets) - An availability zone will be automatically picked by system as part of resource creation. */ zonePlacementPolicy?: string; } /** * Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**. */ interface PlanResponse { /** * The plan ID. */ name?: string; /** * Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. */ product?: string; /** * The promotion code. */ promotionCode?: string; /** * The publisher ID. */ publisher?: string; } /** * This is the platform attribute of the image version. */ interface PlatformAttributeResponse { /** * This property specifies the name of the platformAttribute. It is read-only. */ name: string; /** * This property specifies the value of the corresponding name property. It is read-only. */ value: string; } /** * A policy violation reported against a gallery artifact. */ interface PolicyViolationResponse { /** * Describes the nature of the policy violation. */ category?: string; /** * Describes specific details about why this policy violation was reported. */ details?: string; } /** * Specifies the target splits for Spot and Regular priority VMs within a scale set with flexible orchestration mode. With this property the customer is able to specify the base number of regular priority VMs created as the VMSS flex instance scales out and the split between Spot and Regular priority VMs after this base target has been reached. */ interface PriorityMixPolicyResponse { /** * The base number of regular priority VMs that will be created in this scale set as it scales out. */ baseRegularPriorityCount?: number; /** * The percentage of VM instances, after the base regular priority count has been reached, that are expected to use regular priority. */ regularPriorityPercentageAboveBase?: number; } /** * The Private Endpoint Connection resource. */ interface PrivateEndpointConnectionResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * The resource of private end point. */ privateEndpoint: outputs.compute.PrivateEndpointResponse; /** * A collection of information about the state of the connection between DiskAccess and Virtual Network. */ privateLinkServiceConnectionState: outputs.compute.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.compute.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The Private Endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Properties of the disk for which update is pending. */ interface PropertyUpdatesInProgressResponse { /** * The target performance tier of the disk if a tier change operation is in progress. */ targetTier?: string; } /** * Specifies the user intent of the proximity placement group. */ interface ProximityPlacementGroupPropertiesIntentResponse { /** * Specifies possible sizes of virtual machines that can be created in the proximity placement group. */ vmSizes?: string[]; } /** * Specifies ProxyAgent settings for the virtual machine or virtual machine scale set. Minimum api-version: 2023-09-01. */ interface ProxyAgentSettingsResponse { /** * Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. */ enabled?: boolean; /** * Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. */ imds?: outputs.compute.HostEndpointSettingsResponse; /** * Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. */ keyIncarnationId?: number; /** * Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. */ mode?: string; /** * Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. */ wireServer?: outputs.compute.HostEndpointSettingsResponse; } /** * Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. */ interface PublicIPAddressSkuResponse { /** * Specify public IP sku name */ name?: string; /** * Specify public IP sku tier */ tier?: string; } /** * The properties describe the recommended machine configuration for this Image Definition. These properties are updatable. */ interface RecommendedMachineConfigurationResponse { /** * Describes the resource range. */ memory?: outputs.compute.ResourceRangeResponse; /** * Describes the resource range. */ vCPUs?: outputs.compute.ResourceRangeResponse; } /** * This is the regional replication status. */ interface RegionalReplicationStatusResponse { /** * The details of the replication status. */ details: string; /** * It indicates progress of the replication job. */ progress: number; /** * The region to which the gallery image version is being replicated to. */ region: string; /** * This is the regional replication state. */ state: string; } /** * Gallery regional sharing status */ interface RegionalSharingStatusResponse { /** * Details of gallery regional sharing failure. */ details?: string; /** * Region name */ region?: string; /** * Gallery sharing state in current region */ state: string; } /** * This is the replication status of the gallery image version. */ interface ReplicationStatusResponse { /** * This is the aggregated replication status based on all the regional replication status flags. */ aggregatedState: string; /** * This is a summary of replication status for each region. */ summary: outputs.compute.RegionalReplicationStatusResponse[]; } /** * Describes an resiliency policy - AutomaticZoneRebalancingPolicy, ResilientVMCreationPolicy, ResilientVMDeletionPolicy and OperationRecoverySettings (version > 2025-11-01). */ interface ResiliencyPolicyResponse { /** * The configuration parameters used while performing automatic AZ balancing. */ automaticZoneRebalancingPolicy?: outputs.compute.AutomaticZoneRebalancingPolicyResponse; /** * The configuration parameters used while performing resilient VM creation. */ resilientVMCreationPolicy?: outputs.compute.ResilientVMCreationPolicyResponse; /** * The configuration parameters used while performing resilient VM deletion. */ resilientVMDeletionPolicy?: outputs.compute.ResilientVMDeletionPolicyResponse; } /** * The configuration parameters used while performing resilient VM creation. */ interface ResilientVMCreationPolicyResponse { /** * Specifies whether resilient VM creation should be enabled on the virtual machine scale set. The default value is false. */ enabled?: boolean; } /** * The configuration parameters used while performing resilient VM deletion. */ interface ResilientVMDeletionPolicyResponse { /** * Specifies whether resilient VM deletion should be enabled on the virtual machine scale set. The default value is false. */ enabled?: boolean; } /** * Describes the resource range. */ interface ResourceRangeResponse { /** * The maximum number of the resource. */ max?: number; /** * The minimum number of the resource. */ min?: number; } interface ResourceSharingProfileResponse { /** * Specifies an array of subscription resource IDs that capacity reservation group is shared with. Block Capacity Reservations does not support sharing across subscriptions. **Note:** Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details. */ subscriptionIds?: outputs.compute.SubResourceResponse[]; } /** * The properties of the source resource that this restore point collection is created from. */ interface RestorePointCollectionSourcePropertiesResponse { /** * Resource Id of the source resource used to create this restore point collection */ id?: string; /** * Location of the source resource used to create this restore point collection. */ location: string; } /** * Encryption at rest settings for disk restore point. It is an optional property that can be specified in the input while creating a restore point. */ interface RestorePointEncryptionResponse { /** * Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. */ diskEncryptionSet?: outputs.compute.DiskEncryptionSetParametersResponse; /** * The type of key used to encrypt the data of the disk restore point. */ type?: string; } /** * The instance view of a restore point. */ interface RestorePointInstanceViewResponse { /** * The disk restore points information. */ diskRestorePoints?: outputs.compute.DiskRestorePointInstanceViewResponse[]; /** * The resource status information. */ statuses?: outputs.compute.InstanceViewStatusResponse[]; } /** * Restore Point details. */ interface RestorePointResponse { /** * ConsistencyMode of the RestorePoint. Can be specified in the input while creating a restore point. For now, only CrashConsistent is accepted as a valid input. Please refer to https://aka.ms/RestorePoints for more details. */ consistencyMode?: string; /** * List of disk resource ids that the customer wishes to exclude from the restore point. If no disks are specified, all disks will be included. */ excludeDisks?: outputs.compute.ApiEntityReferenceResponse[]; /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The restore point instance view. */ instanceView: outputs.compute.RestorePointInstanceViewResponse; /** * The name of the resource */ name: string; /** * Gets the provisioning state of the restore point. */ provisioningState: string; /** * Gets the details of the VM captured at the time of the restore point creation. */ sourceMetadata?: outputs.compute.RestorePointSourceMetadataResponse; /** * Resource Id of the source restore point from which a copy needs to be created. */ sourceRestorePoint?: outputs.compute.ApiEntityReferenceResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.compute.SystemDataResponse; /** * Gets the creation time of the restore point. */ timeCreated?: string; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Describes the properties of the Virtual Machine for which the restore point was created. The properties provided are a subset and the snapshot of the overall Virtual Machine properties captured at the time of the restore point creation. */ interface RestorePointSourceMetadataResponse { /** * Gets the diagnostics profile. */ diagnosticsProfile: outputs.compute.DiagnosticsProfileResponse; /** * Gets the hardware profile. */ hardwareProfile: outputs.compute.HardwareProfileResponse; /** * HyperVGeneration of the source VM for which restore point is captured. */ hyperVGeneration: string; /** * Gets the license type, which is for bring your own license scenario. */ licenseType: string; /** * Location of the VM from which the restore point was created. */ location: string; /** * Gets the OS profile. */ osProfile: outputs.compute.OSProfileResponse; /** * Gets the security profile. */ securityProfile: outputs.compute.SecurityProfileResponse; /** * Gets the storage profile. */ storageProfile?: outputs.compute.RestorePointSourceVMStorageProfileResponse; /** * UserData associated with the source VM for which restore point is captured, which is a base-64 encoded value. */ userData: string; /** * Gets the virtual machine unique id. */ vmId: string; } /** * Describes a data disk. */ interface RestorePointSourceVMDataDiskResponse { /** * Gets the caching type. */ caching: string; /** * Contains Disk Restore Point properties. */ diskRestorePoint?: outputs.compute.DiskRestorePointAttributesResponse; /** * Gets the initial disk size in GB for blank data disks, and the new desired size for existing OS and Data disks. */ diskSizeGB: number; /** * Gets the logical unit number. */ lun: number; /** * Contains the managed disk details. */ managedDisk?: outputs.compute.ManagedDiskParametersResponse; /** * Gets the disk name. */ name: string; /** * Shows true if the disk is write-accelerator enabled. */ writeAcceleratorEnabled: boolean; } /** * Describes an Operating System disk. */ interface RestorePointSourceVMOSDiskResponse { /** * Gets the caching type. */ caching: string; /** * Contains Disk Restore Point properties. */ diskRestorePoint?: outputs.compute.DiskRestorePointAttributesResponse; /** * Gets the disk size in GB. */ diskSizeGB: number; /** * Gets the disk encryption settings. */ encryptionSettings: outputs.compute.DiskEncryptionSettingsResponse; /** * Gets the managed disk details */ managedDisk?: outputs.compute.ManagedDiskParametersResponse; /** * Gets the disk name. */ name: string; /** * Gets the Operating System type. */ osType: string; /** * Shows true if the disk is write-accelerator enabled. */ writeAcceleratorEnabled: boolean; } /** * Describes the storage profile. */ interface RestorePointSourceVMStorageProfileResponse { /** * Gets the data disks of the VM captured at the time of the restore point creation. */ dataDisks?: outputs.compute.RestorePointSourceVMDataDiskResponse[]; /** * Gets the disk controller type of the VM captured at the time of the restore point creation. */ diskControllerType: string; /** * Gets the OS disk of the VM captured at the time of the restore point creation. */ osDisk?: outputs.compute.RestorePointSourceVMOSDiskResponse; } /** * The configuration parameters used while performing a rolling upgrade. */ interface RollingUpgradePolicyResponse { /** * Allow VMSS to ignore AZ boundaries when constructing upgrade batches. Take into consideration the Update Domain and maxBatchInstancePercent to determine the batch size. */ enableCrossZoneUpgrade?: boolean; /** * The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%. */ maxBatchInstancePercent?: number; /** * Create new virtual machines to upgrade the scale set, rather than updating the existing virtual machines. Existing virtual machines will be deleted once the new virtual machines are created for each batch. */ maxSurge?: boolean; /** * The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%. */ maxUnhealthyInstancePercent?: number; /** * The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%. */ maxUnhealthyUpgradedInstancePercent?: number; /** * The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S). */ pauseTimeBetweenBatches?: string; /** * Upgrade all unhealthy instances in a scale set before any healthy instances. */ prioritizeUnhealthyInstances?: boolean; /** * Rollback failed instances to previous model if the Rolling Upgrade policy is violated. */ rollbackFailedInstancesOnPolicyBreach?: boolean; } /** * Describes the properties of a run command parameter. */ interface RunCommandInputParameterResponse { /** * The run command parameter name. */ name: string; /** * The run command parameter value. */ value: string; } /** * Contains clientId or objectId (use only one, not both) of a user-assigned managed identity that has access to storage blob used in Run Command. Use an empty RunCommandManagedIdentity object in case of system-assigned identity. Make sure the Azure storage blob exists in case of scriptUri, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment with scriptUri blob and 'Storage Blob Data Contributor' for Append blobs(outputBlobUri, errorBlobUri). In case of user assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged. */ interface RunCommandManagedIdentityResponse { /** * Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. */ clientId?: string; /** * Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. */ objectId?: string; } /** * Describes a scale-in policy for a virtual machine scale set. */ interface ScaleInPolicyResponse { /** * This property allows you to specify if virtual machines chosen for removal have to be force deleted when a virtual machine scale set is being scaled-in.(Feature in Preview) */ forceDeletion?: boolean; /** * This property allows you to prioritize the deletion of unhealthy and inactive VMs when a virtual machine scale set is being scaled-in.(Feature in Preview) */ prioritizeUnhealthyVMs?: boolean; /** * The rules to be followed when scaling-in a virtual machine scale set.

Possible values are:

**Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

**OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

**NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

*/ rules?: string[]; } interface ScheduledEventsAdditionalPublishingTargetsResponse { /** * The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. */ eventGridAndResourceGraph?: outputs.compute.EventGridAndResourceGraphResponse; } /** * Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations. */ interface ScheduledEventsPolicyResponse { /** * The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. */ scheduledEventsAdditionalPublishingTargets?: outputs.compute.ScheduledEventsAdditionalPublishingTargetsResponse; /** * The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. */ userInitiatedReboot?: outputs.compute.UserInitiatedRebootResponse; /** * The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. */ userInitiatedRedeploy?: outputs.compute.UserInitiatedRedeployResponse; } interface ScheduledEventsProfileResponse { /** * Specifies OS Image Scheduled Event related configurations. */ osImageNotificationProfile?: outputs.compute.OSImageNotificationProfileResponse; /** * Specifies Terminate Scheduled Event related configurations. */ terminateNotificationProfile?: outputs.compute.TerminateNotificationProfileResponse; } /** * The source script from which the Script Version is going to be created. */ interface ScriptSourceResponse { /** * Optional. Any input parameters that needs to passed to the script and are accessed within the script for its execution. */ parameters?: outputs.compute.GalleryScriptParameterResponse[]; /** * Required. The link of the source script, it must be a readable storage blob with SAS URI or publicly accessible URI or managed identity enabled. */ scriptLink: string; } /** * Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 */ interface SecurityPostureReferenceResponse { /** * The list of virtual machine extension names to exclude when applying the security posture. */ excludeExtensions?: string[]; /** * The security posture reference id in the form of /CommunityGalleries/{communityGalleryName}/securityPostures/{securityPostureName}/versions/{major.minor.patch}|latest */ id: string; /** * Whether the security posture can be overridden by the user. */ isOverridable?: boolean; } /** * Specifies the Security profile settings for the virtual machine or virtual machine scale set. */ interface SecurityProfileResponse { /** * This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. */ encryptionAtHost?: boolean; /** * Specifies the Managed Identity used by ADE to get access token for keyvault operations. */ encryptionIdentity?: outputs.compute.EncryptionIdentityResponse; /** * Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01. */ proxyAgentSettings?: outputs.compute.ProxyAgentSettingsResponse; /** * Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set and is not Standard. If not specified, Standard will be returned starting api version 2025-11-01. */ securityType?: string; /** * Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. */ uefiSettings?: outputs.compute.UefiSettingsResponse; } /** * Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01 */ interface ServiceArtifactReferenceResponse { /** * The service artifact reference id in the form of /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Compute/galleries/{galleryName}/serviceArtifacts/{serviceArtifactName}/vmArtifactsProfiles/{vmArtifactsProfilesName} */ id?: string; } interface ShareInfoElementResponse { /** * A relative URI containing the ID of the VM that has the disk attached. */ vmUri: string; } /** * Group of the gallery sharing profile */ interface SharingProfileGroupResponse { /** * A list of subscription/tenant ids the gallery is aimed to be shared to. */ ids?: string[]; /** * This property allows you to specify the type of sharing group. Possible values are: **Subscriptions,** **AADTenants.** */ type?: string; } /** * Profile for gallery sharing to subscription or tenant */ interface SharingProfileResponse { /** * Information of community gallery if current gallery is shared to community. */ communityGalleryInfo?: outputs.compute.CommunityGalleryInfoResponse; /** * A list of sharing profile groups. */ groups: outputs.compute.SharingProfileGroupResponse[]; /** * This property allows you to specify the permission of sharing gallery. Possible values are: **Private,** **Groups,** **Community.** */ permissions?: string; } /** * Sharing status of current gallery. */ interface SharingStatusResponse { /** * Aggregated sharing state of current gallery. */ aggregatedState: string; /** * Summary of all regional sharing status. */ summary?: outputs.compute.RegionalSharingStatusResponse[]; } /** * Specifies the sku profile for the virtual machine scale set. With this property the customer is able to specify a list of VM sizes and an allocation strategy. */ interface SkuProfileResponse { /** * Specifies the allocation strategy for the virtual machine scale set based on which the VMs will be allocated. */ allocationStrategy?: string; /** * Specifies the VM sizes for the virtual machine scale set. */ vmSizes?: outputs.compute.SkuProfileVMSizeResponse[]; } /** * Specifies the VM Size. */ interface SkuProfileVMSizeResponse { /** * Specifies the name of the VM Size. */ name?: string; /** * Specifies the rank (a.k.a priority) associated with the VM Size. */ rank?: number; } /** * Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name. */ interface SkuResponse { /** * Specifies the number of virtual machines in the scale set. */ capacity?: number; /** * The sku name. */ name?: string; /** * Specifies the tier of virtual machines in a scale set.

Possible Values:

**Standard**

**Basic** */ tier?: string; } /** * The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot */ interface SnapshotSkuResponse { /** * The sku name. */ name?: string; /** * The sku tier. */ tier: string; } /** * Contains information about the soft deletion policy of the gallery. */ interface SoftDeletePolicyResponse { /** * Enables soft-deletion for resources in this gallery, allowing them to be recovered within retention time. */ isSoftDeleteEnabled?: boolean; } /** * The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName} */ interface SourceVaultResponse { /** * Resource Id */ id?: string; } /** * Specifies the Spot-Try-Restore properties for the virtual machine scale set. With this property customer can enable or disable automatic restore of the evicted Spot VMSS VM instances opportunistically based on capacity availability and pricing constraint. */ interface SpotRestorePolicyResponse { /** * Enables the Spot-Try-Restore feature where evicted VMSS SPOT instances will be tried to be restored opportunistically based on capacity availability and pricing constraints */ enabled?: boolean; /** * Timeout value expressed as an ISO 8601 time duration after which the platform will not try to restore the VMSS SPOT instances */ restoreTimeout?: string; } /** * SSH configuration for Linux based VMs running on Azure */ interface SshConfigurationResponse { /** * The list of SSH public keys used to authenticate with linux based VMs. */ publicKeys?: outputs.compute.SshPublicKeyResponse[]; } /** * Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. */ interface SshPublicKeyResponse { /** * SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). */ keyData?: string; /** * Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys */ path?: string; } /** * Specifies the storage settings for the virtual machine disks. */ interface StorageProfileResponse { /** * Specifies whether the regional disks should be aligned/moved to the VM zone. This is applicable only for VMs with placement property set. Please note that this change is irreversible. Minimum api-version: 2024-11-01. */ alignRegionalDisksToVMZone?: boolean; /** * Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */ dataDisks?: outputs.compute.DataDiskResponse[]; /** * Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. */ diskControllerType?: string; /** * Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. */ imageReference?: outputs.compute.ImageReferenceResponse; /** * Specifies information about the operating system disk used by the virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */ osDisk?: outputs.compute.OSDiskResponse; } interface SubResourceReadOnlyResponse { /** * Resource Id */ id: string; } interface SubResourceResponse { /** * Resource Id */ id?: string; } interface SubResourceWithColocationStatusResponse { /** * Describes colocation status of a resource in the Proximity Placement Group. */ colocationStatus?: outputs.compute.InstanceViewStatusResponse; /** * Resource Id */ id?: string; } /** * List of supported capabilities persisted on the disk resource for VM use. */ interface SupportedCapabilitiesResponse { /** * True if the image from which the OS disk is created supports accelerated networking. */ acceleratedNetwork?: boolean; /** * CPU architecture supported by an OS disk. */ architecture?: string; /** * The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI. */ diskControllerTypes?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Describes the target region information. */ interface TargetRegionResponse { /** * List of storage sku with replica count to create direct drive replicas. */ additionalReplicaSets?: outputs.compute.AdditionalReplicaSetResponse[]; /** * Optional. Allows users to provide customer managed keys for encrypting the OS and data disks in the gallery artifact. */ encryption?: outputs.compute.EncryptionImagesResponse; /** * Contains the flag setting to hide an image when users specify version='latest' */ excludeFromLatest?: boolean; /** * The name of the region. */ name: string; /** * The number of replicas of the Image Version to be created per region. This property is updatable. */ regionalReplicaCount?: number; /** * Specifies the storage account type to be used to store the image. This property is not updatable. */ storageAccountType?: string; } interface TerminateNotificationProfileResponse { /** * Specifies whether the Terminate Scheduled event is enabled or disabled. */ enable?: boolean; /** * Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) */ notBeforeTimeout?: string; } /** * A UEFI key signature. */ interface UefiKeyResponse { /** * The type of key signature. */ type?: string; /** * The value of the key signature. */ value?: string[]; } /** * Additional UEFI key signatures that will be added to the image in addition to the signature templates */ interface UefiKeySignaturesResponse { /** * The database of UEFI keys for this image version. */ db?: outputs.compute.UefiKeyResponse[]; /** * The database of revoked UEFI keys for this image version. */ dbx?: outputs.compute.UefiKeyResponse[]; /** * The Key Encryption Keys of this image version. */ kek?: outputs.compute.UefiKeyResponse[]; /** * The Platform Key of this image version. */ pk?: outputs.compute.UefiKeyResponse; } /** * Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. */ interface UefiSettingsResponse { /** * Specifies whether secure boot should be enabled on the virtual machine. Minimum api-version: 2020-12-01. */ secureBootEnabled?: boolean; /** * Specifies whether vTPM should be enabled on the virtual machine. Minimum api-version: 2020-12-01. */ vTpmEnabled?: boolean; } /** * Describes an upgrade policy - automatic, manual, or rolling. */ interface UpgradePolicyResponse { /** * Configuration parameters used for performing automatic OS Upgrade. */ automaticOSUpgradePolicy?: outputs.compute.AutomaticOSUpgradePolicyResponse; /** * Specifies the mode of an upgrade to virtual machines in the scale set.

Possible values are:

**Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

**Automatic** - All virtual machines in the scale set are automatically updated at the same time. */ mode?: string; /** * The configuration parameters used while performing a rolling upgrade. */ rollingUpgradePolicy?: outputs.compute.RollingUpgradePolicyResponse; } interface UserArtifactManageResponse { /** * Required. The path and arguments to install the gallery application. This is limited to 4096 characters. */ install: string; /** * Required. The path and arguments to remove the gallery application. This is limited to 4096 characters. */ remove: string; /** * Optional. The path and arguments to update the gallery application. If not present, then update operation will invoke remove command on the previous version and install command on the current version of the gallery application. This is limited to 4096 characters. */ update?: string; } /** * Additional settings for the VM app that contains the target package and config file name when it is deployed to target VM or VM scale set. */ interface UserArtifactSettingsResponse { /** * Optional. The name to assign the downloaded config file on the VM. This is limited to 4096 characters. If not specified, the config file will be named the Gallery Application name appended with "_config". */ configFileName?: string; /** * Optional. The name to assign the downloaded package file on the VM. This is limited to 4096 characters. If not specified, the package file will be named the same as the Gallery Application name. */ packageFileName?: string; /** * Optional. The action to be taken with regards to install/update/remove of the gallery application in the event of a reboot. */ scriptBehaviorAfterReboot?: string; } /** * The source image from which the Image Version is going to be created. */ interface UserArtifactSourceResponse { /** * Optional. The defaultConfigurationLink of the artifact, must be a readable storage page blob. */ defaultConfigurationLink?: string; /** * Required. The mediaLink of the artifact, must be a readable storage page blob. */ mediaLink: string; } interface UserAssignedIdentitiesValueResponse { /** * The client id of user assigned identity. */ clientId: string; /** * The principal id of user assigned identity. */ principalId: string; } /** * Specifies Reboot related Scheduled Event related configurations. */ interface UserInitiatedRebootResponse { /** * Specifies Reboot Scheduled Event related configurations. */ automaticallyApprove?: boolean; } /** * Specifies Redeploy related Scheduled Event related configurations. */ interface UserInitiatedRedeployResponse { /** * Specifies Redeploy Scheduled Event related configurations. */ automaticallyApprove?: boolean; } /** * Specifies the security profile settings for the managed disk. **Note:** It can only be set for Confidential VMs. */ interface VMDiskSecurityProfileResponse { /** * Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. */ diskEncryptionSet?: outputs.compute.DiskEncryptionSetParametersResponse; /** * Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. */ securityEncryptionType?: string; } /** * Specifies the required information to reference a compute gallery application version */ interface VMGalleryApplicationResponse { /** * Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided */ configurationReference?: string; /** * If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS */ enableAutomaticUpgrade?: boolean; /** * Optional, Specifies the order in which the packages have to be installed */ order?: number; /** * Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} */ packageReferenceId: string; /** * Optional, Specifies a passthrough value for more generic context. */ tags?: string; /** * Optional, If true, any failure for any operation in the VmApplication will fail the deployment */ treatFailureAsDeploymentFailure?: boolean; } /** * Specifies VM Size Property settings on the virtual machine. */ interface VMSizePropertiesResponse { /** * Specifies the number of vCPUs available for the VM. When this property is not specified in the request body the default behavior is to set it to the value of vCPUs available for that VM size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). */ vCPUsAvailable?: number; /** * Specifies the vCPU to physical core ratio. When this property is not specified in the request body the default behavior is set to the value of vCPUsPerCore for the VM Size exposed in api response of [List all available virtual machine sizes in a region](https://docs.microsoft.com/en-us/rest/api/compute/resource-skus/list). **Setting this property to 1 also means that hyper-threading is disabled.** */ vCPUsPerCore?: number; } /** * This is the validations profile of a Gallery Image Version. */ interface ValidationsProfileResponse { executedValidations?: outputs.compute.ExecutedValidationResponse[]; /** * This specifies the pub, offer, sku and version of the image version metadata */ platformAttributes?: outputs.compute.PlatformAttributeResponse[]; /** * The published time of the image version */ validationEtag?: string; } /** * Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM. */ interface VaultCertificateResponse { /** * For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted. */ certificateStore?: string; /** * This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */ certificateUrl?: string; } /** * Describes a set of certificates which are all in the same Key Vault. */ interface VaultSecretGroupResponse { /** * The relative URL of the Key Vault containing all of the certificates in VaultCertificates. */ sourceVault?: outputs.compute.SubResourceResponse; /** * The list of key vault references in SourceVault which contain certificates. */ vaultCertificates?: outputs.compute.VaultCertificateResponse[]; } /** * Describes the uri of a disk. */ interface VirtualHardDiskResponse { /** * Specifies the virtual hard disk's uri. */ uri?: string; } /** * The instance view of the VM Agent running on the virtual machine. */ interface VirtualMachineAgentInstanceViewResponse { /** * The virtual machine extension handler instance view. */ extensionHandlers?: outputs.compute.VirtualMachineExtensionHandlerInstanceViewResponse[]; /** * The resource status information. */ statuses?: outputs.compute.InstanceViewStatusResponse[]; /** * The VM Agent full version. */ vmAgentVersion?: string; } /** * The instance view of a virtual machine extension handler. */ interface VirtualMachineExtensionHandlerInstanceViewResponse { /** * The extension handler status. */ status?: outputs.compute.InstanceViewStatusResponse; /** * Specifies the type of the extension; an example is "CustomScriptExtension". */ type?: string; /** * Specifies the version of the script handler. */ typeHandlerVersion?: string; } /** * The instance view of a virtual machine extension. */ interface VirtualMachineExtensionInstanceViewResponse { /** * The virtual machine extension name. */ name?: string; /** * The resource status information. */ statuses?: outputs.compute.InstanceViewStatusResponse[]; /** * The resource status information. */ substatuses?: outputs.compute.InstanceViewStatusResponse[]; /** * Specifies the type of the extension; an example is "CustomScriptExtension". */ type?: string; /** * Specifies the version of the script handler. */ typeHandlerVersion?: string; } /** * Describes a Virtual Machine Extension. */ interface VirtualMachineExtensionResponse { /** * Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */ autoUpgradeMinorVersion?: boolean; /** * Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */ enableAutomaticUpgrade?: boolean; /** * How the extension handler should be forced to update even if the extension configuration has not changed. */ forceUpdateTag?: string; /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The virtual machine extension instance view. */ instanceView?: outputs.compute.VirtualMachineExtensionInstanceViewResponse; /** * The geo-location where the resource lives */ location: string; /** * The name of the resource */ name: string; /** * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */ protectedSettings?: any; /** * The extensions protected settings that are passed by reference, and consumed from key vault */ protectedSettingsFromKeyVault?: outputs.compute.KeyVaultSecretReferenceResponse; /** * Collection of extension names after which this extension needs to be provisioned. */ provisionAfterExtensions?: string[]; /** * The provisioning state, which only appears in the response. */ provisioningState: string; /** * The name of the extension handler publisher. */ publisher?: string; /** * Json formatted public settings for the extension. */ settings?: any; /** * Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. */ suppressFailures?: boolean; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.compute.SystemDataResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; /** * Specifies the version of the script handler. */ typeHandlerVersion?: string; } /** * The health status of the VM. */ interface VirtualMachineHealthStatusResponse { /** * The health status information for the VM. */ status: outputs.compute.InstanceViewStatusResponse; } /** * Identity for the virtual machine. */ interface VirtualMachineIdentityResponse { /** * The principal id of virtual machine identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity. */ tenantId: string; /** * The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. */ type?: string; /** * The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.compute.UserAssignedIdentitiesValueResponse; }; } /** * The instance view of a virtual machine. */ interface VirtualMachineInstanceViewResponse { /** * Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. */ assignedHost: string; /** * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. */ bootDiagnostics?: outputs.compute.BootDiagnosticsInstanceViewResponse; /** * The computer name assigned to the virtual machine. */ computerName?: string; /** * The virtual machine disk information. */ disks?: outputs.compute.DiskInstanceViewResponse[]; /** * The extensions information. */ extensions?: outputs.compute.VirtualMachineExtensionInstanceViewResponse[]; /** * Specifies the HyperVGeneration Type associated with a resource */ hyperVGeneration?: string; /** * [Preview Feature] Specifies whether the VM is currently in or out of the Standby Pool. */ isVMInStandbyPool: boolean; /** * The Maintenance Operation status on the virtual machine. */ maintenanceRedeployStatus?: outputs.compute.MaintenanceRedeployStatusResponse; /** * The Operating System running on the virtual machine. */ osName?: string; /** * The version of Operating System running on the virtual machine. */ osVersion?: string; /** * [Preview Feature] The status of virtual machine patch operations. */ patchStatus?: outputs.compute.VirtualMachinePatchStatusResponse; /** * Specifies the fault domain of the virtual machine. */ platformFaultDomain?: number; /** * Specifies the update domain of the virtual machine. */ platformUpdateDomain?: number; /** * The Remote desktop certificate thumbprint. */ rdpThumbPrint?: string; /** * The resource status information. */ statuses?: outputs.compute.InstanceViewStatusResponse[]; /** * The VM Agent running on the virtual machine. */ vmAgent?: outputs.compute.VirtualMachineAgentInstanceViewResponse; /** * The health status for the VM. */ vmHealth: outputs.compute.VirtualMachineHealthStatusResponse; } /** * Contains the IP tag associated with the public IP address. */ interface VirtualMachineIpTagResponse { /** * IP tag type. Example: FirstPartyUsage. */ ipTagType?: string; /** * IP tag associated with the public IP. Example: SQL, Storage etc. */ tag?: string; } /** * Describes a virtual machine network interface configurations. */ interface VirtualMachineNetworkInterfaceConfigurationResponse { /** * Specifies whether the Auxiliary mode is enabled for the Network Interface resource. */ auxiliaryMode?: string; /** * Specifies whether the Auxiliary sku is enabled for the Network Interface resource. */ auxiliarySku?: string; /** * Specify what happens to the network interface when the VM is deleted */ deleteOption?: string; /** * Specifies whether the network interface is disabled for tcp state tracking. */ disableTcpStateTracking?: boolean; /** * The dns settings to be applied on the network interfaces. */ dnsSettings?: outputs.compute.VirtualMachineNetworkInterfaceDnsSettingsConfigurationResponse; dscpConfiguration?: outputs.compute.SubResourceResponse; /** * Specifies whether the network interface is accelerated networking-enabled. */ enableAcceleratedNetworking?: boolean; /** * Specifies whether the network interface is FPGA networking-enabled. */ enableFpga?: boolean; /** * Whether IP forwarding enabled on this NIC. */ enableIPForwarding?: boolean; /** * Specifies the IP configurations of the network interface. */ ipConfigurations: outputs.compute.VirtualMachineNetworkInterfaceIPConfigurationResponse[]; /** * The network interface configuration name. */ name: string; /** * The network security group. */ networkSecurityGroup?: outputs.compute.SubResourceResponse; /** * Specifies the primary network interface in case the virtual machine has more than 1 network interface. */ primary?: boolean; } /** * Describes a virtual machines network configuration's DNS settings. */ interface VirtualMachineNetworkInterfaceDnsSettingsConfigurationResponse { /** * List of DNS servers IP addresses */ dnsServers?: string[]; } /** * Describes a virtual machine network profile's IP configuration. */ interface VirtualMachineNetworkInterfaceIPConfigurationResponse { /** * Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. */ applicationGatewayBackendAddressPools?: outputs.compute.SubResourceResponse[]; /** * Specifies an array of references to application security group. */ applicationSecurityGroups?: outputs.compute.SubResourceResponse[]; /** * Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. */ loadBalancerBackendAddressPools?: outputs.compute.SubResourceResponse[]; /** * The IP configuration name. */ name: string; /** * Specifies the primary network interface in case the virtual machine has more than 1 network interface. */ primary?: boolean; /** * Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. */ privateIPAddressVersion?: string; /** * The publicIPAddressConfiguration. */ publicIPAddressConfiguration?: outputs.compute.VirtualMachinePublicIPAddressConfigurationResponse; /** * Specifies the identifier of the subnet. */ subnet?: outputs.compute.SubResourceResponse; } /** * The status of virtual machine patch operations. */ interface VirtualMachinePatchStatusResponse { /** * The available patch summary of the latest assessment operation for the virtual machine. */ availablePatchSummary?: outputs.compute.AvailablePatchSummaryResponse; /** * The enablement status of the specified patchMode */ configurationStatuses: outputs.compute.InstanceViewStatusResponse[]; /** * The installation summary of the latest installation operation for the virtual machine. */ lastPatchInstallationSummary?: outputs.compute.LastPatchInstallationSummaryResponse; } /** * Describes a virtual machines IP Configuration's PublicIPAddress configuration */ interface VirtualMachinePublicIPAddressConfigurationResponse { /** * Specify what happens to the public IP address when the VM is deleted */ deleteOption?: string; /** * The dns settings to be applied on the publicIP addresses . */ dnsSettings?: outputs.compute.VirtualMachinePublicIPAddressDnsSettingsConfigurationResponse; /** * The idle timeout of the public IP address. */ idleTimeoutInMinutes?: number; /** * The list of IP tags associated with the public IP address. */ ipTags?: outputs.compute.VirtualMachineIpTagResponse[]; /** * The publicIP address configuration name. */ name: string; /** * Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. */ publicIPAddressVersion?: string; /** * Specify the public IP allocation type */ publicIPAllocationMethod?: string; /** * The PublicIPPrefix from which to allocate publicIP addresses. */ publicIPPrefix?: outputs.compute.SubResourceResponse; /** * Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. */ sku?: outputs.compute.PublicIPAddressSkuResponse; } /** * Describes a virtual machines network configuration's DNS settings. */ interface VirtualMachinePublicIPAddressDnsSettingsConfigurationResponse { /** * The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. */ domainNameLabel: string; /** * The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. */ domainNameLabelScope?: string; } /** * The instance view of a virtual machine run command. */ interface VirtualMachineRunCommandInstanceViewResponse { /** * Script end time. */ endTime?: string; /** * Script error stream. */ error?: string; /** * Communicate script configuration errors or execution messages. */ executionMessage?: string; /** * Script execution status. */ executionState?: string; /** * Exit code returned from script execution. */ exitCode?: number; /** * Script output stream. */ output?: string; /** * Script start time. */ startTime?: string; /** * The resource status information. */ statuses?: outputs.compute.InstanceViewStatusResponse[]; } /** * Describes the script sources for run command. Use only one of these script sources: script, scriptUri, commandId, galleryScriptReferenceId. */ interface VirtualMachineRunCommandScriptSourceResponse { /** * Specifies a commandId of predefined built-in script. Command IDs available for Linux are listed at https://aka.ms/RunCommandManagedLinux#available-commands, Windows at https://aka.ms/RunCommandManagedWindows#available-commands. */ commandId?: string; /** * Specifies the script content to be executed on the VM. */ script?: string; /** * Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI. */ scriptUri?: string; /** * User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged. */ scriptUriManagedIdentity?: outputs.compute.RunCommandManagedIdentityResponse; } /** * Describes a virtual machine scale set data disk. */ interface VirtualMachineScaleSetDataDiskResponse { /** * Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** */ caching?: string; /** * The create option. */ createOption: string; /** * Specifies whether data disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the data disk is deleted when the VMSS Flex VM is deleted.

**Detach** If this value is used, the data disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. */ deleteOption?: string; /** * Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. */ diskIOPSReadWrite?: number; /** * Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB. */ diskMBpsReadWrite?: number; /** * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property diskSizeGB is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. */ diskSizeGB?: number; /** * Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. */ lun: number; /** * The managed disk parameters. */ managedDisk?: outputs.compute.VirtualMachineScaleSetManagedDiskParametersResponse; /** * The disk name. */ name?: string; /** * Specifies whether writeAccelerator should be enabled or disabled on the disk. */ writeAcceleratorEnabled?: boolean; } /** * Describes a virtual machine scale set extension profile. */ interface VirtualMachineScaleSetExtensionProfileResponse { /** * The virtual machine scale set child extension resources. */ extensions?: outputs.compute.VirtualMachineScaleSetExtensionResponse[]; /** * Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum api-version: 2020-06-01. */ extensionsTimeBudget?: string; } /** * Describes a Virtual Machine Scale Set Extension. */ interface VirtualMachineScaleSetExtensionResponse { /** * Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */ autoUpgradeMinorVersion?: boolean; /** * Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */ enableAutomaticUpgrade?: boolean; /** * If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. */ forceUpdateTag?: string; /** * Resource Id */ id: string; /** * Resource name */ name?: string; /** * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */ protectedSettings?: any; /** * The extensions protected settings that are passed by reference, and consumed from key vault */ protectedSettingsFromKeyVault?: outputs.compute.KeyVaultSecretReferenceResponse; /** * Collection of extension names after which this extension needs to be provisioned. */ provisionAfterExtensions?: string[]; /** * The provisioning state, which only appears in the response. */ provisioningState: string; /** * The name of the extension handler publisher. */ publisher?: string; /** * Json formatted public settings for the extension. */ settings?: any; /** * Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. */ suppressFailures?: boolean; /** * Resource type */ type: string; /** * Specifies the version of the script handler. */ typeHandlerVersion?: string; } /** * Specifies the hardware settings for the virtual machine scale set. */ interface VirtualMachineScaleSetHardwareProfileResponse { /** * Specifies the properties for customizing the size of the virtual machine. Minimum api-version: 2021-11-01. Please follow the instructions in [VM Customization](https://aka.ms/vmcustomization) for more details. */ vmSizeProperties?: outputs.compute.VMSizePropertiesResponse; } /** * Describes a virtual machine scale set network profile's IP configuration. */ interface VirtualMachineScaleSetIPConfigurationResponse { /** * Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway. */ applicationGatewayBackendAddressPools?: outputs.compute.SubResourceResponse[]; /** * Specifies an array of references to application security group. */ applicationSecurityGroups?: outputs.compute.SubResourceResponse[]; /** * Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. */ loadBalancerBackendAddressPools?: outputs.compute.SubResourceResponse[]; /** * Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer. */ loadBalancerInboundNatPools?: outputs.compute.SubResourceResponse[]; /** * The IP configuration name. */ name: string; /** * Specifies the primary network interface in case the virtual machine has more than 1 network interface. */ primary?: boolean; /** * Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. */ privateIPAddressVersion?: string; /** * The publicIPAddressConfiguration. */ publicIPAddressConfiguration?: outputs.compute.VirtualMachineScaleSetPublicIPAddressConfigurationResponse; /** * Specifies the identifier of the subnet. */ subnet?: outputs.compute.ApiEntityReferenceResponse; } /** * Identity for the virtual machine scale set. */ interface VirtualMachineScaleSetIdentityResponse { /** * The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity. */ tenantId: string; /** * The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set. */ type?: string; /** * The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.compute.UserAssignedIdentitiesValueResponse; }; } /** * Contains the IP tag associated with the public IP address. */ interface VirtualMachineScaleSetIpTagResponse { /** * IP tag type. Example: FirstPartyUsage. */ ipTagType?: string; /** * IP tag associated with the public IP. Example: SQL, Storage etc. */ tag?: string; } /** * Describes the parameters of a ScaleSet managed disk. */ interface VirtualMachineScaleSetManagedDiskParametersResponse { /** * Specifies the customer managed disk encryption set resource id for the managed disk. */ diskEncryptionSet?: outputs.compute.DiskEncryptionSetParametersResponse; /** * Specifies the security profile for the managed disk. */ securityProfile?: outputs.compute.VMDiskSecurityProfileResponse; /** * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. */ storageAccountType?: string; } /** * Describes the Availability Set properties related to migration to Flexible Virtual Machine Scale Set. */ interface VirtualMachineScaleSetMigrationInfoResponse { /** * Indicates the target Virtual Machine ScaleSet properties upon triggering a seamless migration without downtime of the VMs via the ConvertToVirtualMachineScaleSet API. */ defaultVirtualMachineScaleSetInfo: outputs.compute.DefaultVirtualMachineScaleSetInfoResponse; /** * Specifies the Virtual Machine Scale Set that the Availability Set is migrated to. */ migrateToVirtualMachineScaleSet: outputs.compute.SubResourceResponse; } /** * Describes a virtual machines scale sets network configuration's DNS settings. */ interface VirtualMachineScaleSetNetworkConfigurationDnsSettingsResponse { /** * List of DNS servers IP addresses */ dnsServers?: string[]; } /** * Describes a virtual machine scale set network profile's network configurations. */ interface VirtualMachineScaleSetNetworkConfigurationResponse { /** * Specifies whether the Auxiliary mode is enabled for the Network Interface resource. */ auxiliaryMode?: string; /** * Specifies whether the Auxiliary sku is enabled for the Network Interface resource. */ auxiliarySku?: string; /** * Specify what happens to the network interface when the VM is deleted */ deleteOption?: string; /** * Specifies whether the network interface is disabled for tcp state tracking. */ disableTcpStateTracking?: boolean; /** * The dns settings to be applied on the network interfaces. */ dnsSettings?: outputs.compute.VirtualMachineScaleSetNetworkConfigurationDnsSettingsResponse; /** * Specifies whether the network interface is accelerated networking-enabled. */ enableAcceleratedNetworking?: boolean; /** * Specifies whether the network interface is FPGA networking-enabled. */ enableFpga?: boolean; /** * Whether IP forwarding enabled on this NIC. */ enableIPForwarding?: boolean; /** * Specifies the IP configurations of the network interface. */ ipConfigurations: outputs.compute.VirtualMachineScaleSetIPConfigurationResponse[]; /** * The network configuration name. */ name: string; /** * The network security group. */ networkSecurityGroup?: outputs.compute.SubResourceResponse; /** * Specifies the primary network interface in case the virtual machine has more than 1 network interface. */ primary?: boolean; } /** * Describes a virtual machine scale set network profile. */ interface VirtualMachineScaleSetNetworkProfileResponse { /** * A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'. */ healthProbe?: outputs.compute.ApiEntityReferenceResponse; /** * specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations for Virtual Machine Scale Set with orchestration mode 'Flexible' */ networkApiVersion?: string; /** * The list of network configurations. */ networkInterfaceConfigurations?: outputs.compute.VirtualMachineScaleSetNetworkConfigurationResponse[]; } /** * Describes a virtual machine scale set operating system disk. */ interface VirtualMachineScaleSetOSDiskResponse { /** * Specifies the caching requirements. Possible values are: **None,** **ReadOnly,** **ReadWrite.** The default values are: **None for Standard storage. ReadOnly for Premium storage.** */ caching?: string; /** * Specifies how the virtual machines in the scale set should be created. The only allowed value is: **FromImage.** This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described. */ createOption: string; /** * Specifies whether OS Disk should be deleted or detached upon VMSS Flex deletion (This feature is available for VMSS with Flexible OrchestrationMode only).

Possible values:

**Delete** If this value is used, the OS disk is deleted when VMSS Flex VM is deleted.

**Detach** If this value is used, the OS disk is retained after VMSS Flex VM is deleted.

The default value is set to **Delete**. For an Ephemeral OS Disk, the default value is set to **Delete**. User cannot change the delete option for Ephemeral OS Disk. */ deleteOption?: string; /** * Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set. */ diffDiskSettings?: outputs.compute.DiffDiskSettingsResponse; /** * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. */ diskSizeGB?: number; /** * Specifies information about the unmanaged user image to base the scale set on. */ image?: outputs.compute.VirtualHardDiskResponse; /** * The managed disk parameters. */ managedDisk?: outputs.compute.VirtualMachineScaleSetManagedDiskParametersResponse; /** * The disk name. */ name?: string; /** * This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: **Windows,** **Linux.** */ osType?: string; /** * Specifies the container urls that are used to store operating system disks for the scale set. */ vhdContainers?: string[]; /** * Specifies whether writeAccelerator should be enabled or disabled on the disk. */ writeAcceleratorEnabled?: boolean; } /** * Describes a virtual machine scale set OS profile. */ interface VirtualMachineScaleSetOSProfileResponse { /** * Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) */ adminPassword?: string; /** * Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters */ adminUsername?: string; /** * Specifies whether extension operations should be allowed on the virtual machine scale set. This may only be set to False when no extensions are present on the virtual machine scale set. */ allowExtensionOperations?: boolean; /** * Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long. */ computerNamePrefix?: string; /** * Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init) */ customData?: string; /** * Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */ linuxConfiguration?: outputs.compute.LinuxConfigurationResponse; /** * Optional property which must either be set to True or omitted. */ requireGuestProvisionSignal?: boolean; /** * Specifies set of certificates that should be installed onto the virtual machines in the scale set. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */ secrets?: outputs.compute.VaultSecretGroupResponse[]; /** * Specifies Windows operating system settings on the virtual machine. */ windowsConfiguration?: outputs.compute.WindowsConfigurationResponse; } /** * Describes a virtual machines scale sets network configuration's DNS settings. */ interface VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettingsResponse { /** * The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created */ domainNameLabel: string; /** * The Domain name label scope.The concatenation of the hashed domain name label that generated according to the policy from domain name label scope and vm index will be the domain name labels of the PublicIPAddress resources that will be created */ domainNameLabelScope?: string; } /** * Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration */ interface VirtualMachineScaleSetPublicIPAddressConfigurationResponse { /** * Specify what happens to the public IP when the VM is deleted */ deleteOption?: string; /** * The dns settings to be applied on the publicIP addresses . */ dnsSettings?: outputs.compute.VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettingsResponse; /** * The idle timeout of the public IP address. */ idleTimeoutInMinutes?: number; /** * The list of IP tags associated with the public IP address. */ ipTags?: outputs.compute.VirtualMachineScaleSetIpTagResponse[]; /** * The publicIP address configuration name. */ name: string; /** * Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. */ publicIPAddressVersion?: string; /** * The PublicIPPrefix from which to allocate publicIP addresses. */ publicIPPrefix?: outputs.compute.SubResourceResponse; /** * Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. */ sku?: outputs.compute.PublicIPAddressSkuResponse; } /** * Describes a virtual machine scale set storage profile. */ interface VirtualMachineScaleSetStorageProfileResponse { /** * Specifies the parameters that are used to add data disks to the virtual machines in the scale set. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */ dataDisks?: outputs.compute.VirtualMachineScaleSetDataDiskResponse[]; /** * Specifies the disk controller type configured for the virtual machines in the scale set. Minimum api-version: 2022-08-01 */ diskControllerType?: string; /** * Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. */ imageReference?: outputs.compute.ImageReferenceResponse; /** * Specifies information about the operating system disk used by the virtual machines in the scale set. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */ osDisk?: outputs.compute.VirtualMachineScaleSetOSDiskResponse; } /** * The instance view of a virtual machine scale set VM. */ interface VirtualMachineScaleSetVMInstanceViewResponse { /** * Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled. Minimum api-version: 2020-06-01. */ assignedHost: string; /** * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. */ bootDiagnostics?: outputs.compute.BootDiagnosticsInstanceViewResponse; /** * Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

**Max-length (Windows):** 15 characters

**Max-length (Linux):** 64 characters.

For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://learn.microsoft.com/previous-versions/azure/virtual-machines/linux/infrastructure-example?toc=%2Fazure%2Fvirtual-machines%2Flinux%2Ftoc.json#1-naming-conventions). */ computerName?: string; /** * The disks information. */ disks?: outputs.compute.DiskInstanceViewResponse[]; /** * The extensions information. */ extensions?: outputs.compute.VirtualMachineExtensionInstanceViewResponse[]; /** * The hypervisor generation of the Virtual Machine [V1, V2] */ hyperVGeneration?: string; /** * The Maintenance Operation status on the virtual machine. */ maintenanceRedeployStatus?: outputs.compute.MaintenanceRedeployStatusResponse; /** * The Operating System running on the hybrid machine. */ osName?: string; /** * The version of Operating System running on the hybrid machine. */ osVersion?: string; /** * The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId. */ placementGroupId?: string; /** * The Fault Domain count. */ platformFaultDomain?: number; /** * The Update Domain count. */ platformUpdateDomain?: number; /** * The Remote desktop certificate thumbprint. */ rdpThumbPrint?: string; /** * The resource status information. */ statuses?: outputs.compute.InstanceViewStatusResponse[]; /** * The VM Agent running on the virtual machine. */ vmAgent?: outputs.compute.VirtualMachineAgentInstanceViewResponse; /** * The health status for the VM. */ vmHealth: outputs.compute.VirtualMachineHealthStatusResponse; } /** * Describes a virtual machine scale set VM network profile. */ interface VirtualMachineScaleSetVMNetworkProfileConfigurationResponse { /** * The list of network configurations. */ networkInterfaceConfigurations?: outputs.compute.VirtualMachineScaleSetNetworkConfigurationResponse[]; } /** * Describes a virtual machine scale set virtual machine profile. */ interface VirtualMachineScaleSetVMProfileResponse { /** * Specifies the gallery applications that should be made available to the VM/VMSS */ applicationProfile?: outputs.compute.ApplicationProfileResponse; /** * Specifies the billing related details of a Azure Spot VMSS. Minimum api-version: 2019-03-01. */ billingProfile?: outputs.compute.BillingProfileResponse; /** * Specifies the capacity reservation related details of a scale set. Minimum api-version: 2021-04-01. */ capacityReservation?: outputs.compute.CapacityReservationProfileResponse; /** * Specifies the boot diagnostic settings state. Minimum api-version: 2015-06-15. */ diagnosticsProfile?: outputs.compute.DiagnosticsProfileResponse; /** * Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set. For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01. For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview. */ evictionPolicy?: string; /** * Specifies a collection of settings for extensions installed on virtual machines in the scale set. */ extensionProfile?: outputs.compute.VirtualMachineScaleSetExtensionProfileResponse; /** * Specifies the hardware profile related details of a scale set. Minimum api-version: 2021-11-01. */ hardwareProfile?: outputs.compute.VirtualMachineScaleSetHardwareProfileResponse; /** * Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 */ licenseType?: string; /** * Specifies properties of the network interfaces of the virtual machines in the scale set. */ networkProfile?: outputs.compute.VirtualMachineScaleSetNetworkProfileResponse; /** * Specifies the operating system settings for the virtual machines in the scale set. */ osProfile?: outputs.compute.VirtualMachineScaleSetOSProfileResponse; /** * Specifies the priority for the virtual machines in the scale set. Minimum api-version: 2017-10-30-preview. */ priority?: string; /** * Specifies Scheduled Event related configurations. */ scheduledEventsProfile?: outputs.compute.ScheduledEventsProfileResponse; /** * Specifies the security posture to be used in the scale set. Minimum api-version: 2023-03-01 */ securityPostureReference?: outputs.compute.SecurityPostureReferenceResponse; /** * Specifies the Security related profile settings for the virtual machines in the scale set. */ securityProfile?: outputs.compute.SecurityProfileResponse; /** * Specifies the service artifact reference id used to set same image version for all virtual machines in the scale set when using 'latest' image version. Minimum api-version: 2022-11-01 */ serviceArtifactReference?: outputs.compute.ServiceArtifactReferenceResponse; /** * Specifies the storage settings for the virtual machine disks. */ storageProfile?: outputs.compute.VirtualMachineScaleSetStorageProfileResponse; /** * Specifies the time in which this VM profile for the Virtual Machine Scale Set was created. This value will be added to VMSS Flex VM tags when creating/updating the VMSS VM Profile. Minimum API version for this property is 2023-09-01. */ timeCreated: string; /** * UserData for the virtual machines in the scale set, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum api-version: 2021-03-01. */ userData?: string; } /** * The protection policy of a virtual machine scale set VM. */ interface VirtualMachineScaleSetVMProtectionPolicyResponse { /** * Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation. */ protectFromScaleIn?: boolean; /** * Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM. */ protectFromScaleSetActions?: boolean; } /** * Describes Windows Remote Management configuration of the VM */ interface WinRMConfigurationResponse { /** * The list of Windows Remote Management listeners */ listeners?: outputs.compute.WinRMListenerResponse[]; } /** * Describes Protocol and thumbprint of Windows Remote Management listener */ interface WinRMListenerResponse { /** * This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */ certificateUrl?: string; /** * Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** */ protocol?: string; } /** * Specifies Windows operating system settings on the virtual machine. */ interface WindowsConfigurationResponse { /** * Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. */ additionalUnattendContent?: outputs.compute.AdditionalUnattendContentResponse[]; /** * Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. */ enableAutomaticUpdates?: boolean; /** * Indicates whether VMAgent Platform Updates are enabled for the Windows Virtual Machine. */ enableVMAgentPlatformUpdates: boolean; /** * [Preview Feature] Specifies settings related to VM Guest Patching on Windows. */ patchSettings?: outputs.compute.PatchSettingsResponse; /** * Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. */ provisionVMAgent?: boolean; /** * Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). */ timeZone?: string; /** * Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. */ winRM?: outputs.compute.WinRMConfigurationResponse; } /** * Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings. */ interface WindowsVMGuestPatchAutomaticByPlatformSettingsResponse { /** * Enables customer to schedule patching without accidental upgrades */ bypassPlatformSafetyChecksOnUserSchedule?: boolean; /** * Specifies the reboot setting for all AutomaticByPlatform patch installation operations. */ rebootSetting?: string; } } export declare namespace computebulkactions { /** * Enables or disables a capability on the virtual machine or virtual machine scale set. */ interface AdditionalCapabilitiesResponse { /** * The flag that enables or disables hibernation capability on the VM. */ hibernationEnabled?: boolean; /** * The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled. */ ultraSSDEnabled?: boolean; } /** * Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied. */ interface AdditionalUnattendContentResponse { /** * The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup. */ componentName?: string; /** * Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted. */ content?: string; /** * The pass name. Currently, the only allowable value is OobeSystem. */ passName?: string; /** * Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon. */ settingName?: string; } /** * Specifies if Scheduled Events should be auto-approved when all instances are down. */ interface AllInstancesDownResponse { /** * Specifies if Scheduled Events should be auto-approved when all instances are down. Its default value is true. */ automaticallyApprove?: boolean; } /** * The API entity reference. */ interface ApiEntityReferenceResponse { /** * The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... */ id?: string; } /** * Contains the list of gallery applications that should be made available to the VM */ interface ApplicationProfileResponse { /** * Specifies the gallery applications that should be made available to the VM */ galleryApplications?: outputs.computebulkactions.VMGalleryApplicationResponse[]; } /** * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. */ interface BootDiagnosticsResponse { /** * Whether boot diagnostics should be enabled on the Virtual Machine. */ enabled?: boolean; /** * Uri of the storage account to use for placing the console output and screenshot. If storageUri is not specified while enabling boot diagnostics, managed storage will be used. */ storageUri?: string; } /** * The parameters of a capacity reservation Profile. */ interface CapacityReservationProfileResponse { /** * Specifies the capacity reservation group resource id that should be used for allocating the virtual machine provided enough capacity has been reserved. Please refer to https://aka.ms/CapacityReservation for more details. */ capacityReservationGroup?: outputs.computebulkactions.SubResourceResponse; } /** * Compute Profile to configure the Virtual Machines. */ interface ComputeProfileResponse { /** * Specifies the Microsoft.Compute API version to use when creating underlying Virtual Machines. * The default value will be the latest supported computeApiVersion by LaunchBulkInstancesOperation. */ computeApiVersion?: string; /** * Virtual Machine Extensions Array to be specified according to "specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachine.json#/definitions/VirtualMachineExtension" */ extensions?: outputs.computebulkactions.VirtualMachineExtensionResponse[]; /** * Base Virtual Machine Profile Properties to be specified according to "specification/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/{computeApiVersion}/virtualMachine.json#/definitions/VirtualMachineProperties" */ virtualMachineProfile: outputs.computebulkactions.VirtualMachineProfileResponse; } /** * Describes a data disk. */ interface DataDiskResponse { /** * Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage. */ caching?: string; /** * Specifies how the virtual machine disk should be created. Possible values are Attach, FromImage, Empty, Copy, Restore. */ createOption: string; /** * Specifies whether data disk should be deleted or detached upon VM deletion. Possible values are: Delete, Detach. The default value is set to Detach. */ deleteOption?: string; /** * Specifies the detach behavior to be used while detaching a disk or which is already in the process of detachment from the virtual machine. Supported values: ForceDetach. This feature is still in preview. To force-detach a data disk update toBeDetached to 'true' along with setting detachOption: 'ForceDetach'. */ detachOption?: string; /** * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. */ diskSizeGB?: number; /** * The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. */ image?: outputs.computebulkactions.VirtualHardDiskResponse; /** * Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. */ lun: number; /** * The managed disk parameters. */ managedDisk?: outputs.computebulkactions.ManagedDiskParametersResponse; /** * The disk name. */ name?: string; /** * The source resource identifier. It can be a snapshot, or disk restore point from which to create a disk. */ sourceResource?: outputs.computebulkactions.ApiEntityReferenceResponse; /** * Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset. */ toBeDetached?: boolean; /** * The virtual hard disk. */ vhd?: outputs.computebulkactions.VirtualHardDiskResponse; /** * Specifies whether writeAccelerator should be enabled or disabled on the disk. */ writeAcceleratorEnabled?: boolean; } /** * Specifies the boot diagnostic settings state. Minimum compute api-version: 2015-06-15. */ interface DiagnosticsProfileResponse { /** * Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status. **NOTE**: If storageUri is being specified then ensure that the storage account is in the same region and subscription as the VM. You can easily view the output of your console log. Azure also enables you to see a screenshot of the VM from the hypervisor. */ bootDiagnostics?: outputs.computebulkactions.BootDiagnosticsResponse; } /** * Describes the parameters of ephemeral disk settings that can be specified for operating system disk. Note: The ephemeral disk settings can only be specified for managed disk. */ interface DiffDiskSettingsResponse { /** * Specifies the ephemeral disk settings for operating system disk. */ option?: string; /** * Specifies the ephemeral disk placement for operating system disk. Possible values are: CacheDisk, ResourceDisk, NvmeDisk. The defaulting behavior is: CacheDisk if one is configured for the VM size otherwise ResourceDisk or NvmeDisk is used. Minimum api-version for NvmeDisk: 2024-03-01. */ placement?: string; } /** * Describes the parameter of customer managed disk encryption set resource id that can be specified for disk. **Note:** The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details. */ interface DiskEncryptionSetParametersResponse { /** * The ID of the sub-resource. */ id?: string; } /** * Describes a Encryption Settings for a Disk */ interface DiskEncryptionSettingsResponse { /** * Specifies the location of the disk encryption key, which is a Key Vault Secret. */ diskEncryptionKey?: outputs.computebulkactions.KeyVaultSecretReferenceResponse; /** * Specifies whether disk encryption should be enabled on the virtual machine. */ enabled?: boolean; /** * Specifies the location of the key encryption key in Key Vault. */ keyEncryptionKey?: outputs.computebulkactions.KeyVaultKeyReferenceResponse; } /** * Specifies the Managed Identity used by ADE to get access token for keyvault operations. */ interface EncryptionIdentityResponse { /** * Specifies ARM Resource ID of one of the user identities associated with the VM. */ userAssignedIdentityResourceId?: string; } /** * Specifies eventGridAndResourceGraph related Scheduled Event related configurations. */ interface EventGridAndResourceGraphResponse { /** * Specifies if event grid and resource graph is enabled for Scheduled event related configurations. */ enable?: boolean; /** * Specifies the api-version to determine which Scheduled Events configuration schema version will be delivered. */ scheduledEventsApiVersion?: string; } /** * Specifies particular host endpoint settings. */ interface HostEndpointSettingsResponse { /** * Specifies the InVMAccessControlProfileVersion resource id in the format of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/inVMAccessControlProfiles/{profile}/versions/{version} */ inVMAccessControlProfileReferenceId?: string; /** * Specifies the execution mode. In Audit mode, the system acts as if it is enforcing the access control policy, including emitting access denial entries in the logs but it does not actually deny any requests to host endpoints. In Enforce mode, the system will enforce the access control and it is the recommended mode of operation. */ mode?: string; } /** * Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set. */ interface ImageReferenceResponse { /** * Specified the community gallery image unique id for vm deployment. This can be fetched from community gallery image GET call. */ communityGalleryImageId?: string; /** * The ID of the sub-resource. */ id?: string; /** * Specifies the offer of the platform image or marketplace image used to create the virtual machine. */ offer?: string; /** * The image publisher. */ publisher?: string; /** * Specified the shared gallery image unique id for vm deployment. This can be fetched from shared gallery image GET call. */ sharedGalleryImageId?: string; /** * The image SKU. */ sku?: string; /** * Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. Please do not use field 'version' for gallery image deployment, gallery image should always use 'id' field for deployment, to use 'latest' version of gallery image, just set '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' in the 'id' field without version input. */ version?: string; } /** * Describes a reference to Key Vault Key */ interface KeyVaultKeyReferenceResponse { /** * The URL referencing a key encryption key in Key Vault. */ keyUrl: string; /** * The relative URL of the Key Vault containing the key. */ sourceVault: outputs.computebulkactions.SubResourceResponse; } /** * Describes a reference to Key Vault Secret */ interface KeyVaultSecretReferenceResponse { /** * The URL referencing a secret in a Key Vault. */ secretUrl: string; /** * The relative URL of the Key Vault containing the secret. */ sourceVault: outputs.computebulkactions.SubResourceResponse; } /** * Details of the LaunchBulkInstancesOperation. */ interface LaunchBulkInstancesOperationPropertiesResponse { /** * Total capacity to achieve. It can be in terms of VMs or vCPUs. */ capacity: number; /** * Specifies capacity type for launching instances. It can be in terms of VMs or vCPUs. */ capacityType?: string; /** * Compute Profile to configure the Virtual Machines. */ computeProfile: outputs.computebulkactions.ComputeProfileResponse; /** * Configuration Options for Regular or Spot instances in LaunchBulkInstancesOperation. */ priorityProfile: outputs.computebulkactions.PriorityProfileResponse; /** * The status of the last operation. */ provisioningState: string; /** * Retry policy the user can pass */ retryPolicy?: outputs.computebulkactions.RetryPolicyResponse; /** * Attributes to launch instances. */ vmAttributes?: outputs.computebulkactions.VMAttributesResponse; /** * List of VM sizes supported for LaunchBulkInstancesOperation */ vmSizesProfile?: outputs.computebulkactions.VmSizeProfileResponse[]; /** * Zone Allocation Policy for launching instances. */ zoneAllocationPolicy?: outputs.computebulkactions.ZoneAllocationPolicyResponse; } /** * Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */ interface LinuxConfigurationResponse { /** * Specifies whether password authentication should be disabled. */ disablePasswordAuthentication?: boolean; /** * Indicates whether VMAgent Platform Updates is enabled for the Linux virtual machine. Default value is false. */ enableVMAgentPlatformUpdates?: boolean; /** * [Preview Feature] Specifies settings related to VM Guest Patching on Linux. */ patchSettings?: outputs.computebulkactions.LinuxPatchSettingsResponse; /** * Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. */ provisionVMAgent?: boolean; /** * Specifies the ssh key configuration for a Linux OS. */ ssh?: outputs.computebulkactions.SshConfigurationResponse; } /** * Specifies settings related to VM Guest Patching on Linux. */ interface LinuxPatchSettingsResponse { /** * Specifies the mode of VM Guest Patch Assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. */ assessmentMode?: string; /** * Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Linux. */ automaticByPlatformSettings?: outputs.computebulkactions.LinuxVMGuestPatchAutomaticByPlatformSettingsResponse; /** * Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**ImageDefault** - The virtual machine's default patching configuration is used.

**AutomaticByPlatform** - The virtual machine will be automatically updated by the platform. The property provisionVMAgent must be true */ patchMode?: string; } /** * Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Linux patch settings. */ interface LinuxVMGuestPatchAutomaticByPlatformSettingsResponse { /** * Enables customer to schedule patching without accidental upgrades */ bypassPlatformSafetyChecksOnUserSchedule?: boolean; /** * Specifies the reboot setting for all AutomaticByPlatform patch installation operations. */ rebootSetting?: string; } /** * The parameters of a managed disk. */ interface ManagedDiskParametersResponse { /** * Specifies the customer managed disk encryption set resource id for the managed disk. */ diskEncryptionSet?: outputs.computebulkactions.DiskEncryptionSetParametersResponse; /** * The ID of the sub-resource. */ id?: string; /** * Specifies the security profile for the managed disk. */ securityProfile?: outputs.computebulkactions.VMDiskSecurityProfileResponse; /** * Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk. */ storageAccountType?: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.computebulkactions.UserAssignedIdentityResponse; }; } /** * Describes a network interface reference properties. */ interface NetworkInterfaceReferencePropertiesResponse { /** * Specify what happens to the network interface when the VM is deleted */ deleteOption?: string; /** * Specifies the primary network interface in case the virtual machine has more than 1 network interface. */ primary?: boolean; } /** * Describes a network interface reference. */ interface NetworkInterfaceReferenceResponse { /** * The ID of the sub-resource. */ id?: string; /** * Describes a network interface reference properties. */ properties?: outputs.computebulkactions.NetworkInterfaceReferencePropertiesResponse; } /** * Specifies the network interfaces or the networking configuration of the virtual machine. */ interface NetworkProfileResponse { /** * specifies the Microsoft.Network API version used when creating networking resources in the Network Interface Configurations */ networkApiVersion?: string; /** * Specifies the networking configurations that will be used to create the virtual machine networking resources. */ networkInterfaceConfigurations?: outputs.computebulkactions.VirtualMachineNetworkInterfaceConfigurationResponse[]; /** * Specifies the list of resource Ids for the network interfaces associated with the virtual machine. */ networkInterfaces?: outputs.computebulkactions.NetworkInterfaceReferenceResponse[]; } /** * Specifies information about the operating system disk used by the virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */ interface OSDiskResponse { /** * Specifies the caching requirements. Possible values are: None, ReadOnly, ReadWrite. The defaulting behavior is: None for Standard storage. ReadOnly for Premium storage. */ caching?: string; /** * Specifies how the virtual machine disk should be created. Possible values are Attach, FromImage. If you are using a platform image, you should also use the imageReference element described above. If you are using a marketplace image, you should also use the plan element previously described. */ createOption: string; /** * Specifies whether OS Disk should be deleted or detached upon VM deletion. Possible values are: Delete, Detach. The default value is set to Detach. For an ephemeral OS Disk, the default value is set to Delete. The user cannot change the delete option for an ephemeral OS Disk. */ deleteOption?: string; /** * Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine. */ diffDiskSettings?: outputs.computebulkactions.DiffDiskSettingsResponse; /** * Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. The property 'diskSizeGB' is the number of bytes x 1024^3 for the disk and the value cannot be larger than 1023. */ diskSizeGB?: number; /** * Specifies the encryption settings for the OS Disk. Minimum compute api-version: 2015-06-15. */ encryptionSettings?: outputs.computebulkactions.DiskEncryptionSettingsResponse; /** * The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist. */ image?: outputs.computebulkactions.VirtualHardDiskResponse; /** * The managed disk parameters. */ managedDisk?: outputs.computebulkactions.ManagedDiskParametersResponse; /** * The disk name. */ name?: string; /** * This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux. */ osType?: string; /** * The virtual hard disk. */ vhd?: outputs.computebulkactions.VirtualHardDiskResponse; /** * Specifies whether writeAccelerator should be enabled or disabled on the disk. */ writeAcceleratorEnabled?: boolean; } /** * Profile for the OS Image Scheduled event. */ interface OSImageNotificationProfileResponse { /** * Specifies whether the OS Image Scheduled event is enabled or disabled. */ enable?: boolean; /** * Length of time a Virtual Machine being reimaged or having its OS upgraded will have to potentially approve the OS Image Scheduled Event before the event is auto approved (timed out). The configuration is specified in ISO 8601 format, and the value must be 15 minutes (PT15M) */ notBeforeTimeout?: string; } /** * Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. */ interface OSProfileResponse { /** * Specifies the password of the administrator account.

**Minimum-length (Windows):** 8 characters

**Minimum-length (Linux):** 6 characters

**Max-length (Windows):** 123 characters

**Max-length (Linux):** 72 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) */ adminPassword?: string; /** * Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters. */ adminUsername?: string; /** * Specifies whether extension operations should be allowed on the virtual machine. This may only be set to False when no extensions are present on the virtual machine. */ allowExtensionOperations?: boolean; /** * Specifies the host OS name of the virtual machine. This name cannot be updated after the VM is created. **Max-length (Windows):** 15 characters. **Max-length (Linux):** 64 characters. For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/azure-resource-manager/management/resource-name-rules). */ computerName?: string; /** * Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes. **Note: Do not pass any secrets or passwords in customData property.** This property cannot be updated after the VM is created. The property 'customData' is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/blog/custom-data-and-cloud-init-on-windows-azure/). For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/linux/using-cloud-init). */ customData?: string; /** * Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */ linuxConfiguration?: outputs.computebulkactions.LinuxConfigurationResponse; /** * Optional property which must either be set to True or omitted. */ requireGuestProvisionSignal?: boolean; /** * Specifies set of certificates that should be installed onto the virtual machine. To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */ secrets?: outputs.computebulkactions.VaultSecretGroupResponse[]; /** * Specifies Windows operating system settings on the virtual machine. */ windowsConfiguration?: outputs.computebulkactions.WindowsConfigurationResponse; } /** * Specifies settings related to VM Guest Patching on Windows. */ interface PatchSettingsResponse { /** * Specifies the mode of VM Guest patch assessment for the IaaS virtual machine.

Possible values are:

**ImageDefault** - You control the timing of patch assessments on a virtual machine.

**AutomaticByPlatform** - The platform will trigger periodic patch assessments. The property provisionVMAgent must be true. */ assessmentMode?: string; /** * Specifies additional settings for patch mode AutomaticByPlatform in VM Guest Patching on Windows. */ automaticByPlatformSettings?: outputs.computebulkactions.WindowsVMGuestPatchAutomaticByPlatformSettingsResponse; /** * Enables customers to patch their Azure VMs without requiring a reboot. For enableHotpatching, the 'provisionVMAgent' must be set to true and 'patchMode' must be set to 'AutomaticByPlatform'. */ enableHotpatching?: boolean; /** * Specifies the mode of VM Guest Patching to IaaS virtual machine or virtual machines associated to virtual machine scale set with OrchestrationMode as Flexible.

Possible values are:

**Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

**AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

**AutomaticByPlatform** - the virtual machine will automatically updated by the platform. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true */ patchMode?: string; } /** * Plan for the resource. */ interface PlanResponse { /** * A user defined name of the 3rd Party Artifact that is being procured. */ name: string; /** * The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. */ product: string; /** * A publisher provided promotion code as provisioned in Data Market for the said product/artifact. */ promotionCode?: string; /** * The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic */ publisher: string; /** * The version of the desired product/artifact. */ version?: string; } /** * Contains properties that are applicable to both Spot and Regular. */ interface PriorityProfileResponse { /** * Allocation strategy to follow when determining the VM sizes distribution. */ allocationStrategy?: string; /** * Eviction Policy to follow when evicting Spot VMs. */ evictionPolicy?: string; /** * Price per hour of each Spot VM will never exceed this. */ maxPricePerVM?: number; /** * Specifies the type of Virtual Machine. */ type?: string; } /** * Specifies ProxyAgent settings for the virtual machine or virtual machine scale set. Minimum api-version: 2023-09-01. */ interface ProxyAgentSettingsResponse { /** * Specify whether to implicitly install the ProxyAgent Extension. This option is currently applicable only for Linux Os. */ addProxyAgentExtension?: boolean; /** * Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set. */ enabled?: boolean; /** * Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. */ imds?: outputs.computebulkactions.HostEndpointSettingsResponse; /** * Increase the value of this property allows users to reset the key used for securing communication channel between guest and host. */ keyIncarnationId?: number; /** * Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. */ mode?: string; /** * Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01. */ wireServer?: outputs.computebulkactions.HostEndpointSettingsResponse; } /** * Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. */ interface PublicIPAddressSkuResponse { /** * Specify public IP sku name */ name?: string; /** * Specify public IP sku tier */ tier?: string; } /** * The retry policy for the user request */ interface RetryPolicyResponse { /** * Retry count for user request */ retryCount?: number; /** * Retry window in minutes for user request */ retryWindowInMinutes?: number; } /** * Specifies additional publishing targets for scheduled events. */ interface ScheduledEventsAdditionalPublishingTargetsResponse { /** * The configuration parameters used while creating eventGridAndResourceGraph Scheduled Event setting. */ eventGridAndResourceGraph?: outputs.computebulkactions.EventGridAndResourceGraphResponse; } /** * Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations. */ interface ScheduledEventsPolicyResponse { /** * The configuration parameters used while creating AllInstancesDown scheduled event setting creation. */ allInstancesDown?: outputs.computebulkactions.AllInstancesDownResponse; /** * The configuration parameters used while publishing scheduledEventsAdditionalPublishingTargets. */ scheduledEventsAdditionalPublishingTargets?: outputs.computebulkactions.ScheduledEventsAdditionalPublishingTargetsResponse; /** * The configuration parameters used while creating userInitiatedReboot scheduled event setting creation. */ userInitiatedReboot?: outputs.computebulkactions.UserInitiatedRebootResponse; /** * The configuration parameters used while creating userInitiatedRedeploy scheduled event setting creation. */ userInitiatedRedeploy?: outputs.computebulkactions.UserInitiatedRedeployResponse; } /** * Profile for the scheduled events. */ interface ScheduledEventsProfileResponse { /** * Specifies OS Image Scheduled Event related configurations. */ osImageNotificationProfile?: outputs.computebulkactions.OSImageNotificationProfileResponse; /** * Specifies Terminate Scheduled Event related configurations. */ terminateNotificationProfile?: outputs.computebulkactions.TerminateNotificationProfileResponse; } /** * Specifies the Security profile settings for the virtual machine or virtual machine scale set. */ interface SecurityProfileResponse { /** * This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource. */ encryptionAtHost?: boolean; /** * Specifies the Managed Identity used by ADE to get access token for keyvault operations. */ encryptionIdentity?: outputs.computebulkactions.EncryptionIdentityResponse; /** * Specifies ProxyAgent settings while creating the virtual machine. Minimum compute api-version: 2023-09-01. */ proxyAgentSettings?: outputs.computebulkactions.ProxyAgentSettingsResponse; /** * Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set. */ securityType?: string; /** * Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum compute api-version: 2020-12-01. */ uefiSettings?: outputs.computebulkactions.UefiSettingsResponse; } /** * SSH configuration for Linux based VMs running on Azure */ interface SshConfigurationResponse { /** * The list of SSH public keys used to authenticate with linux based VMs. */ publicKeys?: outputs.computebulkactions.SshPublicKeyResponse[]; } /** * Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. */ interface SshPublicKeyResponse { /** * SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). */ keyData?: string; /** * Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys */ path?: string; } /** * Specifies the storage settings for the virtual machine disks. */ interface StorageProfileResponse { /** * Specifies the parameters that are used to add a data disk to a virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */ dataDisks?: outputs.computebulkactions.DataDiskResponse[]; /** * Specifies the disk controller type configured for the VM. **Note:** This property will be set to the default disk controller type if not specified provided virtual machine is being created with 'hyperVGeneration' set to V2 based on the capabilities of the operating system disk and VM size from the the specified minimum api version. You need to deallocate the VM before updating its disk controller type unless you are updating the VM size in the VM configuration which implicitly deallocates and reallocates the VM. Minimum api-version: 2022-08-01. */ diskControllerType?: string; /** * Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. */ imageReference?: outputs.computebulkactions.ImageReferenceResponse; /** * Specifies information about the operating system disk used by the virtual machine. For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/managed-disks-overview). */ osDisk?: outputs.computebulkactions.OSDiskResponse; } /** * Describes a reference to a sub-resource. */ interface SubResourceResponse { /** * The ID of the sub-resource. */ id?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Profile properties for the Terminate Scheduled event. */ interface TerminateNotificationProfileResponse { /** * Specifies whether the Terminate Scheduled event is enabled or disabled. */ enable?: boolean; /** * Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M) */ notBeforeTimeout?: string; } /** * Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01. */ interface UefiSettingsResponse { /** * Specifies whether secure boot should be enabled on the virtual machine. Minimum compute api-version: 2020-12-01. */ secureBootEnabled?: boolean; /** * Specifies whether vTPM should be enabled on the virtual machine. Minimum compute api-version: 2020-12-01. */ vTpmEnabled?: boolean; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Specifies Reboot related Scheduled Event related configurations. */ interface UserInitiatedRebootResponse { /** * Specifies Reboot Scheduled Event related configurations. */ automaticallyApprove?: boolean; } /** * Specifies Redeploy related Scheduled Event related configurations. */ interface UserInitiatedRedeployResponse { /** * Specifies Redeploy Scheduled Event related configurations. */ automaticallyApprove?: boolean; } /** * VMAttributes using double values. */ interface VMAttributeMinMaxDoubleResponse { /** * Maximum value. Must be greater than zero. Double.MaxValue(1.7976931348623157E+308). */ max?: number; /** * Minimum value. If not specified, no minimum filter is applied. */ min?: number; } /** * While retrieving VMSizes from CRS, Min = 0 (uint.MinValue) if not specified, Max = 4294967295 (uint.MaxValue) if not specified. This allows to filter VMAttributes on all available VMSizes. */ interface VMAttributeMinMaxIntegerResponse { /** * Max VMSize from CRS, Max = 4294967295 (uint.MaxValue) if not specified. */ max?: number; /** * Min VMSize from CRS, Min = 0 (uint.MinValue) if not specified. */ min?: number; } /** * VMAttributes that will be used to filter VMSizes which will be used to launch instances. */ interface VMAttributesResponse { /** * The range of accelerator count specified from min to max. Optional parameter. Either Min or Max is required if specified. * acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. * If acceleratorSupport is "Excluded", this VMAttribute can not be used. */ acceleratorCount?: outputs.computebulkactions.VMAttributeMinMaxIntegerResponse; /** * The accelerator manufacturers specified as a list. * acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. * If acceleratorSupport is "Excluded", this VMAttribute can not be used. */ acceleratorManufacturers?: string[]; /** * Specifies whether the VMSize supporting accelerator should be used to launch instances or not. * acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. * If acceleratorSupport is "Excluded", this VMAttribute can not be used. */ acceleratorSupport?: string; /** * The accelerator types specified as a list. acceleratorSupport should be set to "Included" or "Required" to use this VMAttribute. * If acceleratorSupport is "Excluded", this VMAttribute can not be used. */ acceleratorTypes?: string[]; /** * Specifies which VMSizes should be allowed while filtering on VMAttributes. Cannot be specified together with excludedVMSizes. Maximum of 10 VM sizes allowed. Optional parameter. */ allowedVMSizes?: string[]; /** * The VM architecture types specified as a list. Must be specified if VMAttributes are specified. Must be compatible with image used. */ architectureTypes: string[]; /** * Specifies whether the VMSize supporting burstable capability should be used to launch instances or not. */ burstableSupport?: string; /** * The VM CPU manufacturers specified as a list. Optional parameter. */ cpuManufacturers?: string[]; /** * The range of data disk count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. */ dataDiskCount?: outputs.computebulkactions.VMAttributeMinMaxIntegerResponse; /** * Specifies which VMSizes should be excluded while filtering on VMAttributes. Cannot be specified together with allowedVMSizes. Maximum of 10 VM sizes allowed. Optional parameter. */ excludedVMSizes?: string[]; /** * The hyperV generations specified as a list. Optional parameter. */ hyperVGenerations?: string[]; /** * The local storage disk types specified as a list. LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. * If localStorageSupport is "Excluded", this VMAttribute can not be used. */ localStorageDiskTypes?: string[]; /** * LocalStorageSupport should be set to "Included" or "Required" to use this VMAttribute. * If localStorageSupport is "Excluded", this VMAttribute can not be used. */ localStorageInGiB?: outputs.computebulkactions.VMAttributeMinMaxDoubleResponse; /** * Specifies whether the VMSize supporting local storage should be used to launch instances or not. * Included - Default if not specified as most Azure VMs support local storage. */ localStorageSupport?: string; /** * The range of memory specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. */ memoryInGiB: outputs.computebulkactions.VMAttributeMinMaxDoubleResponse; /** * The range of memory in GiB per vCPU specified from min to max. Optional parameter. Either Min or Max is required if specified. */ memoryInGiBPerVCpu?: outputs.computebulkactions.VMAttributeMinMaxDoubleResponse; /** * The range of network bandwidth in Mbps specified from Min to Max. Optional parameter. Either Min or Max is required if specified. */ networkBandwidthInMbps?: outputs.computebulkactions.VMAttributeMinMaxDoubleResponse; /** * The range of network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. */ networkInterfaceCount?: outputs.computebulkactions.VMAttributeMinMaxIntegerResponse; /** * The range of RDMA (Remote Direct Memory Access) network interface count specified from Min to Max. Optional parameter. Either Min or Max is required if specified. * rdmaSupport should be set to "Included" or "Required" to use this VMAttribute. * If rdmaSupport is "Excluded", this VMAttribute can not be used. */ rdmaNetworkInterfaceCount?: outputs.computebulkactions.VMAttributeMinMaxIntegerResponse; /** * Specifies whether the VMSize supporting RDMA (Remote Direct Memory Access) should be used to build launch instances or not. */ rdmaSupport?: string; /** * The range of vCpuCount specified from Min to Max. Must be specified if VMAttributes are specified, either Min or Max is required if specified. */ vCpuCount: outputs.computebulkactions.VMAttributeMinMaxIntegerResponse; /** * The VM category specified as a list. Optional parameter. */ vmCategories?: string[]; } /** * Specifies the security profile settings for the managed disk. **Note:** It can only be set for Confidential VMs. */ interface VMDiskSecurityProfileResponse { /** * Specifies the customer managed disk encryption set resource id for the managed disk that is used for Customer Managed Key encrypted ConfidentialVM OS Disk and VMGuest blob. */ diskEncryptionSet?: outputs.computebulkactions.DiskEncryptionSetParametersResponse; /** * Specifies the EncryptionType of the managed disk. It is set to DiskWithVMGuestState for encryption of the managed disk along with VMGuestState blob, VMGuestStateOnly for encryption of just the VMGuestState blob, and NonPersistedTPM for not persisting firmware state in the VMGuestState blob.. **Note:** It can be set for only Confidential VMs. */ securityEncryptionType?: string; } /** * Specifies the required information to reference a compute gallery application version */ interface VMGalleryApplicationResponse { /** * Optional, Specifies the uri to an azure blob that will replace the default configuration for the package if provided */ configurationReference?: string; /** * If set to true, when a new Gallery Application version is available in PIR/SIG, it will be automatically updated for the VM/VMSS */ enableAutomaticUpgrade?: boolean; /** * Optional, Specifies the order in which the packages have to be installed */ order?: number; /** * Specifies the GalleryApplicationVersion resource id on the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/applications/{application}/versions/{version} */ packageReferenceId: string; /** * Optional, Specifies a passthrough value for more generic context. */ tags?: string; /** * Optional, If true, any failure for any operation in the VmApplication will fail the deployment */ treatFailureAsDeploymentFailure?: boolean; } /** * Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM. */ interface VaultCertificateResponse { /** * For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account. For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. */ certificateStore?: string; /** * This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
'data':'',
'dataType':'pfx',
'password':''
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */ certificateUrl?: string; } /** * Describes a set of certificates which are all in the same Key Vault. */ interface VaultSecretGroupResponse { /** * The relative URL of the Key Vault containing all of the certificates in VaultCertificates. */ sourceVault?: outputs.computebulkactions.SubResourceResponse; /** * The list of key vault references in SourceVault which contain certificates. */ vaultCertificates?: outputs.computebulkactions.VaultCertificateResponse[]; } /** * Describes the uri of a disk. */ interface VirtualHardDiskResponse { /** * Specifies the virtual hard disk's uri. */ uri?: string; } /** * Describes the properties of a Virtual Machine Extension. */ interface VirtualMachineExtensionPropertiesResponse { /** * Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */ autoUpgradeMinorVersion?: boolean; /** * Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */ enableAutomaticUpgrade?: boolean; /** * How the extension handler should be forced to update even if the extension configuration has not changed. */ forceUpdateTag?: string; /** * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */ protectedSettings?: any; /** * The extensions protected settings that are passed by reference, and consumed from key vault */ protectedSettingsFromKeyVault?: outputs.computebulkactions.KeyVaultSecretReferenceResponse; /** * Collection of extension names after which this extension needs to be provisioned. */ provisionAfterExtensions?: string[]; /** * The name of the extension handler publisher. */ publisher?: string; /** * JSON formatted public settings for the extension. */ settings?: any; /** * Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false. */ suppressFailures?: boolean; /** * Specifies the type of the extension; an example is 'CustomScriptExtension'. */ type?: string; /** * Specifies the version of the script handler. */ typeHandlerVersion?: string; } /** * Defines a virtual machine extension. */ interface VirtualMachineExtensionResponse { /** * The name of the virtual machine extension. */ name: string; /** * Properties of the virtual machine extension. */ properties: outputs.computebulkactions.VirtualMachineExtensionPropertiesResponse; } /** * Contains the IP tag associated with the public IP address. */ interface VirtualMachineIpTagResponse { /** * IP tag type. Example: FirstPartyUsage. */ ipTagType?: string; /** * IP tag associated with the public IP. Example: SQL, Storage etc. */ tag?: string; } /** * Describes a virtual machine network profile's IP configuration. */ interface VirtualMachineNetworkInterfaceConfigurationPropertiesResponse { /** * Specifies whether the Auxiliary mode is enabled for the Network Interface resource. */ auxiliaryMode?: string; /** * Specifies whether the Auxiliary sku is enabled for the Network Interface resource. */ auxiliarySku?: string; /** * Specify what happens to the network interface when the VM is deleted */ deleteOption?: string; /** * Specifies whether the network interface is disabled for tcp state tracking. */ disableTcpStateTracking?: boolean; /** * The dns settings to be applied on the network interfaces. */ dnsSettings?: outputs.computebulkactions.VirtualMachineNetworkInterfaceDnsSettingsConfigurationResponse; /** * The DSCP configuration for the network interface. */ dscpConfiguration?: outputs.computebulkactions.SubResourceResponse; /** * Specifies whether the network interface is accelerated networking-enabled. */ enableAcceleratedNetworking?: boolean; /** * Specifies whether the network interface is FPGA networking-enabled. */ enableFpga?: boolean; /** * Whether IP forwarding enabled on this NIC. */ enableIPForwarding?: boolean; /** * Specifies the IP configurations of the network interface. */ ipConfigurations: outputs.computebulkactions.VirtualMachineNetworkInterfaceIPConfigurationResponse[]; /** * The network security group. */ networkSecurityGroup?: outputs.computebulkactions.SubResourceResponse; /** * Specifies the primary network interface in case the virtual machine has more than 1 network interface. */ primary?: boolean; } /** * Describes a virtual machine network interface configurations. */ interface VirtualMachineNetworkInterfaceConfigurationResponse { /** * The network interface configuration name. */ name: string; /** * Describes a virtual machine network profile's IP configuration. */ properties?: outputs.computebulkactions.VirtualMachineNetworkInterfaceConfigurationPropertiesResponse; /** * Resource tags applied to the networkInterface address created by this NetworkInterfaceConfiguration */ tags?: { [key: string]: string; }; } /** * Describes a virtual machines network configuration's DNS settings. */ interface VirtualMachineNetworkInterfaceDnsSettingsConfigurationResponse { /** * List of DNS servers IP addresses */ dnsServers?: string[]; } /** * Describes a virtual machine network interface IP configuration properties. */ interface VirtualMachineNetworkInterfaceIPConfigurationPropertiesResponse { /** * Specifies an array of references to backend address pools of application gateways. A virtual machine can reference backend address pools of multiple application gateways. Multiple virtual machines cannot use the same application gateway. */ applicationGatewayBackendAddressPools?: outputs.computebulkactions.SubResourceResponse[]; /** * Specifies an array of references to application security group. */ applicationSecurityGroups?: outputs.computebulkactions.SubResourceResponse[]; /** * Specifies an array of references to backend address pools of load balancers. A virtual machine can reference backend address pools of one public and one internal load balancer. [Multiple virtual machines cannot use the same basic sku load balancer]. */ loadBalancerBackendAddressPools?: outputs.computebulkactions.SubResourceResponse[]; /** * Specifies the primary network interface in case the virtual machine has more than 1 network interface. */ primary?: boolean; /** * Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. */ privateIPAddressVersion?: string; /** * The publicIPAddressConfiguration. */ publicIPAddressConfiguration?: outputs.computebulkactions.VirtualMachinePublicIPAddressConfigurationResponse; /** * Specifies the identifier of the subnet. */ subnet?: outputs.computebulkactions.SubResourceResponse; } /** * Describes a virtual machine network profile's IP configuration. */ interface VirtualMachineNetworkInterfaceIPConfigurationResponse { /** * The IP configuration name. */ name: string; /** * Describes a virtual machine network interface IP configuration properties. */ properties?: outputs.computebulkactions.VirtualMachineNetworkInterfaceIPConfigurationPropertiesResponse; } /** * Describes the properties of a Virtual Machine. */ interface VirtualMachineProfileResponse { /** * Specifies additional capabilities enabled or disabled on the virtual machine. */ additionalCapabilities?: outputs.computebulkactions.AdditionalCapabilitiesResponse; /** * Specifies the gallery applications that should be made available to the VM. */ applicationProfile?: outputs.computebulkactions.ApplicationProfileResponse; /** * Specifies information about the capacity reservation that is used to allocate virtual machine. Minimum compute api-version: 2021-04-01. */ capacityReservation?: outputs.computebulkactions.CapacityReservationProfileResponse; /** * Specifies the boot diagnostic settings state. Minimum compute api-version: 2015-06-15. */ diagnosticsProfile?: outputs.computebulkactions.DiagnosticsProfileResponse; /** * Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M). Minimum compute api-version: 2020-06-01. */ extensionsTimeBudget?: string; /** * Specifies that the image or disk that is being used was licensed on-premises.

Possible values for Windows Server operating system are:

Windows_Client

Windows_Server

Possible values for Linux Server operating system are:

RHEL_BYOS (for RHEL)

SLES_BYOS (for SUSE)

For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/windows/hybrid-use-benefit-licensing)

[Azure Hybrid Use Benefit for Linux Server](https://docs.microsoft.com/azure/virtual-machines/linux/azure-hybrid-benefit-linux)

Minimum api-version: 2015-06-15 */ licenseType?: string; /** * Specifies the network interfaces of the virtual machine. */ networkProfile?: outputs.computebulkactions.NetworkProfileResponse; /** * Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned. */ osProfile?: outputs.computebulkactions.OSProfileResponse; /** * Specifies Redeploy, Reboot and ScheduledEventsAdditionalPublishingTargets Scheduled Event related configurations for the virtual machine. */ scheduledEventsPolicy?: outputs.computebulkactions.ScheduledEventsPolicyResponse; /** * Specifies Scheduled Event related configurations. */ scheduledEventsProfile?: outputs.computebulkactions.ScheduledEventsProfileResponse; /** * Specifies the Security related profile settings for the virtual machine. */ securityProfile?: outputs.computebulkactions.SecurityProfileResponse; /** * Specifies the storage settings for the virtual machine disks. */ storageProfile?: outputs.computebulkactions.StorageProfileResponse; /** * UserData for the VM, which must be base-64 encoded. Customer should not pass any secrets in here. Minimum compute api-version: 2021-03-01. */ userData?: string; } /** * Describes a virtual machines IP Configuration's PublicIPAddress configuration */ interface VirtualMachinePublicIPAddressConfigurationPropertiesResponse { /** * Specify what happens to the public IP address when the VM is deleted */ deleteOption?: string; /** * The dns settings to be applied on the publicIP addresses . */ dnsSettings?: outputs.computebulkactions.VirtualMachinePublicIPAddressDnsSettingsConfigurationResponse; /** * The idle timeout of the public IP address. */ idleTimeoutInMinutes?: number; /** * The list of IP tags associated with the public IP address. */ ipTags?: outputs.computebulkactions.VirtualMachineIpTagResponse[]; /** * Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. */ publicIPAddressVersion?: string; /** * Specify the public IP allocation type */ publicIPAllocationMethod?: string; /** * The PublicIPPrefix from which to allocate publicIP addresses. */ publicIPPrefix?: outputs.computebulkactions.SubResourceResponse; } /** * Describes a virtual machines IP Configuration's PublicIPAddress configuration */ interface VirtualMachinePublicIPAddressConfigurationResponse { /** * The publicIP address configuration name. */ name: string; /** * Describes a virtual machines IP Configuration's PublicIPAddress configuration */ properties?: outputs.computebulkactions.VirtualMachinePublicIPAddressConfigurationPropertiesResponse; /** * Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible. */ sku?: outputs.computebulkactions.PublicIPAddressSkuResponse; /** * Resource tags applied to the publicIP address created by this PublicIPAddressConfiguration */ tags?: { [key: string]: string; }; } /** * Describes a virtual machines network configuration's DNS settings. */ interface VirtualMachinePublicIPAddressDnsSettingsConfigurationResponse { /** * The Domain name label prefix of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the domain name label and vm network profile unique ID. */ domainNameLabel: string; /** * The Domain name label scope of the PublicIPAddress resources that will be created. The generated name label is the concatenation of the hashed domain name label with policy according to the domain name label scope and vm network profile unique ID. */ domainNameLabelScope?: string; } /** * Specifications about a VM Size. This will also contain the corresponding rank and weight in future. */ interface VmSizeProfileResponse { /** * The Sku name (e.g. 'Standard_DS1_v2') */ name: string; /** * The rank of the VM size. This is used with 'AllocationStrategy.Prioritized' * The lower the number, the higher the priority. Starting with 0. */ rank?: number; } /** * Describes Windows Remote Management configuration of the VM */ interface WinRMConfigurationResponse { /** * The list of Windows Remote Management listeners */ listeners?: outputs.computebulkactions.WinRMListenerResponse[]; } /** * Describes Protocol and thumbprint of Windows Remote Management listener */ interface WinRMListenerResponse { /** * This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
"data":"",
"dataType":"pfx",
"password":""
}
To install certificates on a virtual machine it is recommended to use the [Azure Key Vault virtual machine extension for Linux](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-linux) or the [Azure Key Vault virtual machine extension for Windows](https://docs.microsoft.com/azure/virtual-machines/extensions/key-vault-windows). */ certificateUrl?: string; /** * Specifies the protocol of WinRM listener. Possible values are: **http,** **https.** */ protocol?: string; } /** * Specifies Windows operating system settings on the virtual machine. */ interface WindowsConfigurationResponse { /** * Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. */ additionalUnattendContent?: outputs.computebulkactions.AdditionalUnattendContentResponse[]; /** * Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true. For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning. */ enableAutomaticUpdates?: boolean; /** * [Preview Feature] Specifies settings related to VM Guest Patching on Windows. */ patchSettings?: outputs.computebulkactions.PatchSettingsResponse; /** * Indicates whether virtual machine agent should be provisioned on the virtual machine. When this property is not specified in the request body, it is set to true by default. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later. */ provisionVMAgent?: boolean; /** * Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/dotnet/api/system.timezoneinfo.getsystemtimezones). */ timeZone?: string; /** * Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell. */ winRM?: outputs.computebulkactions.WinRMConfigurationResponse; } /** * Specifies additional settings to be applied when patch mode AutomaticByPlatform is selected in Windows patch settings. */ interface WindowsVMGuestPatchAutomaticByPlatformSettingsResponse { /** * Enables customer to schedule patching without accidental upgrades */ bypassPlatformSafetyChecksOnUserSchedule?: boolean; /** * Specifies the reboot setting for all AutomaticByPlatform patch installation operations. */ rebootSetting?: string; } /** * ZoneAllocationPolicy for LaunchBulkInstancesOperation. */ interface ZoneAllocationPolicyResponse { /** * Distribution strategy used for zone allocation policy. */ distributionStrategy: string; /** * Zone preferences, required when zone distribution strategy is Prioritized. */ zonePreferences?: outputs.computebulkactions.ZonePreferenceResponse[]; } /** * Zone preferences for LaunchBulkInstancesOperation zone allocation policy. */ interface ZonePreferenceResponse { /** * The rank of the zone. This is used with 'Prioritized' ZoneDistributionStrategy. * The lower the number, the higher the priority, starting with 0. * 0 is the highest rank. If not specified, defaults to lowest rank. */ rank?: number; /** * Name of the zone. */ zone: string; } } export declare namespace computelimit { /** * Properties of the limit name. */ interface LimitNameResponse { /** * The localized limit name. */ localizedValue: string; /** * The limit name. */ value: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace computeschedule { /** * Extra details needed to run the user's request */ interface ExecutionParametersResponse { /** * Details that could optimize the user's request */ optimizationPreference?: string; /** * Retry policy the user can pass */ retryPolicy?: outputs.computeschedule.RetryPolicyResponse; } /** * The information about notifications to be send to about upcoming operations. */ interface NotificationPropertiesResponse { /** * Where the notification should be sent. For email, it should follow email format. */ destination: string; /** * Tells if the notification is enabled or not. */ disabled?: boolean; /** * The language the notification should be sent on. */ language: string; /** * Type of notification to be sent. */ type: string; } /** * notificationPropertiesResponseProvideDefaults sets the appropriate defaults for NotificationPropertiesResponse */ function notificationPropertiesResponseProvideDefaults(val: NotificationPropertiesResponse): NotificationPropertiesResponse; /** * The retry policy for the user request */ interface RetryPolicyResponse { /** * Retry count for user request */ retryCount?: number; /** * Retry window in minutes for user request */ retryWindowInMinutes?: number; } /** * Scheduled action properties */ interface ScheduledActionPropertiesResponse { /** * The action the scheduled action should perform in the resources */ actionType: string; /** * Tell if the scheduled action is disabled or not */ disabled?: boolean; /** * The time when the scheduled action is supposed to stop scheduling */ endTime?: string; /** * The notification settings for the scheduled action */ notificationSettings: outputs.computeschedule.NotificationPropertiesResponse[]; /** * The status of the last provisioning operation performed on the resource. */ provisioningState: string; /** * The type of resource the scheduled action is targeting */ resourceType: string; /** * The schedule the scheduled action is supposed to follow */ schedule: outputs.computeschedule.ScheduledActionsScheduleResponse; /** * The time which the scheduled action is supposed to start running */ startTime: string; } /** * scheduledActionPropertiesResponseProvideDefaults sets the appropriate defaults for ScheduledActionPropertiesResponse */ function scheduledActionPropertiesResponseProvideDefaults(val: ScheduledActionPropertiesResponse): ScheduledActionPropertiesResponse; /** * Specify the schedule in which the scheduled action is supposed to follow */ interface ScheduledActionsScheduleResponse { /** * The type of deadline the scheduled action is supposed to follow for the schedule. If no value is passed, it will default to InitiateAt. */ deadlineType?: string; /** * The execution parameters the scheduled action is supposed to follow */ executionParameters?: outputs.computeschedule.ExecutionParametersResponse; /** * The days of the month the scheduled action is supposed to run on. If empty, it means it will run on every day of the month. */ requestedDaysOfTheMonth: number[]; /** * The months the scheduled action is supposed to run on */ requestedMonths: string[]; /** * The week days the scheduled action is supposed to run on */ requestedWeekDays: string[]; /** * The time the scheduled action is supposed to run on */ scheduledTime: string; /** * The timezone the scheduled time is specified on */ timeZone: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace confidentialledger { /** * AAD based security principal with associated Ledger RoleName */ interface AADBasedSecurityPrincipalResponse { /** * LedgerRole associated with the Security Principal of Ledger */ ledgerRoleName?: string; /** * UUID/GUID based Principal Id of the Security Principal */ principalId?: string; /** * UUID/GUID based Tenant Id of the Security Principal */ tenantId?: string; } /** * Cert based security principal with Ledger RoleName */ interface CertBasedSecurityPrincipalResponse { /** * Public key of the user cert (.pem or .cer) */ cert?: string; /** * LedgerRole associated with the Security Principal of Ledger */ ledgerRoleName?: string; } /** * Tags for Managed CCF Certificates */ interface CertificateTagsResponse { /** * Additional tags for Managed CCF Certificates */ tags?: { [key: string]: string; }; } /** * Object representing DeploymentType for Managed CCF. */ interface DeploymentTypeResponse { /** * Source Uri containing ManagedCCF code */ appSourceUri?: string; /** * Unique name for the Managed CCF. */ languageRuntime?: string; } /** * Additional Confidential Ledger properties. */ interface LedgerPropertiesResponse { /** * Array of all AAD based Security Principals. */ aadBasedSecurityPrincipals?: outputs.confidentialledger.AADBasedSecurityPrincipalResponse[]; /** * Array of all cert based Security Principals. */ certBasedSecurityPrincipals?: outputs.confidentialledger.CertBasedSecurityPrincipalResponse[]; /** * Endpoint for accessing network identity. */ identityServiceUri: string; /** * Internal namespace for the Ledger */ ledgerInternalNamespace: string; /** * Unique name for the Confidential Ledger. */ ledgerName: string; /** * SKU associated with the ledger */ ledgerSku?: string; /** * Type of Confidential Ledger */ ledgerType?: string; /** * Endpoint for calling Ledger Service. */ ledgerUri: string; /** * Provisioning state of Ledger Resource */ provisioningState: string; /** * Object representing RunningState for Ledger. */ runningState?: string; } /** * Additional Managed CCF properties. */ interface ManagedCCFPropertiesResponse { /** * Unique name for the Managed CCF. */ appName: string; /** * Endpoint for calling Managed CCF Service. */ appUri: string; /** * Deployment Type of Managed CCF */ deploymentType?: outputs.confidentialledger.DeploymentTypeResponse; /** * Endpoint for accessing network identity. */ identityServiceUri: string; /** * List of member identity certificates for Managed CCF */ memberIdentityCertificates?: outputs.confidentialledger.MemberIdentityCertificateResponse[]; /** * Number of CCF nodes in the Managed CCF. */ nodeCount?: number; /** * Provisioning state of Managed CCF Resource */ provisioningState: string; /** * Object representing RunningState for Managed CCF. */ runningState?: string; } /** * Object representing MemberIdentityCertificate for Managed CCF. */ interface MemberIdentityCertificateResponse { /** * Member Identity Certificate */ certificate?: string; /** * Member Identity Certificate Encryption Key */ encryptionkey?: string; tags?: outputs.confidentialledger.CertificateTagsResponse[]; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace confluent { /** * The authentication info when auth_type is azureBlobStorageSinkConnector */ interface AzureBlobStorageSinkConnectorServiceInfoResponse { /** * The connector service type. * Expected value is 'AzureBlobStorageSinkConnector'. */ connectorServiceType: "AzureBlobStorageSinkConnector"; /** * Azure Blob Storage Account Key */ storageAccountKey?: string; /** * Azure Blob Storage Account Name */ storageAccountName?: string; /** * Azure Blob Storage Account Container Name */ storageContainerName?: string; } /** * The connector service type is AzureBlobStorageSourceConnector */ interface AzureBlobStorageSourceConnectorServiceInfoResponse { /** * The connector service type. * Expected value is 'AzureBlobStorageSourceConnector'. */ connectorServiceType: "AzureBlobStorageSourceConnector"; /** * Azure Blob Storage Account Key */ storageAccountKey?: string; /** * Azure Blob Storage Account Name */ storageAccountName?: string; /** * Azure Blob Storage Account Container Name */ storageContainerName?: string; } /** * The authentication info when auth_type is AzureCosmosDBSinkConnector */ interface AzureCosmosDBSinkConnectorServiceInfoResponse { /** * The connector service type. * Expected value is 'AzureCosmosDBSinkConnector'. */ connectorServiceType: "AzureCosmosDBSinkConnector"; /** * Azure Cosmos Database Connection Endpoint */ cosmosConnectionEndpoint?: string; /** * Azure Cosmos Database Containers Topic Mapping */ cosmosContainersTopicMapping?: string; /** * Azure Cosmos Database Name */ cosmosDatabaseName?: string; /** * Azure Cosmos Database Id Strategy */ cosmosIdStrategy?: string; /** * Azure Cosmos Database Master Key */ cosmosMasterKey?: string; } /** * The authentication info when auth_type is AzureCosmosDBSourceConnector */ interface AzureCosmosDBSourceConnectorServiceInfoResponse { /** * The connector service type. * Expected value is 'AzureCosmosDBSourceConnector'. */ connectorServiceType: "AzureCosmosDBSourceConnector"; /** * Azure Cosmos Database Connection Endpoint */ cosmosConnectionEndpoint?: string; /** * Azure Cosmos Database Containers Topic Mapping */ cosmosContainersTopicMapping?: string; /** * Azure Cosmos Database Name */ cosmosDatabaseName?: string; /** * Azure Cosmos Database Master Key */ cosmosMasterKey?: string; /** * Azure Cosmos Database Message Key Enabled */ cosmosMessageKeyEnabled?: boolean; /** * Azure Cosmos Database Message Key Field */ cosmosMessageKeyField?: string; } /** * The authentication info when auth_type is AzureSynapseAnalyticsSinkConnector */ interface AzureSynapseAnalyticsSinkConnectorServiceInfoResponse { /** * The connector service type. * Expected value is 'AzureSynapseAnalyticsSinkConnector'. */ connectorServiceType: "AzureSynapseAnalyticsSinkConnector"; /** * Azure Synapse Dedicated SQL Pool Database Name */ synapseSqlDatabaseName?: string; /** * Azure Synapse SQL login details */ synapseSqlPassword?: string; /** * Azure Synapse Analytics SQL Server Name */ synapseSqlServerName?: string; /** * Azure Synapse SQL login details */ synapseSqlUser?: string; } /** * The network associated with this object */ interface ClusterByokEntityResponse { /** * ID of the referred resource */ id?: string; /** * API URL for accessing or modifying the referred object */ related?: string; /** * CRN reference to the referred resource */ resourceName?: string; } /** * The configuration of the Kafka cluster */ interface ClusterConfigEntityResponse { /** * The lifecycle phase of the cluster */ kind?: string; } /** * The environment to which cluster belongs */ interface ClusterEnvironmentEntityResponse { /** * Environment of the referred resource */ environment?: string; /** * ID of the referred resource */ id?: string; /** * API URL for accessing or modifying the referred object */ related?: string; /** * CRN reference to the referred resource */ resourceName?: string; } /** * The network associated with this object */ interface ClusterNetworkEntityResponse { /** * Environment of the referred resource */ environment?: string; /** * ID of the referred resource */ id?: string; /** * API URL for accessing or modifying the referred object */ related?: string; /** * CRN reference to the referred resource */ resourceName?: string; } /** * Details of cluster record */ interface ClusterRecordResponse { /** * Display name of the cluster */ displayName?: string; /** * Id of the cluster */ id?: string; /** * Type of cluster */ kind?: string; /** * Metadata of the record */ metadata?: outputs.confluent.MetadataEntityResponse; /** * Specification of the cluster */ spec?: outputs.confluent.ClusterSpecEntityResponse; /** * Specification of the cluster */ status?: outputs.confluent.ClusterStatusEntityResponse; } /** * Spec of the cluster record */ interface ClusterSpecEntityResponse { /** * The Kafka API cluster endpoint */ apiEndpoint?: string; /** * The availability zone configuration of the cluster */ availability?: string; /** * Specification of the cluster */ byok?: outputs.confluent.ClusterByokEntityResponse; /** * The cloud service provider */ cloud?: string; /** * Specification of the cluster */ config?: outputs.confluent.ClusterConfigEntityResponse; /** * The name of the cluster */ displayName?: string; /** * Specification of the cluster */ environment?: outputs.confluent.ClusterEnvironmentEntityResponse; /** * The cluster HTTP request URL. */ httpEndpoint?: string; /** * The bootstrap endpoint used by Kafka clients to connect to the cluster */ kafkaBootstrapEndpoint?: string; /** * Specification of the cluster */ network?: outputs.confluent.ClusterNetworkEntityResponse; /** * The cloud service provider region */ region?: string; /** * type of zone availability */ zone?: string; } /** * Status of the cluster record */ interface ClusterStatusEntityResponse { /** * The number of Confluent Kafka Units */ cku?: number; /** * The lifecycle phase of the cluster */ phase?: string; } /** * Metadata of the list */ interface ConfluentListMetadataResponse { /** * First page of the list */ first?: string; /** * Last page of the list */ last?: string; /** * Next page of the list */ next?: string; /** * Previous page of the list */ prev?: string; /** * Total size of the list */ totalSize?: number; } /** * Connector Info Base properties */ interface ConnectorInfoBaseResponse { /** * Connector Class */ connectorClass?: string; /** * Connector Id */ connectorId?: string; /** * Connector Name */ connectorName?: string; /** * Connector Status */ connectorState?: string; /** * Connector Type */ connectorType?: string; } /** * Details about environment name, metadata and environment id of an environment */ interface EnvironmentRecordResponse { /** * Display name of the user */ displayName?: string; /** * Id of the environment */ id?: string; /** * Type of environment */ kind?: string; /** * Metadata of the record */ metadata?: outputs.confluent.MetadataEntityResponse; } /** * Record of the invitation */ interface InvitationRecordResponse { /** * Accepted date time of the invitation */ acceptedAt?: string; /** * Auth type of the user */ authType?: string; /** * Email of the user */ email?: string; /** * Expiration date time of the invitation */ expiresAt?: string; /** * Id of the invitation */ id?: string; /** * Type of account */ kind?: string; /** * Metadata of the record */ metadata?: outputs.confluent.MetadataEntityResponse; /** * Status of the invitation */ status?: string; } /** * The partner connector type is KafkaAzureBlobStorageSink */ interface KafkaAzureBlobStorageSinkConnectorInfoResponse { /** * Kafka API Key */ apiKey?: string; /** * Kafka API Key Secret */ apiSecret?: string; /** * Kafka Auth Type */ authType?: string; /** * Flush size */ flushSize?: string; /** * Kafka Input Data Format Type */ inputFormat?: string; /** * Maximum Tasks */ maxTasks?: string; /** * Kafka Output Data Format Type */ outputFormat?: string; /** * Partner Connector type. * Expected value is 'KafkaAzureBlobStorageSink'. */ partnerConnectorType: "KafkaAzureBlobStorageSink"; /** * Kafka Service Account Id */ serviceAccountId?: string; /** * Time Interval */ timeInterval?: string; /** * Kafka topics list */ topics?: string[]; /** * Kafka topics directory */ topicsDir?: string; } /** * The partner connector type is KafkaAzureBlobStorageSource */ interface KafkaAzureBlobStorageSourceConnectorInfoResponse { /** * Kafka API Key */ apiKey?: string; /** * Kafka API Secret */ apiSecret?: string; /** * Kafka Auth Type */ authType?: string; /** * Kafka Input Data Format Type */ inputFormat?: string; /** * Maximum Tasks */ maxTasks?: string; /** * Kafka Output Data Format Type */ outputFormat?: string; /** * Partner Connector type. * Expected value is 'KafkaAzureBlobStorageSource'. */ partnerConnectorType: "KafkaAzureBlobStorageSource"; /** * Kafka Service Account Id */ serviceAccountId?: string; /** * Kafka topics Regex pattern */ topicRegex?: string; /** * Kafka topics directory */ topicsDir?: string; } /** * The partner connector type is KafkaAzureCosmosDBSink */ interface KafkaAzureCosmosDBSinkConnectorInfoResponse { /** * Kafka API Key */ apiKey?: string; /** * Kafka API Key Secret */ apiSecret?: string; /** * Kafka Auth Type */ authType?: string; /** * Flush size */ flushSize?: string; /** * Kafka Input Data Format Type */ inputFormat?: string; /** * Maximum Tasks */ maxTasks?: string; /** * Kafka Output Data Format Type */ outputFormat?: string; /** * Partner Connector type. * Expected value is 'KafkaAzureCosmosDBSink'. */ partnerConnectorType: "KafkaAzureCosmosDBSink"; /** * Kafka Service Account Id */ serviceAccountId?: string; /** * Time Interval */ timeInterval?: string; /** * Kafka topics list */ topics?: string[]; /** * Kafka topics directory */ topicsDir?: string; } /** * The partner connector type is KafkaAzureCosmosDBSource */ interface KafkaAzureCosmosDBSourceConnectorInfoResponse { /** * Kafka API Key */ apiKey?: string; /** * Kafka API Secret */ apiSecret?: string; /** * Kafka Auth Type */ authType?: string; /** * Kafka Input Data Format Type */ inputFormat?: string; /** * Maximum Tasks */ maxTasks?: string; /** * Kafka Output Data Format Type */ outputFormat?: string; /** * Partner Connector type. * Expected value is 'KafkaAzureCosmosDBSource'. */ partnerConnectorType: "KafkaAzureCosmosDBSource"; /** * Kafka Service Account Id */ serviceAccountId?: string; /** * Kafka topics Regex pattern */ topicRegex?: string; /** * Kafka topics directory */ topicsDir?: string; } /** * The partner connector type is KafkaAzureSynapseAnalyticsSink */ interface KafkaAzureSynapseAnalyticsSinkConnectorInfoResponse { /** * Kafka API Key */ apiKey?: string; /** * Kafka API Key Secret */ apiSecret?: string; /** * Kafka Auth Type */ authType?: string; /** * Flush size */ flushSize?: string; /** * Kafka Input Data Format Type */ inputFormat?: string; /** * Maximum Tasks */ maxTasks?: string; /** * Kafka Output Data Format Type */ outputFormat?: string; /** * Partner Connector type. * Expected value is 'KafkaAzureSynapseAnalyticsSink'. */ partnerConnectorType: "KafkaAzureSynapseAnalyticsSink"; /** * Kafka Service Account Id */ serviceAccountId?: string; /** * Time Interval */ timeInterval?: string; /** * Kafka topics list */ topics?: string[]; /** * Kafka topics directory */ topicsDir?: string; } /** * Metadata of the data record */ interface MetadataEntityResponse { /** * Created Date Time */ createdAt?: string; /** * Deleted Date time */ deletedAt?: string; /** * Resource name of the record */ resourceName?: string; /** * Self lookup url */ self?: string; /** * Updated Date time */ updatedAt?: string; } /** * Confluent Offer detail */ interface OfferDetailResponse { /** * Offer Id */ id: string; /** * Offer Plan Id */ planId: string; /** * Offer Plan Name */ planName: string; /** * Private Offer Id */ privateOfferId?: string; /** * Array of Private Offer Ids */ privateOfferIds?: string[]; /** * Publisher Id */ publisherId: string; /** * SaaS Offer Status */ status: string; /** * Offer Plan Term Id */ termId?: string; /** * Offer Plan Term unit */ termUnit: string; } /** * Details of region record */ interface RegionRecordResponse { /** * Id of the cluster */ id?: string; /** * Kind of the cluster */ kind?: string; /** * Metadata of the record */ metadata?: outputs.confluent.SCMetadataEntityResponse; /** * Specification of the region */ spec?: outputs.confluent.RegionSpecEntityResponse; } /** * Region spec details */ interface RegionSpecEntityResponse { /** * Cloud provider name */ cloud?: string; /** * Display Name of the region */ name?: string; packages?: string[]; /** * Region name */ regionName?: string; } /** * Details on principal, role name and crn pattern of a role binding */ interface RoleBindingRecordResponse { /** * A CRN that specifies the scope and resource patterns necessary for the role to bind */ crnPattern?: string; /** * Id of the role binding */ id?: string; /** * The type of the resource. */ kind?: string; /** * Metadata of the record */ metadata?: outputs.confluent.MetadataEntityResponse; /** * The principal User or Group to bind the role to */ principal?: string; /** * The name of the role to bind to the principal */ roleName?: string; } /** * The network associated with this object */ interface SCClusterByokEntityResponse { /** * ID of the referred resource */ id?: string; /** * API URL for accessing or modifying the referred object */ related?: string; /** * CRN reference to the referred resource */ resourceName?: string; } /** * The environment or the network to which cluster belongs */ interface SCClusterNetworkEnvironmentEntityResponse { /** * Environment of the referred resource */ environment?: string; /** * ID of the referred resource */ id?: string; /** * API URL for accessing or modifying the referred object */ related?: string; /** * CRN reference to the referred resource */ resourceName?: string; } /** * Spec of the cluster record */ interface SCClusterSpecEntityResponse { /** * The Kafka API cluster endpoint */ apiEndpoint?: string; /** * The availability zone configuration of the cluster */ availability?: string; /** * Specification of the cluster byok */ byok?: outputs.confluent.SCClusterByokEntityResponse; /** * The cloud service provider */ cloud?: string; /** * Specification of the cluster configuration */ config?: outputs.confluent.ClusterConfigEntityResponse; /** * Specification of the cluster environment */ environment?: outputs.confluent.SCClusterNetworkEnvironmentEntityResponse; /** * The cluster HTTP request URL. */ httpEndpoint?: string; /** * The bootstrap endpoint used by Kafka clients to connect to the cluster */ kafkaBootstrapEndpoint?: string; /** * The name of the cluster */ name?: string; /** * Specification of the cluster network */ network?: outputs.confluent.SCClusterNetworkEnvironmentEntityResponse; /** * Stream governance configuration */ package?: string; /** * The cloud service provider region */ region?: string; /** * type of zone availability */ zone?: string; } /** * Metadata of the data record */ interface SCMetadataEntityResponse { /** * Created Date Time */ createdTimestamp?: string; /** * Deleted Date time */ deletedTimestamp?: string; /** * Resource name of the record */ resourceName?: string; /** * Self lookup url */ self?: string; /** * Updated Date time */ updatedTimestamp?: string; } /** * Record of the service account */ interface ServiceAccountRecordResponse { /** * Description of the service account */ description?: string; /** * Name of the service account */ displayName?: string; /** * Id of the service account */ id?: string; /** * Type of account */ kind?: string; /** * Metadata of the record */ metadata?: outputs.confluent.MetadataEntityResponse; } /** * Stream governance configuration */ interface StreamGovernanceConfigResponse { /** * Stream governance configuration */ package?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Metadata of the data record */ interface TopicMetadataEntityResponse { /** * Resource name of the record */ resourceName?: string; /** * Self lookup url */ self?: string; } /** * Topics input config */ interface TopicsInputConfigResponse { /** * Name of the topic input config */ name?: string; /** * Value of the topic input config */ value?: string; } /** * Partition Config spec of the topic record */ interface TopicsRelatedLinkResponse { /** * Relationship of the topic */ related?: string; } /** * Subscriber detail */ interface UserDetailResponse { /** * AAD email address */ aadEmail?: string; /** * Email address */ emailAddress: string; /** * First name */ firstName?: string; /** * Last name */ lastName?: string; /** * User principal name */ userPrincipalName?: string; } /** * Record of the user */ interface UserRecordResponse { /** * Auth type of the user */ authType?: string; /** * Email of the user */ email?: string; /** * Name of the user */ fullName?: string; /** * Id of the user */ id?: string; /** * Type of account */ kind?: string; /** * Metadata of the record */ metadata?: outputs.confluent.MetadataEntityResponse; } } export declare namespace connectedcache { /** * Model representing cache node for connected cache resource */ interface AdditionalCacheNodePropertiesResponse { /** * Cache node resource aggregated status code. */ aggregatedStatusCode: number; /** * Cache node resource aggregated status details. */ aggregatedStatusDetails: string; /** * Cache node resource aggregated status text. */ aggregatedStatusText: string; /** * Auto update version that is the applied to update on mcc cache node */ autoUpdateAppliedVersion: string; /** * Auto update last applied date time of mcc install */ autoUpdateLastAppliedDateTime: string; /** * Auto Update status details from the backend after applying the new version details */ autoUpdateLastAppliedDetails: string; /** * Last applied auto update state for mcc install of auto update cycle */ autoUpdateLastAppliedState: string; /** * Auto update last triggered date time of mcc install */ autoUpdateLastTriggeredDateTime: string; /** * Auto update last applied date time of mcc install */ autoUpdateNextAvailableDateTime: string; /** * Auto update version that is the Next available version to update on mcc cache node */ autoUpdateNextAvailableVersion: string; /** * Auto update or fast update version */ autoUpdateVersion?: string; /** * Cache node resource Bgp configuration. */ bgpConfiguration?: outputs.connectedcache.BgpConfigurationResponse; /** * issues list to return the issues as part of the additional cache node properties */ cacheNodePropertiesDetailsIssuesList?: string[]; /** * Cache node resource state as integer. */ cacheNodeState: number; /** * Cache node resource detailed state text. */ cacheNodeStateDetailedText: string; /** * Cache node resource short state text. */ cacheNodeStateShortText: string; /** * Cache node resource drive configurations. */ driveConfiguration?: outputs.connectedcache.CacheNodeDriveConfigurationResponse[]; /** * Cache node resource flag indicating if cache node has been physically installed or provisioned on their physical lab. */ isProvisioned: boolean; /** * Cache node resource requires a proxy */ isProxyRequired?: string; /** * Optional property #1 of Mcc response object */ optionalProperty1?: string; /** * Optional property #2 of Mcc response object */ optionalProperty2?: string; /** * Optional property #3 of Mcc response object */ optionalProperty3?: string; /** * Optional property #4 of Mcc response object */ optionalProperty4?: string; /** * Optional property #5 of Mcc response object */ optionalProperty5?: string; /** * Operating system of the cache node */ osType?: string; /** * Cache node resource Mcc product version. */ productVersion: string; /** * Cache node resource Mcc proxy Url */ proxyUrl?: string; /** * proxyUrl configuration of the cache node */ proxyUrlConfiguration?: outputs.connectedcache.ProxyUrlConfigurationResponse; /** * Update Cycle Type */ updateCycleType?: string; /** * Update related information details */ updateInfoDetails?: string; /** * customer requested date time for mcc install of update cycle */ updateRequestedDateTime?: string; } /** * Model representing customer for connected cache resource */ interface AdditionalCustomerPropertiesResponse { /** * Customer resource Asn (autonomous system number). */ customerAsn?: string; /** * Customer resource estimated Asn peering peak in Gbps. */ customerAsnEstimatedEgressPeekGbps: number; /** * Customer resource contact email. */ customerEmail?: string; /** * Customer resource entitlement expiration date string. */ customerEntitlementExpiration?: string; /** * Customer resource entitlement Sku Guid. */ customerEntitlementSkuGuid?: string; /** * Customer resource entitlement Sku Id. */ customerEntitlementSkuId?: string; /** * Customer resource entitlement Sku name. */ customerEntitlementSkuName?: string; /** * Customer resource owner organization name. */ customerOrgName: string; /** * Customer resource average egress in Mbps. */ customerPropertiesOverviewAverageEgressMbps: number; /** * Customer resource average cache miss throughput in Mbps. */ customerPropertiesOverviewAverageMissMbps: number; /** * Customer resource cache efficiency. */ customerPropertiesOverviewCacheEfficiency: number; /** * Customer resource total healthy cache nodes. */ customerPropertiesOverviewCacheNodesHealthyCount: number; /** * Customer resource total unhealthy cache nodes. */ customerPropertiesOverviewCacheNodesUnhealthyCount: number; /** * Customer resource maximum egress in Mbps. */ customerPropertiesOverviewEgressMbpsMax: number; /** * Customer resource peak egress timestamp. */ customerPropertiesOverviewEgressMbpsMaxDateTime: string; /** * Customer resource maximum cache miss throughput in Mbps. */ customerPropertiesOverviewMissMbpsMax: number; /** * Customer resource peak cache miss throughput timestamp. */ customerPropertiesOverviewMissMbpsMaxDateTime: string; /** * Customer resource transit Asn (autonomous system number). */ customerTransitAsn?: string; /** * Customer resource transit state. */ customerTransitState?: string; /** * Optional property #1 of Mcc response object. */ optionalProperty1?: string; /** * Optional property #2 of Mcc response object. */ optionalProperty2?: string; /** * Optional property #3 of Mcc response object. */ optionalProperty3?: string; /** * Optional property #4 of Mcc response object. */ optionalProperty4?: string; /** * Optional property #5 of Mcc response object. */ optionalProperty5?: string; /** * Customer resource last PeeringDB update timestamp. */ peeringDbLastUpdateDate: string; /** * Customer resource last PeeringDB update timestamp. */ peeringDbLastUpdateTime: string; /** * Customer resource signup phase status code as integer. */ signupPhaseStatusCode: number; /** * Customer resource signup phase status as string text. */ signupPhaseStatusText: string; /** * Customer resource signup status as boolean. */ signupStatus: boolean; /** * Customer resource signup status as integer code. */ signupStatusCode: number; /** * Customer resource signup status as string text. */ signupStatusText: string; } /** * Mcc cache node Bgp Cidr details. */ interface BgpCidrsConfigurationResponse { /** * Mcc cache node Bgp Cidr details. */ bgpCidrs: string[]; } /** * Bgp configuration of cache node */ interface BgpConfigurationResponse { /** * Asn to ip address mapping */ asnToIpAddressMapping?: string; } /** * Drive configuration for cache node */ interface CacheNodeDriveConfigurationResponse { /** * corresponding nginx cache number. Valid cache numbers are 1 - 20 */ cacheNumber?: number; /** * full binding for corresponding nginx cache drive */ nginxMapping?: string; /** * physical path location of the folder used for caching content */ physicalPath?: string; /** * physical size of the drive used for caching content */ sizeInGb?: number; } /** * Model representing Cache Node for ConnectedCache resource */ interface CacheNodeEntityResponse { /** * Cache node resource total addressable space defined by the Cidr Csv block. */ addressSpace: number; /** * Customer requested day of week for mcc install of auto update cycle. 0 is default no selection. 1-7 are days of week, 1 is Sunday, 2 is Monday, etc. */ autoUpdateRequestedDay?: number; /** * Customer requested time of the day for mcc install of auto update cycle, should be hh:mm */ autoUpdateRequestedTime?: string; /** * Customer requested week of month for mcc install of auto update cycle. 0 is default no selection. 1-5 are valid weeks of month, 1 is first week, 2 is second week, etc. */ autoUpdateRequestedWeek?: number; /** * Auto Update Ring Type which is stable or beta as new values. slow or fast are legacy from version 2026-06-01. */ autoUpdateRingType?: string; /** * Cache node resource total addressable space defined by Bgp and Cidr Csv blocks. */ bgpAddressSpace: number; /** * Cache node resource Bgp block count. */ bgpCidrBlocksCount: number; /** * Cache node resource last Bgp Cidr Csv update timestamp */ bgpCidrCsvLastUpdateTime: string; /** * Cache node resource bytes truncated from Bgp output file. */ bgpFileBytesTruncated: number; /** * Cache node resource last Bgp report timestamp. */ bgpLastReportedTime: string; /** * Cache node resource Bgp record count. */ bgpNumberOfRecords: number; /** * Cache node resource Bgp update count. */ bgpNumberOfTimesUpdated: number; /** * Cache node resource Bgp review feedback text. */ bgpReviewFeedback: string; /** * Cache node resource Bgp review state string text. */ bgpReviewState: string; /** * Cache node resource Bgp review state string text in detail. */ bgpReviewStateText: string; /** * Cache node resource identifier of the cache node */ cacheNodeId?: string; /** * Cache node resource name. */ cacheNodeName?: string; /** * Cache node resource category. */ category: string; /** * Cache node resource comma separated values of Cidrs. */ cidrCsv?: string[]; /** * Cache node resource last Cidr Csv update timestamp */ cidrCsvLastUpdateTime: string; /** * Cache node resource current Cidr range precedence selection type. */ cidrSelectionType?: number; /** * Cache node resource customer resource client tenant Id of subscription. */ clientTenantId: string; /** * Cache node resource configuration state. */ configurationState: string; /** * Cache node resource configuration state text. */ configurationStateText: string; /** * Cache node resource container configuration details. */ containerConfigurations: string; /** * Cache node resource Mcc container configuration details re-sync trigger. */ containerResyncTrigger: number; /** * Cache node resource create async operation Id. */ createAsyncOperationId: string; /** * Cache node resource customer resource Asn (autonomous system number) */ customerAsn?: number; /** * Cache node resource customer resource GUID Id. */ customerId: string; /** * Cache node resource customer index as string. */ customerIndex?: string; /** * Cache node resource customer resource name. */ customerName?: string; /** * Cache node resource deletion async operation Id. */ deleteAsyncOperationId: string; /** * FQDN(fully qualified domain name) value of the mcc cache node */ fullyQualifiedDomainName?: string; /** * Cache node resource Azure fully qualified resource Id. */ fullyQualifiedResourceId?: string; /** * Cache node resource Mcc Container Id Uri. */ imageUri: string; /** * Cache node resource Ip address. */ ipAddress?: string; /** * Cache node resource flag for indicating if cache node is enabled. */ isEnabled?: boolean; /** * Cache node resource flag for determining if managed by enterprise as boolean. */ isEnterpriseManaged?: boolean; /** * Cache node resource flag for indicating the cache node resource is frozen (not selectable, not editable in UI). */ isFrozen: boolean; /** * Cache node resource last sync timestamp. */ lastSyncWithAzureTimestamp: string; /** * Cache node resource last backend updated timestamp. */ lastUpdatedTimestamp: string; /** * Cache node resource maximum allowed egress in Mbps. */ maxAllowableEgressInMbps?: number; /** * Cache node resource maximum allowed probability of egress. */ maxAllowableProbability: number; /** * Cache node resource release version. */ releaseVersion: number; /** * Cache node resource review feedback text. */ reviewFeedback: string; /** * Cache node resource review process state as integer */ reviewState: number; /** * Cache node resource review state text. */ reviewStateText: string; /** * Cache node resource flag for determining if customer will be migrated. */ shouldMigrate?: boolean; /** * Cache node resource attempts to sync with Azure. */ synchWithAzureAttemptsCount: number; /** * Cache node resource Mcc container deployment worker connection count. */ workerConnections: number; /** * Cache node resource last updated Mcc container deployment worker connection count timestamp. */ workerConnectionsLastUpdatedDateTime: string; /** * Cache node resource Azure XCid. */ xCid: string; } /** * Mcc cache node resource install script properties. */ interface CacheNodeInstallPropertiesResponse { /** * Mcc cache node resource Id. */ cacheNodeId?: string; /** * Mcc customer resource Id. */ customerId?: string; /** * Mcc primary account key. Internal to Mcc. */ primaryAccountKey: string; /** * Mcc Iot Central temporary device registration key, used once. */ registrationKey: string; /** * Mcc secondary account key. Internal to Mcc. */ secondaryAccountKey: string; } /** * Model representing Cache Node for ConnectedCache resource */ interface CacheNodeOldResponseResponse { /** * The error details */ error?: outputs.connectedcache.ErrorDetailResponse; /** * The provisioned state of the resource */ provisioningState: string; /** * status of the HTTP error code */ status: string; /** * statusCode used to get code details of Mcc response object */ statusCode?: string; /** * statusDetails used to get inner details of Mcc response object */ statusDetails?: string; /** * statusText used to get status details in string format of Mcc response object */ statusText?: string; } /** * Model representing an Mcc cache node connectedCache resource */ interface CacheNodePropertyResponse { /** * Mcc cache node resource additional properties. */ additionalCacheNodeProperties?: outputs.connectedcache.AdditionalCacheNodePropertiesResponse; /** * Mcc cache node resource (cache node entity). */ cacheNode?: outputs.connectedcache.CacheNodeEntityResponse; /** * Mcc response error details. */ error?: outputs.connectedcache.ErrorDetailResponse; /** * The provisioned state of the resource */ provisioningState: string; /** * HTTP error status code. */ status: string; /** * Mcc response status code. */ statusCode?: string; /** * Mcc response status details for retrieving response inner details. */ statusDetails?: string; /** * Mcc response status text as string for retrieving status details. */ statusText?: string; } /** * Model representing Customer resource for ConnectedCache resource */ interface CustomerEntityResponse { /** * Customer resource client tenant Id of subscription. */ clientTenantId?: string; /** * Customer resource contact email. */ contactEmail?: string; /** * Customer resource contact full name. */ contactName?: string; /** * Customer resource contact phone. */ contactPhone?: string; /** * Customer resource create async operation Id. */ createAsyncOperationId: string; /** * Customer resource Guid Id. */ customerId: string; /** * Customer resource name. */ customerName?: string; /** * Customer resource deletion async operation Id. */ deleteAsyncOperationId: string; /** * Customer resource Azure fully qualified resource Id. */ fullyQualifiedResourceId?: string; /** * Customer resource flag for enterprise management as boolean. */ isEnterpriseManaged?: boolean; /** * Customer resource entitlement flag as boolean. */ isEntitled?: boolean; /** * Customer resource last Azure sync timestamp. */ lastSyncWithAzureTimestamp: string; /** * Customer resource Mcc release version. */ releaseVersion?: number; /** * Customer resource flag for resending signup code as boolean. */ resendSignupCode?: boolean; /** * Customer resource flag for migration. */ shouldMigrate?: boolean; /** * Customer resource sync attempts. */ synchWithAzureAttemptsCount: number; /** * Customer resource flag for requiring verification of signup code as boolean. */ verifySignupCode?: boolean; } /** * Model representing customer for connectedCache resource */ interface CustomerPropertyResponse { /** * Mcc customer resource additional properties. */ additionalCustomerProperties?: outputs.connectedcache.AdditionalCustomerPropertiesResponse; /** * Mcc customer resource (customer entity). */ customer?: outputs.connectedcache.CustomerEntityResponse; /** * Mcc response error details. */ error: outputs.connectedcache.ErrorDetailResponse; /** * The provisioned state of the resource */ provisioningState: string; /** * HTTP error status code. */ status: string; /** * Mcc response status code. */ statusCode: string; /** * Mcc response status details for retrieving response inner details. */ statusDetails: string; /** * Mcc response status text as string for retrieving status details. */ statusText: string; } /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.connectedcache.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.connectedcache.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * Mcc cache node resource auto update history properties. */ interface MccCacheNodeAutoUpdateHistoryPropertiesResponse { /** * Cache node resource auto update history information. */ autoUpdateHistory?: outputs.connectedcache.MccCacheNodeAutoUpdateInfoResponse[]; /** * Mcc cache node resource Id. */ cacheNodeId: string; /** * Mcc customer resource Id. */ customerId: string; } /** * Mcc cache node resource auto update properties. */ interface MccCacheNodeAutoUpdateInfoResponse { /** * Auto update last applied status. */ autoUpdateLastAppliedStatus: number; /** * Auto update last applied detailed status text. */ autoUpdateLastAppliedStatusDetailedText: string; /** * Auto update last applied status text. */ autoUpdateLastAppliedStatusText: string; /** * Auto update Ring Type. */ autoUpdateRingType: number; /** * Auto update entity created datetime. */ createdDateTimeUtc: string; /** * Auto update image uri before update. */ imageUriBeforeUpdate: string; /** * Auto update image uri targetted to update. */ imageUriTargeted: string; /** * Auto update image uri at Terminal. */ imageUriTerminal: string; /** * Auto update image uri after update. */ movedToTerminalStateDateTime: string; /** * This text describing the purpose of the plan of auto update. */ planChangeLogText: string; /** * Auto update planId. */ planId: number; /** * Auto update image uri after update. */ ruleRequestedDay: number; /** * Auto update rule requested hour. */ ruleRequestedHour: string; /** * Auto update rule requested minute. */ ruleRequestedMinute: string; /** * Auto update image uri before update. */ ruleRequestedWeek: number; /** * Auto update time to go live date time. */ timeToGoLiveDateTime: string; /** * Auto update entity last updated datetime. */ updatedRegistryDateTimeUtc: string; } /** * Mcc cache node resource issue history properties. */ interface MccCacheNodeIssueHistoryPropertiesResponse { /** * Mcc cache node resource Id. */ cacheNodeId: string; /** * Mcc customer resource Id. */ customerId: string; /** * Cache node resource issue details history. */ mccIssueHistory?: outputs.connectedcache.MccIssueResponse[]; } /** * Mcc cache node resource auto update properties. */ interface MccCacheNodeTlsCertificatePropertiesResponse { /** * Mcc cache node resource Id. */ cacheNodeId: string; /** * Mcc customer resource Id. */ customerId: string; /** * Cache node resource tls certificate history details. */ tlsCertificateHistory?: outputs.connectedcache.MccCacheNodeTlsCertificateResponse[]; } /** * Mcc cache node resource Tls certificate details. */ interface MccCacheNodeTlsCertificateResponse { /** * Mcc cache node Tls certificate status. */ actionRequired: string; /** * Mcc cache node Tls certificate file name. */ certificateFileName: string; /** * Mcc cache node Tls certificate expiry date. */ expiryDate: string; /** * Mcc cache node Tls certificate not before date. */ notBeforeDate: string; /** * Mcc cache node Tls certificate subject name. */ subject: string; /** * Mcc cache node Tls certificate subject alternate name. */ subjectAltName: string; /** * Mcc cache node Tls certificate thumbprint. */ thumbprint: string; } /** * Mcc cache node resource issue properties. */ interface MccIssueResponse { /** * Mcc cache node issue detail string. */ detailString: string; /** * Mcc cache node issue related help link. */ helpLink: string; /** * Mcc cache node issue end date. */ issueEndDate: string; /** * Mcc cache node issue start date. */ issueStartDate: string; /** * Mcc cache node issue type. */ mccIssueType: string; /** * Mcc cache node issues toastString. */ toastString: string; } /** * ProxyUrl configuration of cache node */ interface ProxyUrlConfigurationResponse { /** * Host Proxy Address configuration along with port number. This can be a proxy or ip address. ex: xx.xx.xx.xxxx:80 or host name http://exampleproxy.com:80 */ proxyUrl?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace connectedvmwarevsphere { /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.connectedvmwarevsphere.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.connectedvmwarevsphere.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * The extended location. */ interface ExtendedLocationResponse { /** * The extended location name. */ name?: string; /** * The extended location type. */ type?: string; } /** * Specifies the guest agent settings for the virtual machine. */ interface GuestAgentProfileResponse { /** * The hybrid machine agent full version. */ agentVersion: string; /** * Gets or sets the Public Key provided by the client for enabling guest management. */ clientPublicKey?: string; /** * Details about the error state. */ errorDetails: outputs.connectedvmwarevsphere.ErrorDetailResponse[]; /** * The time of the last status change. */ lastStatusChange: string; /** * Specifies whether any MS SQL instance is discovered on the machine. */ mssqlDiscovered: string; /** * The status of the hybrid machine agent. */ status: string; /** * Specifies the VM's unique SMBIOS ID. */ vmUuid: string; } /** * Username / Password Credentials to connect to guest. */ interface GuestCredentialResponse { /** * Gets or sets username to connect with the guest. */ username?: string; } /** * Username / Password Credentials to connect to guest. */ interface GuestCredentialVMInstanceGuestAgentResponse { /** * Private key used to authenticate to a virtual machine through ssh. */ privateKey?: string; /** * Gets or sets username to connect with the guest. */ username?: string; } /** * Specifies the hardware settings for the virtual machine. */ interface HardwareProfileResponse { /** * Gets or sets a value indicating whether virtual processors can be added while this virtual machine is running. */ cpuHotAddEnabled: boolean; /** * Gets or sets a value indicating whether virtual processors can be removed while this virtual machine is running. */ cpuHotRemoveEnabled: boolean; /** * Gets or sets a value indicating whether memory can be added while this virtual machine is running. */ memoryHotAddEnabled: boolean; /** * Gets or sets memory size in MBs for the vm. */ memorySizeMB?: number; /** * Gets or sets the number of vCPUs for the vm. */ numCPUs?: number; /** * Gets or sets the number of cores per socket for the vm. Defaults to 1 if unspecified. */ numCoresPerSocket?: number; } /** * HTTP Proxy configuration for the VM. */ interface HttpProxyConfigurationResponse { /** * Gets or sets httpsProxy url. */ httpsProxy?: string; } /** * Managed service identity. */ interface IdentityResponse { /** * The principal id of managed service identity. */ principalId: string; /** * The tenant of managed service identity. */ tenantId: string; /** * The type of managed service identity. */ type: string; } /** * Specifies the vCenter infrastructure specific settings for the virtual machine. */ interface InfrastructureProfileResponse { /** * Gets the name of the corresponding resource in Kubernetes. */ customResourceName: string; /** * Firmware type */ firmwareType?: string; /** * Gets or sets the folder path of the vm. */ folderPath: string; /** * Gets or sets the instance uuid of the vm. */ instanceUuid: string; /** * Gets or sets the inventory Item ID for the virtual machine. */ inventoryItemId?: string; /** * Gets or sets the vCenter Managed Object name for the virtual machine. */ moName: string; /** * Gets or sets the vCenter MoRef (Managed Object Reference) ID for the virtual machine. */ moRefId: string; /** * Gets or sets the SMBIOS UUID of the vm. */ smbiosUuid?: string; /** * Gets or sets the ARM Id of the template resource to deploy the virtual machine. */ templateId?: string; /** * Gets or sets the ARM Id of the vCenter resource in which this resource pool resides. */ vCenterId?: string; } /** * Instance view status. */ interface MachineExtensionInstanceViewResponseStatus { /** * The status code. */ code: string; /** * The short localizable label for the status. */ displayStatus: string; /** * The level code. */ level: string; /** * The detailed status message, including for alerts and error messages. */ message: string; /** * The time of the status. */ time: string; } /** * The machine extension instance view. */ interface MachineExtensionPropertiesResponseInstanceView { /** * The machine extension name. */ name: string; /** * Instance view status. */ status?: outputs.connectedvmwarevsphere.MachineExtensionInstanceViewResponseStatus; /** * Specifies the type of the extension; an example is "CustomScriptExtension". */ type: string; /** * Specifies the version of the script handler. */ typeHandlerVersion: string; } /** * Network Interface model */ interface NetworkInterfaceResponse { /** * Gets or sets the device key value. */ deviceKey?: number; /** * Gets or sets the nic ip addresses. */ ipAddresses: string[]; /** * Gets or sets the ipsettings. */ ipSettings?: outputs.connectedvmwarevsphere.NicIPSettingsResponse; /** * Gets or sets the label of the virtual network in vCenter that the nic is connected to. */ label: string; /** * Gets or sets the NIC MAC address. */ macAddress: string; /** * Gets or sets the name of the network interface. */ name?: string; /** * Gets or sets the ARM Id of the network resource to connect the virtual machine. */ networkId?: string; /** * Gets or sets the name of the virtual network in vCenter that the nic is connected to. */ networkMoName: string; /** * Gets or sets the vCenter MoRef (Managed Object Reference) ID of the virtual network * that the nic is connected to. */ networkMoRefId: string; /** * NIC type */ nicType?: string; /** * Gets or sets the power on boot. */ powerOnBoot?: string; } /** * Specifies the network interfaces of the virtual machine. */ interface NetworkProfileResponse { /** * Gets or sets the list of network interfaces associated with the virtual machine. */ networkInterfaces?: outputs.connectedvmwarevsphere.NetworkInterfaceResponse[]; } /** * IP address information for a virtual network adapter reported by the fabric. */ interface NicIPAddressSettingsResponse { /** * Gets the ip address allocation method. */ allocationMethod: string; /** * Gets the ip address for the nic. */ ipAddress: string; /** * Gets the mask. */ subnetMask: string; } /** * Defines the network interface ip settings. */ interface NicIPSettingsResponse { /** * Gets or sets the nic allocation method. */ allocationMethod?: string; /** * Gets or sets the dns servers. */ dnsServers?: string[]; /** * Gets or sets the gateway. */ gateway?: string[]; /** * Gets or sets the ip address for the nic. */ ipAddress?: string; /** * Gets or sets the IP address information being reported for this NIC. This contains the same IPv4 information above plus IPV6 information. */ ipAddressInfo: outputs.connectedvmwarevsphere.NicIPAddressSettingsResponse[]; /** * Gets or sets the primary server. */ primaryWinsServer: string; /** * Gets or sets the secondary server. */ secondaryWinsServer: string; /** * Gets or sets the mask. */ subnetMask?: string; } /** * Specifies the operating system settings for the virtual machine. */ interface OsProfileForVMInstanceResponse { /** * Gets or sets administrator username. */ adminUsername?: string; /** * Gets or sets computer name. */ computerName?: string; /** * Gets or sets the guestId. */ guestId?: string; /** * Gets or sets os sku. */ osSku: string; /** * Gets or sets the type of the os. */ osType?: string; /** * Gets or sets the current running status of VMware Tools running in the guest operating system. */ toolsRunningStatus: string; /** * Gets or sets the current version of VMware Tools. */ toolsVersion: string; /** * Gets or sets the current version status of VMware Tools installed in the guest operating system. */ toolsVersionStatus: string; /** * Windows Configuration. */ windowsConfiguration?: outputs.connectedvmwarevsphere.WindowsConfigurationResponse; } /** * Specifies the operating system settings for the virtual machine. */ interface OsProfileResponse { /** * Gets or sets administrator username. */ adminUsername?: string; /** * Gets or sets a value indicating whether the VM is ready for extension operations. */ allowExtensionOperations: boolean; /** * Gets or sets computer name. */ computerName?: string; /** * Gets or sets the guestId. */ guestId?: string; /** * Specifies the linux configuration for update management. */ linuxConfiguration?: outputs.connectedvmwarevsphere.OsProfileResponseLinuxConfiguration; /** * Gets or sets os name. */ osName: string; /** * Gets or sets the type of the os. */ osType?: string; /** * Gets or sets the current running status of VMware Tools running in the guest operating system. */ toolsRunningStatus: string; /** * Gets or sets the current version of VMware Tools. */ toolsVersion: string; /** * Gets or sets the current version status of VMware Tools installed in the guest operating system. */ toolsVersionStatus: string; /** * Specifies the windows configuration for update management. */ windowsConfiguration?: outputs.connectedvmwarevsphere.OsProfileResponseWindowsConfiguration; } /** * Specifies the linux configuration for update management. */ interface OsProfileResponseLinuxConfiguration { /** * Specifies the assessment mode. */ assessmentMode?: string; /** * Specifies the patch mode. */ patchMode?: string; } /** * Specifies the windows configuration for update management. */ interface OsProfileResponseWindowsConfiguration { /** * Specifies the assessment mode. */ assessmentMode?: string; /** * Specifies the patch mode. */ patchMode?: string; } /** * Specifies the compute and storage placement settings for the virtual machine. */ interface PlacementProfileResponse { /** * Gets or sets the ARM Id of the cluster resource on which this virtual machine will deploy. */ clusterId?: string; /** * Gets or sets the ARM Id of the datastore resource on which the data for the virtual machine will be kept. */ datastoreId?: string; /** * Gets or sets the ARM Id of the host resource on which this virtual machine will deploy. */ hostId?: string; /** * Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will deploy. */ resourcePoolId?: string; } /** * The resource status information. */ interface ResourceStatusResponse { /** * The last update time for this condition. */ lastUpdatedAt: string; /** * A human readable message indicating details about the status. */ message: string; /** * The reason for the condition's status. */ reason: string; /** * Severity with which to treat failures of this type of condition. */ severity: string; /** * Status of the condition. */ status: string; /** * The type of the condition. */ type: string; } /** * Specifies the Security profile settings for the virtual machine. */ interface SecurityProfileResponse { /** * Specifies the security settings like secure boot used while creating the virtual machine. */ uefiSettings?: outputs.connectedvmwarevsphere.UefiSettingsResponse; } /** * Specifies the storage settings for the virtual machine disks. */ interface StorageProfileResponse { /** * Gets or sets the list of virtual disks associated with the virtual machine. */ disks?: outputs.connectedvmwarevsphere.VirtualDiskResponse[]; /** * Gets or sets the list of virtual SCSI controllers associated with the virtual machine. */ scsiControllers: outputs.connectedvmwarevsphere.VirtualSCSIControllerResponse[]; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Specifies the security settings like secure boot used while creating the virtual machine. */ interface UefiSettingsResponse { /** * Specifies whether secure boot should be enabled on the virtual machine. */ secureBootEnabled?: boolean; } /** * Username / Password Credentials to connect to vcenter. */ interface VICredentialResponse { /** * Gets or sets username to connect with the vCenter. */ username?: string; } /** * Virtual disk model */ interface VirtualDiskResponse { /** * Gets or sets the controller id. */ controllerKey?: number; /** * Gets or sets the device key value. */ deviceKey?: number; /** * Gets or sets the device name. */ deviceName?: string; /** * Gets or sets the disk mode. */ diskMode?: string; /** * Gets or sets the disk object id. */ diskObjectId: string; /** * Gets or sets the disk total size. */ diskSizeGB?: number; /** * Gets or sets the disk backing type. */ diskType?: string; /** * Gets or sets the label of the virtual disk in vCenter. */ label: string; /** * Gets or sets the name of the virtual disk. */ name?: string; /** * Gets or sets the unit number of the disk on the controller. */ unitNumber?: number; } /** * This data object type contains the properties of a SCSI controller device attached to a virtual machine that is reported by the controller. */ interface VirtualSCSIControllerResponse { /** * Gets or sets the bus number of the controller. */ busNumber?: number; /** * Gets or sets the key of the controller. */ controllerKey?: number; /** * Gets or sets the SCSI controller unit number. */ scsiCtlrUnitNumber?: number; /** * Gets or sets the sharing mode. */ sharing?: string; /** * Gets or sets the controller type. */ type?: string; } /** * Specifies the Windows Configuration settings for the virtual machine. */ interface WindowsConfigurationResponse { /** * Sets a value indicating whether auto logon is enabled. */ autoLogon?: boolean; /** * Sets auto logon count. */ autoLogonCount?: number; /** * Sets domain name that vm should join. */ domainName?: string; /** * Sets domain username. */ domainUsername?: string; /** * Sets first logon commands */ firstLogonCommands?: string[]; /** * Sets full name of the owner of the vm. */ fullName?: string; /** * Sets org name to which the owner of the vm belongs. */ orgName?: string; /** * Sets product id of the vm. */ productId?: string; /** * Specifies the time zone of the virtual machine. e.g. "Pacific Standard Time". Time zone name correspond to time zones listed at Microsoft Time Zone name values(https://learn.microsoft.com/en-us/previous-versions/windows/embedded/ms912391(v=winembedded.11)). */ timeZone?: string; /** * Sets work group name that vm should join. */ workGroupName?: string; } } export declare namespace consumption { /** * The comparison expression to be used in the budgets. */ interface BudgetComparisonExpressionResponse { /** * The name of the column to use in comparison. */ name: string; /** * The operator to use for comparison. */ operator: string; /** * Array of values to use for comparison */ values: string[]; } /** * The Dimensions or Tags to filter a budget by. */ interface BudgetFilterPropertiesResponse { /** * Has comparison expression for a dimension */ dimensions?: outputs.consumption.BudgetComparisonExpressionResponse; /** * Has comparison expression for a tag */ tags?: outputs.consumption.BudgetComparisonExpressionResponse; } /** * May be used to filter budgets by resource group, resource, or meter. */ interface BudgetFilterResponse { /** * The logical "AND" expression. Must have at least 2 items. */ and?: outputs.consumption.BudgetFilterPropertiesResponse[]; /** * Has comparison expression for a dimension */ dimensions?: outputs.consumption.BudgetComparisonExpressionResponse; /** * Has comparison expression for a tag */ tags?: outputs.consumption.BudgetComparisonExpressionResponse; } /** * The start and end date for a budget. */ interface BudgetTimePeriodResponse { /** * The end date for the budget. If not provided, we default this to 10 years from the start date. */ endDate?: string; /** * The start date for the budget. */ startDate: string; } /** * The current amount of cost which is being tracked for a budget. */ interface CurrentSpendResponse { /** * The total amount of cost which is being tracked by the budget. */ amount: number; /** * The unit of measure for the budget amount. */ unit: string; } /** * The forecasted cost which is being tracked for a budget. */ interface ForecastSpendResponse { /** * The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. */ amount: number; /** * The unit of measure for the budget amount. */ unit: string; } /** * The notification associated with a budget. */ interface NotificationResponse { /** * Email addresses to send the budget notification to when the threshold is exceeded. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified. */ contactEmails: string[]; /** * Action groups to send the budget notification to when the threshold is exceeded. Must be provided as a fully qualified Azure resource id. Only supported at Subscription or Resource Group scopes. */ contactGroups?: string[]; /** * Contact roles to send the budget notification to when the threshold is exceeded. */ contactRoles?: string[]; /** * The notification is enabled or not. */ enabled: boolean; /** * Language in which the recipient will receive the notification */ locale?: string; /** * The comparison operator. */ operator: string; /** * Threshold value associated with a notification. Notification is sent when the cost exceeded the threshold. It is always percent and has to be between 0 and 1000. */ threshold: number; /** * The type of threshold */ thresholdType?: string; } /** * notificationResponseProvideDefaults sets the appropriate defaults for NotificationResponse */ function notificationResponseProvideDefaults(val: NotificationResponse): NotificationResponse; /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace containerinstance { /** * The API entity reference. */ interface ApiEntityReferenceResponse { /** * The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... */ id?: string; } /** * NGroups application gateway backend address pool */ interface ApplicationGatewayBackendAddressPoolResponse { /** * The application gateway backend address pool ARM resource Id. */ resource?: string; } /** * Application Gateway the CG profile will use to interact with CGs in a backend pool */ interface ApplicationGatewayResponse { /** * List of Application Gateway Backend Address Pools. */ backendAddressPools?: outputs.containerinstance.ApplicationGatewayBackendAddressPoolResponse[]; /** * The Application Gateway ARM resource Id. */ resource?: string; } /** * The properties of the Azure File volume. Azure File shares are mounted as volumes. */ interface AzureFileVolumeContainerGroupProfileResponse { /** * The flag indicating whether the Azure File shared mounted as a volume is read-only. */ readOnly?: boolean; /** * The name of the Azure File share to be mounted as a volume. */ shareName: string; /** * The storage account access key used to access the Azure File share. */ storageAccountKey?: string; /** * The name of the storage account that contains the Azure File share. */ storageAccountName: string; } /** * The properties of the Azure File volume. Azure File shares are mounted as volumes. */ interface AzureFileVolumeContainerGroupResponse { /** * The flag indicating whether the Azure File shared mounted as a volume is read-only. */ readOnly?: boolean; /** * The name of the Azure File share to be mounted as a volume. */ shareName: string; /** * The storage account access key used to access the Azure File share. */ storageAccountKey?: string; /** * The name of the storage account that contains the Azure File share. */ storageAccountName: string; } /** * The properties of the Azure File volume. Azure File shares are mounted as volumes. */ interface AzureFileVolumeResponse { /** * The flag indicating whether the Azure File shared mounted as a volume is read-only. */ readOnly?: boolean; /** * The name of the Azure File share to be mounted as a volume. */ shareName: string; /** * The storage account access key used to access the Azure File share. */ storageAccountKey?: string; /** * The reference to the storage account access key used to access the Azure File share. */ storageAccountKeyReference?: string; /** * The name of the storage account that contains the Azure File share. */ storageAccountName: string; } /** * The properties for confidential container group */ interface ConfidentialComputePropertiesResponse { /** * The base64 encoded confidential compute enforcement policy */ ccePolicy?: string; } /** * The container config map. */ interface ConfigMapResponse { /** * The key value pairs dictionary in the config map. */ keyValuePairs?: { [key: string]: string; }; } /** * A container instance. */ interface ContainerContainerGroupProfileResponse { /** * The commands to execute within the container instance in exec form. */ command?: string[]; /** * The config map. */ configMap?: outputs.containerinstance.ConfigMapResponse; /** * The environment variables to set in the container instance. */ environmentVariables?: outputs.containerinstance.EnvironmentVariableContainerGroupProfileResponse[]; /** * The name of the image used to create the container instance. */ image?: string; /** * The instance view of the container instance. Only valid in response. */ instanceView: outputs.containerinstance.ContainerPropertiesResponseInstanceView; /** * The liveness probe. */ livenessProbe?: outputs.containerinstance.ContainerProbeResponse; /** * The user-provided name of the container instance. */ name: string; /** * The exposed ports on the container instance. */ ports?: outputs.containerinstance.ContainerPortResponse[]; /** * The readiness probe. */ readinessProbe?: outputs.containerinstance.ContainerProbeResponse; /** * The resource requirements of the container instance. */ resources?: outputs.containerinstance.ResourceRequirementsResponse; /** * The container security properties. */ securityContext?: outputs.containerinstance.SecurityContextDefinitionResponse; /** * The volume mounts available to the container instance. */ volumeMounts?: outputs.containerinstance.VolumeMountResponse[]; } /** * A container instance. */ interface ContainerContainerGroupResponse { /** * The commands to execute within the container instance in exec form. */ command?: string[]; /** * The config map. */ configMap?: outputs.containerinstance.ConfigMapResponse; /** * The environment variables to set in the container instance. */ environmentVariables?: outputs.containerinstance.EnvironmentVariableContainerGroupResponse[]; /** * The name of the image used to create the container instance. */ image?: string; /** * The instance view of the container instance. Only valid in response. */ instanceView: outputs.containerinstance.ContainerPropertiesResponseInstanceView; /** * The liveness probe. */ livenessProbe?: outputs.containerinstance.ContainerProbeResponse; /** * The user-provided name of the container instance. */ name: string; /** * The exposed ports on the container instance. */ ports?: outputs.containerinstance.ContainerPortResponse[]; /** * The readiness probe. */ readinessProbe?: outputs.containerinstance.ContainerProbeResponse; /** * The resource requirements of the container instance. */ resources?: outputs.containerinstance.ResourceRequirementsResponse; /** * The container security properties. */ securityContext?: outputs.containerinstance.SecurityContextDefinitionResponse; /** * The volume mounts available to the container instance. */ volumeMounts?: outputs.containerinstance.VolumeMountResponse[]; } /** * The container execution command, for liveness or readiness probe */ interface ContainerExecResponse { /** * The commands to execute within the container. */ command?: string[]; } /** * Container group diagnostic information. */ interface ContainerGroupDiagnosticsResponse { /** * Container group log analytics information. */ logAnalytics?: outputs.containerinstance.LogAnalyticsResponse; } /** * Identity for the container group. */ interface ContainerGroupIdentityResponse { /** * The principal id of the container group identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant id associated with the container group. This property will only be provided for a system assigned identity. */ tenantId: string; /** * The type of identity used for the container group. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the container group. */ type?: string; /** * The list of user identities associated with the container group. */ userAssignedIdentities?: { [key: string]: outputs.containerinstance.UserAssignedIdentitiesResponse; }; } /** * The container group profile reference. */ interface ContainerGroupProfileReferenceDefinitionResponse { /** * The container group profile reference id.This will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}'. */ id?: string; /** * The container group profile reference revision. */ revision?: number; } /** * The object that contains a reference to a Container Group Profile and it's other related properties. */ interface ContainerGroupProfileStubResponse { /** * Container Group properties which can be set while creating or updating the NGroups. */ containerGroupProperties?: outputs.containerinstance.NGroupContainerGroupPropertiesResponse; /** * A network profile for network settings of a ContainerGroupProfile. */ networkProfile?: outputs.containerinstance.NetworkProfileResponse; /** * A reference to the container group profile ARM resource hosted in ACI RP. */ resource?: outputs.containerinstance.ApiEntityReferenceResponse; /** * The revision of the CG profile is an optional property. If customer does not to provide a revision then NGroups will pickup the latest revision of CGProfile. */ revision?: number; /** * Storage profile for storage related settings of a container group profile. */ storageProfile?: outputs.containerinstance.StorageProfileResponse; } /** * The instance view of the container group. Only valid in response. */ interface ContainerGroupPropertiesResponseInstanceView { /** * The events of this container group. */ events: outputs.containerinstance.EventResponse[]; /** * The state of the container group. Only valid in response. */ state: string; } /** * Container group subnet information. */ interface ContainerGroupSubnetIdResponse { /** * Resource ID of virtual network and subnet. */ id: string; /** * Friendly name for the subnet. */ name?: string; } /** * The container Http Get settings, for liveness or readiness probe */ interface ContainerHttpGetResponse { /** * The HTTP headers. */ httpHeaders?: outputs.containerinstance.HttpHeaderResponse[]; /** * The path to probe. */ path?: string; /** * The port number to probe. */ port: number; /** * The scheme. */ scheme?: string; } /** * The port exposed on the container instance. */ interface ContainerPortResponse { /** * The port number exposed within the container group. */ port: number; /** * The protocol associated with the port. */ protocol?: string; } /** * The container probe, for liveness or readiness */ interface ContainerProbeResponse { /** * The execution command to probe */ exec?: outputs.containerinstance.ContainerExecResponse; /** * The failure threshold. */ failureThreshold?: number; /** * The Http Get settings to probe */ httpGet?: outputs.containerinstance.ContainerHttpGetResponse; /** * The initial delay seconds. */ initialDelaySeconds?: number; /** * The period seconds. */ periodSeconds?: number; /** * The success threshold. */ successThreshold?: number; /** * The timeout seconds. */ timeoutSeconds?: number; } /** * The instance view of the container instance. Only valid in response. */ interface ContainerPropertiesResponseInstanceView { /** * Current container instance state. */ currentState: outputs.containerinstance.ContainerStateResponse; /** * The events of the container instance. */ events: outputs.containerinstance.EventResponse[]; /** * Previous container instance state. */ previousState: outputs.containerinstance.ContainerStateResponse; /** * The number of times that the container instance has been restarted. */ restartCount: number; } /** * A container instance. */ interface ContainerResponse { /** * The commands to execute within the container instance in exec form. */ command?: string[]; /** * The config map. */ configMap?: outputs.containerinstance.ConfigMapResponse; /** * The environment variables to set in the container instance. */ environmentVariables?: outputs.containerinstance.EnvironmentVariableResponse[]; /** * The name of the image used to create the container instance. */ image?: string; /** * The instance view of the container instance. Only valid in response. */ instanceView: outputs.containerinstance.ContainerPropertiesResponseInstanceView; /** * The liveness probe. */ livenessProbe?: outputs.containerinstance.ContainerProbeResponse; /** * The user-provided name of the container instance. */ name: string; /** * The exposed ports on the container instance. */ ports?: outputs.containerinstance.ContainerPortResponse[]; /** * The readiness probe. */ readinessProbe?: outputs.containerinstance.ContainerProbeResponse; /** * The resource requirements of the container instance. */ resources?: outputs.containerinstance.ResourceRequirementsResponse; /** * The container security properties. */ securityContext?: outputs.containerinstance.SecurityContextDefinitionResponse; /** * The volume mounts available to the container instance. */ volumeMounts?: outputs.containerinstance.VolumeMountResponse[]; } /** * The container instance state. */ interface ContainerStateResponse { /** * The human-readable status of the container instance state. */ detailStatus: string; /** * The container instance exit codes correspond to those from the `docker run` command. */ exitCode: number; /** * The date-time when the container instance state finished. */ finishTime: string; /** * The date-time when the container instance state started. */ startTime: string; /** * The state of the container instance. */ state: string; } /** * Extension sidecars to be added to the deployment. */ interface DeploymentExtensionSpecResponse { /** * Type of extension to be added. */ extensionType: string; /** * Name of the extension. */ name: string; /** * Protected settings for the extension. */ protectedSettings?: any; /** * Settings for the extension. */ settings?: any; /** * Version of the extension being used. */ version: string; } /** * DNS configuration for the container group. */ interface DnsConfigurationResponse { /** * The DNS servers for the container group. */ nameServers: string[]; /** * The DNS options for the container group. */ options?: string; /** * The DNS search domains for hostname lookup in the container group. */ searchDomains?: string; } interface ElasticProfileContainerGroupNamingPolicyGuidNamingPolicyResponse { /** * The prefix can be used when there are tooling limitations (e.g. on the Azure portal where CGs from multiple NGroups exist in the same RG). The prefix with the suffixed resource name must still follow Azure resource naming guidelines. */ prefix?: string; } /** * Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. */ interface ElasticProfileContainerGroupNamingPolicyResponse { guidNamingPolicy?: outputs.containerinstance.ElasticProfileContainerGroupNamingPolicyGuidNamingPolicyResponse; } /** * Describes the elastic profile of the NGroup */ interface ElasticProfileResponse { /** * Container Groups are named on a generic guid based naming scheme/policy. Customer can modify naming policy to add prefix to CG names during scale out operation. */ containerGroupNamingPolicy?: outputs.containerinstance.ElasticProfileContainerGroupNamingPolicyResponse; desiredCount?: number; /** * Flag that indicates whether desiredCount should be maintained when customer deletes SPECIFIC container groups (CGs) from the NGroups. In this case, new CGs will be created by NGroup to compensate for the specific deleted ones. */ maintainDesiredCount?: boolean; } /** * The container group encryption properties. */ interface EncryptionPropertiesResponse { /** * The keyvault managed identity. */ identity?: string; /** * The encryption key name. */ keyName: string; /** * The encryption key version. */ keyVersion: string; /** * The keyvault base url. */ vaultBaseUrl: string; } /** * The environment variable to set within the container instance. */ interface EnvironmentVariableContainerGroupProfileResponse { /** * The name of the environment variable. */ name: string; /** * The value of the secure environment variable. */ secureValue?: string; /** * The value of the environment variable. */ value?: string; } /** * The environment variable to set within the container instance. */ interface EnvironmentVariableContainerGroupResponse { /** * The name of the environment variable. */ name: string; /** * The value of the secure environment variable. */ secureValue?: string; /** * The value of the environment variable. */ value?: string; } /** * The environment variable to set within the container instance. */ interface EnvironmentVariableResponse { /** * The name of the environment variable. */ name: string; /** * The value of the secure environment variable. */ secureValue?: string; /** * The reference of the secure environment variable. */ secureValueReference?: string; /** * The value of the environment variable. */ value?: string; } /** * A container group or container instance event. */ interface EventResponse { /** * The count of the event. */ count: number; /** * The date-time of the earliest logged event. */ firstTimestamp: string; /** * The date-time of the latest logged event. */ lastTimestamp: string; /** * The event message. */ message: string; /** * The event name. */ name: string; /** * The event type. */ type: string; } interface FileSharePropertiesResponse { /** * Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium. Learn more at: https://learn.microsoft.com/en-us/rest/api/storagerp/file-shares/create?tabs=HTTP#shareaccesstier */ shareAccessTier?: string; /** * Specifies how Container Groups can access the Azure file share i.e. all CG will share same Azure file share or going to have exclusive file share. */ shareAccessType?: string; } /** * fileSharePropertiesResponseProvideDefaults sets the appropriate defaults for FileSharePropertiesResponse */ function fileSharePropertiesResponseProvideDefaults(val: FileSharePropertiesResponse): FileSharePropertiesResponse; /** * File shares that can be mounted on container groups. */ interface FileShareResponse { name?: string; properties?: outputs.containerinstance.FileSharePropertiesResponse; resourceGroupName?: string; storageAccountName?: string; } /** * fileShareResponseProvideDefaults sets the appropriate defaults for FileShareResponse */ function fileShareResponseProvideDefaults(val: FileShareResponse): FileShareResponse; /** * Represents a volume that is populated with the contents of a git repository */ interface GitRepoVolumeResponse { /** * Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. */ directory?: string; /** * Repository URL */ repository: string; /** * Commit hash for the specified revision. */ revision?: string; } /** * The GPU resource. */ interface GpuResourceResponse { /** * The count of the GPU resource. */ count: number; /** * The SKU of the GPU resource. */ sku: string; } /** * The HTTP header. */ interface HttpHeaderResponse { /** * The header name. */ name?: string; /** * The header value. */ value?: string; } /** * Image registry credential. */ interface ImageRegistryCredentialContainerGroupProfileResponse { /** * The identity for the private registry. */ identity?: string; /** * The identity URL for the private registry. */ identityUrl?: string; /** * The password for the private registry. */ password?: string; /** * The Docker image registry server without a protocol such as "http" and "https". */ server: string; /** * The username for the private registry. */ username?: string; } /** * Image registry credential. */ interface ImageRegistryCredentialContainerGroupResponse { /** * The identity for the private registry. */ identity?: string; /** * The identity URL for the private registry. */ identityUrl?: string; /** * The password for the private registry. */ password?: string; /** * The Docker image registry server without a protocol such as "http" and "https". */ server: string; /** * The username for the private registry. */ username?: string; } /** * Image registry credential. */ interface ImageRegistryCredentialResponse { /** * The identity for the private registry. */ identity?: string; /** * The identity URL for the private registry. */ identityUrl?: string; /** * The password for the private registry. */ password?: string; /** * The reference for the private registry password. */ passwordReference?: string; /** * The Docker image registry server without a protocol such as "http" and "https". */ server: string; /** * The username for the private registry. */ username?: string; } /** * The init container definition. */ interface InitContainerDefinitionContainerGroupProfileResponse { /** * The command to execute within the init container in exec form. */ command?: string[]; /** * The environment variables to set in the init container. */ environmentVariables?: outputs.containerinstance.EnvironmentVariableContainerGroupProfileResponse[]; /** * The image of the init container. */ image?: string; /** * The instance view of the init container. Only valid in response. */ instanceView: outputs.containerinstance.InitContainerPropertiesDefinitionResponseInstanceView; /** * The name for the init container. */ name: string; /** * The container security properties. */ securityContext?: outputs.containerinstance.SecurityContextDefinitionResponse; /** * The volume mounts available to the init container. */ volumeMounts?: outputs.containerinstance.VolumeMountResponse[]; } /** * The init container definition. */ interface InitContainerDefinitionContainerGroupResponse { /** * The command to execute within the init container in exec form. */ command?: string[]; /** * The environment variables to set in the init container. */ environmentVariables?: outputs.containerinstance.EnvironmentVariableContainerGroupResponse[]; /** * The image of the init container. */ image?: string; /** * The instance view of the init container. Only valid in response. */ instanceView: outputs.containerinstance.InitContainerPropertiesDefinitionResponseInstanceView; /** * The name for the init container. */ name: string; /** * The container security properties. */ securityContext?: outputs.containerinstance.SecurityContextDefinitionResponse; /** * The volume mounts available to the init container. */ volumeMounts?: outputs.containerinstance.VolumeMountResponse[]; } /** * The init container definition. */ interface InitContainerDefinitionResponse { /** * The command to execute within the init container in exec form. */ command?: string[]; /** * The environment variables to set in the init container. */ environmentVariables?: outputs.containerinstance.EnvironmentVariableResponse[]; /** * The image of the init container. */ image?: string; /** * The instance view of the init container. Only valid in response. */ instanceView: outputs.containerinstance.InitContainerPropertiesDefinitionResponseInstanceView; /** * The name for the init container. */ name: string; /** * The container security properties. */ securityContext?: outputs.containerinstance.SecurityContextDefinitionResponse; /** * The volume mounts available to the init container. */ volumeMounts?: outputs.containerinstance.VolumeMountResponse[]; } /** * The instance view of the init container. Only valid in response. */ interface InitContainerPropertiesDefinitionResponseInstanceView { /** * The current state of the init container. */ currentState: outputs.containerinstance.ContainerStateResponse; /** * The events of the init container. */ events: outputs.containerinstance.EventResponse[]; /** * The previous state of the init container. */ previousState: outputs.containerinstance.ContainerStateResponse; /** * The number of times that the init container has been restarted. */ restartCount: number; } /** * IP address for the container group. */ interface IpAddressResponse { /** * The value representing the security enum. The 'Unsecure' value is the default value if not selected and means the object's domain name label is not secured against subdomain takeover. The 'TenantReuse' value is the default value if selected and means the object's domain name label can be reused within the same tenant. The 'SubscriptionReuse' value means the object's domain name label can be reused within the same subscription. The 'ResourceGroupReuse' value means the object's domain name label can be reused within the same resource group. The 'NoReuse' value means the object's domain name label cannot be reused within the same resource group, subscription, or tenant. */ autoGeneratedDomainNameLabelScope?: string; /** * The Dns name label for the IP. */ dnsNameLabel?: string; /** * The FQDN for the IP. */ fqdn: string; /** * The IP exposed to the public internet. */ ip?: string; /** * The list of ports exposed on the container group. */ ports: outputs.containerinstance.PortResponse[]; /** * Specifies if the IP is exposed to the public internet or private VNET. */ type: string; } /** * ipAddressResponseProvideDefaults sets the appropriate defaults for IpAddressResponse */ function ipAddressResponseProvideDefaults(val: IpAddressResponse): IpAddressResponse; /** * NGroups load balancer backend address pool */ interface LoadBalancerBackendAddressPoolResponse { /** * The Load Balancer backend address pool ARM resource Id. */ resource?: string; } /** * LoadBalancer the CG profile will use to interact with CGs in a backend pool */ interface LoadBalancerResponse { /** * List of Load Balancer Backend Address Pools. */ backendAddressPools?: outputs.containerinstance.LoadBalancerBackendAddressPoolResponse[]; } /** * Container group log analytics information. */ interface LogAnalyticsResponse { /** * The log type to be used. */ logType?: string; /** * Metadata for log analytics. */ metadata?: { [key: string]: string; }; /** * The workspace id for log analytics */ workspaceId: string; /** * The workspace key for log analytics */ workspaceKey: string; /** * The workspace resource id for log analytics */ workspaceResourceId?: string; } /** * container properties */ interface NGroupCGPropertyContainerPropertiesResponse { volumeMounts?: outputs.containerinstance.VolumeMountResponse[]; } /** * Container properties that can be provided with NGroups object. */ interface NGroupCGPropertyContainerResponse { /** * container name */ name?: string; /** * container properties */ properties?: outputs.containerinstance.NGroupCGPropertyContainerPropertiesResponse; } /** * Contains information about the volumes that can be mounted by Containers in the Container Groups. */ interface NGroupCGPropertyVolumeResponse { /** * The Azure File volume. */ azureFile?: outputs.containerinstance.AzureFileVolumeResponse; /** * The name of the volume. */ name: string; } /** * Container Group properties which can be set while creating or updating the NGroups. */ interface NGroupContainerGroupPropertiesResponse { /** * Contains information about Container which can be set while creating or updating the NGroups. */ containers?: outputs.containerinstance.NGroupCGPropertyContainerResponse[]; /** * Contains information about Virtual Network Subnet ARM Resource */ subnetIds?: outputs.containerinstance.ContainerGroupSubnetIdResponse[]; /** * Contains information about the volumes that can be mounted by Containers in the Container Groups. */ volumes?: outputs.containerinstance.NGroupCGPropertyVolumeResponse[]; } /** * Identity for the NGroup. */ interface NGroupIdentityResponse { /** * The principal id of the NGroup identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant id associated with the NGroup. This property will only be provided for a system assigned identity. */ tenantId: string; /** * The type of identity used for the NGroup. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the NGroup. */ type?: string; /** * The list of user identities associated with the NGroup. */ userAssignedIdentities?: { [key: string]: outputs.containerinstance.UserAssignedIdentitiesResponse; }; } /** * A network profile for network settings of a ContainerGroupProfile. Used to manage load balancer and application gateway backend pools, specifically updating the IP addresses of CGs within the backend pool. */ interface NetworkProfileResponse { /** * Application Gateway the CG profile will use to interact with CGs in a backend pool */ applicationGateway?: outputs.containerinstance.ApplicationGatewayResponse; /** * LoadBalancer the CG profile will use to interact with CGs in a backend pool */ loadBalancer?: outputs.containerinstance.LoadBalancerResponse; } /** * Provides options w.r.t allocation and management w.r.t certain placement policies. These utilize capabilities provided by the underlying Azure infrastructure. They are typically used for high availability scenarios. E.g., distributing CGs across fault domains. */ interface PlacementProfileResponse { /** * The number of fault domains to be used to spread CGs in the NGroups resource. This can only be specified during NGroup creation and is immutable after that. */ faultDomainCount?: number; } /** * The port exposed on the container group. */ interface PortResponse { /** * The port number. */ port: number; /** * The protocol associated with the port. */ protocol?: string; } /** * The resource limits. */ interface ResourceLimitsResponse { /** * The CPU limit of this container instance. */ cpu?: number; /** * The GPU limit of this container instance. */ gpu?: outputs.containerinstance.GpuResourceResponse; /** * The memory limit in GB of this container instance. */ memoryInGB?: number; } /** * The resource requests. */ interface ResourceRequestsResponse { /** * The CPU request of this container instance. */ cpu: number; /** * The GPU request of this container instance. */ gpu?: outputs.containerinstance.GpuResourceResponse; /** * The memory request in GB of this container instance. */ memoryInGB: number; } /** * The resource requirements. */ interface ResourceRequirementsResponse { /** * The resource limits of this container instance. */ limits?: outputs.containerinstance.ResourceLimitsResponse; /** * The resource requests of this container instance. */ requests: outputs.containerinstance.ResourceRequestsResponse; } /** * The capabilities to add or drop from a container. */ interface SecurityContextCapabilitiesDefinitionResponse { /** * The capabilities to add to the container. */ add?: string[]; /** * The capabilities to drop from the container. */ drop?: string[]; } /** * The security context for the container. */ interface SecurityContextDefinitionResponse { /** * A boolean value indicating whether the init process can elevate its privileges */ allowPrivilegeEscalation?: boolean; /** * The capabilities to add or drop from a container. */ capabilities?: outputs.containerinstance.SecurityContextCapabilitiesDefinitionResponse; /** * The flag to determine if the container permissions is elevated to Privileged. */ privileged?: boolean; /** * Sets the User GID for the container. */ runAsGroup?: number; /** * Sets the User UID for the container. */ runAsUser?: number; /** * a base64 encoded string containing the contents of the JSON in the seccomp profile */ seccompProfile?: string; } /** * The standby pool profile reference. */ interface StandbyPoolProfileDefinitionResponse { /** * The flag to determine whether ACI should fail the create request if the container group can not be obtained from standby pool. */ failContainerGroupCreateOnReuseFailure?: boolean; /** * The standby pool profile reference id.This will be an ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StandbyPool/standbyContainerGroupPools/{standbyPoolName}'. */ id?: string; } /** * Storage profile for storage related settings of a container group profile. */ interface StorageProfileResponse { fileShares?: outputs.containerinstance.FileShareResponse[]; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Used by the customer to specify the way to update the Container Groups in NGroup. */ interface UpdateProfileResponse { /** * This profile allows the customers to customize the rolling update. */ rollingUpdateProfile?: outputs.containerinstance.UpdateProfileRollingUpdateProfileResponse; updateMode?: string; } /** * This profile allows the customers to customize the rolling update. */ interface UpdateProfileRollingUpdateProfileResponse { /** * Default is false. If set to true, the CGs will be updated in-place instead of creating new CG and deleting old ones. */ inPlaceUpdate?: boolean; /** * Maximum percentage of total Container Groups which can be updated simultaneously by rolling update in one batch. */ maxBatchPercent?: number; /** * Maximum percentage of the updated Container Groups which can be in unhealthy state after each batch is updated. */ maxUnhealthyPercent?: number; /** * The wait time between batches after completing the one batch of the rolling update and starting the next batch. The time duration should be specified in ISO 8601 format for duration. */ pauseTimeBetweenBatches?: string; } /** * The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ interface UserAssignedIdentitiesResponse { /** * The client id of user assigned identity. */ clientId: string; /** * The principal id of user assigned identity. */ principalId: string; } /** * The properties of the volume. */ interface VolumeContainerGroupProfileResponse { /** * The Azure File volume. */ azureFile?: outputs.containerinstance.AzureFileVolumeContainerGroupProfileResponse; /** * The empty directory volume. */ emptyDir?: any; /** * The git repo volume. */ gitRepo?: outputs.containerinstance.GitRepoVolumeResponse; /** * The name of the volume. */ name: string; /** * The secret volume. */ secret?: { [key: string]: string; }; } /** * The properties of the volume. */ interface VolumeContainerGroupResponse { /** * The Azure File volume. */ azureFile?: outputs.containerinstance.AzureFileVolumeContainerGroupResponse; /** * The empty directory volume. */ emptyDir?: any; /** * The git repo volume. */ gitRepo?: outputs.containerinstance.GitRepoVolumeResponse; /** * The name of the volume. */ name: string; /** * The secret volume. */ secret?: { [key: string]: string; }; } /** * The properties of the volume mount. */ interface VolumeMountResponse { /** * The path within the container where the volume should be mounted. Must not contain colon (:). */ mountPath: string; /** * The name of the volume mount. */ name: string; /** * The flag indicating whether the volume mount is read-only. */ readOnly?: boolean; } /** * The properties of the volume. */ interface VolumeResponse { /** * The Azure File volume. */ azureFile?: outputs.containerinstance.AzureFileVolumeResponse; /** * The empty directory volume. */ emptyDir?: any; /** * The git repo volume. */ gitRepo?: outputs.containerinstance.GitRepoVolumeResponse; /** * The name of the volume. */ name: string; /** * The secret volume. */ secret?: { [key: string]: string; }; /** * The secret reference volume. */ secretReference?: { [key: string]: string; }; } } export declare namespace containerregistry { /** * The activation properties of the connected registry. */ interface ActivationPropertiesResponse { /** * The activation status of the connected registry. */ status: string; } /** * The agent that initiated the event. For most situations, this could be from the authorization context of the request. */ interface ActorResponse { /** * The subject or username associated with the request context that generated the event. */ name?: string; } /** * The properties that determine the run agent configuration. */ interface AgentPropertiesResponse { /** * The CPU configuration in terms of number of cores required for the run. */ cpu?: number; } /** * The properties of the archive package source. */ interface ArchivePackageSourcePropertiesResponse { /** * The type of package source for a archive. */ type?: string; /** * The external repository url. */ url?: string; } /** * The properties of a run argument. */ interface ArgumentResponse { /** * Flag to indicate whether the argument represents a secret and want to be removed from build logs. */ isSecret?: boolean; /** * The name of the argument. */ name: string; /** * The value of the argument. */ value: string; } /** * argumentResponseProvideDefaults sets the appropriate defaults for ArgumentResponse */ function argumentResponseProvideDefaults(val: ArgumentResponse): ArgumentResponse; /** * Authentication credential stored for an upstream. */ interface AuthCredentialResponse { /** * This provides data pertaining to the health of the auth credential. */ credentialHealth: outputs.containerregistry.CredentialHealthResponse; /** * The name of the credential. */ name?: string; /** * KeyVault Secret URI for accessing the password. */ passwordSecretIdentifier?: string; /** * KeyVault Secret URI for accessing the username. */ usernameSecretIdentifier?: string; } /** * The authorization properties for accessing the source code repository. */ interface AuthInfoResponse { /** * Time in seconds that the token remains valid */ expiresIn?: number; /** * The refresh token used to refresh the access token. */ refreshToken?: string; /** * The scope of the access token. */ scope?: string; /** * The access token used to access the source control provider. */ token: string; /** * The type of Auth token. */ tokenType: string; } /** * The policy for using ARM audience token for a container registry. */ interface AzureADAuthenticationAsArmPolicyResponse { /** * The value that indicates whether the policy is enabled or not. */ status?: string; } /** * azureADAuthenticationAsArmPolicyResponseProvideDefaults sets the appropriate defaults for AzureADAuthenticationAsArmPolicyResponse */ function azureADAuthenticationAsArmPolicyResponseProvideDefaults(val: AzureADAuthenticationAsArmPolicyResponse): AzureADAuthenticationAsArmPolicyResponse; /** * Properties that describe a base image dependency. */ interface BaseImageDependencyResponse { /** * The sha256-based digest of the image manifest. */ digest?: string; /** * The registry login server. */ registry?: string; /** * The repository name. */ repository?: string; /** * The tag name. */ tag?: string; /** * The type of the base image dependency. */ type?: string; } /** * The trigger based on base image dependency. */ interface BaseImageTriggerResponse { /** * The type of the auto trigger for base image dependency updates. */ baseImageTriggerType: string; /** * The name of the trigger. */ name: string; /** * The current status of trigger. */ status?: string; /** * The endpoint URL for receiving update triggers. */ updateTriggerEndpoint?: string; /** * Type of Payload body for Base image update triggers. */ updateTriggerPayloadType?: string; } /** * baseImageTriggerResponseProvideDefaults sets the appropriate defaults for BaseImageTriggerResponse */ function baseImageTriggerResponseProvideDefaults(val: BaseImageTriggerResponse): BaseImageTriggerResponse; /** * The health of the auth credential. */ interface CredentialHealthResponse { /** * Error code representing the health check error. */ errorCode?: string; /** * Descriptive message representing the health check error. */ errorMessage?: string; /** * The health status of credential. */ status?: string; } /** * The parameters that describes a set of credentials that will be used when a run is invoked. */ interface CredentialsResponse { /** * Describes the credential parameters for accessing other custom registries. The key * for the dictionary item will be the registry login server (myregistry.azurecr.io) and * the value of the item will be the registry credentials for accessing the registry. */ customRegistries?: { [key: string]: outputs.containerregistry.CustomRegistryCredentialsResponse; }; /** * Describes the credential parameters for accessing the source registry. */ sourceRegistry?: outputs.containerregistry.SourceRegistryCredentialsResponse; } /** * Describes the credentials that will be used to access a custom registry during a run. */ interface CustomRegistryCredentialsResponse { /** * Indicates the managed identity assigned to the custom credential. If a user-assigned identity * this value is the Client ID. If a system-assigned identity, the value will be `system`. In * the case of a system-assigned identity, the Client ID will be determined by the runner. This * identity may be used to authenticate to key vault to retrieve credentials or it may be the only * source of authentication used for accessing the registry. */ identity?: string; /** * The password for logging into the custom registry. The password is a secret * object that allows multiple ways of providing the value for it. */ password?: outputs.containerregistry.SecretObjectResponse; /** * The username for logging into the custom registry. */ userName?: outputs.containerregistry.SecretObjectResponse; } /** * The parameters for a docker quick build. */ interface DockerBuildRequestResponse { /** * The machine configuration of the run agent. */ agentConfiguration?: outputs.containerregistry.AgentPropertiesResponse; /** * The dedicated agent pool for the run. */ agentPoolName?: string; /** * The collection of override arguments to be used when executing the run. */ arguments?: outputs.containerregistry.ArgumentResponse[]; /** * The properties that describes a set of credentials that will be used when this run is invoked. */ credentials?: outputs.containerregistry.CredentialsResponse; /** * The Docker file path relative to the source location. */ dockerFilePath: string; /** * The fully qualified image names including the repository and tag. */ imageNames?: string[]; /** * The value that indicates whether archiving is enabled for the run or not. */ isArchiveEnabled?: boolean; /** * The value of this property indicates whether the image built should be pushed to the registry or not. */ isPushEnabled?: boolean; /** * The template that describes the repository and tag information for run log artifact. */ logTemplate?: string; /** * The value of this property indicates whether the image cache is enabled or not. */ noCache?: boolean; /** * The platform properties against which the run has to happen. */ platform: outputs.containerregistry.PlatformPropertiesResponse; /** * The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository. * If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API. */ sourceLocation?: string; /** * The name of the target build stage for the docker build. */ target?: string; /** * Run timeout in seconds. */ timeout?: number; /** * The type of the run request. * Expected value is 'DockerBuildRequest'. */ type: "DockerBuildRequest"; } /** * dockerBuildRequestResponseProvideDefaults sets the appropriate defaults for DockerBuildRequestResponse */ function dockerBuildRequestResponseProvideDefaults(val: DockerBuildRequestResponse): DockerBuildRequestResponse; /** * The Docker build step. */ interface DockerBuildStepResponse { /** * The collection of override arguments to be used when executing this build step. */ arguments?: outputs.containerregistry.ArgumentResponse[]; /** * List of base image dependencies for a step. */ baseImageDependencies: outputs.containerregistry.BaseImageDependencyResponse[]; /** * The token (git PAT or SAS token of storage account blob) associated with the context for a step. */ contextAccessToken?: string; /** * The URL(absolute or relative) of the source context for the task step. */ contextPath?: string; /** * The Docker file path relative to the source context. */ dockerFilePath: string; /** * The fully qualified image names including the repository and tag. */ imageNames?: string[]; /** * The value of this property indicates whether the image built should be pushed to the registry or not. */ isPushEnabled?: boolean; /** * The value of this property indicates whether the image cache is enabled or not. */ noCache?: boolean; /** * The name of the target build stage for the docker build. */ target?: string; /** * The type of the step. * Expected value is 'Docker'. */ type: "Docker"; } /** * dockerBuildStepResponseProvideDefaults sets the appropriate defaults for DockerBuildStepResponse */ function dockerBuildStepResponseProvideDefaults(val: DockerBuildStepResponse): DockerBuildStepResponse; /** * The parameters for a quick task run request. */ interface EncodedTaskRunRequestResponse { /** * The machine configuration of the run agent. */ agentConfiguration?: outputs.containerregistry.AgentPropertiesResponse; /** * The dedicated agent pool for the run. */ agentPoolName?: string; /** * The properties that describes a set of credentials that will be used when this run is invoked. */ credentials?: outputs.containerregistry.CredentialsResponse; /** * Base64 encoded value of the template/definition file content. */ encodedTaskContent: string; /** * Base64 encoded value of the parameters/values file content. */ encodedValuesContent?: string; /** * The value that indicates whether archiving is enabled for the run or not. */ isArchiveEnabled?: boolean; /** * The template that describes the repository and tag information for run log artifact. */ logTemplate?: string; /** * The platform properties against which the run has to happen. */ platform: outputs.containerregistry.PlatformPropertiesResponse; /** * The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository. * If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API. */ sourceLocation?: string; /** * Run timeout in seconds. */ timeout?: number; /** * The type of the run request. * Expected value is 'EncodedTaskRunRequest'. */ type: "EncodedTaskRunRequest"; /** * The collection of overridable values that can be passed when running a task. */ values?: outputs.containerregistry.SetValueResponse[]; } /** * encodedTaskRunRequestResponseProvideDefaults sets the appropriate defaults for EncodedTaskRunRequestResponse */ function encodedTaskRunRequestResponseProvideDefaults(val: EncodedTaskRunRequestResponse): EncodedTaskRunRequestResponse; /** * The properties of a encoded task step. */ interface EncodedTaskStepResponse { /** * List of base image dependencies for a step. */ baseImageDependencies: outputs.containerregistry.BaseImageDependencyResponse[]; /** * The token (git PAT or SAS token of storage account blob) associated with the context for a step. */ contextAccessToken?: string; /** * The URL(absolute or relative) of the source context for the task step. */ contextPath?: string; /** * Base64 encoded value of the template/definition file content. */ encodedTaskContent: string; /** * Base64 encoded value of the parameters/values file content. */ encodedValuesContent?: string; /** * The type of the step. * Expected value is 'EncodedTask'. */ type: "EncodedTask"; /** * The collection of overridable values that can be passed when running a task. */ values?: outputs.containerregistry.SetValueResponse[]; } interface EncryptionPropertyResponse { /** * Key vault properties. */ keyVaultProperties?: outputs.containerregistry.KeyVaultPropertiesResponse; /** * Indicates whether or not the encryption is enabled for container registry. */ status?: string; } /** * The content of the event request message. */ interface EventContentResponse { /** * The action that encompasses the provided event. */ action?: string; /** * The agent that initiated the event. For most situations, this could be from the authorization context of the request. */ actor?: outputs.containerregistry.ActorResponse; /** * The event ID. */ id?: string; /** * The request that generated the event. */ request?: outputs.containerregistry.RequestResponse; /** * The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. */ source?: outputs.containerregistry.SourceResponse; /** * The target of the event. */ target?: outputs.containerregistry.TargetResponse; /** * The time at which the event occurred. */ timestamp?: string; } /** * The event request message sent to the service URI. */ interface EventRequestMessageResponse { /** * The content of the event request message. */ content?: outputs.containerregistry.EventContentResponse; /** * The headers of the event request message. */ headers?: { [key: string]: string; }; /** * The HTTP method used to send the event request message. */ method?: string; /** * The URI used to send the event request message. */ requestUri?: string; /** * The HTTP message version. */ version?: string; } /** * The event for a webhook. */ interface EventResponse { /** * The event request message sent to the service URI. */ eventRequestMessage?: outputs.containerregistry.EventRequestMessageResponse; /** * The event response message received from the service URI. */ eventResponseMessage?: outputs.containerregistry.EventResponseMessageResponse; /** * The event ID. */ id?: string; } /** * The event response message received from the service URI. */ interface EventResponseMessageResponse { /** * The content of the event response message. */ content?: string; /** * The headers of the event response message. */ headers?: { [key: string]: string; }; /** * The reason phrase of the event response message. */ reasonPhrase?: string; /** * The status code of the event response message. */ statusCode?: string; /** * The HTTP message version. */ version?: string; } /** * The properties of the export pipeline target. */ interface ExportPipelineTargetPropertiesResponse { /** * They key vault secret uri to obtain the target storage SAS token. */ keyVaultUri: string; /** * The type of target for the export pipeline. */ type?: string; /** * The target uri of the export pipeline. * When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" * When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" */ uri?: string; } /** * The export policy for a container registry. */ interface ExportPolicyResponse { /** * The value that indicates whether the policy is enabled or not. */ status?: string; } /** * exportPolicyResponseProvideDefaults sets the appropriate defaults for ExportPolicyResponse */ function exportPolicyResponseProvideDefaults(val: ExportPolicyResponse): ExportPolicyResponse; /** * The request parameters for a scheduling run against a task file. */ interface FileTaskRunRequestResponse { /** * The machine configuration of the run agent. */ agentConfiguration?: outputs.containerregistry.AgentPropertiesResponse; /** * The dedicated agent pool for the run. */ agentPoolName?: string; /** * The properties that describes a set of credentials that will be used when this run is invoked. */ credentials?: outputs.containerregistry.CredentialsResponse; /** * The value that indicates whether archiving is enabled for the run or not. */ isArchiveEnabled?: boolean; /** * The template that describes the repository and tag information for run log artifact. */ logTemplate?: string; /** * The platform properties against which the run has to happen. */ platform: outputs.containerregistry.PlatformPropertiesResponse; /** * The URL(absolute or relative) of the source context. It can be an URL to a tar or git repository. * If it is relative URL, the relative path should be obtained from calling listBuildSourceUploadUrl API. */ sourceLocation?: string; /** * The template/definition file path relative to the source. */ taskFilePath: string; /** * Run timeout in seconds. */ timeout?: number; /** * The type of the run request. * Expected value is 'FileTaskRunRequest'. */ type: "FileTaskRunRequest"; /** * The collection of overridable values that can be passed when running a task. */ values?: outputs.containerregistry.SetValueResponse[]; /** * The values/parameters file path relative to the source. */ valuesFilePath?: string; } /** * fileTaskRunRequestResponseProvideDefaults sets the appropriate defaults for FileTaskRunRequestResponse */ function fileTaskRunRequestResponseProvideDefaults(val: FileTaskRunRequestResponse): FileTaskRunRequestResponse; /** * The properties of a task step. */ interface FileTaskStepResponse { /** * List of base image dependencies for a step. */ baseImageDependencies: outputs.containerregistry.BaseImageDependencyResponse[]; /** * The token (git PAT or SAS token of storage account blob) associated with the context for a step. */ contextAccessToken?: string; /** * The URL(absolute or relative) of the source context for the task step. */ contextPath?: string; /** * The task template/definition file path relative to the source context. */ taskFilePath: string; /** * The type of the step. * Expected value is 'FileTask'. */ type: "FileTask"; /** * The collection of overridable values that can be passed when running a task. */ values?: outputs.containerregistry.SetValueResponse[]; /** * The task values/parameters file path relative to the source context. */ valuesFilePath?: string; } /** * The garbage collection properties of the connected registry. */ interface GarbageCollectionPropertiesResponse { /** * Indicates whether garbage collection is enabled for the connected registry. */ enabled?: boolean; /** * The cron expression indicating the schedule that the connected registry will run garbage collection. */ schedule?: string; } /** * IP rule with specific IP or IP range in CIDR format. */ interface IPRuleResponse { /** * The action of IP ACL rule. */ action?: string; /** * Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. */ iPAddressOrRange: string; } /** * ipruleResponseProvideDefaults sets the appropriate defaults for IPRuleResponse */ function ipruleResponseProvideDefaults(val: IPRuleResponse): IPRuleResponse; /** * Managed identity for the resource. */ interface IdentityPropertiesResponse { /** * The principal ID of resource identity. */ principalId?: string; /** * The tenant ID of resource. */ tenantId?: string; /** * The identity type. */ type?: string; /** * The list of user identities associated with the resource. The user identity * dictionary key references will be ARM resource ids in the form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ * providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.containerregistry.UserIdentityPropertiesResponse; }; } /** * Properties for a registry image. */ interface ImageDescriptorResponse { /** * The sha256-based digest of the image manifest. */ digest?: string; /** * The registry login server. */ registry?: string; /** * The repository name. */ repository?: string; /** * The tag name. */ tag?: string; } /** * The image update trigger that caused a build. */ interface ImageUpdateTriggerResponse { /** * The unique ID of the trigger. */ id?: string; /** * The list of image updates that caused the build. */ images?: outputs.containerregistry.ImageDescriptorResponse[]; /** * The timestamp when the image update happened. */ timestamp?: string; } /** * The properties of the import pipeline source. */ interface ImportPipelineSourcePropertiesResponse { /** * They key vault secret uri to obtain the source storage SAS token. */ keyVaultUri: string; /** * The type of source for the import pipeline. */ type?: string; /** * The source uri of the import pipeline. * When 'AzureStorageBlob': "https://accountName.blob.core.windows.net/containerName/blobName" * When 'AzureStorageBlobContainer': "https://accountName.blob.core.windows.net/containerName" */ uri?: string; } /** * importPipelineSourcePropertiesResponseProvideDefaults sets the appropriate defaults for ImportPipelineSourcePropertiesResponse */ function importPipelineSourcePropertiesResponseProvideDefaults(val: ImportPipelineSourcePropertiesResponse): ImportPipelineSourcePropertiesResponse; interface KeyVaultPropertiesResponse { /** * The client id of the identity which will be used to access key vault. */ identity?: string; /** * Key vault uri to access the encryption key. */ keyIdentifier?: string; /** * Auto key rotation status for a CMK enabled registry. */ keyRotationEnabled: boolean; /** * Timestamp of the last successful key rotation. */ lastKeyRotationTimestamp: string; /** * The fully qualified key identifier that includes the version of the key that is actually used for encryption. */ versionedKeyIdentifier: string; } /** * The logging properties of the connected registry. */ interface LoggingPropertiesResponse { /** * Indicates whether audit logs are enabled on the connected registry. */ auditLogStatus?: string; /** * The verbosity of logs persisted on the connected registry. */ logLevel?: string; } /** * loggingPropertiesResponseProvideDefaults sets the appropriate defaults for LoggingPropertiesResponse */ function loggingPropertiesResponseProvideDefaults(val: LoggingPropertiesResponse): LoggingPropertiesResponse; /** * The login server properties of the connected registry. */ interface LoginServerPropertiesResponse { /** * The host of the connected registry. Can be FQDN or IP. */ host: string; /** * The TLS properties of the connected registry login server. */ tls: outputs.containerregistry.TlsPropertiesResponse; } /** * The network rule set for a container registry. */ interface NetworkRuleSetResponse { /** * The default action of allow or deny when no other rules match. */ defaultAction: string; /** * The IP ACL rules. */ ipRules?: outputs.containerregistry.IPRuleResponse[]; } /** * networkRuleSetResponseProvideDefaults sets the appropriate defaults for NetworkRuleSetResponse */ function networkRuleSetResponseProvideDefaults(val: NetworkRuleSetResponse): NetworkRuleSetResponse; interface OverrideTaskStepPropertiesResponse { /** * Gets or sets the collection of override arguments to be used when * executing a build step. */ arguments?: outputs.containerregistry.ArgumentResponse[]; /** * The source context against which run has to be queued. */ contextPath?: string; /** * The file against which run has to be queued. */ file?: string; /** * The name of the target build stage for the docker build. */ target?: string; /** * Base64 encoded update trigger token that will be attached with the base image trigger webhook. */ updateTriggerToken?: string; /** * The collection of overridable values that can be passed when running a Task. */ values?: outputs.containerregistry.SetValueResponse[]; } /** * The properties of the connected registry parent. */ interface ParentPropertiesResponse { /** * The resource ID of the parent to which the connected registry will be associated. */ id?: string; /** * The sync properties of the connected registry with its parent. */ syncProperties: outputs.containerregistry.SyncPropertiesResponse; } /** * The request properties provided for a pipeline run. */ interface PipelineRunRequestResponse { /** * List of source artifacts to be transferred by the pipeline. * Specify an image by repository ('hello-world'). This will use the 'latest' tag. * Specify an image by tag ('hello-world:latest'). * Specify an image by sha256-based manifest digest ('hello-world@sha256:abc123'). */ artifacts?: string[]; /** * The digest of the tar used to transfer the artifacts. */ catalogDigest?: string; /** * The resource ID of the pipeline to run. */ pipelineResourceId?: string; /** * The source properties of the pipeline run. */ source?: outputs.containerregistry.PipelineRunSourcePropertiesResponse; /** * The target properties of the pipeline run. */ target?: outputs.containerregistry.PipelineRunTargetPropertiesResponse; } /** * pipelineRunRequestResponseProvideDefaults sets the appropriate defaults for PipelineRunRequestResponse */ function pipelineRunRequestResponseProvideDefaults(val: PipelineRunRequestResponse): PipelineRunRequestResponse; /** * The response properties returned for a pipeline run. */ interface PipelineRunResponseResponse { /** * The digest of the tar used to transfer the artifacts. */ catalogDigest?: string; /** * The time the pipeline run finished. */ finishTime?: string; /** * The artifacts imported in the pipeline run. */ importedArtifacts?: string[]; /** * The detailed error message for the pipeline run in the case of failure. */ pipelineRunErrorMessage?: string; /** * The current progress of the copy operation. */ progress?: outputs.containerregistry.ProgressPropertiesResponse; /** * The source of the pipeline run. */ source?: outputs.containerregistry.ImportPipelineSourcePropertiesResponse; /** * The time the pipeline run started. */ startTime?: string; /** * The current status of the pipeline run. */ status?: string; /** * The target of the pipeline run. */ target?: outputs.containerregistry.ExportPipelineTargetPropertiesResponse; /** * The trigger that caused the pipeline run. */ trigger?: outputs.containerregistry.PipelineTriggerDescriptorResponse; } /** * pipelineRunResponseResponseProvideDefaults sets the appropriate defaults for PipelineRunResponseResponse */ function pipelineRunResponseResponseProvideDefaults(val: PipelineRunResponseResponse): PipelineRunResponseResponse; interface PipelineRunSourcePropertiesResponse { /** * The name of the source. */ name?: string; /** * The type of the source. */ type?: string; } /** * pipelineRunSourcePropertiesResponseProvideDefaults sets the appropriate defaults for PipelineRunSourcePropertiesResponse */ function pipelineRunSourcePropertiesResponseProvideDefaults(val: PipelineRunSourcePropertiesResponse): PipelineRunSourcePropertiesResponse; interface PipelineRunTargetPropertiesResponse { /** * The name of the target. */ name?: string; /** * The type of the target. */ type?: string; } /** * pipelineRunTargetPropertiesResponseProvideDefaults sets the appropriate defaults for PipelineRunTargetPropertiesResponse */ function pipelineRunTargetPropertiesResponseProvideDefaults(val: PipelineRunTargetPropertiesResponse): PipelineRunTargetPropertiesResponse; interface PipelineSourceTriggerDescriptorResponse { /** * The timestamp when the source update happened. */ timestamp?: string; } interface PipelineSourceTriggerPropertiesResponse { /** * The current status of the source trigger. */ status: string; } /** * pipelineSourceTriggerPropertiesResponseProvideDefaults sets the appropriate defaults for PipelineSourceTriggerPropertiesResponse */ function pipelineSourceTriggerPropertiesResponseProvideDefaults(val: PipelineSourceTriggerPropertiesResponse): PipelineSourceTriggerPropertiesResponse; interface PipelineTriggerDescriptorResponse { /** * The source trigger that caused the pipeline run. */ sourceTrigger?: outputs.containerregistry.PipelineSourceTriggerDescriptorResponse; } interface PipelineTriggerPropertiesResponse { /** * The source trigger properties of the pipeline. */ sourceTrigger?: outputs.containerregistry.PipelineSourceTriggerPropertiesResponse; } /** * pipelineTriggerPropertiesResponseProvideDefaults sets the appropriate defaults for PipelineTriggerPropertiesResponse */ function pipelineTriggerPropertiesResponseProvideDefaults(val: PipelineTriggerPropertiesResponse): PipelineTriggerPropertiesResponse; /** * The platform properties against which the run has to happen. */ interface PlatformPropertiesResponse { /** * The OS architecture. */ architecture?: string; /** * The operating system type required for the run. */ os: string; /** * Variant of the CPU. */ variant?: string; } /** * The policies for a container registry. */ interface PoliciesResponse { /** * The policy for using ARM audience token for a container registry. */ azureADAuthenticationAsArmPolicy?: outputs.containerregistry.AzureADAuthenticationAsArmPolicyResponse; /** * The export policy for a container registry. */ exportPolicy?: outputs.containerregistry.ExportPolicyResponse; /** * The quarantine policy for a container registry. */ quarantinePolicy?: outputs.containerregistry.QuarantinePolicyResponse; /** * The retention policy for a container registry. */ retentionPolicy?: outputs.containerregistry.RetentionPolicyResponse; /** * The soft delete policy for a container registry. */ softDeletePolicy?: outputs.containerregistry.SoftDeletePolicyResponse; /** * The content trust policy for a container registry. */ trustPolicy?: outputs.containerregistry.TrustPolicyResponse; } /** * policiesResponseProvideDefaults sets the appropriate defaults for PoliciesResponse */ function policiesResponseProvideDefaults(val: PoliciesResponse): PoliciesResponse; /** * An object that represents a private endpoint connection for a container registry. */ interface PrivateEndpointConnectionResponse { /** * The resource ID. */ id: string; /** * The name of the resource. */ name: string; /** * The resource of private endpoint. */ privateEndpoint?: outputs.containerregistry.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState?: outputs.containerregistry.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of private endpoint connection resource. */ provisioningState: string; /** * Metadata pertaining to creation and last modification of the resource. */ systemData: outputs.containerregistry.SystemDataResponse; /** * The type of the resource. */ type: string; } /** * The Private Endpoint resource. */ interface PrivateEndpointResponse { /** * This is private endpoint resource created with Microsoft.Network resource provider. */ id?: string; } /** * The state of a private link service connection. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The description for connection status. For example if connection is rejected it can indicate reason for rejection. */ description?: string; /** * The private link service connection status. */ status?: string; } interface ProgressPropertiesResponse { /** * The percentage complete of the copy operation. */ percentage?: string; } /** * The quarantine policy for a container registry. */ interface QuarantinePolicyResponse { /** * The value that indicates whether the policy is enabled or not. */ status?: string; } /** * quarantinePolicyResponseProvideDefaults sets the appropriate defaults for QuarantinePolicyResponse */ function quarantinePolicyResponseProvideDefaults(val: QuarantinePolicyResponse): QuarantinePolicyResponse; /** * The login password for the container registry. */ interface RegistryPasswordResponse { /** * The password name. */ name?: string; /** * The password value. */ value?: string; } /** * The request that generated the event. */ interface RequestResponse { /** * The IP or hostname and possibly port of the client connection that initiated the event. This is the RemoteAddr from the standard http request. */ addr?: string; /** * The externally accessible hostname of the registry instance, as specified by the http host header on incoming requests. */ host?: string; /** * The ID of the request that initiated the event. */ id?: string; /** * The request method that generated the event. */ method?: string; /** * The user agent header of the request. */ useragent?: string; } /** * The retention policy for a container registry. */ interface RetentionPolicyResponse { /** * The number of days to retain an untagged manifest after which it gets purged. */ days?: number; /** * The timestamp when the policy was last updated. */ lastUpdatedTime: string; /** * The value that indicates whether the policy is enabled or not. */ status?: string; } /** * retentionPolicyResponseProvideDefaults sets the appropriate defaults for RetentionPolicyResponse */ function retentionPolicyResponseProvideDefaults(val: RetentionPolicyResponse): RetentionPolicyResponse; /** * Run resource properties */ interface RunResponse { /** * The machine configuration of the run agent. */ agentConfiguration?: outputs.containerregistry.AgentPropertiesResponse; /** * The dedicated agent pool for the run. */ agentPoolName?: string; /** * The time the run was scheduled. */ createTime?: string; /** * The list of custom registries that were logged in during this run. */ customRegistries?: string[]; /** * The time the run finished. */ finishTime?: string; /** * The resource ID. */ id: string; /** * The image update trigger that caused the run. This is applicable if the task has base image trigger configured. */ imageUpdateTrigger?: outputs.containerregistry.ImageUpdateTriggerResponse; /** * The value that indicates whether archiving is enabled or not. */ isArchiveEnabled?: boolean; /** * The last updated time for the run. */ lastUpdatedTime?: string; /** * The image description for the log artifact. */ logArtifact: outputs.containerregistry.ImageDescriptorResponse; /** * The name of the resource. */ name: string; /** * The list of all images that were generated from the run. This is applicable if the run generates base image dependencies. */ outputImages?: outputs.containerregistry.ImageDescriptorResponse[]; /** * The platform properties against which the run will happen. */ platform?: outputs.containerregistry.PlatformPropertiesResponse; /** * The provisioning state of a run. */ provisioningState?: string; /** * The error message received from backend systems after the run is scheduled. */ runErrorMessage: string; /** * The unique identifier for the run. */ runId?: string; /** * The type of run. */ runType?: string; /** * The scope of the credentials that were used to login to the source registry during this run. */ sourceRegistryAuth?: string; /** * The source trigger that caused the run. */ sourceTrigger?: outputs.containerregistry.SourceTriggerDescriptorResponse; /** * The time the run started. */ startTime?: string; /** * The current status of the run. */ status?: string; /** * Metadata pertaining to creation and last modification of the resource. */ systemData: outputs.containerregistry.SystemDataResponse; /** * The task against which run was scheduled. */ task?: string; /** * The timer trigger that caused the run. */ timerTrigger?: outputs.containerregistry.TimerTriggerDescriptorResponse; /** * The type of the resource. */ type: string; /** * The update trigger token passed for the Run. */ updateTriggerToken?: string; } /** * runResponseProvideDefaults sets the appropriate defaults for RunResponse */ function runResponseProvideDefaults(val: RunResponse): RunResponse; /** * Describes the properties of a secret object value. */ interface SecretObjectResponse { /** * The type of the secret object which determines how the value of the secret object has to be * interpreted. */ type?: string; /** * The value of the secret. The format of this value will be determined * based on the type of the secret object. If the type is Opaque, the value will be * used as is without any modification. */ value?: string; } /** * The properties of a overridable value that can be passed to a task template. */ interface SetValueResponse { /** * Flag to indicate whether the value represents a secret or not. */ isSecret?: boolean; /** * The name of the overridable value. */ name: string; /** * The overridable value. */ value: string; } /** * setValueResponseProvideDefaults sets the appropriate defaults for SetValueResponse */ function setValueResponseProvideDefaults(val: SetValueResponse): SetValueResponse; /** * The SKU of a container registry. */ interface SkuResponse { /** * The SKU name of the container registry. Required for registry creation. */ name: string; /** * The SKU tier based on the SKU name. */ tier: string; } /** * The soft delete policy for a container registry */ interface SoftDeletePolicyResponse { /** * The timestamp when the policy was last updated. */ lastUpdatedTime: string; /** * The number of days after which a soft-deleted item is permanently deleted. */ retentionDays?: number; /** * The value that indicates whether the policy is enabled or not. */ status?: string; } /** * softDeletePolicyResponseProvideDefaults sets the appropriate defaults for SoftDeletePolicyResponse */ function softDeletePolicyResponseProvideDefaults(val: SoftDeletePolicyResponse): SoftDeletePolicyResponse; /** * The properties of the source code repository. */ interface SourcePropertiesResponse { /** * The branch name of the source code. */ branch?: string; /** * The full URL to the source code repository */ repositoryUrl: string; /** * The authorization properties for accessing the source code repository and to set up * webhooks for notifications. */ sourceControlAuthProperties?: outputs.containerregistry.AuthInfoResponse; /** * The type of source control service. */ sourceControlType: string; } /** * Describes the credential parameters for accessing the source registry. */ interface SourceRegistryCredentialsResponse { /** * The authentication mode which determines the source registry login scope. The credentials for the source registry * will be generated using the given scope. These credentials will be used to login to * the source registry during the run. */ loginMode?: string; } /** * The registry node that generated the event. Put differently, while the actor initiates the event, the source generates it. */ interface SourceResponse { /** * The IP or hostname and the port of the registry node that generated the event. Generally, this will be resolved by os.Hostname() along with the running port. */ addr?: string; /** * The running instance of an application. Changes after each restart. */ instanceID?: string; } /** * The source trigger that caused a run. */ interface SourceTriggerDescriptorResponse { /** * The branch name in the repository. */ branchName?: string; /** * The unique ID that identifies a commit. */ commitId?: string; /** * The event type of the trigger. */ eventType?: string; /** * The unique ID of the trigger. */ id?: string; /** * The source control provider type. */ providerType?: string; /** * The unique ID that identifies pull request. */ pullRequestId?: string; /** * The repository URL. */ repositoryUrl?: string; } /** * The properties of a source based trigger. */ interface SourceTriggerResponse { /** * The name of the trigger. */ name: string; /** * The properties that describes the source(code) for the task. */ sourceRepository: outputs.containerregistry.SourcePropertiesResponse; /** * The source event corresponding to the trigger. */ sourceTriggerEvents: string[]; /** * The current status of trigger. */ status?: string; } /** * sourceTriggerResponseProvideDefaults sets the appropriate defaults for SourceTriggerResponse */ function sourceTriggerResponseProvideDefaults(val: SourceTriggerResponse): SourceTriggerResponse; /** * The status detail properties of the connected registry. */ interface StatusDetailPropertiesResponse { /** * The code of the status. */ code: string; /** * The correlation ID of the status. */ correlationId: string; /** * The description of the status. */ description: string; /** * The timestamp of the status. */ timestamp: string; /** * The component of the connected registry corresponding to the status. */ type: string; } /** * The status of an Azure resource at the time the operation was called. */ interface StatusResponse { /** * The short label for the status. */ displayStatus: string; /** * The detailed message for the status, including alerts and error messages. */ message: string; /** * The timestamp when the status was changed to the current value. */ timestamp: string; } /** * The sync properties of the connected registry with its parent. */ interface SyncPropertiesResponse { /** * The gateway endpoint used by the connected registry to communicate with its parent. */ gatewayEndpoint: string; /** * The last time a sync occurred between the connected registry and its parent. */ lastSyncTime: string; /** * The period of time for which a message is available to sync before it is expired. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. */ messageTtl: string; /** * The cron expression indicating the schedule that the connected registry will sync with its parent. */ schedule?: string; /** * The time window during which sync is enabled for each schedule occurrence. Specify the duration using the format P[n]Y[n]M[n]DT[n]H[n]M[n]S as per ISO8601. */ syncWindow?: string; /** * The resource ID of the ACR token used to authenticate the connected registry to its parent during sync. */ tokenId: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource modification (UTC). */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The target of the event. */ interface TargetResponse { /** * The digest of the content, as defined by the Registry V2 HTTP API Specification. */ digest?: string; /** * The number of bytes of the content. Same as Size field. */ length?: number; /** * The MIME type of the referenced object. */ mediaType?: string; /** * The name of the artifact. */ name?: string; /** * The repository name. */ repository?: string; /** * The number of bytes of the content. Same as Length field. */ size?: number; /** * The tag name. */ tag?: string; /** * The direct URL to the content. */ url?: string; /** * The version of the artifact. */ version?: string; } /** * The parameters for a task run request. */ interface TaskRunRequestResponse { /** * The dedicated agent pool for the run. */ agentPoolName?: string; /** * The value that indicates whether archiving is enabled for the run or not. */ isArchiveEnabled?: boolean; /** * The template that describes the repository and tag information for run log artifact. */ logTemplate?: string; /** * Set of overridable parameters that can be passed when running a Task. */ overrideTaskStepProperties?: outputs.containerregistry.OverrideTaskStepPropertiesResponse; /** * The resource ID of task against which run has to be queued. */ taskId: string; /** * The type of the run request. * Expected value is 'TaskRunRequest'. */ type: "TaskRunRequest"; } /** * taskRunRequestResponseProvideDefaults sets the appropriate defaults for TaskRunRequestResponse */ function taskRunRequestResponseProvideDefaults(val: TaskRunRequestResponse): TaskRunRequestResponse; interface TimerTriggerDescriptorResponse { /** * The occurrence that triggered the run. */ scheduleOccurrence?: string; /** * The timer trigger name that caused the run. */ timerTriggerName?: string; } /** * The properties of a timer trigger. */ interface TimerTriggerResponse { /** * The name of the trigger. */ name: string; /** * The CRON expression for the task schedule */ schedule: string; /** * The current status of trigger. */ status?: string; } /** * timerTriggerResponseProvideDefaults sets the appropriate defaults for TimerTriggerResponse */ function timerTriggerResponseProvideDefaults(val: TimerTriggerResponse): TimerTriggerResponse; /** * The TLS certificate properties of the connected registry login server. */ interface TlsCertificatePropertiesResponse { /** * Indicates the location of the certificates. */ location: string; /** * The type of certificate location. */ type: string; } /** * The TLS properties of the connected registry login server. */ interface TlsPropertiesResponse { /** * The certificate used to configure HTTPS for the login server. */ certificate: outputs.containerregistry.TlsCertificatePropertiesResponse; /** * Indicates whether HTTPS is enabled for the login server. */ status: string; } /** * The properties of a certificate used for authenticating a token. */ interface TokenCertificateResponse { /** * Base 64 encoded string of the public certificate1 in PEM format that will be used for authenticating the token. */ encodedPemCertificate?: string; /** * The expiry datetime of the certificate. */ expiry?: string; name?: string; /** * The thumbprint of the certificate. */ thumbprint?: string; } /** * The properties of the credentials that can be used for authenticating the token. */ interface TokenCredentialsPropertiesResponse { certificates?: outputs.containerregistry.TokenCertificateResponse[]; passwords?: outputs.containerregistry.TokenPasswordResponse[]; } /** * The password that will be used for authenticating the token of a container registry. */ interface TokenPasswordResponse { /** * The creation datetime of the password. */ creationTime?: string; /** * The expiry datetime of the password. */ expiry?: string; /** * The password name "password1" or "password2" */ name?: string; /** * The password value. */ value: string; } /** * The properties of a trigger. */ interface TriggerPropertiesResponse { /** * The trigger based on base image dependencies. */ baseImageTrigger?: outputs.containerregistry.BaseImageTriggerResponse; /** * The collection of triggers based on source code repository. */ sourceTriggers?: outputs.containerregistry.SourceTriggerResponse[]; /** * The collection of timer triggers. */ timerTriggers?: outputs.containerregistry.TimerTriggerResponse[]; } /** * triggerPropertiesResponseProvideDefaults sets the appropriate defaults for TriggerPropertiesResponse */ function triggerPropertiesResponseProvideDefaults(val: TriggerPropertiesResponse): TriggerPropertiesResponse; /** * The content trust policy for a container registry. */ interface TrustPolicyResponse { /** * The value that indicates whether the policy is enabled or not. */ status?: string; /** * The type of trust policy. */ type?: string; } /** * trustPolicyResponseProvideDefaults sets the appropriate defaults for TrustPolicyResponse */ function trustPolicyResponseProvideDefaults(val: TrustPolicyResponse): TrustPolicyResponse; interface UserIdentityPropertiesResponse { /** * The client id of user assigned identity. */ clientId?: string; /** * The principal id of user assigned identity. */ principalId?: string; } } export declare namespace containerservice { /** * Access profile for the Fleet hub API server. */ interface APIServerAccessProfileResponse { /** * Whether to create the Fleet hub as a private cluster or not. */ enablePrivateCluster?: boolean; /** * Whether to enable apiserver vnet integration for the Fleet hub or not. */ enableVnetIntegration?: boolean; /** * The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new Fleet with BYO vnet. */ subnetId?: string; } /** * For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'. */ interface AbsoluteMonthlyScheduleResponse { /** * The date of the month. */ dayOfMonth: number; /** * Specifies the number of months between each set of occurrences. */ intervalMonths: number; } /** * Observability profile to enable advanced network metrics and flow logs with historical contexts. */ interface AdvancedNetworkingObservabilityResponse { /** * Indicates the enablement of Advanced Networking observability functionalities on clusters. */ enabled?: boolean; } /** * Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking. */ interface AdvancedNetworkingResponse { /** * Indicates the enablement of Advanced Networking functionalities of observability and security on AKS clusters. When this is set to true, all observability and security features will be set to enabled unless explicitly disabled. If not specified, the default is false. */ enabled?: boolean; /** * Observability profile to enable advanced network metrics and flow logs with historical contexts. */ observability?: outputs.containerservice.AdvancedNetworkingObservabilityResponse; /** * Security profile to enable security features on cilium based cluster. */ security?: outputs.containerservice.AdvancedNetworkingSecurityResponse; } /** * Security profile to enable security features on cilium based cluster. */ interface AdvancedNetworkingSecurityResponse { /** * Enable advanced network policies. This allows users to configure Layer 7 network policies (FQDN, HTTP, Kafka). Policies themselves must be configured via the Cilium Network Policy resources, see https://docs.cilium.io/en/latest/security/policy/index.html. This can be enabled only on cilium-based clusters. If not specified, the default value is FQDN if security.enabled is set to true. */ advancedNetworkPolicies?: string; /** * This feature allows user to configure network policy based on DNS (FQDN) names. It can be enabled only on cilium based clusters. If not specified, the default is false. */ enabled?: boolean; } /** * Affinity is a group of cluster affinity scheduling rules. More to be added. */ interface AffinityResponse { /** * ClusterAffinity contains cluster affinity scheduling rules for the selected resources. */ clusterAffinity?: outputs.containerservice.ClusterAffinityResponse; } /** * Profile of the managed cluster gateway agent pool. */ interface AgentPoolGatewayProfileResponse { /** * The Gateway agent pool associates one public IPPrefix for each static egress gateway to provide public egress. The size of Public IPPrefix should be selected by the user. Each node in the agent pool is assigned with one IP from the IPPrefix. The IPPrefix size thus serves as a cap on the size of the Gateway agent pool. Due to Azure public IPPrefix size limitation, the valid value range is [28, 31] (/31 = 2 nodes/IPs, /30 = 4 nodes/IPs, /29 = 8 nodes/IPs, /28 = 16 nodes/IPs). The default value is 31. */ publicIPPrefixSize?: number; } /** * agentPoolGatewayProfileResponseProvideDefaults sets the appropriate defaults for AgentPoolGatewayProfileResponse */ function agentPoolGatewayProfileResponseProvideDefaults(val: AgentPoolGatewayProfileResponse): AgentPoolGatewayProfileResponse; /** * Network settings of an agent pool. */ interface AgentPoolNetworkProfileResponse { /** * The port ranges that are allowed to access. The specified ranges are allowed to overlap. */ allowedHostPorts?: outputs.containerservice.PortRangeResponse[]; /** * The IDs of the application security groups which agent pool will associate when created. */ applicationSecurityGroups?: string[]; /** * IPTags of instance-level public IPs. */ nodePublicIPTags?: outputs.containerservice.IPTagResponse[]; } /** * The security settings of an agent pool. */ interface AgentPoolSecurityProfileResponse { /** * Secure Boot is a feature of Trusted Launch which ensures that only signed operating systems and drivers can boot. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. */ enableSecureBoot?: boolean; /** * vTPM is a Trusted Launch feature for configuring a dedicated secure vault for keys and measurements held locally on the node. For more details, see aka.ms/aks/trustedlaunch. If not specified, the default is false. */ enableVTPM?: boolean; /** * SSH access method of an agent pool. */ sshAccess?: string; } /** * Contains read-only information about the Agent Pool. */ interface AgentPoolStatusResponse { /** * The error detail information of the agent pool. Preserves the detailed info of failure. If there was no error, this field is omitted. */ provisioningError: outputs.containerservice.ErrorDetailResponse; } /** * Settings for upgrading an agentpool */ interface AgentPoolUpgradeSettingsResponse { /** * The drain timeout for a node. The amount of time (in minutes) to wait on eviction of pods and graceful termination per node. This eviction wait time honors waiting on pod disruption budgets. If this time is exceeded, the upgrade fails. If not specified, the default is 30 minutes. */ drainTimeoutInMinutes?: number; /** * The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 10%. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster */ maxSurge?: string; /** * The maximum number or percentage of nodes that can be simultaneously unavailable during upgrade. This can either be set to an integer (e.g. '1') or a percentage (e.g. '5%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified, the default is 0. For more information, including best practices, see: https://learn.microsoft.com/en-us/azure/aks/upgrade-cluster */ maxUnavailable?: string; /** * The soak duration for a node. The amount of time (in minutes) to wait after draining a node and before reimaging it and moving on to next node. If not specified, the default is 0 minutes. */ nodeSoakDurationInMinutes?: number; /** * Defines the behavior for undrainable nodes during upgrade. The most common cause of undrainable nodes is Pod Disruption Budgets (PDBs), but other issues, such as pod termination grace period is exceeding the remaining per-node drain timeout or pod is still being in a running state, can also cause undrainable nodes. */ undrainableNodeBehavior?: string; } /** * The Windows agent pool's specific profile. */ interface AgentPoolWindowsProfileResponse { /** * Whether to disable OutboundNAT in windows nodes. The default value is false. Outbound NAT can only be disabled if the cluster outboundType is NAT Gateway and the Windows agent pool does not have node public IP enabled. */ disableOutboundNat?: boolean; } /** * Agent profile for the Fleet hub. */ interface AgentProfileResponse { /** * The ID of the subnet which the Fleet hub node will join on startup. If this is not specified, a vnet and subnet will be generated and used. */ subnetId?: string; /** * The virtual machine size of the Fleet hub. */ vmSize?: string; } /** * The node image upgrade to be applied to the target clusters in auto upgrade. */ interface AutoUpgradeNodeImageSelectionResponse { /** * The node image upgrade type. */ type: string; } /** * Azure Key Vault key management service settings for the security profile. */ interface AzureKeyVaultKmsResponse { /** * Whether to enable Azure Key Vault key management service. The default is false. */ enabled?: boolean; /** * Identifier of Azure Key Vault key. See [key identifier format](https://docs.microsoft.com/en-us/azure/key-vault/general/about-keys-secrets-certificates#vault-name-and-object-name) for more details. When Azure Key Vault key management service is enabled, this field is required and must be a valid key identifier. When Azure Key Vault key management service is disabled, leave the field empty. */ keyId?: string; /** * Network access of the key vault. Network access of key vault. The possible values are `Public` and `Private`. `Public` means the key vault allows public access from all networks. `Private` means the key vault disables public access and enables private link. The default value is `Public`. */ keyVaultNetworkAccess?: string; /** * Resource ID of key vault. When keyVaultNetworkAccess is `Private`, this field is required and must be a valid resource ID. When keyVaultNetworkAccess is `Public`, leave the field empty. */ keyVaultResourceId?: string; } /** * azureKeyVaultKmsResponseProvideDefaults sets the appropriate defaults for AzureKeyVaultKmsResponse */ function azureKeyVaultKmsResponseProvideDefaults(val: AzureKeyVaultKmsResponse): AzureKeyVaultKmsResponse; /** * ClusterAffinity contains cluster affinity scheduling rules for the selected resources. */ interface ClusterAffinityResponse { /** * If the affinity requirements specified by this field are not met at scheduling time, the resource will not be scheduled onto the cluster. If the affinity requirements specified by this field cease to be met at some point after the placement (e.g. due to an update), the system may or may not try to eventually remove the resource from the cluster. */ requiredDuringSchedulingIgnoredDuringExecution?: outputs.containerservice.ClusterSelectorResponse; } /** * ClusterResourcePlacementSpec defines the desired state of ClusterResourcePlacement. */ interface ClusterResourcePlacementSpecResponse { /** * Policy defines how to select member clusters to place the selected resources. If unspecified, all the joined member clusters are selected. */ policy?: outputs.containerservice.PlacementPolicyResponse; } /** * ClusterSelector */ interface ClusterSelectorResponse { /** * ClusterSelectorTerms is a list of cluster selector terms. The terms are `ORed`. */ clusterSelectorTerms: outputs.containerservice.ClusterSelectorTermResponse[]; } /** * ClusterSelectorTerm */ interface ClusterSelectorTermResponse { /** * LabelSelector is a label query over all the joined member clusters. Clusters matching the query are selected. If you specify both label and property selectors in the same term, the results are AND'd. */ labelSelector?: outputs.containerservice.LabelSelectorResponse; /** * PropertySelector is a property query over all joined member clusters. Clusters matching the query are selected. If you specify both label and property selectors in the same term, the results are AND'd. At this moment, PropertySelector can only be used with `RequiredDuringSchedulingIgnoredDuringExecution` affinity terms. This field is beta-level; it is for the property-based scheduling feature and is only functional when a property provider is enabled in the deployment. */ propertySelector?: outputs.containerservice.PropertySelectorResponse; } /** * Settings for upgrading a cluster. */ interface ClusterUpgradeSettingsResponse { /** * Settings for overrides. */ overrideSettings?: outputs.containerservice.UpgradeOverrideSettingsResponse; } /** * Profile for Linux VMs in the container service cluster. */ interface ContainerServiceLinuxProfileResponse { /** * The administrator username to use for Linux VMs. */ adminUsername: string; /** * The SSH configuration for Linux-based VMs running on Azure. */ ssh: outputs.containerservice.ContainerServiceSshConfigurationResponse; } /** * Profile of network configuration. */ interface ContainerServiceNetworkProfileResponse { /** * Advanced Networking profile for enabling observability and security feature suite on a cluster. For more information see aka.ms/aksadvancednetworking. */ advancedNetworking?: outputs.containerservice.AdvancedNetworkingResponse; /** * An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. */ dnsServiceIP?: string; /** * The IP families used to specify IP versions available to the cluster. IP families are used to determine single-stack or dual-stack clusters. For single-stack, the expected value is IPv4. For dual-stack, the expected values are IPv4 and IPv6. */ ipFamilies?: string[]; /** * Profile of the cluster load balancer. */ loadBalancerProfile?: outputs.containerservice.ManagedClusterLoadBalancerProfileResponse; /** * The load balancer sku for the managed cluster. The default is 'standard'. See [Azure Load Balancer SKUs](https://docs.microsoft.com/azure/load-balancer/skus) for more information about the differences between load balancer SKUs. */ loadBalancerSku?: string; /** * Profile of the cluster NAT gateway. */ natGatewayProfile?: outputs.containerservice.ManagedClusterNATGatewayProfileResponse; /** * Network dataplane used in the Kubernetes cluster. */ networkDataplane?: string; /** * The network mode Azure CNI is configured with. This cannot be specified if networkPlugin is anything other than 'azure'. */ networkMode?: string; /** * Network plugin used for building the Kubernetes network. */ networkPlugin?: string; /** * The mode the network plugin should use. */ networkPluginMode?: string; /** * Network policy used for building the Kubernetes network. */ networkPolicy?: string; /** * The outbound (egress) routing method. This can only be set at cluster creation time and cannot be changed later. For more information see [egress outbound type](https://docs.microsoft.com/azure/aks/egress-outboundtype). */ outboundType?: string; /** * A CIDR notation IP range from which to assign pod IPs when kubenet is used. */ podCidr?: string; /** * The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. */ podCidrs?: string[]; /** * A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. */ serviceCidr?: string; /** * The CIDR notation IP ranges from which to assign service cluster IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. They must not overlap with any Subnet IP ranges. */ serviceCidrs?: string[]; /** * The profile for Static Egress Gateway addon. For more details about Static Egress Gateway, see https://aka.ms/aks/static-egress-gateway. */ staticEgressGatewayProfile?: outputs.containerservice.ManagedClusterStaticEgressGatewayProfileResponse; } /** * containerServiceNetworkProfileResponseProvideDefaults sets the appropriate defaults for ContainerServiceNetworkProfileResponse */ function containerServiceNetworkProfileResponseProvideDefaults(val: ContainerServiceNetworkProfileResponse): ContainerServiceNetworkProfileResponse; /** * SSH configuration for Linux-based VMs running on Azure. */ interface ContainerServiceSshConfigurationResponse { /** * The list of SSH public keys used to authenticate with Linux-based VMs. A maximum of 1 key may be specified. */ publicKeys: outputs.containerservice.ContainerServiceSshPublicKeyResponse[]; } /** * Contains information about SSH certificate public key data. */ interface ContainerServiceSshPublicKeyResponse { /** * Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers. */ keyData: string; } /** * Data used when creating a target resource from a source resource. */ interface CreationDataResponse { /** * This is the ARM ID of the source object to be used to create the target object. */ sourceResourceId?: string; } /** * The credential result response. */ interface CredentialResultResponse { /** * The name of the credential. */ name: string; /** * Base64-encoded Kubernetes configuration file. */ value: string; } /** * For schedules like: 'recur every day' or 'recur every 3 days'. */ interface DailyScheduleResponse { /** * Specifies the number of days between each set of occurrences. */ intervalDays: number; } /** * A date range. For example, between '2022-12-23' and '2023-01-05'. */ interface DateSpanResponse { /** * The end date of the date span. */ end: string; /** * The start date of the date span. */ start: string; } /** * Delegated resource properties - internal use only. */ interface DelegatedResourceResponse { /** * The source resource location - internal use only. */ location?: string; /** * The delegation id of the referral delegation (optional) - internal use only. */ referralResource?: string; /** * The ARM resource id of the delegated resource - internal use only. */ resourceId?: string; /** * The tenant id of the delegated resource - internal use only. */ tenantId?: string; } /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.containerservice.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.containerservice.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * The complex type of the extended location. */ interface ExtendedLocationResponse { /** * The name of the extended location. */ name?: string; /** * The type of the extended location. */ type?: string; } /** * One credential result item. */ interface FleetCredentialResultResponse { /** * The name of the credential. */ name: string; /** * Base64-encoded Kubernetes configuration file. */ value: string; } /** * The FleetHubProfile configures the fleet hub. */ interface FleetHubProfileResponse { /** * The agent profile for the Fleet hub. */ agentProfile?: outputs.containerservice.AgentProfileResponse; /** * The access profile for the Fleet hub API server. */ apiServerAccessProfile?: outputs.containerservice.APIServerAccessProfileResponse; /** * DNS prefix used to create the FQDN for the Fleet hub. */ dnsPrefix?: string; /** * The FQDN of the Fleet hub. */ fqdn: string; /** * The Kubernetes version of the Fleet hub. */ kubernetesVersion: string; /** * The Azure Portal FQDN of the Fleet hub. */ portalFqdn: string; } /** * The properties of a fleet managed namespace. */ interface FleetManagedNamespacePropertiesResponse { /** * Action if the managed namespace with the same name already exists. Default is Never. */ adoptionPolicy: string; /** * Delete options of a fleet managed namespace. Default is Keep. */ deletePolicy: string; /** * The namespace properties for the fleet managed namespace. */ managedNamespaceProperties?: outputs.containerservice.ManagedNamespacePropertiesResponse; /** * The Azure Portal FQDN of the Fleet hub. */ portalFqdn: string; /** * The profile of the propagation to create the namespace. */ propagationPolicy?: outputs.containerservice.PropagationPolicyResponse; /** * The status of the last operation. */ provisioningState: string; /** * Status information of the last operation for fleet managed namespace. */ status: outputs.containerservice.FleetManagedNamespaceStatusResponse; } /** * Status information for the fleet managed namespace. */ interface FleetManagedNamespaceStatusResponse { /** * The last operation error of the fleet managed namespace */ lastOperationError: outputs.containerservice.ErrorDetailResponse; /** * The last operation ID for the fleet managed namespace */ lastOperationId: string; } /** * GPU settings for the Agent Pool. */ interface GPUProfileResponse { /** * Whether to install GPU drivers. When it's not specified, default is Install. */ driver?: string; } /** * Contains the IPTag associated with the object. */ interface IPTagResponse { /** * The IP tag type. Example: RoutingPreference. */ ipTagType?: string; /** * The value of the IP tag associated with the public IP. Example: Internet. */ tag?: string; } /** * Managed identity profile for the identity binding. */ interface IdentityBindingManagedIdentityProfileResponse { /** * The client ID of the managed identity. */ clientId: string; /** * The object ID of the managed identity. */ objectId: string; /** * The resource ID of the managed identity. */ resourceId: string; /** * The tenant ID of the managed identity. */ tenantId: string; } /** * IdentityBinding OIDC issuer profile. */ interface IdentityBindingOidcIssuerProfileResponse { /** * The OIDC issuer URL of the IdentityBinding. */ oidcIssuerUrl: string; } /** * IdentityBinding properties. */ interface IdentityBindingPropertiesResponse { /** * Managed identity profile for the identity binding. */ managedIdentity: outputs.containerservice.IdentityBindingManagedIdentityProfileResponse; /** * The OIDC issuer URL of the IdentityBinding. */ oidcIssuer: outputs.containerservice.IdentityBindingOidcIssuerProfileResponse; /** * The status of the last operation. */ provisioningState: string; } /** * Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca */ interface IstioCertificateAuthorityResponse { /** * Plugin certificates information for Service Mesh. */ plugin?: outputs.containerservice.IstioPluginCertificateAuthorityResponse; } /** * Istio components configuration. */ interface IstioComponentsResponse { /** * Istio egress gateways. */ egressGateways?: outputs.containerservice.IstioEgressGatewayResponse[]; /** * Istio ingress gateways. */ ingressGateways?: outputs.containerservice.IstioIngressGatewayResponse[]; } /** * Istio egress gateway configuration. */ interface IstioEgressGatewayResponse { /** * Whether to enable the egress gateway. */ enabled: boolean; /** * Name of the gateway configuration custom resource for the Istio add-on egress gateway. Must be specified when enabling the Istio egress gateway. Must be deployed in the same namespace that the Istio egress gateway will be deployed in. */ gatewayConfigurationName?: string; /** * Name of the Istio add-on egress gateway. */ name: string; /** * Namespace that the Istio add-on egress gateway should be deployed in. If unspecified, the default is aks-istio-egress. */ namespace?: string; } /** * Istio ingress gateway configuration. For now, we support up to one external ingress gateway named `aks-istio-ingressgateway-external` and one internal ingress gateway named `aks-istio-ingressgateway-internal`. */ interface IstioIngressGatewayResponse { /** * Whether to enable the ingress gateway. */ enabled: boolean; /** * Mode of an ingress gateway. */ mode: string; } /** * Plugin certificates information for Service Mesh. */ interface IstioPluginCertificateAuthorityResponse { /** * Certificate chain object name in Azure Key Vault. */ certChainObjectName?: string; /** * Intermediate certificate object name in Azure Key Vault. */ certObjectName?: string; /** * Intermediate certificate private key object name in Azure Key Vault. */ keyObjectName?: string; /** * The resource ID of the Key Vault. */ keyVaultId?: string; /** * Root certificate object name in Azure Key Vault. */ rootCertObjectName?: string; } /** * Istio service mesh configuration. */ interface IstioServiceMeshResponse { /** * Istio Service Mesh Certificate Authority (CA) configuration. For now, we only support plugin certificates as described here https://aka.ms/asm-plugin-ca */ certificateAuthority?: outputs.containerservice.IstioCertificateAuthorityResponse; /** * Istio components configuration. */ components?: outputs.containerservice.IstioComponentsResponse; /** * The list of revisions of the Istio control plane. When an upgrade is not in progress, this holds one value. When canary upgrade is in progress, this can only hold two consecutive values. For more information, see: https://learn.microsoft.com/en-us/azure/aks/istio-upgrade */ revisions?: string[]; } /** * The claim mapping expression for JWTAuthenticator. */ interface JWTAuthenticatorClaimMappingExpressionResponse { /** * The CEL expression used to access token claims. */ expression: string; } /** * The claim mappings for JWTAuthenticator. */ interface JWTAuthenticatorClaimMappingsResponse { /** * The expression to extract extra attribute from the token claims. When not provided, no extra attributes are extracted from the token claims. */ extra?: outputs.containerservice.JWTAuthenticatorExtraClaimMappingExpressionResponse[]; /** * The expression to extract groups attribute from the token claims. When not provided, no groups are extracted from the token claims. */ groups?: outputs.containerservice.JWTAuthenticatorClaimMappingExpressionResponse; /** * The expression to extract uid attribute from the token claims. When not provided, no uid is extracted from the token claims. */ uid?: outputs.containerservice.JWTAuthenticatorClaimMappingExpressionResponse; /** * The expression to extract username attribute from the token claims. */ username: outputs.containerservice.JWTAuthenticatorClaimMappingExpressionResponse; } /** * The extra claim mapping expression for JWTAuthenticator. */ interface JWTAuthenticatorExtraClaimMappingExpressionResponse { /** * The key of the extra attribute. */ key: string; /** * The CEL expression used to extract the value of the extra attribute. */ valueExpression: string; } /** * The OIDC issuer details for JWTAuthenticator. */ interface JWTAuthenticatorIssuerResponse { /** * The set of acceptable audiences the JWT must be issued to. At least one is required. When multiple is set, AudienceMatchPolicy is used in API Server configuration. */ audiences: string[]; /** * The issuer URL. The URL must begin with the scheme https and cannot contain a query string or fragment. This must match the "iss" claim in the presented JWT, and the issuer returned from discovery. */ url: string; } /** * The properties of JWTAuthenticator. For details on how to configure the properties of a JWT authenticator, please refer to the Kubernetes documentation: https://kubernetes.io/docs/reference/access-authn-authz/authentication/#using-authentication-configuration. Please note that not all fields available in the Kubernetes documentation are supported by AKS. For troubleshooting, please see https://aka.ms/aks-external-issuers-docs. */ interface JWTAuthenticatorPropertiesResponse { /** * The mappings that define how user attributes are extracted from the token claims. */ claimMappings: outputs.containerservice.JWTAuthenticatorClaimMappingsResponse; /** * The rules that are applied to validate token claims to authenticate users. All the expressions must evaluate to true for validation to succeed. */ claimValidationRules?: outputs.containerservice.JWTAuthenticatorValidationRuleResponse[]; /** * The JWT OIDC issuer details. */ issuer: outputs.containerservice.JWTAuthenticatorIssuerResponse; /** * The current provisioning state of the JWT authenticator. */ provisioningState: string; /** * The rules that are applied to the mapped user before completing authentication. All the expressions must evaluate to true for validation to succeed. */ userValidationRules?: outputs.containerservice.JWTAuthenticatorValidationRuleResponse[]; } /** * The validation rule for JWTAuthenticator. */ interface JWTAuthenticatorValidationRuleResponse { /** * The CEL expression used to validate the claim or attribute. */ expression: string; /** * The validation error message. */ message?: string; } /** * Kubelet configurations of agent nodes. See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. */ interface KubeletConfigResponse { /** * Allowed list of unsafe sysctls or unsafe sysctl patterns (ending in `*`). */ allowedUnsafeSysctls?: string[]; /** * The maximum number of container log files that can be present for a container. The number must be ≥ 2. */ containerLogMaxFiles?: number; /** * The maximum size (e.g. 10Mi) of container log file before it is rotated. */ containerLogMaxSizeMB?: number; /** * If CPU CFS quota enforcement is enabled for containers that specify CPU limits. The default is true. */ cpuCfsQuota?: boolean; /** * The CPU CFS quota period value. The default is '100ms.' Valid values are a sequence of decimal numbers with an optional fraction and a unit suffix. For example: '300ms', '2h45m'. Supported units are 'ns', 'us', 'ms', 's', 'm', and 'h'. */ cpuCfsQuotaPeriod?: string; /** * The CPU Manager policy to use. The default is 'none'. See [Kubernetes CPU management policies](https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/#cpu-management-policies) for more information. Allowed values are 'none' and 'static'. */ cpuManagerPolicy?: string; /** * If set to true it will make the Kubelet fail to start if swap is enabled on the node. */ failSwapOn?: boolean; /** * The percent of disk usage after which image garbage collection is always run. To disable image garbage collection, set to 100. The default is 85% */ imageGcHighThreshold?: number; /** * The percent of disk usage before which image garbage collection is never run. This cannot be set higher than imageGcHighThreshold. The default is 80% */ imageGcLowThreshold?: number; /** * The maximum number of processes per pod. */ podMaxPids?: number; /** * The Topology Manager policy to use. For more information see [Kubernetes Topology Manager](https://kubernetes.io/docs/tasks/administer-cluster/topology-manager). The default is 'none'. Allowed values are 'none', 'best-effort', 'restricted', and 'single-numa-node'. */ topologyManagerPolicy?: string; } /** * A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface LabelSelectorLoadBalancerResponse { /** * matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: outputs.containerservice.LabelSelectorRequirementLoadBalancerResponse[]; /** * matchLabels is an array of {key=value} pairs. A single {key=value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is `key`, the operator is `In`, and the values array contains only `value`. The requirements are ANDed. */ matchLabels?: string[]; } /** * A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface LabelSelectorRequirementLoadBalancerResponse { /** * key is the label key that the selector applies to. */ key?: string; /** * operator represents a key's relationship to a set of values. Valid operators are In and NotIn */ operator?: string; /** * values is an array of string values, the values array must be non-empty. */ values?: string[]; } /** * A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. */ interface LabelSelectorRequirementResponse { /** * key is the label key that the selector applies to. */ key: string; /** * operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** * values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. */ interface LabelSelectorResponse { /** * matchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: outputs.containerservice.LabelSelectorRequirementResponse[]; /** * matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: { [key: string]: string; }; } /** * OS configurations of Linux agent nodes. See [AKS custom node configuration](https://docs.microsoft.com/azure/aks/custom-node-configuration) for more details. */ interface LinuxOSConfigResponse { /** * The size in MB of a swap file that will be created on each node. */ swapFileSizeMB?: number; /** * Sysctl settings for Linux agent nodes. */ sysctls?: outputs.containerservice.SysctlConfigResponse; /** * Whether the kernel should make aggressive use of memory compaction to make more hugepages available. Valid values are 'always', 'defer', 'defer+madvise', 'madvise' and 'never'. The default is 'madvise'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). */ transparentHugePageDefrag?: string; /** * Whether transparent hugepages are enabled. Valid values are 'always', 'madvise', and 'never'. The default is 'always'. For more information see [Transparent Hugepages](https://www.kernel.org/doc/html/latest/admin-guide/mm/transhuge.html#admin-guide-transhuge). */ transparentHugePageEnabled?: string; } /** * Overrides for localDNS profile. */ interface LocalDNSOverrideResponse { /** * Cache max TTL in seconds. See [cache plugin](https://coredns.io/plugins/cache) for more information. */ cacheDurationInSeconds?: number; /** * Destination server for DNS queries to be forwarded from localDNS. */ forwardDestination?: string; /** * Forward policy for selecting upstream DNS server. See [forward plugin](https://coredns.io/plugins/forward) for more information. */ forwardPolicy?: string; /** * Maximum number of concurrent queries. See [forward plugin](https://coredns.io/plugins/forward) for more information. */ maxConcurrent?: number; /** * Enforce TCP or prefer UDP protocol for connections from localDNS to upstream DNS server. */ protocol?: string; /** * Log level for DNS queries in localDNS. */ queryLogging?: string; /** * Policy for serving stale data. See [cache plugin](https://coredns.io/plugins/cache) for more information. */ serveStale?: string; /** * Serve stale duration in seconds. See [cache plugin](https://coredns.io/plugins/cache) for more information. */ serveStaleDurationInSeconds?: number; } /** * localDNSOverrideResponseProvideDefaults sets the appropriate defaults for LocalDNSOverrideResponse */ function localDNSOverrideResponseProvideDefaults(val: LocalDNSOverrideResponse): LocalDNSOverrideResponse; /** * Configures the per-node local DNS, with VnetDNS and KubeDNS overrides. LocalDNS helps improve performance and reliability of DNS resolution in an AKS cluster. For more details see aka.ms/aks/localdns. */ interface LocalDNSProfileResponse { /** * KubeDNS overrides apply to DNS traffic from pods with dnsPolicy:ClusterFirst (referred to as KubeDNS traffic). */ kubeDNSOverrides?: { [key: string]: outputs.containerservice.LocalDNSOverrideResponse; }; /** * Mode of enablement for localDNS. */ mode?: string; /** * System-generated state of localDNS. */ state: string; /** * VnetDNS overrides apply to DNS traffic from pods with dnsPolicy:default or kubelet (referred to as VnetDNS traffic). */ vnetDNSOverrides?: { [key: string]: outputs.containerservice.LocalDNSOverrideResponse; }; } /** * localDNSProfileResponseProvideDefaults sets the appropriate defaults for LocalDNSProfileResponse */ function localDNSProfileResponseProvideDefaults(val: LocalDNSProfileResponse): LocalDNSProfileResponse; /** * Maintenance window used to configure scheduled auto-upgrade for a Managed Cluster. */ interface MaintenanceWindowResponse { /** * Length of maintenance window range from 4 to 24 hours. */ durationHours: number; /** * Date ranges on which upgrade is not allowed. 'utcOffset' applies to this field. For example, with 'utcOffset: +02:00' and 'dateSpan' being '2022-12-23' to '2023-01-03', maintenance will be blocked from '2022-12-22 22:00' to '2023-01-03 22:00' in UTC time. */ notAllowedDates?: outputs.containerservice.DateSpanResponse[]; /** * Recurrence schedule for the maintenance window. */ schedule: outputs.containerservice.ScheduleResponse; /** * The date the maintenance window activates. If the current date is before this date, the maintenance window is inactive and will not be used for upgrades. If not specified, the maintenance window will be active right away. */ startDate?: string; /** * The start time of the maintenance window. Accepted values are from '00:00' to '23:59'. 'utcOffset' applies to this field. For example: '02:00' with 'utcOffset: +02:00' means UTC time '00:00'. */ startTime: string; /** * The UTC offset in format +/-HH:mm. For example, '+05:30' for IST and '-07:00' for PST. If not specified, the default is '+00:00'. */ utcOffset?: string; } /** * maintenanceWindowResponseProvideDefaults sets the appropriate defaults for MaintenanceWindowResponse */ function maintenanceWindowResponseProvideDefaults(val: MaintenanceWindowResponse): MaintenanceWindowResponse; /** * AADProfile specifies attributes for Azure Active Directory integration. For more details see [managed AAD on AKS](https://docs.microsoft.com/azure/aks/managed-aad). */ interface ManagedClusterAADProfileResponse { /** * The list of AAD group object IDs that will have admin role of the cluster. */ adminGroupObjectIDs?: string[]; /** * (DEPRECATED) The client AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. */ clientAppID?: string; /** * Whether to enable Azure RBAC for Kubernetes authorization. */ enableAzureRBAC?: boolean; /** * Whether to enable managed AAD. */ managed?: boolean; /** * (DEPRECATED) The server AAD application ID. Learn more at https://aka.ms/aks/aad-legacy. */ serverAppID?: string; /** * (DEPRECATED) The server AAD application secret. Learn more at https://aka.ms/aks/aad-legacy. */ serverAppSecret?: string; /** * The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. */ tenantID?: string; } /** * When enabling the operator, a set of AKS managed CRDs and controllers will be installed in the cluster. The operator automates the deployment of OSS models for inference and/or training purposes. It provides a set of preset models and enables distributed inference against them. */ interface ManagedClusterAIToolchainOperatorProfileResponse { /** * Whether to enable AI toolchain operator to the cluster. Indicates if AI toolchain operator enabled or not. */ enabled?: boolean; } /** * Access profile for managed cluster API server. */ interface ManagedClusterAPIServerAccessProfileResponse { /** * The IP ranges authorized to access the Kubernetes API server. IP ranges are specified in CIDR format, e.g. 137.117.106.88/29. This feature is not compatible with clusters that use Public IP Per Node, or clusters that are using a Basic Load Balancer. For more information see [API server authorized IP ranges](https://docs.microsoft.com/azure/aks/api-server-authorized-ip-ranges). */ authorizedIPRanges?: string[]; /** * Whether to disable run command for the cluster or not. */ disableRunCommand?: boolean; /** * Whether to create the cluster as a private cluster or not. For more details, see [Creating a private AKS cluster](https://docs.microsoft.com/azure/aks/private-clusters). */ enablePrivateCluster?: boolean; /** * Whether to create additional public FQDN for private cluster or not. */ enablePrivateClusterPublicFQDN?: boolean; /** * Whether to enable apiserver vnet integration for the cluster or not. See aka.ms/AksVnetIntegration for more details. */ enableVnetIntegration?: boolean; /** * The private DNS zone mode for the cluster. The default is System. For more details see [configure private DNS zone](https://docs.microsoft.com/azure/aks/private-clusters#configure-private-dns-zone). Allowed values are 'system' and 'none'. */ privateDNSZone?: string; /** * The subnet to be used when apiserver vnet integration is enabled. It is required when creating a new cluster with BYO Vnet, or when updating an existing cluster to enable apiserver vnet integration. */ subnetId?: string; } /** * A Kubernetes add-on profile for a managed cluster. */ interface ManagedClusterAddonProfileResponse { /** * Key-value pairs for configuring an add-on. */ config?: { [key: string]: string; }; /** * Whether the add-on is enabled or not. */ enabled: boolean; /** * Information of user assigned identity used by this add-on. */ identity: outputs.containerservice.ManagedClusterAddonProfileResponseIdentity; } /** * Information of user assigned identity used by this add-on. */ interface ManagedClusterAddonProfileResponseIdentity { /** * The client ID of the user assigned identity. */ clientId?: string; /** * The object ID of the user assigned identity. */ objectId?: string; /** * The resource ID of the user assigned identity. */ resourceId?: string; } /** * Profile for the container service agent pool. */ interface ManagedClusterAgentPoolProfileResponse { /** * The list of Availability zones to use for nodes. This can only be specified if the AgentPoolType property is 'VirtualMachineScaleSets'. */ availabilityZones?: string[]; /** * AKS will associate the specified agent pool with the Capacity Reservation Group. */ capacityReservationGroupID?: string; /** * Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 1000 (inclusive) for user pools and in the range of 1 to 1000 (inclusive) for system pools. The default value is 1. */ count?: number; /** * CreationData to be used to specify the source Snapshot ID if the node pool will be created/upgraded using a snapshot. */ creationData?: outputs.containerservice.CreationDataResponse; /** * The version of Kubernetes the Agent Pool is running. If orchestratorVersion is a fully specified version , this field will be exactly equal to it. If orchestratorVersion is , this field will contain the full version being used. */ currentOrchestratorVersion: string; /** * Unique read-only string used to implement optimistic concurrency. The eTag value will change when the resource is updated. Specify an if-match or if-none-match header with the eTag value for a subsequent request to enable optimistic concurrency per the normal eTag convention. */ eTag: string; /** * Whether to enable auto-scaler */ enableAutoScaling?: boolean; /** * Whether to enable host based OS and data drive encryption. This is only supported on certain VM sizes and in certain Azure regions. For more information, see: https://docs.microsoft.com/azure/aks/enable-host-encryption */ enableEncryptionAtHost?: boolean; /** * Whether to use a FIPS-enabled OS. See [Add a FIPS-enabled node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#add-a-fips-enabled-node-pool-preview) for more details. */ enableFIPS?: boolean; /** * Whether each node is allocated its own public IP. Some scenarios may require nodes in a node pool to receive their own dedicated public IP addresses. A common scenario is for gaming workloads, where a console needs to make a direct connection to a cloud virtual machine to minimize hops. For more information see [assigning a public IP per node](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#assign-a-public-ip-per-node-for-your-node-pools). The default is false. */ enableNodePublicIP?: boolean; /** * Whether to enable UltraSSD */ enableUltraSSD?: boolean; /** * Profile specific to a managed agent pool in Gateway mode. This field cannot be set if agent pool mode is not Gateway. */ gatewayProfile?: outputs.containerservice.AgentPoolGatewayProfileResponse; /** * GPUInstanceProfile to be used to specify GPU MIG instance profile for supported GPU VM SKU. */ gpuInstanceProfile?: string; /** * GPU settings for the Agent Pool. */ gpuProfile?: outputs.containerservice.GPUProfileResponse; /** * The fully qualified resource ID of the Dedicated Host Group to provision virtual machines from, used only in creation scenario and not allowed to changed once set. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}. For more information see [Azure dedicated hosts](https://docs.microsoft.com/azure/virtual-machines/dedicated-hosts). */ hostGroupID?: string; /** * The Kubelet configuration on the agent pool nodes. */ kubeletConfig?: outputs.containerservice.KubeletConfigResponse; /** * Determines the placement of emptyDir volumes, container runtime data root, and Kubelet ephemeral storage. */ kubeletDiskType?: string; /** * The OS configuration of Linux agent nodes. */ linuxOSConfig?: outputs.containerservice.LinuxOSConfigResponse; /** * Configures the per-node local DNS, with VnetDNS and KubeDNS overrides. LocalDNS helps improve performance and reliability of DNS resolution in an AKS cluster. For more details see aka.ms/aks/localdns. */ localDNSProfile?: outputs.containerservice.LocalDNSProfileResponse; /** * The maximum number of nodes for auto-scaling */ maxCount?: number; /** * The maximum number of pods that can run on a node. */ maxPods?: number; /** * Message of the day for Linux nodes, base64-encoded. A base64-encoded string which will be written to /etc/motd after decoding. This allows customization of the message of the day for Linux nodes. It must not be specified for Windows nodes. It must be a static string (i.e., will be printed raw and not be executed as a script). */ messageOfTheDay?: string; /** * The minimum number of nodes for auto-scaling */ minCount?: number; /** * The mode of an agent pool. A cluster must have at least one 'System' Agent Pool at all times. For additional information on agent pool restrictions and best practices, see: https://docs.microsoft.com/azure/aks/use-system-pools */ mode?: string; /** * Unique name of the agent pool profile in the context of the subscription and resource group. Windows agent pool names must be 6 characters or less. */ name: string; /** * Network-related settings of an agent pool. */ networkProfile?: outputs.containerservice.AgentPoolNetworkProfileResponse; /** * The version of node image */ nodeImageVersion: string; /** * The node labels to be persisted across all nodes in agent pool. */ nodeLabels?: { [key: string]: string; }; /** * The public IP prefix ID which VM nodes should use IPs from. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIPPrefixName} */ nodePublicIPPrefixID?: string; /** * The taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule. */ nodeTaints?: string[]; /** * The version of Kubernetes specified by the user. Both patch version (e.g. 1.20.13) and (e.g. 1.20) are supported. When is specified, the latest supported GA patch version is chosen automatically. Updating the cluster with the same once it has been created (e.g. 1.14.x -> 1.14) will not trigger an upgrade, even if a newer patch version is available. As a best practice, you should upgrade all node pools in an AKS cluster to the same Kubernetes version. The node pool version must have the same major version as the control plane. The node pool minor version must be within two minor versions of the control plane version. The node pool version cannot be greater than the control plane version. For more information see [upgrading a node pool](https://docs.microsoft.com/azure/aks/use-multiple-node-pools#upgrade-a-node-pool). */ orchestratorVersion?: string; /** * OS Disk Size in GB to be used to specify the disk size for every machine in the master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified. */ osDiskSizeGB?: number; /** * The OS disk type to be used for machines in the agent pool. The default is 'Ephemeral' if the VM supports it and has a cache disk larger than the requested OSDiskSizeGB. Otherwise, defaults to 'Managed'. May not be changed after creation. For more information see [Ephemeral OS](https://docs.microsoft.com/azure/aks/cluster-configuration#ephemeral-os). */ osDiskType?: string; /** * Specifies the OS SKU used by the agent pool. The default is Ubuntu if OSType is Linux. The default is Windows2019 when Kubernetes <= 1.24 or Windows2022 when Kubernetes >= 1.25 if OSType is Windows. */ osSKU?: string; /** * The operating system type. The default is Linux. */ osType?: string; /** * Pod IP Allocation Mode. The IP allocation mode for pods in the agent pool. Must be used with podSubnetId. The default is 'DynamicIndividual'. */ podIPAllocationMode?: string; /** * The ID of the subnet which pods will join when launched. If omitted, pod IPs are statically assigned on the node subnet (see vnetSubnetID for more details). This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} */ podSubnetID?: string; /** * Whether the Agent Pool is running or stopped. When an Agent Pool is first created it is initially Running. The Agent Pool can be stopped by setting this field to Stopped. A stopped Agent Pool stops all of its VMs and does not accrue billing charges. An Agent Pool can only be stopped if it is Running and provisioning state is Succeeded */ powerState?: outputs.containerservice.PowerStateResponse; /** * The current deployment or provisioning state. */ provisioningState: string; /** * The ID for Proximity Placement Group. */ proximityPlacementGroupID?: string; /** * The scale down mode to use when scaling the Agent Pool. This also effects the cluster autoscaler behavior. If not specified, it defaults to Delete. */ scaleDownMode?: string; /** * The Virtual Machine Scale Set eviction policy to use. This cannot be specified unless the scaleSetPriority is 'Spot'. If not specified, the default is 'Delete'. */ scaleSetEvictionPolicy?: string; /** * The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. */ scaleSetPriority?: string; /** * The security settings of an agent pool. */ securityProfile?: outputs.containerservice.AgentPoolSecurityProfileResponse; /** * The max price (in US Dollars) you are willing to pay for spot instances. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand. Possible values are any decimal value greater than zero or -1 which indicates the willingness to pay any on-demand price. For more details on spot pricing, see [spot VMs pricing](https://docs.microsoft.com/azure/virtual-machines/spot-vms#pricing) */ spotMaxPrice?: number; /** * Contains read-only information about the Agent Pool. */ status?: outputs.containerservice.AgentPoolStatusResponse; /** * The tags to be persisted on the agent pool virtual machine scale set. */ tags?: { [key: string]: string; }; /** * The type of Agent Pool. */ type?: string; /** * Settings for upgrading the agentpool */ upgradeSettings?: outputs.containerservice.AgentPoolUpgradeSettingsResponse; /** * The status of nodes in a VirtualMachines agent pool. */ virtualMachineNodesStatus?: outputs.containerservice.VirtualMachineNodesResponse[]; /** * Specifications on VirtualMachines agent pool. */ virtualMachinesProfile?: outputs.containerservice.VirtualMachinesProfileResponse; /** * The size of the agent pool VMs. VM size availability varies by region. If a node contains insufficient compute resources (memory, cpu, etc) pods might fail to run correctly. For more details on restricted VM sizes, see: https://docs.microsoft.com/azure/aks/quotas-skus-regions */ vmSize?: string; /** * The ID of the subnet which agent pool nodes and optionally pods will join on startup. If this is not specified, a VNET and subnet will be generated and used. If no podSubnetID is specified, this applies to nodes and pods, otherwise it applies to just nodes. This is of the form: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName} */ vnetSubnetID?: string; /** * The Windows agent pool's specific profile. */ windowsProfile?: outputs.containerservice.AgentPoolWindowsProfileResponse; /** * Determines the type of workload a node can run. */ workloadRuntime?: string; } /** * managedClusterAgentPoolProfileResponseProvideDefaults sets the appropriate defaults for ManagedClusterAgentPoolProfileResponse */ function managedClusterAgentPoolProfileResponseProvideDefaults(val: ManagedClusterAgentPoolProfileResponse): ManagedClusterAgentPoolProfileResponse; /** * Auto upgrade profile for a managed cluster. */ interface ManagedClusterAutoUpgradeProfileResponse { /** * Node OS Upgrade Channel. Manner in which the OS on your nodes is updated. The default is NodeImage. */ nodeOSUpgradeChannel?: string; /** * The upgrade channel for auto upgrade. The default is 'none'. For more information see [setting the AKS cluster auto-upgrade channel](https://docs.microsoft.com/azure/aks/upgrade-cluster#set-auto-upgrade-channel). */ upgradeChannel?: string; } /** * Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details. */ interface ManagedClusterAzureMonitorProfileKubeStateMetricsResponse { /** * Comma-separated list of Kubernetes annotation keys that will be used in the resource's labels metric (Example: 'namespaces=[kubernetes.io/team,...],pods=[kubernetes.io/team],...'). By default the metric contains only resource name and namespace labels. */ metricAnnotationsAllowList?: string; /** * Comma-separated list of additional Kubernetes label keys that will be used in the resource's labels metric (Example: 'namespaces=[k8s-label-1,k8s-label-n,...],pods=[app],...'). By default the metric contains only resource name and namespace labels. */ metricLabelsAllowlist?: string; } /** * Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview. */ interface ManagedClusterAzureMonitorProfileMetricsResponse { /** * Whether to enable or disable the Azure Managed Prometheus addon for Prometheus monitoring. See aka.ms/AzureManagedPrometheus-aks-enable for details on enabling and disabling. */ enabled: boolean; /** * Kube State Metrics profile for the Azure Managed Prometheus addon. These optional settings are for the kube-state-metrics pod that is deployed with the addon. See aka.ms/AzureManagedPrometheus-optional-parameters for details. */ kubeStateMetrics?: outputs.containerservice.ManagedClusterAzureMonitorProfileKubeStateMetricsResponse; } /** * Azure Monitor addon profiles for monitoring the managed cluster. */ interface ManagedClusterAzureMonitorProfileResponse { /** * Metrics profile for the Azure Monitor managed service for Prometheus addon. Collect out-of-the-box Kubernetes infrastructure metrics to send to an Azure Monitor Workspace and configure additional scraping for custom targets. See aka.ms/AzureManagedPrometheus for an overview. */ metrics?: outputs.containerservice.ManagedClusterAzureMonitorProfileMetricsResponse; } /** * The bootstrap profile. */ interface ManagedClusterBootstrapProfileResponse { /** * The artifact source. The source where the artifacts are downloaded from. */ artifactSource?: string; /** * The resource Id of Azure Container Registry. The registry must have private network access, premium SKU and zone redundancy. */ containerRegistryId?: string; } /** * managedClusterBootstrapProfileResponseProvideDefaults sets the appropriate defaults for ManagedClusterBootstrapProfileResponse */ function managedClusterBootstrapProfileResponseProvideDefaults(val: ManagedClusterBootstrapProfileResponse): ManagedClusterBootstrapProfileResponse; /** * The cost analysis configuration for the cluster */ interface ManagedClusterCostAnalysisResponse { /** * Whether to enable cost analysis. The Managed Cluster sku.tier must be set to 'Standard' or 'Premium' to enable this feature. Enabling this will add Kubernetes Namespace and Deployment details to the Cost Analysis views in the Azure portal. If not specified, the default is false. For more information see aka.ms/aks/docs/cost-analysis. */ enabled?: boolean; } /** * Cluster HTTP proxy configuration. */ interface ManagedClusterHTTPProxyConfigResponse { /** * The HTTP proxy server endpoint to use. */ httpProxy?: string; /** * The HTTPS proxy server endpoint to use. */ httpsProxy?: string; /** * The endpoints that should not go through proxy. */ noProxy?: string[]; /** * Alternative CA cert to use for connecting to proxy servers. */ trustedCa?: string; } /** * Identity for the managed cluster. */ interface ManagedClusterIdentityResponse { /** * The delegated identity resources assigned to this managed cluster. This can only be set by another Azure Resource Provider, and managed cluster only accept one delegated identity resource. Internal use only. */ delegatedResources?: { [key: string]: outputs.containerservice.DelegatedResourceResponse; }; /** * The principal id of the system assigned identity which is used by master components. */ principalId: string; /** * The tenant id of the system assigned identity which is used by master components. */ tenantId: string; /** * The type of identity used for the managed cluster. For more information see [use managed identities in AKS](https://docs.microsoft.com/azure/aks/use-managed-identity). */ type?: string; /** * The user identity associated with the managed cluster. This identity will be used in control plane. Only one user assigned identity is allowed. The keys must be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.containerservice.ManagedClusterIdentityResponseUserAssignedIdentities; }; } interface ManagedClusterIdentityResponseUserAssignedIdentities { /** * The client id of user assigned identity. */ clientId: string; /** * The principal id of user assigned identity. */ principalId: string; } interface ManagedClusterIngressProfileNginxResponse { /** * Ingress type for the default NginxIngressController custom resource */ defaultIngressControllerType?: string; } /** * Ingress profile for the container service cluster. */ interface ManagedClusterIngressProfileResponse { /** * App Routing settings for the ingress profile. You can find an overview and onboarding guide for this feature at https://learn.microsoft.com/en-us/azure/aks/app-routing?tabs=default%2Cdeploy-app-default. */ webAppRouting?: outputs.containerservice.ManagedClusterIngressProfileWebAppRoutingResponse; } /** * Application Routing add-on settings for the ingress profile. */ interface ManagedClusterIngressProfileWebAppRoutingResponse { /** * Resource IDs of the DNS zones to be associated with the Application Routing add-on. Used only when Application Routing add-on is enabled. Public and private DNS zones can be in different resource groups, but all public DNS zones must be in the same resource group and all private DNS zones must be in the same resource group. */ dnsZoneResourceIds?: string[]; /** * Whether to enable the Application Routing add-on. */ enabled?: boolean; /** * Managed identity of the Application Routing add-on. This is the identity that should be granted permissions, for example, to manage the associated Azure DNS resource and get certificates from Azure Key Vault. See [this overview of the add-on](https://learn.microsoft.com/en-us/azure/aks/web-app-routing?tabs=with-osm) for more instructions. */ identity: outputs.containerservice.UserAssignedIdentityManagedClusterResponse; /** * Configuration for the default NginxIngressController. See more at https://learn.microsoft.com/en-us/azure/aks/app-routing-nginx-configuration#the-default-nginx-ingress-controller. */ nginx?: outputs.containerservice.ManagedClusterIngressProfileNginxResponse; } /** * Profile of the managed cluster load balancer. */ interface ManagedClusterLoadBalancerProfileResponse { /** * The desired number of allocated SNAT ports per VM. Allowed values are in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports. */ allocatedOutboundPorts?: number; /** * The type of the managed inbound Load Balancer BackendPool. */ backendPoolType?: string; /** * The effective outbound IP resources of the cluster load balancer. */ effectiveOutboundIPs: outputs.containerservice.ResourceReferenceResponse[]; /** * Enable multiple standard load balancers per AKS cluster or not. */ enableMultipleStandardLoadBalancers?: boolean; /** * Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 30 minutes. */ idleTimeoutInMinutes?: number; /** * Desired managed outbound IPs for the cluster load balancer. */ managedOutboundIPs?: outputs.containerservice.ManagedClusterLoadBalancerProfileResponseManagedOutboundIPs; /** * Desired outbound IP Prefix resources for the cluster load balancer. */ outboundIPPrefixes?: outputs.containerservice.ManagedClusterLoadBalancerProfileResponseOutboundIPPrefixes; /** * Desired outbound IP resources for the cluster load balancer. */ outboundIPs?: outputs.containerservice.ManagedClusterLoadBalancerProfileResponseOutboundIPs; } /** * managedClusterLoadBalancerProfileResponseProvideDefaults sets the appropriate defaults for ManagedClusterLoadBalancerProfileResponse */ function managedClusterLoadBalancerProfileResponseProvideDefaults(val: ManagedClusterLoadBalancerProfileResponse): ManagedClusterLoadBalancerProfileResponse; /** * Desired managed outbound IPs for the cluster load balancer. */ interface ManagedClusterLoadBalancerProfileResponseManagedOutboundIPs { /** * The desired number of IPv4 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. */ count?: number; /** * The desired number of IPv6 outbound IPs created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 0 for single-stack and 1 for dual-stack. */ countIPv6?: number; } /** * managedClusterLoadBalancerProfileResponseManagedOutboundIPsProvideDefaults sets the appropriate defaults for ManagedClusterLoadBalancerProfileResponseManagedOutboundIPs */ function managedClusterLoadBalancerProfileResponseManagedOutboundIPsProvideDefaults(val: ManagedClusterLoadBalancerProfileResponseManagedOutboundIPs): ManagedClusterLoadBalancerProfileResponseManagedOutboundIPs; /** * Desired outbound IP Prefix resources for the cluster load balancer. */ interface ManagedClusterLoadBalancerProfileResponseOutboundIPPrefixes { /** * A list of public IP prefix resources. */ publicIPPrefixes?: outputs.containerservice.ResourceReferenceResponse[]; } /** * Desired outbound IP resources for the cluster load balancer. */ interface ManagedClusterLoadBalancerProfileResponseOutboundIPs { /** * A list of public IP resources. */ publicIPs?: outputs.containerservice.ResourceReferenceResponse[]; } /** * Profile of the managed outbound IP resources of the managed cluster. */ interface ManagedClusterManagedOutboundIPProfileResponse { /** * The desired number of outbound IPs created/managed by Azure. Allowed values must be in the range of 1 to 16 (inclusive). The default value is 1. */ count?: number; } /** * managedClusterManagedOutboundIPProfileResponseProvideDefaults sets the appropriate defaults for ManagedClusterManagedOutboundIPProfileResponse */ function managedClusterManagedOutboundIPProfileResponseProvideDefaults(val: ManagedClusterManagedOutboundIPProfileResponse): ManagedClusterManagedOutboundIPProfileResponse; /** * The metrics profile for the ManagedCluster. */ interface ManagedClusterMetricsProfileResponse { /** * The configuration for detailed per-Kubernetes resource cost analysis. */ costAnalysis?: outputs.containerservice.ManagedClusterCostAnalysisResponse; } /** * Profile of the managed cluster NAT gateway. */ interface ManagedClusterNATGatewayProfileResponse { /** * The effective outbound IP resources of the cluster NAT gateway. */ effectiveOutboundIPs: outputs.containerservice.ResourceReferenceResponse[]; /** * Desired outbound flow idle timeout in minutes. Allowed values are in the range of 4 to 120 (inclusive). The default value is 4 minutes. */ idleTimeoutInMinutes?: number; /** * Profile of the managed outbound IP resources of the cluster NAT gateway. */ managedOutboundIPProfile?: outputs.containerservice.ManagedClusterManagedOutboundIPProfileResponse; } /** * managedClusterNATGatewayProfileResponseProvideDefaults sets the appropriate defaults for ManagedClusterNATGatewayProfileResponse */ function managedClusterNATGatewayProfileResponseProvideDefaults(val: ManagedClusterNATGatewayProfileResponse): ManagedClusterNATGatewayProfileResponse; interface ManagedClusterNodeProvisioningProfileResponse { /** * The set of default Karpenter NodePools (CRDs) configured for node provisioning. This field has no effect unless mode is 'Auto'. Warning: Changing this from Auto to None on an existing cluster will cause the default Karpenter NodePools to be deleted, which will drain and delete the nodes associated with those pools. It is strongly recommended to not do this unless there are idle nodes ready to take the pods evicted by that action. If not specified, the default is Auto. For more information see aka.ms/aks/nap#node-pools. */ defaultNodePools?: string; /** * The node provisioning mode. If not specified, the default is Manual. */ mode?: string; } /** * managedClusterNodeProvisioningProfileResponseProvideDefaults sets the appropriate defaults for ManagedClusterNodeProvisioningProfileResponse */ function managedClusterNodeProvisioningProfileResponseProvideDefaults(val: ManagedClusterNodeProvisioningProfileResponse): ManagedClusterNodeProvisioningProfileResponse; /** * Node resource group lockdown profile for a managed cluster. */ interface ManagedClusterNodeResourceGroupProfileResponse { /** * The restriction level applied to the cluster's node resource group. If not specified, the default is 'Unrestricted' */ restrictionLevel?: string; } /** * The OIDC issuer profile of the Managed Cluster. */ interface ManagedClusterOIDCIssuerProfileResponse { /** * Whether the OIDC issuer is enabled. */ enabled?: boolean; /** * The OIDC issuer url of the Managed Cluster. */ issuerURL: string; } /** * A pod identity exception, which allows pods with certain labels to access the Azure Instance Metadata Service (IMDS) endpoint without being intercepted by the node-managed identity (NMI) server. See [disable AAD Pod Identity for a specific Pod/Application](https://azure.github.io/aad-pod-identity/docs/configure/application_exception/) for more details. */ interface ManagedClusterPodIdentityExceptionResponse { /** * The name of the pod identity exception. */ name: string; /** * The namespace of the pod identity exception. */ namespace: string; /** * The pod labels to match. */ podLabels: { [key: string]: string; }; } /** * The pod identity profile of the Managed Cluster. See [use AAD pod identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity) for more details on pod identity integration. */ interface ManagedClusterPodIdentityProfileResponse { /** * Whether pod identity is allowed to run on clusters with Kubenet networking. Running in Kubenet is disabled by default due to the security related nature of AAD Pod Identity and the risks of IP spoofing. See [using Kubenet network plugin with AAD Pod Identity](https://docs.microsoft.com/azure/aks/use-azure-ad-pod-identity#using-kubenet-network-plugin-with-azure-active-directory-pod-managed-identities) for more information. */ allowNetworkPluginKubenet?: boolean; /** * Whether the pod identity addon is enabled. */ enabled?: boolean; /** * The pod identities to use in the cluster. */ userAssignedIdentities?: outputs.containerservice.ManagedClusterPodIdentityResponse[]; /** * The pod identity exceptions to allow. */ userAssignedIdentityExceptions?: outputs.containerservice.ManagedClusterPodIdentityExceptionResponse[]; } /** * An error response from the pod identity provisioning. */ interface ManagedClusterPodIdentityProvisioningErrorBodyResponse { /** * An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */ code?: string; /** * A list of additional details about the error. */ details?: outputs.containerservice.ManagedClusterPodIdentityProvisioningErrorBodyResponse[]; /** * A message describing the error, intended to be suitable for display in a user interface. */ message?: string; /** * The target of the particular error. For example, the name of the property in error. */ target?: string; } /** * An error response from the pod identity provisioning. */ interface ManagedClusterPodIdentityProvisioningErrorResponse { /** * Details about the error. */ error?: outputs.containerservice.ManagedClusterPodIdentityProvisioningErrorBodyResponse; } /** * Details about the pod identity assigned to the Managed Cluster. */ interface ManagedClusterPodIdentityResponse { /** * The binding selector to use for the AzureIdentityBinding resource. */ bindingSelector?: string; /** * The user assigned identity details. */ identity: outputs.containerservice.UserAssignedIdentityManagedClusterResponse; /** * The name of the pod identity. */ name: string; /** * The namespace of the pod identity. */ namespace: string; provisioningInfo: outputs.containerservice.ManagedClusterPodIdentityResponseProvisioningInfo; /** * The current provisioning state of the pod identity. */ provisioningState: string; } interface ManagedClusterPodIdentityResponseProvisioningInfo { /** * Pod identity assignment error (if any). */ error?: outputs.containerservice.ManagedClusterPodIdentityProvisioningErrorResponse; } /** * managed cluster properties for snapshot, these properties are read only. */ interface ManagedClusterPropertiesForSnapshotResponse { /** * Whether the cluster has enabled Kubernetes Role-Based Access Control or not. */ enableRbac?: boolean; /** * The current kubernetes version. */ kubernetesVersion?: string; /** * The current network profile. */ networkProfile: outputs.containerservice.NetworkProfileForSnapshotResponse; /** * The current managed cluster sku. */ sku?: outputs.containerservice.ManagedClusterSKUResponse; } /** * Parameters to be applied to the cluster-autoscaler when enabled */ interface ManagedClusterPropertiesResponseAutoScalerProfile { /** * Detects similar node pools and balances the number of nodes between them. Valid values are 'true' and 'false' */ balanceSimilarNodeGroups?: string; /** * DaemonSet pods will be gracefully terminated from empty nodes. If set to true, all daemonset pods on empty nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted. */ daemonsetEvictionForEmptyNodes?: boolean; /** * DaemonSet pods will be gracefully terminated from non-empty nodes. If set to true, all daemonset pods on occupied nodes will be evicted before deletion of the node. If the daemonset pod cannot be evicted another node will be chosen for scaling. If set to false, the node will be deleted without ensuring that daemonset pods are deleted or evicted. */ daemonsetEvictionForOccupiedNodes?: boolean; /** * The expander to use when scaling up. If not specified, the default is 'random'. See [expanders](https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.md#what-are-expanders) for more information. */ expander?: string; /** * Should CA ignore DaemonSet pods when calculating resource utilization for scaling down. If set to true, the resources used by daemonset will be taken into account when making scaling down decisions. */ ignoreDaemonsetsUtilization?: boolean; /** * The maximum number of empty nodes that can be deleted at the same time. This must be a positive integer. The default is 10. */ maxEmptyBulkDelete?: string; /** * The maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node. The default is 600. */ maxGracefulTerminationSec?: string; /** * The maximum time the autoscaler waits for a node to be provisioned. The default is '15m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. */ maxNodeProvisionTime?: string; /** * The maximum percentage of unready nodes in the cluster. After this percentage is exceeded, cluster autoscaler halts operations. The default is 45. The maximum is 100 and the minimum is 0. */ maxTotalUnreadyPercentage?: string; /** * Ignore unscheduled pods before they're a certain age. For scenarios like burst/batch scale where you don't want CA to act before the kubernetes scheduler could schedule all the pods, you can tell CA to ignore unscheduled pods before they're a certain age. The default is '0s'. Values must be an integer followed by a unit ('s' for seconds, 'm' for minutes, 'h' for hours, etc). */ newPodScaleUpDelay?: string; /** * The number of allowed unready nodes, irrespective of max-total-unready-percentage. This must be an integer. The default is 3. */ okTotalUnreadyCount?: string; /** * How long after scale up that scale down evaluation resumes. The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. */ scaleDownDelayAfterAdd?: string; /** * How long after node deletion that scale down evaluation resumes. The default is the scan-interval. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. */ scaleDownDelayAfterDelete?: string; /** * How long after scale down failure that scale down evaluation resumes. The default is '3m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. */ scaleDownDelayAfterFailure?: string; /** * How long a node should be unneeded before it is eligible for scale down. The default is '10m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. */ scaleDownUnneededTime?: string; /** * How long an unready node should be unneeded before it is eligible for scale down. The default is '20m'. Values must be an integer followed by an 'm'. No unit of time other than minutes (m) is supported. */ scaleDownUnreadyTime?: string; /** * Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down. The default is '0.5'. */ scaleDownUtilizationThreshold?: string; /** * How often cluster is reevaluated for scale up or down. The default is '10'. Values must be an integer number of seconds. */ scanInterval?: string; /** * If cluster autoscaler will skip deleting nodes with pods with local storage, for example, EmptyDir or HostPath. The default is true. */ skipNodesWithLocalStorage?: string; /** * If cluster autoscaler will skip deleting nodes with pods from kube-system (except for DaemonSet or mirror pods). The default is true. */ skipNodesWithSystemPods?: string; } /** * The SKU of a Managed Cluster. */ interface ManagedClusterSKUResponse { /** * The name of a managed cluster SKU. */ name?: string; /** * If not specified, the default is 'Free'. See [AKS Pricing Tier](https://learn.microsoft.com/azure/aks/free-standard-pricing-tiers) for more details. */ tier?: string; } /** * Microsoft Defender settings for the security profile. */ interface ManagedClusterSecurityProfileDefenderResponse { /** * Resource ID of the Log Analytics workspace to be associated with Microsoft Defender. When Microsoft Defender is enabled, this field is required and must be a valid workspace resource ID. When Microsoft Defender is disabled, leave the field empty. */ logAnalyticsWorkspaceResourceId?: string; /** * Microsoft Defender threat detection for Cloud settings for the security profile. */ securityMonitoring?: outputs.containerservice.ManagedClusterSecurityProfileDefenderSecurityMonitoringResponse; } /** * Microsoft Defender settings for the security profile threat detection. */ interface ManagedClusterSecurityProfileDefenderSecurityMonitoringResponse { /** * Whether to enable Defender threat detection */ enabled?: boolean; } /** * Image Cleaner removes unused images from nodes, freeing up disk space and helping to reduce attack surface area. Here are settings for the security profile. */ interface ManagedClusterSecurityProfileImageCleanerResponse { /** * Whether to enable Image Cleaner on AKS cluster. */ enabled?: boolean; /** * Image Cleaner scanning interval in hours. */ intervalHours?: number; } /** * Security profile for the container service cluster. */ interface ManagedClusterSecurityProfileResponse { /** * Azure Key Vault [key management service](https://kubernetes.io/docs/tasks/administer-cluster/kms-provider/) settings for the security profile. */ azureKeyVaultKms?: outputs.containerservice.AzureKeyVaultKmsResponse; /** * A list of up to 10 base64 encoded CAs that will be added to the trust store on all nodes in the cluster. For more information see [Custom CA Trust Certificates](https://learn.microsoft.com/en-us/azure/aks/custom-certificate-authority). */ customCATrustCertificates?: string[]; /** * Microsoft Defender settings for the security profile. */ defender?: outputs.containerservice.ManagedClusterSecurityProfileDefenderResponse; /** * Image Cleaner settings for the security profile. */ imageCleaner?: outputs.containerservice.ManagedClusterSecurityProfileImageCleanerResponse; /** * Workload identity settings for the security profile. Workload identity enables Kubernetes applications to access Azure cloud resources securely with Azure AD. See https://aka.ms/aks/wi for more details. */ workloadIdentity?: outputs.containerservice.ManagedClusterSecurityProfileWorkloadIdentityResponse; } /** * managedClusterSecurityProfileResponseProvideDefaults sets the appropriate defaults for ManagedClusterSecurityProfileResponse */ function managedClusterSecurityProfileResponseProvideDefaults(val: ManagedClusterSecurityProfileResponse): ManagedClusterSecurityProfileResponse; /** * Workload identity settings for the security profile. */ interface ManagedClusterSecurityProfileWorkloadIdentityResponse { /** * Whether to enable workload identity. */ enabled?: boolean; } /** * Information about a service principal identity for the cluster to use for manipulating Azure APIs. */ interface ManagedClusterServicePrincipalProfileResponse { /** * The ID for the service principal. */ clientId: string; /** * The secret password associated with the service principal in plain text. */ secret?: string; } /** * The Static Egress Gateway addon configuration for the cluster. */ interface ManagedClusterStaticEgressGatewayProfileResponse { /** * Enable Static Egress Gateway addon. Indicates if Static Egress Gateway addon is enabled or not. */ enabled?: boolean; } /** * Contains read-only information about the Managed Cluster. */ interface ManagedClusterStatusResponse { /** * The error details information of the managed cluster. Preserves the detailed info of failure. If there was no error, this field is omitted. */ provisioningError: outputs.containerservice.ErrorDetailResponse; } /** * AzureBlob CSI Driver settings for the storage profile. */ interface ManagedClusterStorageProfileBlobCSIDriverResponse { /** * Whether to enable AzureBlob CSI Driver. The default value is false. */ enabled?: boolean; } /** * AzureDisk CSI Driver settings for the storage profile. */ interface ManagedClusterStorageProfileDiskCSIDriverResponse { /** * Whether to enable AzureDisk CSI Driver. The default value is true. */ enabled?: boolean; } /** * AzureFile CSI Driver settings for the storage profile. */ interface ManagedClusterStorageProfileFileCSIDriverResponse { /** * Whether to enable AzureFile CSI Driver. The default value is true. */ enabled?: boolean; } /** * Storage profile for the container service cluster. */ interface ManagedClusterStorageProfileResponse { /** * AzureBlob CSI Driver settings for the storage profile. */ blobCSIDriver?: outputs.containerservice.ManagedClusterStorageProfileBlobCSIDriverResponse; /** * AzureDisk CSI Driver settings for the storage profile. */ diskCSIDriver?: outputs.containerservice.ManagedClusterStorageProfileDiskCSIDriverResponse; /** * AzureFile CSI Driver settings for the storage profile. */ fileCSIDriver?: outputs.containerservice.ManagedClusterStorageProfileFileCSIDriverResponse; /** * Snapshot Controller settings for the storage profile. */ snapshotController?: outputs.containerservice.ManagedClusterStorageProfileSnapshotControllerResponse; } /** * Snapshot Controller settings for the storage profile. */ interface ManagedClusterStorageProfileSnapshotControllerResponse { /** * Whether to enable Snapshot Controller. The default value is true. */ enabled?: boolean; } /** * The update to be applied to the ManagedClusters. */ interface ManagedClusterUpdateResponse { /** * The node image upgrade to be applied to the target nodes in update run. */ nodeImageSelection?: outputs.containerservice.NodeImageSelectionResponse; /** * The upgrade to apply to the ManagedClusters. */ upgrade: outputs.containerservice.ManagedClusterUpgradeSpecResponse; } /** * The upgrade to apply to a ManagedCluster. */ interface ManagedClusterUpgradeSpecResponse { /** * The Kubernetes version to upgrade the member clusters to. */ kubernetesVersion?: string; /** * ManagedClusterUpgradeType is the type of upgrade to be applied. */ type: string; } /** * Profile for Windows VMs in the managed cluster. */ interface ManagedClusterWindowsProfileResponse { /** * Specifies the password of the administrator account.

**Minimum-length:** 8 characters

**Max-length:** 123 characters

**Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
Has lower characters
Has upper characters
Has a digit
Has a special character (Regex match [\W_])

**Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!" */ adminPassword?: string; /** * Specifies the name of the administrator account.

**Restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length:** 1 character

**Max-length:** 20 characters */ adminUsername: string; /** * Whether to enable CSI proxy. For more details on CSI proxy, see the [CSI proxy GitHub repo](https://github.com/kubernetes-csi/csi-proxy). */ enableCSIProxy?: boolean; /** * The Windows gMSA Profile in the Managed Cluster. */ gmsaProfile?: outputs.containerservice.WindowsGmsaProfileResponse; /** * The license type to use for Windows VMs. See [Azure Hybrid User Benefits](https://azure.microsoft.com/pricing/hybrid-benefit/faq/) for more details. */ licenseType?: string; } /** * KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile. */ interface ManagedClusterWorkloadAutoScalerProfileKedaResponse { /** * Whether to enable KEDA. */ enabled: boolean; } /** * Workload Auto-scaler profile for the managed cluster. */ interface ManagedClusterWorkloadAutoScalerProfileResponse { /** * KEDA (Kubernetes Event-driven Autoscaling) settings for the workload auto-scaler profile. */ keda?: outputs.containerservice.ManagedClusterWorkloadAutoScalerProfileKedaResponse; /** * VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile. */ verticalPodAutoscaler?: outputs.containerservice.ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscalerResponse; } /** * managedClusterWorkloadAutoScalerProfileResponseProvideDefaults sets the appropriate defaults for ManagedClusterWorkloadAutoScalerProfileResponse */ function managedClusterWorkloadAutoScalerProfileResponseProvideDefaults(val: ManagedClusterWorkloadAutoScalerProfileResponse): ManagedClusterWorkloadAutoScalerProfileResponse; /** * VPA (Vertical Pod Autoscaler) settings for the workload auto-scaler profile. */ interface ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscalerResponse { /** * Whether to enable VPA. Default value is false. */ enabled: boolean; } /** * managedClusterWorkloadAutoScalerProfileVerticalPodAutoscalerResponseProvideDefaults sets the appropriate defaults for ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscalerResponse */ function managedClusterWorkloadAutoScalerProfileVerticalPodAutoscalerResponseProvideDefaults(val: ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscalerResponse): ManagedClusterWorkloadAutoScalerProfileVerticalPodAutoscalerResponse; /** * The namespace properties for the fleet managed namespace. */ interface ManagedNamespacePropertiesResponse { /** * The annotations for the fleet managed namespace. */ annotations?: { [key: string]: string; }; /** * The default network policy for the fleet managed namespace. */ defaultNetworkPolicy?: outputs.containerservice.NetworkPolicyResponse; /** * The default resource quota for the fleet managed namespace. */ defaultResourceQuota?: outputs.containerservice.ResourceQuotaResponse; /** * The labels for the fleet managed namespace. */ labels?: { [key: string]: string; }; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.containerservice.UserAssignedIdentityResponse; }; } /** * Specifications on number of machines. */ interface ManualScaleProfileResponse { /** * Number of nodes. */ count?: number; /** * VM size that AKS will use when creating and scaling e.g. 'Standard_E4s_v3', 'Standard_E16s_v3' or 'Standard_D16s_v5'. */ size?: string; } /** * The status of a member update operation. */ interface MemberUpdateStatusResponse { /** * The Azure resource id of the target Kubernetes cluster. */ clusterResourceId: string; /** * The status message after processing the member update operation. */ message: string; /** * The name of the FleetMember. */ name: string; /** * The operation resource id of the latest attempt to perform the operation. */ operationId: string; /** * The status of the MemberUpdate operation. */ status: outputs.containerservice.UpdateStatusResponse; } /** * Mesh membership properties of a managed cluster. */ interface MeshMembershipPropertiesResponse { /** * The ARM resource id for the managed mesh member. This is of the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppLink/applinks/{appLinkName}/appLinkMembers/{appLinkMemberName}'. Visit https://aka.ms/applink for more information. */ managedMeshID: string; /** * The current provisioning state of the Mesh Membership. */ provisioningState: string; } /** * Properties of a namespace managed by ARM */ interface NamespacePropertiesNamespaceResponse { /** * Action if Kubernetes namespace with same name already exists. */ adoptionPolicy?: string; /** * The annotations of managed namespace. */ annotations?: { [key: string]: string; }; /** * The default network policy enforced upon the namespace. Customers can have other Kubernetes network policy objects under the namespace. All the network policies will be enforced. */ defaultNetworkPolicy?: outputs.containerservice.NetworkPoliciesResponse; /** * The default resource quota enforced upon the namespace. Customers can have other Kubernetes resource quota objects under the namespace. All the resource quotas will be enforced. */ defaultResourceQuota?: outputs.containerservice.ResourceQuotaResponse; /** * Delete options of a namespace. */ deletePolicy?: string; /** * The labels of managed namespace. */ labels?: { [key: string]: string; }; /** * The current provisioning state of the namespace. */ provisioningState: string; } /** * namespacePropertiesNamespaceResponseProvideDefaults sets the appropriate defaults for NamespacePropertiesNamespaceResponse */ function namespacePropertiesNamespaceResponseProvideDefaults(val: NamespacePropertiesNamespaceResponse): NamespacePropertiesNamespaceResponse; /** * Properties of a namespace managed by ARM */ interface NamespacePropertiesResponse { /** * Action if Kubernetes namespace with same name already exists. */ adoptionPolicy?: string; /** * The annotations of managed namespace. */ annotations?: { [key: string]: string; }; /** * The default network policy enforced upon the namespace. Customers can have other Kubernetes network policy objects under the namespace. Network policies are additive; if a policy or policies apply to a given pod for a given direction, the connections allowed in that direction for the pod is the union of what all applicable policies allow. */ defaultNetworkPolicy?: outputs.containerservice.NetworkPoliciesResponse; /** * The default resource quota enforced upon the namespace. Customers can have other Kubernetes resource quota objects under the namespace. Resource quotas are additive; if multiple resource quotas are applied to a given namespace, then the effective limit will be one such that all quotas on the namespace can be satisfied. */ defaultResourceQuota?: outputs.containerservice.ResourceQuotaResponse; /** * Delete options of a namespace. */ deletePolicy?: string; /** * The labels of managed namespace. */ labels?: { [key: string]: string; }; /** * The special FQDN used by the Azure Portal to access the Managed Cluster. This FQDN is for use only by the Azure Portal and should not be used by other clients. The Azure Portal requires certain Cross-Origin Resource Sharing (CORS) headers to be sent in some responses, which Kubernetes APIServer doesn't handle by default. This special FQDN supports CORS, allowing the Azure Portal to function properly. */ portalFqdn: string; /** * The current provisioning state of the namespace. */ provisioningState: string; } /** * namespacePropertiesResponseProvideDefaults sets the appropriate defaults for NamespacePropertiesResponse */ function namespacePropertiesResponseProvideDefaults(val: NamespacePropertiesResponse): NamespacePropertiesResponse; /** * Default network policy of the namespace, specifying ingress and egress rules. */ interface NetworkPoliciesResponse { /** * Egress policy for the network. */ egress?: string; /** * Ingress policy for the network. */ ingress?: string; } /** * networkPoliciesResponseProvideDefaults sets the appropriate defaults for NetworkPoliciesResponse */ function networkPoliciesResponseProvideDefaults(val: NetworkPoliciesResponse): NetworkPoliciesResponse; /** * The network policy for the managed namespace. */ interface NetworkPolicyResponse { /** * The egress policy for the managed namespace. */ egress?: string; /** * The ingress policy for the managed namespace. */ ingress?: string; } /** * network profile for managed cluster snapshot, these properties are read only. */ interface NetworkProfileForSnapshotResponse { /** * loadBalancerSku for managed cluster snapshot. */ loadBalancerSku?: string; /** * networkMode for managed cluster snapshot. */ networkMode?: string; /** * networkPlugin for managed cluster snapshot. */ networkPlugin?: string; /** * NetworkPluginMode for managed cluster snapshot. */ networkPluginMode?: string; /** * networkPolicy for managed cluster snapshot. */ networkPolicy?: string; } /** * The node image upgrade to be applied to the target nodes in update run. */ interface NodeImageSelectionResponse { /** * Custom node image versions to upgrade the nodes to. This field is required if node image selection type is Custom. Otherwise, it must be empty. For each node image family (e.g., 'AKSUbuntu-1804gen2containerd'), this field can contain at most one version (e.g., only one of 'AKSUbuntu-1804gen2containerd-2023.01.12' or 'AKSUbuntu-1804gen2containerd-2023.02.12', not both). If the nodes belong to a family without a matching image version in this field, they are not upgraded. */ customNodeImageVersions?: outputs.containerservice.NodeImageVersionResponse[]; /** * The node image upgrade type. */ type: string; } /** * The node image upgrade specs for the update run. */ interface NodeImageSelectionStatusResponse { /** * The image versions to upgrade the nodes to. */ selectedNodeImageVersions: outputs.containerservice.NodeImageVersionResponse[]; } /** * The node upgrade image version. */ interface NodeImageVersionResponse { /** * The image version to upgrade the nodes to (e.g., 'AKSUbuntu-1804gen2containerd-2022.12.13'). */ version: string; } /** * PlacementPolicy contains the rules to select target member clusters to place the selected resources. Note that only clusters that are both joined and satisfying the rules will be selected. You can only specify at most one of the two fields: ClusterNames and Affinity. If none is specified, all the joined clusters are selected. */ interface PlacementPolicyResponse { /** * Affinity contains cluster affinity scheduling rules. Defines which member clusters to place the selected resources. Only valid if the placement type is "PickAll" or "PickN". */ affinity?: outputs.containerservice.AffinityResponse; /** * ClusterNames contains a list of names of MemberCluster to place the selected resources. Only valid if the placement type is "PickFixed" */ clusterNames?: string[]; /** * Type of placement. Can be "PickAll", "PickN" or "PickFixed". Default is PickAll. */ placementType?: string; /** * If specified, the ClusterResourcePlacement's Tolerations. Tolerations cannot be updated or deleted. This field is beta-level and is for the taints and tolerations feature. */ tolerations?: outputs.containerservice.TolerationResponse[]; } /** * The configuration profile for default ClusterResourcePlacement for placement. */ interface PlacementProfileResponse { /** * The default ClusterResourcePlacement policy configuration. */ defaultClusterResourcePlacement?: outputs.containerservice.ClusterResourcePlacementSpecResponse; } /** * The port range. */ interface PortRangeResponse { /** * The maximum port that is included in the range. It should be ranged from 1 to 65535, and be greater than or equal to portStart. */ portEnd?: number; /** * The minimum port that is included in the range. It should be ranged from 1 to 65535, and be less than or equal to portEnd. */ portStart?: number; /** * The network protocol of the port. */ protocol?: string; } /** * Describes the Power State of the cluster */ interface PowerStateResponse { /** * Tells whether the cluster is Running or Stopped */ code?: string; } /** * Private endpoint which a connection belongs to. */ interface PrivateEndpointResponse { /** * The resource ID of the private endpoint */ id?: string; } /** * A private link resource */ interface PrivateLinkResourceResponse { /** * The group ID of the resource. */ groupId?: string; /** * The ID of the private link resource. */ id?: string; /** * The name of the private link resource. */ name?: string; /** * The private link service ID of the resource, this field is exposed only to NRP internally. */ privateLinkServiceID: string; /** * The RequiredMembers of the resource */ requiredMembers?: string[]; /** * The resource type. */ type?: string; } /** * The state of a private link service connection. */ interface PrivateLinkServiceConnectionStateResponse { /** * The private link service connection description. */ description?: string; /** * The private link service connection status. */ status?: string; } /** * The propagation to be used for provisioning the namespace among the fleet. */ interface PropagationPolicyResponse { /** * The profile to be used for propagation via placement. */ placementProfile?: outputs.containerservice.PlacementProfileResponse; /** * The type of the policy to be used. Default is Placement. */ type: string; } /** * PropertySelectorRequirement is a specific property requirement when picking clusters for resource placement. */ interface PropertySelectorRequirementResponse { /** * Name is the name of the property; it should be a Kubernetes label name. */ name: string; /** * Operator specifies the relationship between a cluster's observed value of the specified property and the values given in the requirement. */ operator: string; /** * Values are a list of values of the specified property which Fleet will compare against the observed values of individual member clusters in accordance with the given operator. At this moment, each value should be a Kubernetes quantity. For more information, see https://pkg.go.dev/k8s.io/apimachinery/pkg/api/resource#Quantity. If the operator is Gt (greater than), Ge (greater than or equal to), Lt (less than), or `Le` (less than or equal to), Eq (equal to), or Ne (ne), exactly one value must be specified in the list. */ values: string[]; } /** * PropertySelector helps user specify property requirements when picking clusters for resource placement. */ interface PropertySelectorResponse { /** * MatchExpressions is an array of PropertySelectorRequirements. The requirements are AND'd. */ matchExpressions: outputs.containerservice.PropertySelectorRequirementResponse[]; } /** * For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'. */ interface RelativeMonthlyScheduleResponse { /** * Specifies on which day of the week the maintenance occurs. */ dayOfWeek: string; /** * Specifies the number of months between each set of occurrences. */ intervalMonths: number; /** * The week index. Specifies on which week of the month the dayOfWeek applies. */ weekIndex: string; } /** * Resource quota for the namespace. */ interface ResourceQuotaResponse { /** * CPU limit of the namespace in one-thousandth CPU form. See [CPU resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) for more details. */ cpuLimit?: string; /** * CPU request of the namespace in one-thousandth CPU form. See [CPU resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-cpu) for more details. */ cpuRequest?: string; /** * Memory limit of the namespace in the power-of-two equivalents form: Ei, Pi, Ti, Gi, Mi, Ki. See [Memory resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) for more details. */ memoryLimit?: string; /** * Memory request of the namespace in the power-of-two equivalents form: Ei, Pi, Ti, Gi, Mi, Ki. See [Memory resource units](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#meaning-of-memory) for more details. */ memoryRequest?: string; } /** * A reference to an Azure resource. */ interface ResourceReferenceResponse { /** * The fully qualified Azure resource id. */ id?: string; } /** * Specifications on how to scale a VirtualMachines agent pool. */ interface ScaleProfileResponse { /** * Specifications on how to scale the VirtualMachines agent pool to a fixed size. */ manual?: outputs.containerservice.ManualScaleProfileResponse[]; } /** * One and only one of the schedule types should be specified. Choose either 'daily', 'weekly', 'absoluteMonthly' or 'relativeMonthly' for your maintenance schedule. */ interface ScheduleResponse { /** * For schedules like: 'recur every month on the 15th' or 'recur every 3 months on the 20th'. */ absoluteMonthly?: outputs.containerservice.AbsoluteMonthlyScheduleResponse; /** * For schedules like: 'recur every day' or 'recur every 3 days'. */ daily?: outputs.containerservice.DailyScheduleResponse; /** * For schedules like: 'recur every month on the first Monday' or 'recur every 3 months on last Friday'. */ relativeMonthly?: outputs.containerservice.RelativeMonthlyScheduleResponse; /** * For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'. */ weekly?: outputs.containerservice.WeeklyScheduleResponse; } /** * Service mesh profile for a managed cluster. */ interface ServiceMeshProfileResponse { /** * Istio service mesh configuration. */ istio?: outputs.containerservice.IstioServiceMeshResponse; /** * Mode of the service mesh. */ mode: string; } /** * Sysctl settings for Linux agent nodes. */ interface SysctlConfigResponse { /** * Sysctl setting fs.aio-max-nr. */ fsAioMaxNr?: number; /** * Sysctl setting fs.file-max. */ fsFileMax?: number; /** * Sysctl setting fs.inotify.max_user_watches. */ fsInotifyMaxUserWatches?: number; /** * Sysctl setting fs.nr_open. */ fsNrOpen?: number; /** * Sysctl setting kernel.threads-max. */ kernelThreadsMax?: number; /** * Sysctl setting net.core.netdev_max_backlog. */ netCoreNetdevMaxBacklog?: number; /** * Sysctl setting net.core.optmem_max. */ netCoreOptmemMax?: number; /** * Sysctl setting net.core.rmem_default. */ netCoreRmemDefault?: number; /** * Sysctl setting net.core.rmem_max. */ netCoreRmemMax?: number; /** * Sysctl setting net.core.somaxconn. */ netCoreSomaxconn?: number; /** * Sysctl setting net.core.wmem_default. */ netCoreWmemDefault?: number; /** * Sysctl setting net.core.wmem_max. */ netCoreWmemMax?: number; /** * Sysctl setting net.ipv4.ip_local_port_range. */ netIpv4IpLocalPortRange?: string; /** * Sysctl setting net.ipv4.neigh.default.gc_thresh1. */ netIpv4NeighDefaultGcThresh1?: number; /** * Sysctl setting net.ipv4.neigh.default.gc_thresh2. */ netIpv4NeighDefaultGcThresh2?: number; /** * Sysctl setting net.ipv4.neigh.default.gc_thresh3. */ netIpv4NeighDefaultGcThresh3?: number; /** * Sysctl setting net.ipv4.tcp_fin_timeout. */ netIpv4TcpFinTimeout?: number; /** * Sysctl setting net.ipv4.tcp_keepalive_probes. */ netIpv4TcpKeepaliveProbes?: number; /** * Sysctl setting net.ipv4.tcp_keepalive_time. */ netIpv4TcpKeepaliveTime?: number; /** * Sysctl setting net.ipv4.tcp_max_syn_backlog. */ netIpv4TcpMaxSynBacklog?: number; /** * Sysctl setting net.ipv4.tcp_max_tw_buckets. */ netIpv4TcpMaxTwBuckets?: number; /** * Sysctl setting net.ipv4.tcp_tw_reuse. */ netIpv4TcpTwReuse?: boolean; /** * Sysctl setting net.ipv4.tcp_keepalive_intvl. */ netIpv4TcpkeepaliveIntvl?: number; /** * Sysctl setting net.netfilter.nf_conntrack_buckets. */ netNetfilterNfConntrackBuckets?: number; /** * Sysctl setting net.netfilter.nf_conntrack_max. */ netNetfilterNfConntrackMax?: number; /** * Sysctl setting vm.max_map_count. */ vmMaxMapCount?: number; /** * Sysctl setting vm.swappiness. */ vmSwappiness?: number; /** * Sysctl setting vm.vfs_cache_pressure. */ vmVfsCachePressure?: number; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Time in a week. */ interface TimeInWeekResponse { /** * The day of the week. */ day?: string; /** * A list of hours in the day used to identify a time range. Each integer hour represents a time range beginning at 0m after the hour ending at the next hour (non-inclusive). 0 corresponds to 00:00 UTC, 23 corresponds to 23:00 UTC. Specifying [0, 1] means the 00:00 - 02:00 UTC time range. */ hourSlots?: number[]; } /** * A time range. For example, between 2021-05-25T13:00:00Z and 2021-05-25T14:00:00Z. */ interface TimeSpanResponse { /** * The end of a time span */ end?: string; /** * The start of a time span */ start?: string; } /** * Toleration allows ClusterResourcePlacement to tolerate any taint that matches the triple using the matching operator . */ interface TolerationResponse { /** * Effect indicates the taint effect to match. Empty means match all taint effects. When specified, only allowed value is NoSchedule. */ effect?: string; /** * Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys. */ key?: string; /** * Operator represents a key's relationship to the value. Valid operators are Exists and Equal. Defaults to Equal. Exists is equivalent to wildcard for value, so that a ClusterResourcePlacement can tolerate all taints of a particular category. */ operator?: string; /** * Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string. */ value?: string; } /** * A group to be updated. */ interface UpdateGroupResponse { /** * Name of the group. * It must match a group name of an existing fleet member. */ name: string; } /** * The status of a UpdateGroup. */ interface UpdateGroupStatusResponse { /** * The list of member this UpdateGroup updates. */ members: outputs.containerservice.MemberUpdateStatusResponse[]; /** * The name of the UpdateGroup. */ name: string; /** * The status of the UpdateGroup. */ status: outputs.containerservice.UpdateStatusResponse; } /** * The status of a UpdateRun. */ interface UpdateRunStatusResponse { /** * The node image upgrade specs for the update run. It is only set in update run when `NodeImageSelection.type` is `Consistent`. */ nodeImageSelection: outputs.containerservice.NodeImageSelectionStatusResponse; /** * The stages composing an update run. Stages are run sequentially withing an UpdateRun. */ stages: outputs.containerservice.UpdateStageStatusResponse[]; /** * The status of the UpdateRun. */ status: outputs.containerservice.UpdateStatusResponse; } /** * Defines the update sequence of the clusters via stages and groups. * * Stages within a run are executed sequentially one after another. * Groups within a stage are executed in parallel. * Member clusters within a group are updated sequentially one after another. * * A valid strategy contains no duplicate groups within or across stages. */ interface UpdateRunStrategyResponse { /** * The list of stages that compose this update run. Min size: 1. */ stages: outputs.containerservice.UpdateStageResponse[]; } /** * Defines a stage which contains the groups to update and the steps to take (e.g., wait for a time period) before starting the next stage. */ interface UpdateStageResponse { /** * The time in seconds to wait at the end of this stage before starting the next one. Defaults to 0 seconds if unspecified. */ afterStageWaitInSeconds?: number; /** * Defines the groups to be executed in parallel in this stage. Duplicate groups are not allowed. Min size: 1. */ groups?: outputs.containerservice.UpdateGroupResponse[]; /** * The name of the stage. Must be unique within the UpdateRun. */ name: string; } /** * The status of a UpdateStage. */ interface UpdateStageStatusResponse { /** * The status of the wait period configured on the UpdateStage. */ afterStageWaitStatus: outputs.containerservice.WaitStatusResponse; /** * The list of groups to be updated as part of this UpdateStage. */ groups: outputs.containerservice.UpdateGroupStatusResponse[]; /** * The name of the UpdateStage. */ name: string; /** * The status of the UpdateStage. */ status: outputs.containerservice.UpdateStatusResponse; } /** * The status for an operation or group of operations. */ interface UpdateStatusResponse { /** * The time the operation or group was completed. */ completedTime: string; /** * The error details when a failure is encountered. */ error: outputs.containerservice.ErrorDetailResponse; /** * The time the operation or group was started. */ startTime: string; /** * The State of the operation or group. */ state: string; } /** * Settings for overrides when upgrading a cluster. */ interface UpgradeOverrideSettingsResponse { /** * Whether to force upgrade the cluster. Note that this option instructs upgrade operation to bypass upgrade protections such as checking for deprecated API usage. Enable this option only with caution. */ forceUpgrade?: boolean; /** * Until when the overrides are effective. Note that this only matches the start time of an upgrade, and the effectiveness won't change once an upgrade starts even if the `until` expires as upgrade proceeds. This field is not set by default. It must be set for the overrides to take effect. */ until?: string; } /** * Details about a user assigned identity. */ interface UserAssignedIdentityManagedClusterResponse { /** * The client ID of the user assigned identity. */ clientId?: string; /** * The object ID of the user assigned identity. */ objectId?: string; /** * The resource ID of the user assigned identity. */ resourceId?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Current status on a group of nodes of the same vm size. */ interface VirtualMachineNodesResponse { /** * Number of nodes. */ count?: number; /** * The VM size of the agents used to host this group of nodes. */ size?: string; } /** * Specifications on VirtualMachines agent pool. */ interface VirtualMachinesProfileResponse { /** * Specifications on how to scale a VirtualMachines agent pool. */ scale?: outputs.containerservice.ScaleProfileResponse; } /** * The status of the wait duration. */ interface WaitStatusResponse { /** * The status of the wait duration. */ status: outputs.containerservice.UpdateStatusResponse; /** * The wait duration configured in seconds. */ waitDurationInSeconds: number; } /** * For schedules like: 'recur every Monday' or 'recur every 3 weeks on Wednesday'. */ interface WeeklyScheduleResponse { /** * Specifies on which day of the week the maintenance occurs. */ dayOfWeek: string; /** * Specifies the number of weeks between each set of occurrences. */ intervalWeeks: number; } /** * Windows gMSA Profile in the managed cluster. */ interface WindowsGmsaProfileResponse { /** * Specifies the DNS server for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. */ dnsServer?: string; /** * Whether to enable Windows gMSA. Specifies whether to enable Windows gMSA in the managed cluster. */ enabled?: boolean; /** * Specifies the root domain name for Windows gMSA.

Set it to empty if you have configured the DNS server in the vnet which is used to create the managed cluster. */ rootDomainName?: string; } } export declare namespace containerstorage { /** * Assignment Properties */ interface AssignmentResponse { /** * Resource id for the assigned resource */ id: string; /** * Indicates if the assignment is in a usable state */ status: outputs.containerstorage.AssignmentStatusResponse; } /** * Status of the assignment resource */ interface AssignmentStatusResponse { /** * Reason for the status */ message?: string; /** * State of the assignment resource */ state: string; } /** * Azure Disk Pool Properties */ interface AzureDiskResponse { /** * Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). */ disks?: outputs.containerstorage.DiskResponse[]; /** * Encryption specifies the encryption configuration for the Azure Disk pool */ encryption?: outputs.containerstorage.EncryptionResponse; /** * Managed resource group for the pool. */ resourceGroup: string; /** * Sku name */ skuName?: string; } /** * Model for disk for that pool is using */ interface DiskResponse { /** * ID is the disk identifier visible to the OS. It is typically the WWN or disk ID in formats such as eui.e8238fa6bf530001001b448b45263379 or 0x5002cf6cbc5dd460 */ id: string; /** * Reference is the location of the disk in an external system. */ reference: string; } /** * Elastic San Pool Properties */ interface ElasticSanResponse { /** * Encryption specifies the encryption configuration for the Azure Disk pool */ encryption?: outputs.containerstorage.EncryptionResponse; /** * Managed resource group for the pool. */ resourceGroup: string; /** * Sku name */ skuName?: string; } /** * Properties of the ElasticSAN iSCSI target */ interface ElasticSanVolumePropertiesResponse { /** * iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server" */ targetIqn: string; /** * iSCSI Target Portal Host Name */ targetPortalHostname: string; /** * iSCSI Target Portal Port */ targetPortalPort: number; } /** * Encryption key properties for the pool. */ interface EncryptionResponse { /** * The managed service identities assigned to this resource. */ identity?: outputs.containerstorage.ManagedServiceIdentityResponse; /** * The name of the key vault key. */ keyName: string; /** * The URI of the key vault. */ keyVaultUri: string; } /** * Ephemeral Disk Pool Properties */ interface EphemeralDiskResponse { /** * Only required if individual disk selection is desired. Path to disk, e.g. :/dev/sda or WWN. Supports specifying multiple disks (same syntax as tags). */ disks?: outputs.containerstorage.DiskResponse[]; /** * The number of data copies. Default 3. */ replicas?: number; } /** * ephemeralDiskResponseProvideDefaults sets the appropriate defaults for EphemeralDiskResponse */ function ephemeralDiskResponseProvideDefaults(val: EphemeralDiskResponse): EphemeralDiskResponse; /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.containerstorage.UserAssignedIdentityResponse; }; } /** * Type of the Pool: ephemeralDisk, azureDisk, or elasticsan */ interface PoolTypeResponse { /** * Disk Pool Properties */ azureDisk?: outputs.containerstorage.AzureDiskResponse; /** * Elastic San Pool Properties */ elasticSan?: outputs.containerstorage.ElasticSanResponse; /** * Ephemeral Pool Properties */ ephemeralDisk?: outputs.containerstorage.EphemeralDiskResponse; } /** * poolTypeResponseProvideDefaults sets the appropriate defaults for PoolTypeResponse */ function poolTypeResponseProvideDefaults(val: PoolTypeResponse): PoolTypeResponse; /** * Requests for capacity for the pool. */ interface RequestsResponse { /** * Requested capacity of the pool in GiB. */ storage?: number; } /** * requestsResponseProvideDefaults sets the appropriate defaults for RequestsResponse */ function requestsResponseProvideDefaults(val: RequestsResponse): RequestsResponse; /** * Status of the resource */ interface ResourceOperationalStatusResponse { /** * Reason for state. */ message?: string; /** * state of the resource */ state: string; } /** * Resource Requests for the pool. */ interface ResourcesResponse { /** * Requests for capacity for the pool. */ requests?: outputs.containerstorage.RequestsResponse; } /** * resourcesResponseProvideDefaults sets the appropriate defaults for ResourcesResponse */ function resourcesResponseProvideDefaults(val: ResourcesResponse): ResourcesResponse; /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Properties of the volume */ interface VolumeTypeResponse { /** * Properties of the ElasticSAN iSCSI target */ elasticSan: outputs.containerstorage.ElasticSanVolumePropertiesResponse; } } export declare namespace contoso { /** * Employee properties */ interface EmployeePropertiesResponse { /** * Age of employee */ age?: number; /** * City of employee */ city?: string; /** * Profile of employee */ profile?: string; /** * The status of the last operation. */ provisioningState: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace cosmosdb { /** * The metadata related to an access key for a given database account. */ interface AccountKeyMetadataResponse { /** * Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means that the last key regeneration was triggered before 2022-06-18. */ generationTime: string; } /** * Analytical storage specific properties. */ interface AnalyticalStorageConfigurationResponse { /** * Describes the types of schema for analytical storage. */ schemaType?: string; } interface ApiPropertiesResponse { /** * Describes the version of the MongoDB account. */ serverVersion?: string; } /** * Ldap authentication method properties. This feature is in preview. */ interface AuthenticationMethodLdapPropertiesResponse { /** * Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms. */ connectionTimeoutInMs?: number; /** * Distinguished name of the object to start the recursive search of users from. */ searchBaseDistinguishedName?: string; /** * Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login. */ searchFilterTemplate?: string; serverCertificates?: outputs.cosmosdb.CertificateResponse[]; /** * Hostname of the LDAP server. */ serverHostname?: string; /** * Port of the LDAP server. */ serverPort?: number; /** * Distinguished name of the look up user account, who can look up user details on authentication. */ serviceUserDistinguishedName?: string; /** * Password of the look up user. */ serviceUserPassword?: string; } interface AutoscaleSettingsResponse { /** * Represents maximum throughput, the resource can scale up to. */ maxThroughput?: number; } /** * The object representing the state of the migration between the backup policies. */ interface BackupPolicyMigrationStateResponse { /** * Time at which the backup policy migration started (ISO-8601 format). */ startTime?: string; /** * Describes the status of migration between backup policy types. */ status?: string; /** * Describes the target backup policy type of the backup policy migration. */ targetType?: string; } /** * Cosmos DB capability object */ interface CapabilityResponse { /** * Name of the Cosmos DB capability. For example, "name": "EnableCassandra". Current values also include "EnableTable" and "EnableGremlin". */ name?: string; } /** * The object that represents all properties related to capacity enforcement on an account. */ interface CapacityResponse { /** * The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput. */ totalThroughputLimit?: number; } interface CassandraErrorResponse { /** * Additional information about the error. */ additionalErrorInfo?: string; /** * The code of error that occurred. */ code?: string; /** * The message of the error. */ message?: string; /** * The target resource of the error. */ target?: string; } interface CassandraKeyspaceGetPropertiesResponseOptions { /** * Specifies the Autoscale settings. */ autoscaleSettings?: outputs.cosmosdb.AutoscaleSettingsResponse; /** * Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details. */ throughput?: number; } interface CassandraKeyspaceGetPropertiesResponseResource { /** * A system generated property representing the resource etag required for optimistic concurrency control. */ etag: string; /** * Name of the Cosmos DB Cassandra keyspace */ id: string; /** * A system generated property. A unique identifier. */ rid: string; /** * A system generated property that denotes the last updated timestamp of the resource. */ ts: number; } /** * Cosmos DB Cassandra table partition key */ interface CassandraPartitionKeyResponse { /** * Name of the Cosmos DB Cassandra table partition key */ name?: string; } /** * Cosmos DB Cassandra table schema */ interface CassandraSchemaResponse { /** * List of cluster key. */ clusterKeys?: outputs.cosmosdb.ClusterKeyResponse[]; /** * List of Cassandra table columns. */ columns?: outputs.cosmosdb.ColumnResponse[]; /** * List of partition key. */ partitionKeys?: outputs.cosmosdb.CassandraPartitionKeyResponse[]; } interface CassandraTableGetPropertiesResponseOptions { /** * Specifies the Autoscale settings. */ autoscaleSettings?: outputs.cosmosdb.AutoscaleSettingsResponse; /** * Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details. */ throughput?: number; } interface CassandraTableGetPropertiesResponseResource { /** * Analytical TTL. */ analyticalStorageTtl?: number; /** * Time to live of the Cosmos DB Cassandra table */ defaultTtl?: number; /** * A system generated property representing the resource etag required for optimistic concurrency control. */ etag: string; /** * Name of the Cosmos DB Cassandra table */ id: string; /** * A system generated property. A unique identifier. */ rid: string; /** * Schema of the Cosmos DB Cassandra table */ schema?: outputs.cosmosdb.CassandraSchemaResponse; /** * A system generated property that denotes the last updated timestamp of the resource. */ ts: number; } interface CassandraViewGetPropertiesResponseOptions { /** * Specifies the Autoscale settings. */ autoscaleSettings?: outputs.cosmosdb.AutoscaleSettingsResponse; /** * Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details. */ throughput?: number; } interface CassandraViewGetPropertiesResponseResource { /** * A system generated property representing the resource etag required for optimistic concurrency control. */ etag: string; /** * Name of the Cosmos DB Cassandra view */ id: string; /** * A system generated property. A unique identifier. */ rid: string; /** * A system generated property that denotes the last updated timestamp of the resource. */ ts: number; /** * View Definition of the Cosmos DB Cassandra view */ viewDefinition: string; } interface CertificateResponse { /** * PEM formatted public key. */ pem?: string; } /** * . */ interface ClientEncryptionIncludedPathResponse { /** * The identifier of the Client Encryption Key to be used to encrypt the path. */ clientEncryptionKeyId: string; /** * The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256. */ encryptionAlgorithm: string; /** * The type of encryption to be performed. Eg - Deterministic, Randomized. */ encryptionType: string; /** * Path that needs to be encrypted. */ path: string; } /** * Cosmos DB client encryption policy. */ interface ClientEncryptionPolicyResponse { /** * Paths of the item that need encryption along with path-specific settings. */ includedPaths: outputs.cosmosdb.ClientEncryptionIncludedPathResponse[]; /** * Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 supports id and partition key path encryption. */ policyFormatVersion: number; } /** * Cosmos DB Cassandra table cluster key */ interface ClusterKeyResponse { /** * Name of the Cosmos DB Cassandra table cluster key */ name?: string; /** * Order of the Cosmos DB Cassandra table cluster key, only support "Asc" and "Desc" */ orderBy?: string; } /** * Properties of a managed Cassandra cluster. */ interface ClusterResourceResponseProperties { /** * Which authentication method Cassandra should use to authenticate clients. 'None' turns off authentication, so should not be used except in emergencies. 'Cassandra' is the default password based authentication. The default is 'Cassandra'. */ authenticationMethod?: string; /** * How to connect to the azure services needed for running the cluster */ azureConnectionMethod?: string; /** * Whether Cassandra audit logging is enabled */ cassandraAuditLoggingEnabled?: boolean; /** * Which version of Cassandra should this cluster converge to running (e.g., 3.11). When updated, the cluster may take some time to migrate to the new version. */ cassandraVersion?: string; /** * List of TLS certificates used to authorize clients connecting to the cluster. All connections are TLS encrypted whether clientCertificates is set or not, but if clientCertificates is set, the managed Cassandra cluster will reject all connections not bearing a TLS client certificate that can be validated from one or more of the public certificates in this property. */ clientCertificates?: outputs.cosmosdb.CertificateResponse[]; /** * If you need to set the clusterName property in cassandra.yaml to something besides the resource name of the cluster, set the value to use on this property. */ clusterNameOverride?: string; /** * Whether the cluster and associated data centers has been deallocated. */ deallocated?: boolean; /** * Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/' */ delegatedManagementSubnetId?: string; /** * List of TLS certificates used to authorize gossip from unmanaged data centers. The TLS certificates of all nodes in unmanaged data centers must be verifiable using one of the certificates provided in this property. */ externalGossipCertificates?: outputs.cosmosdb.CertificateResponse[]; /** * List of IP addresses of seed nodes in unmanaged data centers. These will be added to the seed node lists of all managed nodes. */ externalSeedNodes?: outputs.cosmosdb.SeedNodeResponse[]; /** * List of TLS certificates that unmanaged nodes must trust for gossip with managed nodes. All managed nodes will present TLS client certificates that are verifiable using one of the certificates provided in this property. */ gossipCertificates: outputs.cosmosdb.CertificateResponse[]; /** * (Deprecated) Number of hours to wait between taking a backup of the cluster. */ hoursBetweenBackups?: number; /** * If the Connection Method is VPN, this is the Id of the private link resource that the datacenters need to connect to. */ privateLinkResourceId: string; /** * Hostname or IP address where the Prometheus endpoint containing data about the managed Cassandra nodes can be reached. */ prometheusEndpoint?: outputs.cosmosdb.SeedNodeResponse; /** * Error related to resource provisioning. */ provisionError?: outputs.cosmosdb.CassandraErrorResponse; /** * The status of the resource at the time the operation was called. */ provisioningState?: string; /** * Should automatic repairs run on this cluster? If omitted, this is true, and should stay true unless you are running a hybrid cluster where you are already doing your own repairs. */ repairEnabled?: boolean; /** * List of IP addresses of seed nodes in the managed data centers. These should be added to the seed node lists of all unmanaged nodes. */ seedNodes: outputs.cosmosdb.SeedNodeResponse[]; } /** * Cosmos DB Cassandra table column */ interface ColumnResponse { /** * Name of the Cosmos DB Cassandra table column */ name?: string; /** * Type of the Cosmos DB Cassandra table column */ type?: string; } interface CompositePathResponse { /** * Sort order for composite paths. */ order?: string; /** * The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) */ path?: string; } /** * The definition of a computed property */ interface ComputedPropertyResponse { /** * The name of a computed property, for example - "cp_lowerName" */ name?: string; /** * The query that evaluates the value for computed property, for example - "SELECT VALUE LOWER(c.name) FROM c" */ query?: string; } /** * The conflict resolution policy for the container. */ interface ConflictResolutionPolicyResponse { /** * The conflict resolution path in the case of LastWriterWins mode. */ conflictResolutionPath?: string; /** * The procedure to resolve conflicts in the case of custom mode. */ conflictResolutionProcedure?: string; /** * Indicates the conflict resolution mode. */ mode?: string; } /** * conflictResolutionPolicyResponseProvideDefaults sets the appropriate defaults for ConflictResolutionPolicyResponse */ function conflictResolutionPolicyResponseProvideDefaults(val: ConflictResolutionPolicyResponse): ConflictResolutionPolicyResponse; /** * Connection string for the mongo cluster */ interface ConnectionStringResponse { /** * Value of the connection string */ connectionString: string; /** * Description of the connection string */ description: string; } /** * The consistency policy for the Cosmos DB database account. */ interface ConsistencyPolicyResponse { /** * The default consistency level and configuration settings of the Cosmos DB account. */ defaultConsistencyLevel: string; /** * When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'. */ maxIntervalInSeconds?: number; /** * When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'. */ maxStalenessPrefix?: number; } /** * The configuration of the partition key to be used for partitioning data into multiple partitions */ interface ContainerPartitionKeyGremlinResourceGremlinGraphResponse { /** * Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create */ kind?: string; /** * List of paths using which data within the container can be partitioned */ paths?: string[]; /** * Indicates if the container is using a system generated partition key */ systemKey: boolean; /** * Indicates the version of the partition key definition */ version?: number; } /** * containerPartitionKeyGremlinResourceGremlinGraphResponseProvideDefaults sets the appropriate defaults for ContainerPartitionKeyGremlinResourceGremlinGraphResponse */ function containerPartitionKeyGremlinResourceGremlinGraphResponseProvideDefaults(val: ContainerPartitionKeyGremlinResourceGremlinGraphResponse): ContainerPartitionKeyGremlinResourceGremlinGraphResponse; /** * The configuration of the partition key to be used for partitioning data into multiple partitions */ interface ContainerPartitionKeyResponse { /** * Indicates the kind of algorithm used for partitioning */ kind?: string; /** * List of paths using which data within the container can be partitioned */ paths?: string[]; } /** * containerPartitionKeyResponseProvideDefaults sets the appropriate defaults for ContainerPartitionKeyResponse */ function containerPartitionKeyResponseProvideDefaults(val: ContainerPartitionKeyResponse): ContainerPartitionKeyResponse; /** * The configuration of the partition key to be used for partitioning data into multiple partitions */ interface ContainerPartitionKeySqlResourceSqlContainerResponse { /** * Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) are supported for container create */ kind?: string; /** * List of paths using which data within the container can be partitioned */ paths?: string[]; /** * Indicates if the container is using a system generated partition key */ systemKey: boolean; /** * Indicates the version of the partition key definition */ version?: number; } /** * containerPartitionKeySqlResourceSqlContainerResponseProvideDefaults sets the appropriate defaults for ContainerPartitionKeySqlResourceSqlContainerResponse */ function containerPartitionKeySqlResourceSqlContainerResponseProvideDefaults(val: ContainerPartitionKeySqlResourceSqlContainerResponse): ContainerPartitionKeySqlResourceSqlContainerResponse; /** * The object representing continuous mode backup policy. */ interface ContinuousModeBackupPolicyResponse { /** * Configuration values for continuous mode backup */ continuousModeProperties?: outputs.cosmosdb.ContinuousModePropertiesResponse; /** * The object representing the state of the migration between the backup policies. */ migrationState?: outputs.cosmosdb.BackupPolicyMigrationStateResponse; /** * Describes the mode of backups. * Expected value is 'Continuous'. */ type: "Continuous"; } /** * Configuration values for periodic mode backup */ interface ContinuousModePropertiesResponse { /** * Enum to indicate type of Continuous backup mode */ tier?: string; } /** * The CORS policy for the Cosmos DB database account. */ interface CorsPolicyResponse { /** * The request headers that the origin domain may specify on the CORS request. */ allowedHeaders?: string; /** * The methods (HTTP request verbs) that the origin domain may use for a CORS request. */ allowedMethods?: string; /** * The origin domains that are permitted to make a request against the service via CORS. */ allowedOrigins: string; /** * The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer. */ exposedHeaders?: string; /** * The maximum amount time that a browser should cache the preflight OPTIONS request. */ maxAgeInSeconds?: number; } /** * Properties of a managed Cassandra data center. */ interface DataCenterResourceResponseProperties { /** * Ldap authentication method properties. This feature is in preview. */ authenticationMethodLdapProperties?: outputs.cosmosdb.AuthenticationMethodLdapPropertiesResponse; /** * If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines. */ availabilityZone?: boolean; /** * Indicates the Key Uri of the customer key to use for encryption of the backup storage account. */ backupStorageCustomerKeyUri?: string; /** * A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed. */ base64EncodedCassandraYamlFragment?: string; /** * The region this data center should be created in. */ dataCenterLocation?: string; /** * Whether the data center has been deallocated. */ deallocated?: boolean; /** * Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'. */ delegatedSubnetId?: string; /** * Number of disks attached to each node. Default is 4. */ diskCapacity?: number; /** * Disk SKU used for data centers. Default value is P30. */ diskSku?: string; /** * Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key. */ managedDiskCustomerKeyUri?: string; /** * The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster. */ nodeCount?: number; /** * Ip of the VPN Endpoint for this data center. */ privateEndpointIpAddress?: string; /** * Error related to resource provisioning. */ provisionError?: outputs.cosmosdb.CassandraErrorResponse; /** * The status of the resource at the time the operation was called. */ provisioningState?: string; /** * IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster. */ seedNodes: outputs.cosmosdb.SeedNodeResponse[]; /** * Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2 */ sku?: string; } /** * Resource for a regional service location. */ interface DataTransferRegionalServiceResourceResponse { /** * The location name. */ location: string; /** * The regional service name. */ name: string; /** * Describes the status of a service. */ status: string; } /** * Properties for DataTransferServiceResource. */ interface DataTransferServiceResourcePropertiesResponse { /** * Time of the last state change (ISO-8601 format). */ creationTime: string; /** * Instance count for the service. */ instanceCount?: number; /** * Instance type for the service. */ instanceSize?: string; /** * An array that contains all of the locations for the service. */ locations: outputs.cosmosdb.DataTransferRegionalServiceResourceResponse[]; /** * ServiceType for the service. * Expected value is 'DataTransfer'. */ serviceType: "DataTransfer"; /** * Describes the status of a service. */ status: string; } /** * Connection string for the Cosmos DB account */ interface DatabaseAccountConnectionStringResponse { /** * Value of the connection string */ connectionString: string; /** * Description of the connection string */ description: string; /** * Kind of the connection string key */ keyKind: string; /** * Type of the connection string */ type: string; } /** * The metadata related to each access key for the given Cosmos DB database account. */ interface DatabaseAccountKeysMetadataResponse { /** * The metadata related to the Primary Read-Write Key for the given Cosmos DB database account. */ primaryMasterKey: outputs.cosmosdb.AccountKeyMetadataResponse; /** * The metadata related to the Primary Read-Only Key for the given Cosmos DB database account. */ primaryReadonlyMasterKey: outputs.cosmosdb.AccountKeyMetadataResponse; /** * The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account. */ secondaryMasterKey: outputs.cosmosdb.AccountKeyMetadataResponse; /** * The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account. */ secondaryReadonlyMasterKey: outputs.cosmosdb.AccountKeyMetadataResponse; } /** * Specific Databases to restore. */ interface DatabaseRestoreResourceResponse { /** * The names of the collections available for restore. */ collectionNames?: string[]; /** * The name of the database available for restore. */ databaseName?: string; } /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.cosmosdb.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.cosmosdb.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } interface ExcludedPathResponse { /** * The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) */ path?: string; } /** * The failover policy for a given region of a database account. */ interface FailoverPolicyResponse { /** * The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists. */ failoverPriority?: number; /** * The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>. */ id: string; /** * The name of the region in which the database account exists. */ locationName?: string; } /** * Configuration for fleetspace Account in the fleetspace. */ interface FleetspaceAccountPropertiesResponseGlobalDatabaseAccountProperties { /** * The location of global database account in the Fleetspace Account. */ armLocation?: string; /** * The resource identifier of global database account in the Fleetspace Account. */ resourceId?: string; } /** * Configuration for throughput pool in the fleetspace. */ interface FleetspacePropertiesResponseThroughputPoolConfiguration { /** * Maximum throughput for the pool. */ maxThroughput?: number; /** * Minimum throughput for the pool. */ minThroughput?: number; } /** * Represents the full text index path. */ interface FullTextIndexPathResponse { /** * The path to the full text field in the document. */ path: string; } /** * Represents the full text path specification. */ interface FullTextPathResponse { /** * The language of the full text field in the document. */ language?: string; /** * The path to the full text field in the document. */ path: string; } /** * Cosmos DB FullText Policy */ interface FullTextPolicyResponse { /** * The default language for a full text paths. */ defaultLanguage?: string; /** * List of FullText Paths */ fullTextPaths?: outputs.cosmosdb.FullTextPathResponse[]; } /** * Endpoint for clients to connect to the cluster. */ interface GarnetClusterResourcePropertiesEndPointsItemResponse { /** * Ipv4 address of the endpoint. */ ipAddress?: string; /** * Port number. */ port?: number; } /** * Properties of a Garnet cache cluster. */ interface GarnetClusterResourcePropertiesResponse { /** * Allocation state of the cluster and data center resources. Active implies the virtual machines of the cluster are allocated, deallocated implies virtual machines and resources are deallocated. */ allocationState?: string; /** * If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the garnet cluster virtual machines. */ availabilityZone?: boolean; /** * Type of the cluster. If set to Production, some operations might not be permitted on cluster. */ clusterType?: string; /** * Endpoints for clients to connect to the cluster. */ endPoints: outputs.cosmosdb.GarnetClusterResourcePropertiesEndPointsItemResponse[]; /** * Extensions to be added or updated on cluster. */ extensions?: string[]; /** * Number of nodes. */ nodeCount?: number; /** * Virtual Machine SKU used for clusters. Default value is Standard_DS14_v2. */ nodeSku?: string; /** * Error related to resource provisioning. */ provisionError?: outputs.cosmosdb.ErrorDetailResponse; /** * The provisioning state of the resource. */ provisioningState: string; /** * Number of copies of data maintained by the cluster. */ replicationFactor?: number; /** * Resource id of a subnet that this cluster's management service should have its network interface attached to. The subnet must be routable to all subnets that will be delegated to data centers. The resource id must be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/' */ subnetId?: string; } /** * Resource for a regional service location. */ interface GraphAPIComputeRegionalServiceResourceResponse { /** * The regional endpoint for GraphAPICompute. */ graphApiComputeEndpoint: string; /** * The location name. */ location: string; /** * The regional service name. */ name: string; /** * Describes the status of a service. */ status: string; } /** * Properties for GraphAPIComputeServiceResource. */ interface GraphAPIComputeServiceResourcePropertiesResponse { /** * Time of the last state change (ISO-8601 format). */ creationTime: string; /** * GraphAPICompute endpoint for the service. */ graphApiComputeEndpoint?: string; /** * Instance count for the service. */ instanceCount?: number; /** * Instance type for the service. */ instanceSize?: string; /** * An array that contains all of the locations for the service. */ locations: outputs.cosmosdb.GraphAPIComputeRegionalServiceResourceResponse[]; /** * ServiceType for the service. * Expected value is 'GraphAPICompute'. */ serviceType: "GraphAPICompute"; /** * Describes the status of a service. */ status: string; } interface GraphResourceGetPropertiesResponseOptions { /** * Specifies the Autoscale settings. */ autoscaleSettings?: outputs.cosmosdb.AutoscaleSettingsResponse; /** * Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details. */ throughput?: number; } interface GraphResourceGetPropertiesResponseResource { /** * Name of the Cosmos DB Graph */ id: string; } interface GremlinDatabaseGetPropertiesResponseOptions { /** * Specifies the Autoscale settings. */ autoscaleSettings?: outputs.cosmosdb.AutoscaleSettingsResponse; /** * Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details. */ throughput?: number; } interface GremlinDatabaseGetPropertiesResponseResource { /** * Enum to indicate the mode of resource creation. */ createMode?: string; /** * A system generated property representing the resource etag required for optimistic concurrency control. */ etag: string; /** * Name of the Cosmos DB Gremlin database */ id: string; /** * Parameters to indicate the information about the restore */ restoreParameters?: outputs.cosmosdb.ResourceRestoreParametersResponse; /** * A system generated property. A unique identifier. */ rid: string; /** * A system generated property that denotes the last updated timestamp of the resource. */ ts: number; } /** * Specific Gremlin Databases to restore. */ interface GremlinDatabaseRestoreResourceResponse { /** * The name of the gremlin database available for restore. */ databaseName?: string; /** * The names of the graphs available for restore. */ graphNames?: string[]; } interface GremlinGraphGetPropertiesResponseOptions { /** * Specifies the Autoscale settings. */ autoscaleSettings?: outputs.cosmosdb.AutoscaleSettingsResponse; /** * Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details. */ throughput?: number; } interface GremlinGraphGetPropertiesResponseResource { /** * Analytical TTL. */ analyticalStorageTtl?: number; /** * The conflict resolution policy for the graph. */ conflictResolutionPolicy?: outputs.cosmosdb.ConflictResolutionPolicyResponse; /** * Enum to indicate the mode of resource creation. */ createMode?: string; /** * Default time to live */ defaultTtl?: number; /** * A system generated property representing the resource etag required for optimistic concurrency control. */ etag: string; /** * Name of the Cosmos DB Gremlin graph */ id: string; /** * The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph */ indexingPolicy?: outputs.cosmosdb.IndexingPolicyGremlinResourceGremlinGraphResponse; /** * The configuration of the partition key to be used for partitioning data into multiple partitions */ partitionKey?: outputs.cosmosdb.ContainerPartitionKeyGremlinResourceGremlinGraphResponse; /** * Parameters to indicate the information about the restore */ restoreParameters?: outputs.cosmosdb.ResourceRestoreParametersResponse; /** * A system generated property. A unique identifier. */ rid: string; /** * A system generated property that denotes the last updated timestamp of the resource. */ ts: number; /** * The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. */ uniqueKeyPolicy?: outputs.cosmosdb.UniqueKeyPolicyResponse; } /** * gremlinGraphGetPropertiesResponseResourceProvideDefaults sets the appropriate defaults for GremlinGraphGetPropertiesResponseResource */ function gremlinGraphGetPropertiesResponseResourceProvideDefaults(val: GremlinGraphGetPropertiesResponseResource): GremlinGraphGetPropertiesResponseResource; /** * The paths that are included in indexing */ interface IncludedPathResponse { /** * List of indexes for this path */ indexes?: outputs.cosmosdb.IndexesResponse[]; /** * The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) */ path?: string; } /** * The indexes for the path. */ interface IndexesResponse { /** * The datatype for which the indexing behavior is applied to. */ dataType?: string; /** * Indicates the type of index. */ kind?: string; /** * The precision of the index. -1 is maximum precision. */ precision?: number; } /** * indexesResponseProvideDefaults sets the appropriate defaults for IndexesResponse */ function indexesResponseProvideDefaults(val: IndexesResponse): IndexesResponse; /** * Cosmos DB indexing policy */ interface IndexingPolicyGremlinResourceGremlinGraphResponse { /** * Indicates if the indexing policy is automatic */ automatic?: boolean; /** * List of composite path list */ compositeIndexes?: outputs.cosmosdb.CompositePathResponse[][]; /** * List of paths to exclude from indexing */ excludedPaths?: outputs.cosmosdb.ExcludedPathResponse[]; /** * List of paths to include in the full text indexing */ fullTextIndexes?: outputs.cosmosdb.FullTextIndexPathResponse[]; /** * List of paths to include in the indexing */ includedPaths?: outputs.cosmosdb.IncludedPathResponse[]; /** * Indicates the indexing mode. */ indexingMode?: string; /** * List of spatial specifics */ spatialIndexes?: outputs.cosmosdb.SpatialSpecResponse[]; /** * List of paths to include in the vector indexing */ vectorIndexes?: outputs.cosmosdb.VectorIndexResponse[]; } /** * indexingPolicyGremlinResourceGremlinGraphResponseProvideDefaults sets the appropriate defaults for IndexingPolicyGremlinResourceGremlinGraphResponse */ function indexingPolicyGremlinResourceGremlinGraphResponseProvideDefaults(val: IndexingPolicyGremlinResourceGremlinGraphResponse): IndexingPolicyGremlinResourceGremlinGraphResponse; /** * Cosmos DB indexing policy */ interface IndexingPolicyResponse { /** * Indicates if the indexing policy is automatic */ automatic?: boolean; /** * List of paths to exclude from indexing */ excludedPaths?: outputs.cosmosdb.ExcludedPathResponse[]; /** * List of paths to include in the indexing */ includedPaths?: outputs.cosmosdb.IncludedPathResponse[]; /** * Indicates the indexing mode. */ indexingMode?: string; } /** * indexingPolicyResponseProvideDefaults sets the appropriate defaults for IndexingPolicyResponse */ function indexingPolicyResponseProvideDefaults(val: IndexingPolicyResponse): IndexingPolicyResponse; /** * Cosmos DB indexing policy */ interface IndexingPolicySqlResourceSqlContainerResponse { /** * Indicates if the indexing policy is automatic */ automatic?: boolean; /** * List of composite path list */ compositeIndexes?: outputs.cosmosdb.CompositePathResponse[][]; /** * List of paths to exclude from indexing */ excludedPaths?: outputs.cosmosdb.ExcludedPathResponse[]; /** * List of paths to include in the full text indexing */ fullTextIndexes?: outputs.cosmosdb.FullTextIndexPathResponse[]; /** * List of paths to include in the indexing */ includedPaths?: outputs.cosmosdb.IncludedPathResponse[]; /** * Indicates the indexing mode. */ indexingMode?: string; /** * List of spatial specifics */ spatialIndexes?: outputs.cosmosdb.SpatialSpecResponse[]; /** * List of paths to include in the vector indexing */ vectorIndexes?: outputs.cosmosdb.VectorIndexResponse[]; } /** * indexingPolicySqlResourceSqlContainerResponseProvideDefaults sets the appropriate defaults for IndexingPolicySqlResourceSqlContainerResponse */ function indexingPolicySqlResourceSqlContainerResponseProvideDefaults(val: IndexingPolicySqlResourceSqlContainerResponse): IndexingPolicySqlResourceSqlContainerResponse; /** * IpAddressOrRange object */ interface IpAddressOrRangeResponse { /** * A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”. */ ipAddressOrRange?: string; } /** * A region in which the Azure Cosmos DB database account is deployed. */ interface LocationResponse { /** * The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/ */ documentEndpoint: string; /** * The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists. */ failoverPriority?: number; /** * The unique identifier of the region within the database account. Example: <accountName>-<locationName>. */ id: string; /** * Flag to indicate whether or not this region is an AvailabilityZone region */ isZoneRedundant?: boolean; /** * The name of the region. */ locationName?: string; /** * The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed. */ provisioningState: string; } /** * Identity for the resource. */ interface ManagedCassandraManagedServiceIdentityResponse { /** * The object id of the identity resource. */ principalId: string; /** * The tenant id of the resource. */ tenantId: string; /** * The type of the resource. */ type?: string; } /** * Identity for the resource. */ interface ManagedServiceIdentityResponse { /** * The principal id of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * The type of identity used for the resource. The type 'SystemAssigned,UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. */ type?: string; /** * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.cosmosdb.ManagedServiceIdentityResponseUserAssignedIdentities; }; } interface ManagedServiceIdentityResponseUserAssignedIdentities { /** * The client id of user assigned identity. */ clientId: string; /** * The principal id of user assigned identity. */ principalId: string; } /** * Resource for a regional service location. */ interface MaterializedViewsBuilderRegionalServiceResourceResponse { /** * The location name. */ location: string; /** * The regional service name. */ name: string; /** * Describes the status of a service. */ status: string; } /** * Properties for MaterializedViewsBuilderServiceResource. */ interface MaterializedViewsBuilderServiceResourcePropertiesResponse { /** * Time of the last state change (ISO-8601 format). */ creationTime: string; /** * Instance count for the service. */ instanceCount?: number; /** * Instance type for the service. */ instanceSize?: string; /** * An array that contains all of the locations for the service. */ locations: outputs.cosmosdb.MaterializedViewsBuilderRegionalServiceResourceResponse[]; /** * ServiceType for the service. * Expected value is 'MaterializedViewsBuilder'. */ serviceType: "MaterializedViewsBuilder"; /** * Describes the status of a service. */ status: string; } interface MongoDBCollectionGetPropertiesResponseOptions { /** * Specifies the Autoscale settings. */ autoscaleSettings?: outputs.cosmosdb.AutoscaleSettingsResponse; /** * Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details. */ throughput?: number; } interface MongoDBCollectionGetPropertiesResponseResource { /** * Analytical TTL. */ analyticalStorageTtl?: number; /** * Enum to indicate the mode of resource creation. */ createMode?: string; /** * A system generated property representing the resource etag required for optimistic concurrency control. */ etag: string; /** * Name of the Cosmos DB MongoDB collection */ id: string; /** * List of index keys */ indexes?: outputs.cosmosdb.MongoIndexResponse[]; /** * Parameters to indicate the information about the restore */ restoreParameters?: outputs.cosmosdb.ResourceRestoreParametersResponse; /** * A system generated property. A unique identifier. */ rid: string; /** * A key-value pair of shard keys to be applied for the request. */ shardKey?: { [key: string]: string; }; /** * A system generated property that denotes the last updated timestamp of the resource. */ ts: number; } interface MongoDBDatabaseGetPropertiesResponseOptions { /** * Specifies the Autoscale settings. */ autoscaleSettings?: outputs.cosmosdb.AutoscaleSettingsResponse; /** * Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details. */ throughput?: number; } interface MongoDBDatabaseGetPropertiesResponseResource { /** * Enum to indicate the mode of resource creation. */ createMode?: string; /** * A system generated property representing the resource etag required for optimistic concurrency control. */ etag: string; /** * Name of the Cosmos DB MongoDB database */ id: string; /** * Parameters to indicate the information about the restore */ restoreParameters?: outputs.cosmosdb.ResourceRestoreParametersResponse; /** * A system generated property. A unique identifier. */ rid: string; /** * A system generated property that denotes the last updated timestamp of the resource. */ ts: number; } /** * Cosmos DB MongoDB collection resource object */ interface MongoIndexKeysResponse { /** * List of keys for each MongoDB collection in the Azure Cosmos DB service */ keys?: string[]; } /** * Cosmos DB MongoDB collection index options */ interface MongoIndexOptionsResponse { /** * Expire after seconds */ expireAfterSeconds?: number; /** * Is unique or not */ unique?: boolean; } /** * Cosmos DB MongoDB collection index key */ interface MongoIndexResponse { /** * Cosmos DB MongoDB collection index keys */ key?: outputs.cosmosdb.MongoIndexKeysResponse; /** * Cosmos DB MongoDB collection index key options */ options?: outputs.cosmosdb.MongoIndexOptionsResponse; } /** * Specification for a node group. */ interface NodeGroupSpecResponse { /** * The disk storage size for the node group in GB. Example values: 128, 256, 512, 1024. */ diskSizeGB?: number; /** * Whether high availability is enabled on the node group. */ enableHa?: boolean; /** * The node type deployed in the node group. */ kind?: string; /** * The number of nodes in the node group. */ nodeCount?: number; /** * The resource sku for the node group. This defines the size of CPU and memory that is provisioned for each node. Example values: 'M30', 'M40'. */ sku?: string; } /** * The object representing periodic mode backup policy. */ interface PeriodicModeBackupPolicyResponse { /** * The object representing the state of the migration between the backup policies. */ migrationState?: outputs.cosmosdb.BackupPolicyMigrationStateResponse; /** * Configuration values for periodic mode backup */ periodicModeProperties?: outputs.cosmosdb.PeriodicModePropertiesResponse; /** * Describes the mode of backups. * Expected value is 'Periodic'. */ type: "Periodic"; } /** * Configuration values for periodic mode backup */ interface PeriodicModePropertiesResponse { /** * An integer representing the interval in minutes between two backups */ backupIntervalInMinutes?: number; /** * An integer representing the time (in hours) that each backup is retained */ backupRetentionIntervalInHours?: number; /** * Enum to indicate type of backup residency */ backupStorageRedundancy?: string; } /** * The set of data plane operations permitted through this Role Definition. */ interface PermissionResponse { /** * An array of data actions that are allowed. */ dataActions?: string[]; /** * The id for the permission. */ id?: string; /** * An array of data actions that are denied. */ notDataActions?: string[]; } /** * The set of data plane operations permitted through this Role Definition. */ interface PermissionSqlResourceSqlRoleDefinitionResponse { /** * An array of data actions that are allowed. */ dataActions?: string[]; /** * An array of data actions that are denied. */ notDataActions?: string[]; } /** * A private endpoint connection */ interface PrivateEndpointConnectionResponse { /** * Group id of the private endpoint. */ groupId?: string; /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * Private endpoint which the connection belongs to. */ privateEndpoint?: outputs.cosmosdb.PrivateEndpointPropertyResponse; /** * Connection State of the Private Endpoint Connection. */ privateLinkServiceConnectionState?: outputs.cosmosdb.PrivateLinkServiceConnectionStatePropertyResponse; /** * Provisioning state of the private endpoint. */ provisioningState?: string; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Private endpoint which the connection belongs to. */ interface PrivateEndpointPropertyResponse { /** * Resource id of the private endpoint. */ id?: string; } /** * Connection State of the Private Endpoint Connection. */ interface PrivateLinkServiceConnectionStatePropertyResponse { /** * Any action that is required beyond basic workflow (approve/ reject/ disconnect) */ actionsRequired: string; /** * The private link service connection description. */ description?: string; /** * The private link service connection status. */ status?: string; } /** * The set of data plane operations permitted through this Role Definition. */ interface PrivilegeResponse { /** * An array of actions that are allowed. */ actions?: string[]; /** * An Azure Cosmos DB Mongo DB Resource. */ resource?: outputs.cosmosdb.PrivilegeResponseResource; } /** * An Azure Cosmos DB Mongo DB Resource. */ interface PrivilegeResponseResource { /** * The collection name the role is applied. */ collection?: string; /** * The database name the role is applied. */ db?: string; } /** * Parameters to indicate the information about the restore. */ interface ResourceRestoreParametersResponse { /** * The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} */ restoreSource?: string; /** * Time to which the account has to be restored (ISO-8601 format). */ restoreTimestampInUtc?: string; /** * Specifies whether the restored account will have Time-To-Live disabled upon the successful restore. */ restoreWithTtlDisabled?: boolean; } /** * Parameters to indicate the information about the restore. */ interface RestoreParametersResponse { /** * List of specific databases available for restore. */ databasesToRestore?: outputs.cosmosdb.DatabaseRestoreResourceResponse[]; /** * List of specific gremlin databases available for restore. */ gremlinDatabasesToRestore?: outputs.cosmosdb.GremlinDatabaseRestoreResourceResponse[]; /** * Describes the mode of the restore. */ restoreMode?: string; /** * The id of the restorable database account from which the restore has to be initiated. For example: /subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} */ restoreSource?: string; /** * Time to which the account has to be restored (ISO-8601 format). */ restoreTimestampInUtc?: string; /** * Specifies whether the restored account will have Time-To-Live disabled upon the successful restore. */ restoreWithTtlDisabled?: boolean; /** * The source backup location for restore. */ sourceBackupLocation?: string; /** * List of specific tables available for restore. */ tablesToRestore?: string[]; } /** * The set of roles permitted through this Role Definition. */ interface RoleResponse { /** * The database name the role is applied. */ db?: string; /** * The role name. */ role?: string; } interface SeedNodeResponse { /** * IP address of this seed node. */ ipAddress?: string; } interface SpatialSpecResponse { /** * The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*) */ path?: string; /** * List of path's spatial type */ types?: string[]; } interface SqlContainerGetPropertiesResponseOptions { /** * Specifies the Autoscale settings. */ autoscaleSettings?: outputs.cosmosdb.AutoscaleSettingsResponse; /** * Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details. */ throughput?: number; } interface SqlContainerGetPropertiesResponseResource { /** * Analytical TTL. */ analyticalStorageTtl?: number; /** * The client encryption policy for the container. */ clientEncryptionPolicy?: outputs.cosmosdb.ClientEncryptionPolicyResponse; /** * List of computed properties */ computedProperties?: outputs.cosmosdb.ComputedPropertyResponse[]; /** * The conflict resolution policy for the container. */ conflictResolutionPolicy?: outputs.cosmosdb.ConflictResolutionPolicyResponse; /** * Enum to indicate the mode of resource creation. */ createMode?: string; /** * Default time to live */ defaultTtl?: number; /** * A system generated property representing the resource etag required for optimistic concurrency control. */ etag: string; /** * The FullText policy for the container. */ fullTextPolicy?: outputs.cosmosdb.FullTextPolicyResponse; /** * Name of the Cosmos DB SQL container */ id: string; /** * The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container */ indexingPolicy?: outputs.cosmosdb.IndexingPolicySqlResourceSqlContainerResponse; /** * The configuration of the partition key to be used for partitioning data into multiple partitions */ partitionKey?: outputs.cosmosdb.ContainerPartitionKeySqlResourceSqlContainerResponse; /** * Parameters to indicate the information about the restore */ restoreParameters?: outputs.cosmosdb.ResourceRestoreParametersResponse; /** * A system generated property. A unique identifier. */ rid: string; /** * A system generated property that denotes the last updated timestamp of the resource. */ ts: number; /** * The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. */ uniqueKeyPolicy?: outputs.cosmosdb.UniqueKeyPolicyResponse; /** * The vector embedding policy for the container. */ vectorEmbeddingPolicy?: outputs.cosmosdb.VectorEmbeddingPolicyResponse; } /** * sqlContainerGetPropertiesResponseResourceProvideDefaults sets the appropriate defaults for SqlContainerGetPropertiesResponseResource */ function sqlContainerGetPropertiesResponseResourceProvideDefaults(val: SqlContainerGetPropertiesResponseResource): SqlContainerGetPropertiesResponseResource; interface SqlDatabaseGetPropertiesResponseOptions { /** * Specifies the Autoscale settings. */ autoscaleSettings?: outputs.cosmosdb.AutoscaleSettingsResponse; /** * Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details. */ throughput?: number; } interface SqlDatabaseGetPropertiesResponseResource { /** * A system generated property that specified the addressable path of the collections resource. */ colls?: string; /** * Enum to indicate the mode of resource creation. */ createMode?: string; /** * A system generated property representing the resource etag required for optimistic concurrency control. */ etag: string; /** * Name of the Cosmos DB SQL database */ id: string; /** * Parameters to indicate the information about the restore */ restoreParameters?: outputs.cosmosdb.ResourceRestoreParametersResponse; /** * A system generated property. A unique identifier. */ rid: string; /** * A system generated property that denotes the last updated timestamp of the resource. */ ts: number; /** * A system generated property that specifies the addressable path of the users resource. */ users?: string; } /** * Resource for a regional service location. */ interface SqlDedicatedGatewayRegionalServiceResourceResponse { /** * The location name. */ location: string; /** * The regional service name. */ name: string; /** * The regional endpoint for SqlDedicatedGateway. */ sqlDedicatedGatewayEndpoint: string; /** * Describes the status of a service. */ status: string; } /** * Properties for SqlDedicatedGatewayServiceResource. */ interface SqlDedicatedGatewayServiceResourcePropertiesResponse { /** * Time of the last state change (ISO-8601 format). */ creationTime: string; /** * DedicatedGatewayType for the service. */ dedicatedGatewayType?: string; /** * Instance count for the service. */ instanceCount?: number; /** * Instance type for the service. */ instanceSize?: string; /** * An array that contains all of the locations for the service. */ locations: outputs.cosmosdb.SqlDedicatedGatewayRegionalServiceResourceResponse[]; /** * ServiceType for the service. * Expected value is 'SqlDedicatedGateway'. */ serviceType: "SqlDedicatedGateway"; /** * SqlDedicatedGateway endpoint for the service. */ sqlDedicatedGatewayEndpoint?: string; /** * Describes the status of a service. */ status: string; } interface SqlStoredProcedureGetPropertiesResponseResource { /** * Body of the Stored Procedure */ body?: string; /** * A system generated property representing the resource etag required for optimistic concurrency control. */ etag: string; /** * Name of the Cosmos DB SQL storedProcedure */ id: string; /** * A system generated property. A unique identifier. */ rid: string; /** * A system generated property that denotes the last updated timestamp of the resource. */ ts: number; } interface SqlTriggerGetPropertiesResponseResource { /** * Body of the Trigger */ body?: string; /** * A system generated property representing the resource etag required for optimistic concurrency control. */ etag: string; /** * Name of the Cosmos DB SQL trigger */ id: string; /** * A system generated property. A unique identifier. */ rid: string; /** * The operation the trigger is associated with */ triggerOperation?: string; /** * Type of the Trigger */ triggerType?: string; /** * A system generated property that denotes the last updated timestamp of the resource. */ ts: number; } interface SqlUserDefinedFunctionGetPropertiesResponseResource { /** * Body of the User Defined Function */ body?: string; /** * A system generated property representing the resource etag required for optimistic concurrency control. */ etag: string; /** * Name of the Cosmos DB SQL userDefinedFunction */ id: string; /** * A system generated property. A unique identifier. */ rid: string; /** * A system generated property that denotes the last updated timestamp of the resource. */ ts: number; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } interface TableGetPropertiesResponseOptions { /** * Specifies the Autoscale settings. */ autoscaleSettings?: outputs.cosmosdb.AutoscaleSettingsResponse; /** * Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details. */ throughput?: number; } interface TableGetPropertiesResponseResource { /** * Enum to indicate the mode of resource creation. */ createMode?: string; /** * A system generated property representing the resource etag required for optimistic concurrency control. */ etag: string; /** * Name of the Cosmos DB table */ id: string; /** * Parameters to indicate the information about the restore */ restoreParameters?: outputs.cosmosdb.ResourceRestoreParametersResponse; /** * A system generated property. A unique identifier. */ rid: string; /** * A system generated property that denotes the last updated timestamp of the resource. */ ts: number; } /** * The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service. */ interface UniqueKeyPolicyResponse { /** * List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. */ uniqueKeys?: outputs.cosmosdb.UniqueKeyResponse[]; } /** * The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service. */ interface UniqueKeyResponse { /** * List of paths must be unique for each document in the Azure Cosmos DB service */ paths?: string[]; } /** * Cosmos DB Vector Embedding Policy */ interface VectorEmbeddingPolicyResponse { /** * List of vector embeddings */ vectorEmbeddings?: outputs.cosmosdb.VectorEmbeddingResponse[]; } /** * Represents a vector embedding. A vector embedding is used to define a vector field in the documents. */ interface VectorEmbeddingResponse { /** * Indicates the data type of vector. */ dataType: string; /** * The number of dimensions in the vector. */ dimensions: number; /** * The distance function to use for distance calculation in between vectors. */ distanceFunction: string; /** * The path to the vector field in the document. */ path: string; } interface VectorIndexResponse { /** * This is the size of the candidate list of approximate neighbors stored while building the DiskANN index as part of the optimization processes. Large values may improve recall at the expense of latency. This is only applicable for the diskANN vector index type. */ indexingSearchListSize?: number; /** * The path to the vector field in the document. */ path: string; /** * The number of bytes used in product quantization of the vectors. A larger value may result in better recall for vector searches at the expense of latency. This is only applicable for the quantizedFlat and diskANN vector index types. */ quantizationByteSize?: number; /** * The index type of the vector. Currently, flat, diskANN, and quantizedFlat are supported. */ type: string; /** * Array of shard keys for the vector index. This is only applicable for the quantizedFlat and diskANN vector index types. */ vectorIndexShardKey?: string[]; } /** * vectorIndexResponseProvideDefaults sets the appropriate defaults for VectorIndexResponse */ function vectorIndexResponseProvideDefaults(val: VectorIndexResponse): VectorIndexResponse; /** * Virtual Network ACL Rule object */ interface VirtualNetworkRuleResponse { /** * Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. */ id?: string; /** * Create firewall rule before the virtual network has vnet service endpoint enabled. */ ignoreMissingVNetServiceEndpoint?: boolean; } } export declare namespace costmanagement { /** * The comparison expression to be used in the budgets. */ interface BudgetComparisonExpressionResponse { /** * The name of the column to use in comparison. */ name: string; /** * The operator to use for comparison. */ operator: string; /** * Array of values to use for comparison */ values: string[]; } /** * The Dimensions or Tags to filter a budget by. * * Supported for CategoryType(s): Cost, ReservationUtilization. */ interface BudgetFilterPropertiesResponse { /** * Has comparison expression for a dimension. * * Supported for CategoryType(s): Cost, ReservationUtilization. * * Supported dimension names for **CategoryType: ReservationUtilization** * - ReservationId * - ReservedResourceType */ dimensions?: outputs.costmanagement.BudgetComparisonExpressionResponse; /** * Has comparison expression for a tag. * * Supported for CategoryType(s): Cost. */ tags?: outputs.costmanagement.BudgetComparisonExpressionResponse; } /** * May be used to filter budgets by user-specified dimensions and/or tags. * * Supported for CategoryType(s): Cost, ReservationUtilization. */ interface BudgetFilterResponse { /** * The logical "AND" expression. Must have at least 2 items. * * Supported for CategoryType(s): Cost. */ and?: outputs.costmanagement.BudgetFilterPropertiesResponse[]; /** * Has comparison expression for a dimension. * * Supported for CategoryType(s): Cost, ReservationUtilization. * * Supported dimension names for **CategoryType: ReservationUtilization** * - ReservationId * - ReservedResourceType */ dimensions?: outputs.costmanagement.BudgetComparisonExpressionResponse; /** * Has comparison expression for a tag. * * Supported for CategoryType(s): Cost. */ tags?: outputs.costmanagement.BudgetComparisonExpressionResponse; } /** * The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate. * * Supported for CategoryType(s): Cost, ReservationUtilization. * * Required for CategoryType(s): Cost, ReservationUtilization. */ interface BudgetTimePeriodResponse { /** * The end date for the budget. * * - Constraints for **CategoryType: Cost** - No constraints. If not provided, we default this to 10 years from the start date. * * - Constraints for **CategoryType: ReservationUtilization** - End date cannot be more than 3 years after the start date. */ endDate?: string; /** * The start date for the budget. * * - Constraints for **CategoryType: Cost** - Must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. * * - Constraints for **CategoryType: ReservationUtilization** - Must be on or after the current date and less than the end date. */ startDate: string; } /** * The common properties of the export. */ interface CommonExportPropertiesResponse { /** * Has the definition for the export. */ definition: outputs.costmanagement.ExportDefinitionResponse; /** * Has delivery information for the export. */ deliveryInfo: outputs.costmanagement.ExportDeliveryInfoResponse; /** * The format of the export being delivered. Currently only 'Csv' is supported. */ format?: string; /** * If the export has an active schedule, provides an estimate of the next run time. */ nextRunTimeEstimate: string; /** * If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file. Note: this option is currently available only for Microsoft Customer Agreement commerce scopes. */ partitionData?: boolean; /** * If requested, has the most recent run history for the export. */ runHistory?: outputs.costmanagement.ExportExecutionListResultResponse; } /** * Details of any error encountered on last collection attempt */ interface ConnectorCollectionErrorInfoConnectorResponse { /** * Short error message */ errorCode: string; /** * Detailed error message */ errorMessage: string; /** * Time the error started occurring (Last time error occurred in lastRun) */ errorStartTime: string; } /** * Details of any error encountered on last collection attempt */ interface ConnectorCollectionErrorInfoResponse { /** * Short error code */ errorCode: string; /** * External Provider error message */ errorInnerMessage: string; /** * Detailed error message */ errorMessage: string; /** * Time the error started occurring (Last time error occurred in lastChecked) */ errorStartTime: string; } /** * Collection and ingestion information */ interface ConnectorCollectionInfoConnectorResponse { /** * Error information of last collection */ error?: outputs.costmanagement.ConnectorCollectionErrorInfoConnectorResponse; /** * Last time the data acquisition process completed (even if no new data was found) */ lastRun: string; /** * Last time the external data was updated into Azure */ lastUpdated: string; /** * Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) */ sourceLastUpdated: string; } /** * Collection and ingestion information */ interface ConnectorCollectionInfoResponse { /** * Error information of last collection */ error?: outputs.costmanagement.ConnectorCollectionErrorInfoResponse; /** * Last time the data acquisition process initiated connecting to the external provider */ lastChecked: string; /** * Last time the external data was updated into Azure */ lastUpdated: string; /** * Source timestamp of external data currently available in Azure (eg AWS last processed CUR file timestamp) */ sourceLastUpdated: string; } /** * Target resources and allocation */ interface CostAllocationProportionResponse { /** * Target resource for cost allocation */ name: string; /** * Percentage of source cost to allocate to this resource. This value can be specified to two decimal places and the total percentage of all resources in this rule must sum to 100.00. */ percentage: number; } /** * Resource details of the cost allocation rule */ interface CostAllocationRuleDetailsResponse { /** * Source resources for cost allocation. At this time, this list can contain no more than one element. */ sourceResources?: outputs.costmanagement.SourceCostAllocationResourceResponse[]; /** * Target resources for cost allocation. At this time, this list can contain no more than one element. */ targetResources?: outputs.costmanagement.TargetCostAllocationResourceResponse[]; } /** * The properties of a cost allocation rule */ interface CostAllocationRulePropertiesResponse { /** * Time at which the rule was created. Rules that change cost for the same resource are applied in order of creation. */ createdDate: string; /** * Description of a cost allocation rule. */ description?: string; /** * Resource information for the cost allocation rule */ details: outputs.costmanagement.CostAllocationRuleDetailsResponse; /** * Status of the rule */ status: string; /** * Time at which the rule was last updated. */ updatedDate: string; } /** * The current amount of cost which is being tracked for a budget. * * Supported for CategoryType(s): Cost. */ interface CurrentSpendResponse { /** * The total amount of cost which is being tracked by the budget. */ amount: number; /** * The unit of measure for the budget amount. */ unit: string; } /** * The customer billing metadata */ interface CustomerMetadataResponse { /** * Customer billing account id */ billingAccountId: string; /** * Customer billing profile id */ billingProfileId: string; } /** * The details of the error. */ interface ErrorDetailsResponse { /** * Error code. */ code: string; /** * Error message indicating why the operation failed. */ message: string; } /** * The export dataset configuration. Allows columns to be selected for the export. If not provided then the export will include all available columns. */ interface ExportDatasetConfigurationResponse { /** * Array of column names to be included in the export. If not provided then the export will include all available columns. The available columns can vary by customer channel (see examples). */ columns?: string[]; } /** * The definition for data in the export. */ interface ExportDatasetResponse { /** * The export dataset configuration. */ configuration?: outputs.costmanagement.ExportDatasetConfigurationResponse; /** * The granularity of rows in the export. Currently only 'Daily' is supported. */ granularity?: string; } /** * The definition of an export. */ interface ExportDefinitionResponse { /** * The definition for data in the export. */ dataSet?: outputs.costmanagement.ExportDatasetResponse; /** * Has time period for pulling data for the export. */ timePeriod?: outputs.costmanagement.ExportTimePeriodResponse; /** * The time frame for pulling data for the export. If custom, then a specific time period must be provided. */ timeframe: string; /** * The type of the export. Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations. */ type: string; } /** * This represents the blob storage account location where exports of costs will be delivered. There are two ways to configure the destination. The approach recommended for most customers is to specify the resourceId of the storage account. This requires a one-time registration of the account's subscription with the Microsoft.CostManagementExports resource provider in order to give Cost Management services access to the storage. When creating an export in the Azure portal this registration is performed automatically but API users may need to register the subscription explicitly (for more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Another way to configure the destination is available ONLY to Partners with a Microsoft Partner Agreement plan who are global admins of their billing account. These Partners, instead of specifying the resourceId of a storage account, can specify the storage account name along with a SAS token for the account. This allows exports of costs to a storage account in any tenant. The SAS token should be created for the blob service with Service/Container/Object resource types and with Read/Write/Delete/List/Add/Create permissions (for more information see https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ). */ interface ExportDeliveryDestinationResponse { /** * The name of the container where exports will be uploaded. If the container does not exist it will be created. */ container: string; /** * The resource id of the storage account where exports will be delivered. This is not required if a sasToken and storageAccount are specified. */ resourceId?: string; /** * The name of the directory where exports will be uploaded. */ rootFolderPath?: string; /** * A SAS token for the storage account. For a restricted set of Azure customers this together with storageAccount can be specified instead of resourceId. Note: the value returned by the API for this property will always be obfuscated. Returning this same obfuscated value will not result in the SAS token being updated. To update this value a new SAS token must be specified. */ sasToken?: string; /** * The storage account where exports will be uploaded. For a restricted set of Azure customers this together with sasToken can be specified instead of resourceId. */ storageAccount?: string; } /** * The delivery information associated with a export. */ interface ExportDeliveryInfoResponse { /** * Has destination for the export being delivered. */ destination: outputs.costmanagement.ExportDeliveryDestinationResponse; } /** * Result of listing the run history of an export. */ interface ExportExecutionListResultResponse { /** * A list of export runs. */ value: outputs.costmanagement.ExportRunResponse[]; } /** * The start and end date for recurrence schedule. */ interface ExportRecurrencePeriodResponse { /** * The start date of recurrence. */ from: string; /** * The end date of recurrence. */ to?: string; } /** * An export run. */ interface ExportRunResponse { /** * eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not. */ eTag?: string; /** * The details of any error. */ error?: outputs.costmanagement.ErrorDetailsResponse; /** * The type of the export run. */ executionType?: string; /** * The name of the exported file. */ fileName?: string; /** * Resource Id. */ id: string; /** * Resource name. */ name: string; /** * The time when the export run finished. */ processingEndTime?: string; /** * The time when export was picked up to be run. */ processingStartTime?: string; /** * The export settings that were in effect for this run. */ runSettings?: outputs.costmanagement.CommonExportPropertiesResponse; /** * The last known status of the export run. */ status?: string; /** * The identifier for the entity that triggered the export. For on-demand runs it is the user email. For scheduled runs it is 'System'. */ submittedBy?: string; /** * The time when export was queued to be run. */ submittedTime?: string; /** * Resource type. */ type: string; } /** * The schedule associated with the export. */ interface ExportScheduleResponse { /** * The schedule recurrence. */ recurrence?: string; /** * Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. */ recurrencePeriod?: outputs.costmanagement.ExportRecurrencePeriodResponse; /** * The status of the export's schedule. If 'Inactive', the export's schedule is paused. */ status?: string; } /** * The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months. */ interface ExportTimePeriodResponse { /** * The start date for export data. */ from: string; /** * The end date for export data. */ to: string; } /** * Destination of the view data. This is optional. Currently only CSV format is supported. */ interface FileDestinationResponse { /** * Destination of the view data. Currently only CSV format is supported. */ fileFormats?: string[]; } /** * The forecasted cost which is being tracked for a budget. * * Supported for CategoryType(s): Cost. */ interface ForecastSpendResponse { /** * The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type. */ amount: number; /** * The unit of measure for the budget amount. */ unit: string; } /** * Each KPI must contain a 'type' and 'enabled' key. */ interface KpiPropertiesResponse { /** * show the KPI in the UI? */ enabled?: boolean; /** * ID of resource related to metric (budget). */ id?: string; /** * KPI type (Forecast, Budget). */ type?: string; } /** * The properties of the scheduled action notification. */ interface NotificationPropertiesResponse { /** * Locale of the email. */ language?: string; /** * Optional message to be added in the email. Length is limited to 250 characters. */ message?: string; /** * Regional format used for formatting date/time and currency values in the email. */ regionalFormat?: string; /** * Subject of the email. Length is limited to 70 characters. */ subject: string; /** * Array of email addresses. */ to: string[]; } /** * The notification associated with a budget. * * Supported for CategoryType(s): Cost, ReservationUtilization. */ interface NotificationResponse { /** * Email addresses to send the notification to when the threshold is breached. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified. * * Supported for CategoryType(s): Cost, ReservationUtilization. */ contactEmails: string[]; /** * Subscription or Resource Group scopes only. Action groups to send the notification to when the threshold is exceeded. Must be provided as a fully qualified Azure resource id. * * Supported for CategoryType(s): Cost. */ contactGroups?: string[]; /** * Subscription or Resource Group scopes only. Contact roles to send the notification to when the threshold is breached. * * Supported for CategoryType(s): Cost. */ contactRoles?: string[]; /** * The notification is enabled or not. * * Supported for CategoryType(s): Cost, ReservationUtilization. */ enabled: boolean; /** * Frequency of a notification. Represents how long the notification will be silent after triggering an alert for a threshold breach. If not specified, the frequency will be set by default based on the timeGrain (Weekly when timeGrain: Last7Days, Monthly when timeGrain: Last30Days). * * Supported for CategoryType(s): ReservationUtilization. */ frequency?: string; /** * Language in which the recipient will receive the notification, * * Supported for CategoryType(s): Cost, ReservationUtilization. */ locale?: string; /** * The comparison operator. * * Supported for CategoryType(s): Cost, ReservationUtilization. * * Supported operators for **CategoryType: Cost** * - GreaterThan * - GreaterThanOrEqualTo * * Supported operators for **CategoryType: ReservationUtilization** * - LessThan */ operator: string; /** * Threshold value associated with a notification. It is always percent with a maximum of 2 decimal places. * * Supported for CategoryType(s): Cost, ReservationUtilization. * * **CategoryType: Cost** - Must be between 0 and 1000. Notification is sent when the cost exceeded the threshold. * * **CategoryType: ReservationUtilization** - Must be between 0 and 100. Notification is sent when a reservation has a utilization percentage below the threshold. */ threshold: number; /** * The type of threshold. * * Supported for CategoryType(s): Cost. */ thresholdType?: string; } /** * notificationResponseProvideDefaults sets the appropriate defaults for NotificationResponse */ function notificationResponseProvideDefaults(val: NotificationResponse): NotificationResponse; /** * Each pivot must contain a 'type' and 'name'. */ interface PivotPropertiesResponse { /** * Data field to show in view. */ name?: string; /** * Data type to show in view. */ type?: string; } /** * The aggregation expression to be used in the report. */ interface ReportAggregationResponse { /** * The name of the aggregation function to use. */ function: string; /** * The name of the column to aggregate. */ name: string; } /** * The comparison expression to be used in the report. */ interface ReportComparisonExpressionResponse { /** * The name of the column to use in comparison. */ name: string; /** * The operator to use for comparison. */ operator: string; /** * Array of values to use for comparison */ values: string[]; } /** * The aggregation expression to be used in the report. */ interface ReportConfigAggregationResponse { /** * The name of the aggregation function to use. */ function: string; /** * The name of the column to aggregate. */ name: string; } /** * The comparison expression to be used in the report. */ interface ReportConfigComparisonExpressionResponse { /** * The name of the column to use in comparison. */ name: string; /** * The operator to use for comparison. */ operator: string; /** * Array of values to use for comparison */ values: string[]; } /** * The configuration of dataset in the report. */ interface ReportConfigDatasetConfigurationResponse { /** * Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. */ columns?: string[]; } /** * The definition of data present in the report. */ interface ReportConfigDatasetResponse { /** * Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses. */ aggregation?: { [key: string]: outputs.costmanagement.ReportConfigAggregationResponse; }; /** * Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided. */ configuration?: outputs.costmanagement.ReportConfigDatasetConfigurationResponse; /** * Has filter expression to use in the report. */ filter?: outputs.costmanagement.ReportConfigFilterResponse; /** * The granularity of rows in the report. */ granularity?: string; /** * Array of group by expression to use in the report. Report can have up to 2 group by clauses. */ grouping?: outputs.costmanagement.ReportConfigGroupingResponse[]; /** * Array of order by expression to use in the report. */ sorting?: outputs.costmanagement.ReportConfigSortingResponse[]; } /** * The filter expression to be used in the report. */ interface ReportConfigFilterResponse { /** * The logical "AND" expression. Must have at least 2 items. */ and?: outputs.costmanagement.ReportConfigFilterResponse[]; /** * Has comparison expression for a dimension */ dimensions?: outputs.costmanagement.ReportConfigComparisonExpressionResponse; /** * The logical "OR" expression. Must have at least 2 items. */ or?: outputs.costmanagement.ReportConfigFilterResponse[]; /** * Has comparison expression for a tag */ tags?: outputs.costmanagement.ReportConfigComparisonExpressionResponse; } /** * The group by expression to be used in the report. */ interface ReportConfigGroupingResponse { /** * The name of the column to group. This version supports subscription lowest possible grain. */ name: string; /** * Has type of the column to group. */ type: string; } /** * The order by expression to be used in the report. */ interface ReportConfigSortingResponse { /** * Direction of sort. */ direction?: string; /** * The name of the column to sort. */ name: string; } /** * The start and end date for pulling data for the report. */ interface ReportConfigTimePeriodResponse { /** * The start date to pull data from. */ from: string; /** * The end date to pull data to. */ to: string; } /** * The configuration of dataset in the report. */ interface ReportDatasetConfigurationResponse { /** * Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns. */ columns?: string[]; } /** * The definition of data present in the report. */ interface ReportDatasetResponse { /** * Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses. */ aggregation?: { [key: string]: outputs.costmanagement.ReportAggregationResponse; }; /** * Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided. */ configuration?: outputs.costmanagement.ReportDatasetConfigurationResponse; /** * Has filter expression to use in the report. */ filter?: outputs.costmanagement.ReportFilterResponse; /** * The granularity of rows in the report. */ granularity?: string; /** * Array of group by expression to use in the report. Report can have up to 2 group by clauses. */ grouping?: outputs.costmanagement.ReportGroupingResponse[]; } /** * The definition of a report. */ interface ReportDefinitionResponse { /** * Has definition for data in this report. */ dataset?: outputs.costmanagement.ReportDatasetResponse; /** * Has time period for pulling data for the report. */ timePeriod?: outputs.costmanagement.ReportTimePeriodResponse; /** * The time frame for pulling data for the report. If custom, then a specific time period must be provided. */ timeframe: string; /** * The type of the report. */ type: string; } /** * The destination information for the delivery of the report. */ interface ReportDeliveryDestinationResponse { /** * The name of the container where reports will be uploaded. */ container: string; /** * The resource id of the storage account where reports will be delivered. */ resourceId: string; /** * The name of the directory where reports will be uploaded. */ rootFolderPath?: string; } /** * The delivery information associated with a report. */ interface ReportDeliveryInfoResponse { /** * Has destination for the report being delivered. */ destination: outputs.costmanagement.ReportDeliveryDestinationResponse; } /** * The filter expression to be used in the report. */ interface ReportFilterResponse { /** * The logical "AND" expression. Must have at least 2 items. */ and?: outputs.costmanagement.ReportFilterResponse[]; /** * Has comparison expression for a dimension */ dimension?: outputs.costmanagement.ReportComparisonExpressionResponse; /** * The logical "NOT" expression. */ not?: outputs.costmanagement.ReportFilterResponse; /** * The logical "OR" expression. Must have at least 2 items. */ or?: outputs.costmanagement.ReportFilterResponse[]; /** * Has comparison expression for a tag */ tag?: outputs.costmanagement.ReportComparisonExpressionResponse; } /** * The group by expression to be used in the report. */ interface ReportGroupingResponse { /** * The name of the column to group. */ name: string; /** * Has type of the column to group. */ type: string; } /** * The start and end date for recurrence schedule. */ interface ReportRecurrencePeriodResponse { /** * The start date of recurrence. */ from: string; /** * The end date of recurrence. */ to?: string; } /** * The schedule associated with a report. */ interface ReportScheduleResponse { /** * The schedule recurrence. */ recurrence: string; /** * Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date. */ recurrencePeriod?: outputs.costmanagement.ReportRecurrencePeriodResponse; /** * The status of the schedule. Whether active or not. If inactive, the report's scheduled execution is paused. */ status?: string; } /** * The start and end date for pulling data for the report. */ interface ReportTimePeriodResponse { /** * The start date to pull data from. */ from: string; /** * The end date to pull data to. */ to: string; } /** * The properties of the schedule. */ interface SchedulePropertiesResponse { /** * UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek. */ dayOfMonth?: number; /** * Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly. */ daysOfWeek?: string[]; /** * The end date and time of the scheduled action (UTC). */ endDate: string; /** * Frequency of the schedule. */ frequency: string; /** * UTC time at which cost analysis data will be emailed. */ hourOfDay?: number; /** * The start date and time of the scheduled action (UTC). */ startDate: string; /** * Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek. */ weeksOfMonth?: string[]; } interface SettingsPropertiesResponseCache { /** * Indicates the account type. Allowed values include: EA, PAYG, Modern, Internal, Unknown. */ channel: string; /** * Resource ID used by Resource Manager to uniquely identify the scope. */ id: string; /** * Display name for the scope. */ name: string; /** * Resource ID of the parent scope. For instance, subscription's resource ID for a resource group or a management group resource ID for a subscription. */ parent?: string; /** * Indicates the status of the scope. Status only applies to subscriptions and billing accounts. */ status?: string; /** * Indicates the type of modern account. Allowed values include: Individual, Enterprise, Partner, Indirect, NotApplicable */ subchannel: string; } /** * Source resources for cost allocation */ interface SourceCostAllocationResourceResponse { /** * If resource type is dimension, this must be either ResourceGroupName or SubscriptionId. If resource type is tag, this must be a valid Azure tag */ name: string; /** * Type of resources contained in this cost allocation rule */ resourceType: string; /** * Source Resources for cost allocation. This list cannot contain more than 25 values. */ values: string[]; } /** * Managed service identity (either system assigned, or none) */ interface SystemAssignedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (either system assigned, or none). */ type: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The properties of the tag inheritance setting. */ interface TagInheritancePropertiesResponse { /** * This property defines the behavior when an inherited tag being applied matches a lower scope tag (Eg. Subscription tag matches the resource tag). If set to true - when tags match, the highest scope tags will be applied. Billing profile is the highest scope, followed by invoice sections, subscriptions and resource groups (allows overriding of lower scope tag values). If set to false - when tags match, the lowest scope tags will be applied. So, if a resource has the same tag as a subscription tag, the resource tag will be applied (does not allow overriding of lower scope tag values). */ preferContainerTags: boolean; } /** * Target resources for cost allocation. */ interface TargetCostAllocationResourceResponse { /** * If resource type is dimension, this must be either ResourceGroupName or SubscriptionId. If resource type is tag, this must be a valid Azure tag */ name: string; /** * Method of cost allocation for the rule */ policyType: string; /** * Type of resources contained in this cost allocation rule */ resourceType: string; /** * Target resources for cost allocation. This list cannot contain more than 25 values. */ values: outputs.costmanagement.CostAllocationProportionResponse[]; } } export declare namespace customerinsights { /** * The AssignmentPrincipal */ interface AssignmentPrincipalResponse { /** * The principal id being assigned to. */ principalId: string; /** * Other metadata for the principal. */ principalMetadata?: { [key: string]: string; }; /** * The Type of the principal ID. */ principalType: string; } /** * Definition of canonical profile. */ interface CanonicalProfileDefinitionResponse { /** * Canonical profile ID. */ canonicalProfileId?: number; /** * Properties of the canonical profile. */ properties?: outputs.customerinsights.CanonicalProfileDefinitionResponseProperties[]; } /** * The definition of a canonical profile property. */ interface CanonicalProfileDefinitionResponseProperties { /** * Profile name. */ profileName?: string; /** * Property name of profile. */ profilePropertyName?: string; /** * The rank. */ rank?: number; /** * Type of canonical property value. */ type?: string; /** * Value of the canonical property. */ value?: string; } /** * Connector mapping property availability. */ interface ConnectorMappingAvailabilityResponse { /** * The frequency to update. */ frequency?: string; /** * The interval of the given frequency to use. */ interval: number; } /** * The complete operation. */ interface ConnectorMappingCompleteOperationResponse { /** * The type of completion operation. */ completionOperationType?: string; /** * The destination folder where files will be moved to once the import is done. */ destinationFolder?: string; } /** * The error management. */ interface ConnectorMappingErrorManagementResponse { /** * The error limit allowed while importing data. */ errorLimit?: number; /** * The type of error management to use for the mapping. */ errorManagementType: string; } /** * Connector mapping property format. */ interface ConnectorMappingFormatResponse { /** * The oData language. */ acceptLanguage?: string; /** * Character separating array elements. */ arraySeparator?: string; /** * The character that signifies a break between columns. */ columnDelimiter?: string; /** * The type mapping format. */ formatType: string; /** * Quote character, used to indicate enquoted fields. */ quoteCharacter?: string; /** * Escape character for quotes, can be the same as the quoteCharacter. */ quoteEscapeCharacter?: string; } /** * The connector mapping properties. */ interface ConnectorMappingPropertiesResponse { /** * The availability of mapping property. */ availability: outputs.customerinsights.ConnectorMappingAvailabilityResponse; /** * The operation after import is done. */ completeOperation: outputs.customerinsights.ConnectorMappingCompleteOperationResponse; /** * The error management setting for the mapping. */ errorManagement: outputs.customerinsights.ConnectorMappingErrorManagementResponse; /** * The file filter for the mapping. */ fileFilter?: string; /** * The folder path for the mapping. */ folderPath?: string; /** * The format of mapping property. */ format: outputs.customerinsights.ConnectorMappingFormatResponse; /** * If the file contains a header or not. */ hasHeader?: boolean; /** * Ingestion mapping information at property level. */ structure: outputs.customerinsights.ConnectorMappingStructureResponse[]; } /** * Connector mapping property structure. */ interface ConnectorMappingStructureResponse { /** * The column name of the import file. */ columnName: string; /** * Custom format specifier for input parsing. */ customFormatSpecifier?: string; /** * Indicates if the column is encrypted. */ isEncrypted?: boolean; /** * The property name of the mapping entity. */ propertyName: string; } /** * The data source precedence is a way to know the precedence of each data source. */ interface DataSourcePrecedenceResponse { /** * The data source reference id. */ dataSourceReferenceId: string; /** * The data source type. */ dataSourceType: string; /** * The data source ID. */ id: number; /** * The data source name */ name: string; /** * the precedence value. */ precedence?: number; /** * The data source status. */ status: string; } /** * Hub billing info. */ interface HubBillingInfoFormatResponse { /** * The maximum number of units can be used. One unit is 10,000 Profiles and 100,000 Interactions. */ maxUnits?: number; /** * The minimum number of units will be billed. One unit is 10,000 Profiles and 100,000 Interactions. */ minUnits?: number; /** * The sku name. */ skuName?: string; } /** * The KPI alias. */ interface KpiAliasResponse { /** * KPI alias name. */ aliasName: string; /** * The expression. */ expression: string; } /** * The KPI extract. */ interface KpiExtractResponse { /** * The expression. */ expression: string; /** * KPI extract name. */ extractName: string; } /** * The KPI GroupBy field metadata. */ interface KpiGroupByMetadataResponse { /** * The display name. */ displayName?: { [key: string]: string; }; /** * The name of the field. */ fieldName?: string; /** * The type of the field. */ fieldType?: string; } /** * The KPI participant profile metadata. */ interface KpiParticipantProfilesMetadataResponse { /** * Name of the type. */ typeName: string; } /** * Defines the KPI Threshold limits. */ interface KpiThresholdsResponse { /** * Whether or not the KPI is an increasing KPI. */ increasingKpi: boolean; /** * The lower threshold limit. */ lowerLimit: number; /** * The upper threshold limit. */ upperLimit: number; } /** * The participant profile property reference. */ interface ParticipantProfilePropertyReferenceResponse { /** * The source interaction property that maps to the target profile property. */ interactionPropertyName: string; /** * The target profile property that maps to the source interaction property. */ profilePropertyName: string; } /** * The participant property reference. */ interface ParticipantPropertyReferenceResponse { /** * The source property that maps to the target property. */ sourcePropertyName: string; /** * The target property that maps to the source property. */ targetPropertyName: string; } /** * The definition of the prediction distribution. */ interface PredictionDistributionDefinitionResponse { /** * Distributions of the prediction. */ distributions?: outputs.customerinsights.PredictionDistributionDefinitionResponseDistributions[]; /** * Total negatives in the distribution. */ totalNegatives?: number; /** * Total positive in the distribution. */ totalPositives?: number; } /** * The definition of a prediction distribution. */ interface PredictionDistributionDefinitionResponseDistributions { /** * Number of negatives. */ negatives?: number; /** * Number of negatives above threshold. */ negativesAboveThreshold?: number; /** * Number of positives. */ positives?: number; /** * Number of positives above threshold. */ positivesAboveThreshold?: number; /** * Score threshold. */ scoreThreshold?: number; } /** * The definition of a prediction grade. */ interface PredictionResponseGrades { /** * Name of the grade. */ gradeName?: string; /** * Maximum score threshold. */ maxScoreThreshold?: number; /** * Minimum score threshold. */ minScoreThreshold?: number; } /** * Definition of the link mapping of prediction. */ interface PredictionResponseMappings { /** * The grade of the link mapping. */ grade: string; /** * The reason of the link mapping. */ reason: string; /** * The score of the link mapping. */ score: string; } /** * System generated entities. */ interface PredictionResponseSystemGeneratedEntities { /** * Generated interaction types. */ generatedInteractionTypes?: string[]; /** * Generated KPIs. */ generatedKpis?: { [key: string]: string; }; /** * Generated links. */ generatedLinks?: string[]; } /** * Valid enum values in case of an enum property. */ interface ProfileEnumValidValuesFormatResponse { /** * Localized names of the enum member. */ localizedValueNames?: { [key: string]: string; }; /** * The integer value of the enum member. */ value?: number; } /** * Property definition. */ interface PropertyDefinitionResponse { /** * Array value separator for properties with isArray set. */ arrayValueSeparator?: string; /** * This is specific to interactions modeled as activities. Data sources are used to determine where data is stored and also in precedence rules. */ dataSourcePrecedenceRules: outputs.customerinsights.DataSourcePrecedenceResponse[]; /** * Describes valid values for an enum property. */ enumValidValues?: outputs.customerinsights.ProfileEnumValidValuesFormatResponse[]; /** * Name of the property. */ fieldName: string; /** * Type of the property. */ fieldType: string; /** * Indicates if the property is actually an array of the fieldType above on the data api. */ isArray?: boolean; /** * Whether property is available in graph or not. */ isAvailableInGraph?: boolean; /** * Indicates if the property is an enum. */ isEnum?: boolean; /** * Indicates if the property is an flag enum. */ isFlagEnum?: boolean; /** * Whether the property is an Image. */ isImage?: boolean; /** * Whether the property is a localized string. */ isLocalizedString?: boolean; /** * Whether the property is a name or a part of name. */ isName?: boolean; /** * Whether property value is required on instances, IsRequired field only for Interaction. Profile Instance will not check for required field. */ isRequired?: boolean; /** * Max length of string. Used only if type is string. */ maxLength?: number; /** * The ID associated with the property. */ propertyId?: string; /** * URL encoded schema.org item prop link for the property. */ schemaItemPropLink?: string; } /** * The fields mapping for Relationships. */ interface RelationshipLinkFieldMappingResponse { /** * The field name on the Interaction Type. */ interactionFieldName: string; /** * Link type. */ linkType?: string; /** * The field name on the Relationship metadata. */ relationshipFieldName: string; } /** * Map a field of profile to its corresponding StrongId in Related Profile. */ interface RelationshipTypeFieldMappingResponse { /** * Specifies the fieldName in profile. */ profileFieldName: string; /** * Specifies the KeyProperty (from StrongId) of the related profile. */ relatedProfileKeyProperty: string; } /** * Maps fields in Profile to their corresponding StrongIds in Related Profile. */ interface RelationshipTypeMappingResponse { /** * Maps a profile property with the StrongId of related profile. This is an array to support StrongIds that are composite key as well. */ fieldMappings: outputs.customerinsights.RelationshipTypeFieldMappingResponse[]; } /** * The resource set description. */ interface ResourceSetDescriptionResponse { /** * The elements included in the set. */ elements?: string[]; /** * The elements that are not included in the set, in case elements contains '*' indicating 'all'. */ exceptions?: string[]; } /** * Property/Properties which represent a unique ID. */ interface StrongIdResponse { /** * Localized descriptions. */ description?: { [key: string]: string; }; /** * Localized display name. */ displayName?: { [key: string]: string; }; /** * The properties which make up the unique ID. */ keyPropertyNames: string[]; /** * The Name identifying the strong ID. */ strongIdName: string; } /** * Metadata for a Link's property mapping. */ interface TypePropertiesMappingResponse { /** * Link type. */ linkType?: string; /** * Property name on the source Entity Type. */ sourcePropertyName: string; /** * Property name on the target Entity Type. */ targetPropertyName: string; } } export declare namespace customproviders { /** * The route definition for an action implemented by the custom resource provider. */ interface CustomRPActionRouteDefinitionResponse { /** * The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}') */ endpoint: string; /** * The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') */ name: string; /** * The routing types that are supported for action requests. */ routingType?: string; } /** * The route definition for a resource implemented by the custom resource provider. */ interface CustomRPResourceTypeRouteDefinitionResponse { /** * The route definition endpoint URI that the custom resource provider will proxy requests to. This can be in the form of a flat URI (e.g. 'https://testendpoint/') or can specify to route via a path (e.g. 'https://testendpoint/{requestPath}') */ endpoint: string; /** * The name of the route definition. This becomes the name for the ARM extension (e.g. '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{name}') */ name: string; /** * The routing types that are supported for resource requests. */ routingType?: string; } /** * A validation to apply on custom resource provider requests. */ interface CustomRPValidationsResponse { /** * A link to the validation specification. The specification must be hosted on raw.githubusercontent.com. */ specification: string; /** * The type of validation to run against a matching request. */ validationType?: string; } } export declare namespace dashboard { /** * Integrations for Azure Monitor Workspace. */ interface AzureMonitorWorkspaceIntegrationResponse { /** * The resource Id of the connected Azure Monitor Workspace. */ azureMonitorWorkspaceResourceId?: string; } /** * Properties specific to the dashboard definition. */ interface DashboardDefinitionPropertiesResponse { /** * The provisioning state of the dashboard definition resource. */ provisioningState: string; /** * The dashboard definition data in JSON format. */ serializedData?: string; } /** * Enterprise settings of a Grafana instance */ interface EnterpriseConfigurationsResponse { /** * The AutoRenew setting of the Enterprise subscription */ marketplaceAutoRenew?: string; /** * The Plan Id of the Azure Marketplace subscription for the Enterprise plugins */ marketplacePlanId?: string; } /** * Server configurations of a Grafana instance */ interface GrafanaConfigurationsResponse { /** * Grafana security settings */ security?: outputs.dashboard.SecurityResponse; /** * Email server settings. * https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp */ smtp?: outputs.dashboard.SmtpResponse; /** * Grafana Snapshots settings */ snapshots?: outputs.dashboard.SnapshotsResponse; /** * Grafana users settings */ users?: outputs.dashboard.UsersResponse; } /** * grafanaConfigurationsResponseProvideDefaults sets the appropriate defaults for GrafanaConfigurationsResponse */ function grafanaConfigurationsResponseProvideDefaults(val: GrafanaConfigurationsResponse): GrafanaConfigurationsResponse; /** * GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios. */ interface GrafanaIntegrationsResponse { azureMonitorWorkspaceIntegrations?: outputs.dashboard.AzureMonitorWorkspaceIntegrationResponse[]; } /** * Plugin of Grafana */ interface GrafanaPluginResponse { /** * Grafana plugin id */ pluginId: string; } interface IntegrationFabricPropertiesResponse { /** * The resource Id of the Azure resource which is used to configure Grafana data source. E.g., an Azure Monitor Workspace, an Azure Data Explorer cluster, etc. */ dataSourceResourceId?: string; /** * Provisioning state of the resource. */ provisioningState: string; /** * A list of integration scenarios covered by this integration fabric */ scenarios?: string[]; /** * The resource Id of the Azure resource being integrated with Azure Managed Grafana. E.g., an Azure Kubernetes Service cluster. */ targetResourceId?: string; } /** * Properties specific to the grafana resource. */ interface ManagedGrafanaPropertiesResponse { /** * The api key setting of the Grafana instance. */ apiKey?: string; /** * Scope for dns deterministic name hash calculation. */ autoGeneratedDomainNameLabelScope?: string; /** * Whether a Grafana instance uses deterministic outbound IPs. */ deterministicOutboundIP?: string; /** * The endpoint of the Grafana instance. */ endpoint: string; /** * Enterprise settings of a Grafana instance */ enterpriseConfigurations?: outputs.dashboard.EnterpriseConfigurationsResponse; /** * Server configurations of a Grafana instance */ grafanaConfigurations?: outputs.dashboard.GrafanaConfigurationsResponse; /** * GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios. */ grafanaIntegrations?: outputs.dashboard.GrafanaIntegrationsResponse; /** * The major Grafana software version to target. */ grafanaMajorVersion?: string; /** * Installed plugin list of the Grafana instance. Key is plugin id, value is plugin definition. */ grafanaPlugins?: { [key: string]: outputs.dashboard.GrafanaPluginResponse; }; /** * The Grafana software version. */ grafanaVersion: string; /** * List of outbound IPs if deterministicOutboundIP is enabled. */ outboundIPs: string[]; /** * The private endpoint connections of the Grafana instance. */ privateEndpointConnections: outputs.dashboard.PrivateEndpointConnectionResponse[]; /** * Provisioning state of the resource. */ provisioningState: string; /** * Indicate the state for enable or disable traffic over the public interface. */ publicNetworkAccess?: string; /** * The zone redundancy setting of the Grafana instance. */ zoneRedundancy?: string; } /** * managedGrafanaPropertiesResponseProvideDefaults sets the appropriate defaults for ManagedGrafanaPropertiesResponse */ function managedGrafanaPropertiesResponseProvideDefaults(val: ManagedGrafanaPropertiesResponse): ManagedGrafanaPropertiesResponse; /** * The state of managed private endpoint connection. */ interface ManagedPrivateEndpointConnectionStateResponse { /** * Gets or sets the reason for approval/rejection of the connection. */ description: string; /** * The approval/rejection status of managed private endpoint connection. */ status: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.dashboard.UserAssignedIdentityResponse; }; } /** * The Private Endpoint Connection resource. */ interface PrivateEndpointConnectionResponse { /** * The private endpoint connection group ids. */ groupIds?: string[]; /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * The resource of private end point. */ privateEndpoint?: outputs.dashboard.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.dashboard.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.dashboard.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The Private Endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } interface ResourceSkuResponse { name: string; } /** * Grafana security settings */ interface SecurityResponse { /** * Set to true to execute the CSRF check even if the login cookie is not in a request (default false). */ csrfAlwaysCheck?: boolean; } /** * Email server settings. * https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp */ interface SmtpResponse { /** * Enable this to allow Grafana to send email. Default is false */ enabled?: boolean; /** * Address used when sending out emails * https://pkg.go.dev/net/mail#Address */ fromAddress?: string; /** * Name to be used when sending out emails. Default is "Azure Managed Grafana Notification" * https://pkg.go.dev/net/mail#Address */ fromName?: string; /** * SMTP server hostname with port, e.g. test.email.net:587 */ host?: string; /** * Password of SMTP auth. If the password contains # or ;, then you have to wrap it with triple quotes */ password?: string; /** * Verify SSL for SMTP server. Default is false * https://pkg.go.dev/crypto/tls#Config */ skipVerify?: boolean; /** * The StartTLSPolicy setting of the SMTP configuration * https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy */ startTLSPolicy?: string; /** * User of SMTP auth */ user?: string; } /** * smtpResponseProvideDefaults sets the appropriate defaults for SmtpResponse */ function smtpResponseProvideDefaults(val: SmtpResponse): SmtpResponse; /** * Grafana Snapshots settings */ interface SnapshotsResponse { /** * Set to false to disable external snapshot publish endpoint */ externalEnabled?: boolean; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Grafana users settings */ interface UsersResponse { /** * Set to true so viewers can access and use explore and perform temporary edits on panels in dashboards they have access to. They cannot save their changes. */ viewersCanEdit?: boolean; } } export declare namespace databasefleetmanager { /** * Database Identity properties. */ interface DatabaseIdentityResponse { /** * Client Id of the database identity. */ clientId?: string; /** * Principal Id of the database identity. */ principalId?: string; /** * Resource Id of the database identity. */ resourceId?: string; } /** * A Firewall rule properties. */ interface FirewallRulePropertiesResponse { /** * End IP address. */ endIpAddress?: string; /** * Provisioning state. */ provisioningState: string; /** * Start IP address. */ startIpAddress?: string; } /** * Fleet database properties. */ interface FleetDatabasePropertiesResponse { /** * Backup retention in days. */ backupRetentionDays: number; /** * Database collation. */ collation?: string; /** * Connection string to connect to the database with. */ connectionString: string; /** * Create mode. Available options: Default - Create a database. Copy - Copy the source database (source database name must be specified) PointInTimeRestore - Create a database by restoring source database from a point in time (source database name and restore from time must be specified) */ createMode?: string; /** * Maximum database size in Gb. */ databaseSizeGbMax: number; /** * Earliest restore time. */ earliestRestoreTime: string; /** * Identity property. */ identity?: outputs.databasefleetmanager.IdentityResponse; /** * Latest restore time. */ latestRestoreTime: string; /** * Resource identifier for the underlying database resource. */ originalDatabaseId: string; /** * Database state. */ provisioningState: string; /** * If true, database is recoverable. */ recoverable: boolean; /** * Additional database properties to be applied as the underlying database resource tags. */ resourceTags?: { [key: string]: string; }; /** * Restore from time when CreateMode is PointInTimeRestore. */ restoreFromTime?: string; /** * Source database name used when CreateMode is Copy or PointInTimeRestore. */ sourceDatabaseName?: string; /** * Name of the tier this database belongs to. */ tierName?: string; /** * Transparent Data Encryption properties */ transparentDataEncryption?: outputs.databasefleetmanager.TransparentDataEncryptionResponse; } /** * The Database Fleet properties. */ interface FleetPropertiesResponse { /** * Fleet description. */ description?: string; /** * Provisioning state. */ provisioningState: string; } /** * A Fleet tier properties. */ interface FleetTierPropertiesResponse { /** * Capacity of provisioned resources in the tier, in units matching the specified service tier, for example vCore for GeneralPurpose. */ capacity?: number; /** * Maximum allocated capacity per database, in units matching the specified service tier. */ databaseCapacityMax?: number; /** * Minimum allocated capacity per database, in units matching the specified service tier. */ databaseCapacityMin?: number; /** * Maximum database size in Gb. */ databaseSizeGbMax?: number; /** * If true, tier is disabled. */ disabled: boolean; /** * Family of provisioned resources, for example Gen5. */ family?: string; /** * Number of high availability replicas for databases in this tier. */ highAvailabilityReplicaCount?: number; /** * Maximum number of databases per pool. */ poolNumOfDatabasesMax?: number; /** * If true, databases are pooled. */ pooled?: boolean; /** * Provisioning state. */ provisioningState: string; /** * If true, serverless resources are provisioned in the tier. */ serverless?: boolean; /** * Service tier of provisioned resources. Supported values: GeneralPurpose, Hyperscale. */ serviceTier?: string; /** * Enable zone redundancy for all databases in this tier. */ zoneRedundancy?: string; } /** * A Fleetspace properties. */ interface FleetspacePropertiesResponse { /** * Maximum number of vCores database fleet manager is allowed to provision in the fleetspace. */ capacityMax?: number; /** * Main Microsoft Entra ID principal that has admin access to all databases in the fleetspace. */ mainPrincipal?: outputs.databasefleetmanager.MainPrincipalResponse; /** * Fleetspace state. */ provisioningState: string; } /** * Database Identity. */ interface IdentityResponse { /** * The federated client id for the SQL Database. It is used for cross tenant CMK scenario. */ federatedClientId?: string; /** * Identity type of the main principal. */ identityType?: string; /** * User identity ids */ userAssignedIdentities?: outputs.databasefleetmanager.DatabaseIdentityResponse[]; } /** * A main principal. */ interface MainPrincipalResponse { /** * Application Id of the main principal. */ applicationId?: string; /** * Login name of the main principal. */ login?: string; /** * Object Id of the main principal. */ objectId?: string; /** * Principal type of the main principal. */ principalType?: string; /** * Tenant Id of the main principal. */ tenantId?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Transparent Data Encryption properties. */ interface TransparentDataEncryptionResponse { /** * Enable key auto rotation */ enableAutoRotation?: boolean; /** * Customer Managed Key (CMK) Uri. */ keyUri?: string; /** * Additional Keys */ keys?: string[]; } } export declare namespace databasewatcher { /** * The properties of a data store. */ interface DatastoreResponse { /** * The Azure resource ID of an Azure Data Explorer cluster. */ adxClusterResourceId?: string; /** * The Kusto cluster display name. */ kustoClusterDisplayName?: string; /** * The Kusto cluster URI. */ kustoClusterUri: string; /** * The Kusto data ingestion URI. */ kustoDataIngestionUri: string; /** * The name of a Kusto database. */ kustoDatabaseName: string; /** * The Kusto management URL. */ kustoManagementUrl: string; /** * The type of a Kusto offering. */ kustoOfferingType: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.databasewatcher.UserAssignedIdentityResponse; }; } /** * The properties specific to an elastic pool in Azure SQL Database. */ interface SqlDbElasticPoolTargetPropertiesResponse { /** * The Azure resource ID of the anchor database used to connect to an elastic pool. */ anchorDatabaseResourceId: string; /** * The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be 'sql-logical-server-22092780.database.windows.net'; for an Azure SQL managed instance in the Azure commercial cloud, the value might be 'sql-mi-39441134.767d5869f605.database.windows.net'. Port number and instance name must be specified separately. */ connectionServerName: string; /** * The provisioning state of the resource. */ provisioningState: string; /** * Set to true to monitor a high availability replica of specified target, if any. */ readIntent?: boolean; /** * The Azure resource ID of an Azure SQL DB elastic pool target. */ sqlEpResourceId: string; /** * The type of authentication to use when connecting to a target. */ targetAuthenticationType: string; /** * Discriminator property for TargetProperties. * Expected value is 'SqlEp'. */ targetType: "SqlEp"; /** * To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored. */ targetVault?: outputs.databasewatcher.VaultSecretResponse; } /** * sqlDbElasticPoolTargetPropertiesResponseProvideDefaults sets the appropriate defaults for SqlDbElasticPoolTargetPropertiesResponse */ function sqlDbElasticPoolTargetPropertiesResponseProvideDefaults(val: SqlDbElasticPoolTargetPropertiesResponse): SqlDbElasticPoolTargetPropertiesResponse; /** * The properties specific to a database in Azure SQL Database. */ interface SqlDbSingleDatabaseTargetPropertiesResponse { /** * The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be 'sql-logical-server-22092780.database.windows.net'; for an Azure SQL managed instance in the Azure commercial cloud, the value might be 'sql-mi-39441134.767d5869f605.database.windows.net'. Port number and instance name must be specified separately. */ connectionServerName: string; /** * The provisioning state of the resource. */ provisioningState: string; /** * Set to true to monitor a high availability replica of specified target, if any. */ readIntent?: boolean; /** * The Azure resource ID of an Azure SQL DB database target. */ sqlDbResourceId: string; /** * The type of authentication to use when connecting to a target. */ targetAuthenticationType: string; /** * Discriminator property for TargetProperties. * Expected value is 'SqlDb'. */ targetType: "SqlDb"; /** * To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored. */ targetVault?: outputs.databasewatcher.VaultSecretResponse; } /** * sqlDbSingleDatabaseTargetPropertiesResponseProvideDefaults sets the appropriate defaults for SqlDbSingleDatabaseTargetPropertiesResponse */ function sqlDbSingleDatabaseTargetPropertiesResponseProvideDefaults(val: SqlDbSingleDatabaseTargetPropertiesResponse): SqlDbSingleDatabaseTargetPropertiesResponse; /** * The properties specific to Azure SQL Managed Instance targets. */ interface SqlMiTargetPropertiesResponse { /** * The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be 'sql-logical-server-22092780.database.windows.net'; for an Azure SQL managed instance in the Azure commercial cloud, the value might be 'sql-mi-39441134.767d5869f605.database.windows.net'. Port number and instance name must be specified separately. */ connectionServerName: string; /** * The TCP port number to optionally use in the connection string when connecting to an Azure SQL Managed Instance target. */ connectionTcpPort?: number; /** * The provisioning state of the resource. */ provisioningState: string; /** * Set to true to monitor a high availability replica of specified target, if any. */ readIntent?: boolean; /** * The Azure resource ID of an Azure SQL Managed Instance target. */ sqlMiResourceId: string; /** * The type of authentication to use when connecting to a target. */ targetAuthenticationType: string; /** * Discriminator property for TargetProperties. * Expected value is 'SqlMi'. */ targetType: "SqlMi"; /** * To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored. */ targetVault?: outputs.databasewatcher.VaultSecretResponse; } /** * sqlMiTargetPropertiesResponseProvideDefaults sets the appropriate defaults for SqlMiTargetPropertiesResponse */ function sqlMiTargetPropertiesResponseProvideDefaults(val: SqlMiTargetPropertiesResponse): SqlMiTargetPropertiesResponse; /** * The properties specific to Azure SQL VM targets. */ interface SqlVmTargetPropertiesResponse { /** * The FQDN host name of the server to use in the connection string when connecting to a target. For example, for an Azure SQL logical server in the Azure commercial cloud, the value might be 'sql-logical-server-22092780.database.windows.net'; for an Azure SQL managed instance in the Azure commercial cloud, the value might be 'sql-mi-39441134.767d5869f605.database.windows.net'. Port number and instance name must be specified separately. */ connectionServerName: string; /** * The TCP port number to optionally use in the connection string when connecting to an Azure SQL VM target. */ connectionTcpPort?: number; /** * The provisioning state of the resource. */ provisioningState: string; /** * The SQL instance name to optionally use in the connection string when connecting to an Azure SQL VM target. */ sqlNamedInstanceName?: string; /** * The Azure resource ID of an Azure SQL VM target. */ sqlVmResourceId: string; /** * The type of authentication to use when connecting to a target. */ targetAuthenticationType: string; /** * Discriminator property for TargetProperties. * Expected value is 'SqlVm'. */ targetType: "SqlVm"; /** * To use SQL authentication when connecting to targets, specify the vault where the login name and password secrets are stored. */ targetVault?: outputs.databasewatcher.VaultSecretResponse; } /** * sqlVmTargetPropertiesResponseProvideDefaults sets the appropriate defaults for SqlVmTargetPropertiesResponse */ function sqlVmTargetPropertiesResponseProvideDefaults(val: SqlVmTargetPropertiesResponse): SqlVmTargetPropertiesResponse; /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * The vault specific details required if using SQL authentication to connect to a target. */ interface VaultSecretResponse { /** * The Azure resource ID of the Key Vault instance storing database authentication secrets. */ akvResourceId?: string; /** * The path to the Key Vault secret storing the password for authentication to a target. */ akvTargetPassword?: string; /** * The path to the Key Vault secret storing the login name (aka user name, aka account name) for authentication to a target. */ akvTargetUser?: string; } } export declare namespace databox { /** * Credential details of the account. */ interface AccountCredentialDetailsResponse { /** * Connection string of the account endpoint to use the account as a storage endpoint on the device. */ accountConnectionString: string; /** * Name of the account. */ accountName: string; /** * Type of the account. */ dataAccountType: string; /** * Per share level unencrypted access credentials. */ shareCredentialDetails: outputs.databox.ShareCredentialDetailsResponse[]; } /** * This class represents additional info which Resource Providers pass when an error occurs. */ interface AdditionalErrorInfoResponse { /** * Additional information of the type of error. */ info?: any; /** * Type of error (e.g. CustomerIntervention, PolicyViolation, SecurityViolation). */ type?: string; } /** * The Network Adapter configuration of a DataBox. */ interface ApplianceNetworkConfigurationResponse { /** * Mac Address. */ macAddress: string; /** * Name of the network. */ name: string; } /** * Filter details to transfer Azure files */ interface AzureFileFilterDetailsResponse { /** * List of full path of the files to be transferred. */ filePathList?: string[]; /** * Prefix list of the Azure files to be transferred. */ filePrefixList?: string[]; /** * List of file shares to be transferred. */ fileShareList?: string[]; } /** * Filter details to transfer Azure Blobs */ interface BlobFilterDetailsResponse { /** * List of full path of the blobs to be transferred. */ blobPathList?: string[]; /** * Prefix list of the Azure blobs to be transferred. */ blobPrefixList?: string[]; /** * List of blob containers to be transferred. */ containerList?: string[]; } /** * Provides additional information about an http error response. */ interface CloudErrorResponse { /** * Gets or sets additional error info. */ additionalInfo: outputs.databox.AdditionalErrorInfoResponse[]; /** * Error code. */ code?: string; /** * Gets or sets details for the error. */ details: outputs.databox.CloudErrorResponse[]; /** * The error message parsed from the body of the http error response. */ message?: string; /** * Gets or sets the target of the error. */ target?: string; } /** * Contact Details. */ interface ContactDetailsResponse { /** * Contact name of the person. */ contactName: string; /** * List of Email-ids to be notified about job progress. */ emailList: string[]; /** * Mobile number of the contact person. */ mobile?: string; /** * Notification preference for a job stage. */ notificationPreference?: outputs.databox.NotificationPreferenceResponse[]; /** * Phone number of the contact person. */ phone: string; /** * Phone extension number of the contact person. */ phoneExtension?: string; } /** * Contact Info. */ interface ContactInfoResponse { /** * Contact name of the person. */ contactName: string; /** * Mobile number of the contact person. */ mobile?: string; /** * Phone number of the contact person. */ phone: string; /** * Phone extension number of the contact person. */ phoneExtension?: string; } /** * Copy progress. */ interface CopyProgressResponse { /** * Id of the account where the data needs to be uploaded. */ accountId: string; /** * Available actions on the job. */ actions: string[]; /** * To indicate bytes transferred. */ bytesProcessed: number; /** * Data Account Type. */ dataAccountType: string; /** * To indicate directories errored out in the job. */ directoriesErroredOut: number; /** * Error, if any, in the stage */ error: outputs.databox.CloudErrorResponse; /** * Number of files which could not be copied */ filesErroredOut: number; /** * Number of files processed */ filesProcessed: number; /** * To indicate directories renamed */ invalidDirectoriesProcessed: number; /** * Total amount of data not adhering to azure naming conventions which were processed by automatic renaming */ invalidFileBytesUploaded: number; /** * Number of files not adhering to azure naming conventions which were processed by automatic renaming */ invalidFilesProcessed: number; /** * To indicate if enumeration of data is in progress. * Until this is true, the TotalBytesToProcess may not be valid. */ isEnumerationInProgress: boolean; /** * Number of folders not adhering to azure naming conventions which were processed by automatic renaming */ renamedContainerCount: number; /** * Name of the storage account. This will be empty for data account types other than storage account. */ storageAccountName: string; /** * Total amount of data to be processed by the job. */ totalBytesToProcess: number; /** * Total files to process */ totalFilesToProcess: number; /** * Transfer type of data */ transferType: string; } /** * The secrets related to customer disk job. */ interface CustomerDiskJobSecretsResponse { /** * Carrier Account Number of the customer */ carrierAccountNumber: string; /** * Dc Access Security Code for Customer Managed Shipping */ dcAccessSecurityCode: outputs.databox.DcAccessSecurityCodeResponse; /** * Contains the list of secrets object for that device. */ diskSecrets: outputs.databox.DiskSecretResponse[]; /** * Error while fetching the secrets. */ error: outputs.databox.CloudErrorResponse; /** * Used to indicate what type of job secrets object. * Expected value is 'DataBoxCustomerDisk'. */ jobSecretsType: "DataBoxCustomerDisk"; } /** * Copy log details for a storage account of a DataBox job */ interface DataBoxAccountCopyLogDetailsResponse { /** * Account name. */ accountName: string; /** * Indicates the type of job details. * Expected value is 'DataBox'. */ copyLogDetailsType: "DataBox"; /** * Link for copy logs. */ copyLogLink: string; /** * Link for copy verbose logs. This will be set only when LogCollectionLevel is set to Verbose. */ copyVerboseLogLink: string; } /** * Copy Log Details for customer disk */ interface DataBoxCustomerDiskCopyLogDetailsResponse { /** * Indicates the type of job details. * Expected value is 'DataBoxCustomerDisk'. */ copyLogDetailsType: "DataBoxCustomerDisk"; /** * Link for copy error logs. */ errorLogLink: string; /** * Disk Serial Number. */ serialNumber: string; /** * Link for copy verbose logs. */ verboseLogLink: string; } /** * DataBox CustomerDisk Copy Progress */ interface DataBoxCustomerDiskCopyProgressResponse { /** * Id of the account where the data needs to be uploaded. */ accountId: string; /** * Available actions on the job. */ actions: string[]; /** * To indicate bytes transferred. */ bytesProcessed: number; /** * The Status of the copy */ copyStatus: string; /** * Data Account Type. */ dataAccountType: string; /** * To indicate directories errored out in the job. */ directoriesErroredOut: number; /** * Error, if any, in the stage */ error: outputs.databox.CloudErrorResponse; /** * Number of files which could not be copied */ filesErroredOut: number; /** * Number of files processed */ filesProcessed: number; /** * To indicate directories renamed */ invalidDirectoriesProcessed: number; /** * Total amount of data not adhering to azure naming conventions which were processed by automatic renaming */ invalidFileBytesUploaded: number; /** * Number of files not adhering to azure naming conventions which were processed by automatic renaming */ invalidFilesProcessed: number; /** * To indicate if enumeration of data is in progress. * Until this is true, the TotalBytesToProcess may not be valid. */ isEnumerationInProgress: boolean; /** * Number of folders not adhering to azure naming conventions which were processed by automatic renaming */ renamedContainerCount: number; /** * Disk Serial Number. */ serialNumber: string; /** * Name of the storage account. This will be empty for data account types other than storage account. */ storageAccountName: string; /** * Total amount of data to be processed by the job. */ totalBytesToProcess: number; /** * Total files to process */ totalFilesToProcess: number; /** * Transfer type of data */ transferType: string; } /** * Customer disk job details. */ interface DataBoxCustomerDiskJobDetailsResponse { /** * Available actions on the job. */ actions: string[]; /** * Shared access key to download the chain of custody logs */ chainOfCustodySasKey: string; /** * Contact details for notification and shipping. */ contactDetails: outputs.databox.ContactDetailsResponse; /** * List of copy log details. */ copyLogDetails: (outputs.databox.DataBoxAccountCopyLogDetailsResponse | outputs.databox.DataBoxCustomerDiskCopyLogDetailsResponse | outputs.databox.DataBoxDiskCopyLogDetailsResponse | outputs.databox.DataBoxHeavyAccountCopyLogDetailsResponse)[]; /** * Copy progress per disk. */ copyProgress: outputs.databox.DataBoxCustomerDiskCopyProgressResponse[]; /** * DataCenter code. */ dataCenterCode: string; /** * Details of the data to be exported from azure. */ dataExportDetails?: outputs.databox.DataExportDetailsResponse[]; /** * Details of the data to be imported into azure. */ dataImportDetails?: outputs.databox.DataImportDetailsResponse[]; /** * Datacenter address to ship to, for the given sku and storage location. */ datacenterAddress: outputs.databox.DatacenterAddressInstructionResponseResponse | outputs.databox.DatacenterAddressLocationResponseResponse; /** * Delivery package shipping details. */ deliverToDcPackageDetails: outputs.databox.PackageCarrierInfoResponse; /** * Delivery package shipping details. */ deliveryPackage: outputs.databox.PackageShippingDetailsResponse; /** * Holds device data erasure details */ deviceErasureDetails: outputs.databox.DeviceErasureDetailsResponse; /** * Flag to indicate if disk manifest should be backed-up in the Storage Account. */ enableManifestBackup?: boolean; /** * The expected size of the data, which needs to be transferred in this job, in terabytes. */ expectedDataSizeInTeraBytes?: number; /** * Contains the map of disk serial number to the disk details for export jobs. */ exportDiskDetailsCollection: { [key: string]: outputs.databox.ExportDiskDetailsResponse; }; /** * Contains the map of disk serial number to the disk details for import jobs. */ importDiskDetailsCollection?: { [key: string]: outputs.databox.ImportDiskDetailsResponse; }; /** * Indicates the type of job details. * Expected value is 'DataBoxCustomerDisk'. */ jobDetailsType: "DataBoxCustomerDisk"; /** * List of stages that run in the job. */ jobStages: outputs.databox.JobStagesResponse[]; /** * Details about which key encryption type is being used. */ keyEncryptionKey?: outputs.databox.KeyEncryptionKeyResponse; /** * Last mitigation action performed on the job. */ lastMitigationActionOnJob: outputs.databox.LastMitigationActionOnJobResponse; /** * Preferences for the order. */ preferences?: outputs.databox.PreferencesResponse; /** * Return package shipping details. */ returnPackage: outputs.databox.PackageShippingDetailsResponse; /** * Return package shipping details. */ returnToCustomerPackageDetails: outputs.databox.PackageCarrierDetailsResponse; /** * Shared access key to download the return shipment label */ reverseShipmentLabelSasKey: string; /** * Optional Reverse Shipping details for order. */ reverseShippingDetails?: outputs.databox.ReverseShippingDetailsResponse; /** * Shipping address of the customer. */ shippingAddress?: outputs.databox.ShippingAddressResponse; } /** * dataBoxCustomerDiskJobDetailsResponseProvideDefaults sets the appropriate defaults for DataBoxCustomerDiskJobDetailsResponse */ function dataBoxCustomerDiskJobDetailsResponseProvideDefaults(val: DataBoxCustomerDiskJobDetailsResponse): DataBoxCustomerDiskJobDetailsResponse; /** * Copy Log Details for a disk */ interface DataBoxDiskCopyLogDetailsResponse { /** * Indicates the type of job details. * Expected value is 'DataBoxDisk'. */ copyLogDetailsType: "DataBoxDisk"; /** * Disk Serial Number. */ diskSerialNumber: string; /** * Link for copy error logs. */ errorLogLink: string; /** * Link for copy verbose logs. */ verboseLogLink: string; } /** * DataBox Disk Copy Progress */ interface DataBoxDiskCopyProgressResponse { /** * Available actions on the job. */ actions: string[]; /** * Bytes copied during the copy of disk. */ bytesCopied: number; /** * Error, if any, in the stage */ error: outputs.databox.CloudErrorResponse; /** * Indicates the percentage completed for the copy of the disk. */ percentComplete: number; /** * The serial number of the disk */ serialNumber: string; /** * The Status of the copy */ status: string; } /** * Granular Copy Log Details for customer disk */ interface DataBoxDiskGranularCopyLogDetailsResponse { /** * Account id. */ accountId: string; /** * Indicates the type of job details. * Expected value is 'DataBoxCustomerDisk'. */ copyLogDetailsType: "DataBoxCustomerDisk"; /** * Link for copy error logs. */ errorLogLink: string; /** * Disk Serial Number. */ serialNumber: string; /** * Link for copy verbose logs. */ verboseLogLink: string; } /** * DataBox Disk Granular Copy Progress */ interface DataBoxDiskGranularCopyProgressResponse { /** * Id of the account where the data needs to be uploaded. */ accountId: string; /** * Available actions on the job. */ actions: string[]; /** * To indicate bytes transferred. */ bytesProcessed: number; /** * The Status of the copy */ copyStatus: string; /** * Data Account Type. */ dataAccountType: string; /** * To indicate directories errored out in the job. */ directoriesErroredOut: number; /** * Error, if any, in the stage */ error: outputs.databox.CloudErrorResponse; /** * Number of files which could not be copied */ filesErroredOut: number; /** * Number of files processed */ filesProcessed: number; /** * To indicate directories renamed */ invalidDirectoriesProcessed: number; /** * Total amount of data not adhering to azure naming conventions which were processed by automatic renaming */ invalidFileBytesUploaded: number; /** * Number of files not adhering to azure naming conventions which were processed by automatic renaming */ invalidFilesProcessed: number; /** * To indicate if enumeration of data is in progress. * Until this is true, the TotalBytesToProcess may not be valid. */ isEnumerationInProgress: boolean; /** * Number of folders not adhering to azure naming conventions which were processed by automatic renaming */ renamedContainerCount: number; /** * Disk Serial Number. */ serialNumber: string; /** * Name of the storage account. This will be empty for data account types other than storage account. */ storageAccountName: string; /** * Total amount of data to be processed by the job. */ totalBytesToProcess: number; /** * Total files to process */ totalFilesToProcess: number; /** * Transfer type of data */ transferType: string; } /** * DataBox Disk Job Details. */ interface DataBoxDiskJobDetailsResponse { /** * Available actions on the job. */ actions: string[]; /** * Shared access key to download the chain of custody logs */ chainOfCustodySasKey: string; /** * Contact details for notification and shipping. */ contactDetails: outputs.databox.ContactDetailsResponse; /** * List of copy log details. */ copyLogDetails: (outputs.databox.DataBoxAccountCopyLogDetailsResponse | outputs.databox.DataBoxCustomerDiskCopyLogDetailsResponse | outputs.databox.DataBoxDiskCopyLogDetailsResponse | outputs.databox.DataBoxHeavyAccountCopyLogDetailsResponse)[]; /** * Copy progress per disk. */ copyProgress: outputs.databox.DataBoxDiskCopyProgressResponse[]; /** * DataCenter code. */ dataCenterCode: string; /** * Details of the data to be exported from azure. */ dataExportDetails?: outputs.databox.DataExportDetailsResponse[]; /** * Details of the data to be imported into azure. */ dataImportDetails?: outputs.databox.DataImportDetailsResponse[]; /** * Datacenter address to ship to, for the given sku and storage location. */ datacenterAddress: outputs.databox.DatacenterAddressInstructionResponseResponse | outputs.databox.DatacenterAddressLocationResponseResponse; /** * Delivery package shipping details. */ deliveryPackage: outputs.databox.PackageShippingDetailsResponse; /** * Holds device data erasure details */ deviceErasureDetails: outputs.databox.DeviceErasureDetailsResponse; /** * Contains the map of disk serial number to the disk size being used for the job. Is returned only after the disks are shipped to the customer. */ disksAndSizeDetails: { [key: string]: number; }; /** * The expected size of the data, which needs to be transferred in this job, in terabytes. */ expectedDataSizeInTeraBytes?: number; /** * Copy progress per disk. */ granularCopyLogDetails: outputs.databox.DataBoxDiskGranularCopyLogDetailsResponse[]; /** * Copy progress per disk. */ granularCopyProgress: outputs.databox.DataBoxDiskGranularCopyProgressResponse[]; /** * Indicates the type of job details. * Expected value is 'DataBoxDisk'. */ jobDetailsType: "DataBoxDisk"; /** * List of stages that run in the job. */ jobStages: outputs.databox.JobStagesResponse[]; /** * Details about which key encryption type is being used. */ keyEncryptionKey?: outputs.databox.KeyEncryptionKeyResponse; /** * Last mitigation action performed on the job. */ lastMitigationActionOnJob: outputs.databox.LastMitigationActionOnJobResponse; /** * User entered passkey for DataBox Disk job. */ passkey?: string; /** * Preferences for the order. */ preferences?: outputs.databox.PreferencesResponse; /** * User preference on what size disks are needed for the job. The map is from the disk size in TB to the count. Eg. {2,5} means 5 disks of 2 TB size. Key is string but will be checked against an int. */ preferredDisks?: { [key: string]: number; }; /** * Return package shipping details. */ returnPackage: outputs.databox.PackageShippingDetailsResponse; /** * Shared access key to download the return shipment label */ reverseShipmentLabelSasKey: string; /** * Optional Reverse Shipping details for order. */ reverseShippingDetails?: outputs.databox.ReverseShippingDetailsResponse; /** * Shipping address of the customer. */ shippingAddress?: outputs.databox.ShippingAddressResponse; } /** * dataBoxDiskJobDetailsResponseProvideDefaults sets the appropriate defaults for DataBoxDiskJobDetailsResponse */ function dataBoxDiskJobDetailsResponseProvideDefaults(val: DataBoxDiskJobDetailsResponse): DataBoxDiskJobDetailsResponse; /** * The secrets related to disk job. */ interface DataBoxDiskJobSecretsResponse { /** * Dc Access Security Code for Customer Managed Shipping */ dcAccessSecurityCode: outputs.databox.DcAccessSecurityCodeResponse; /** * Contains the list of secrets object for that device. */ diskSecrets: outputs.databox.DiskSecretResponse[]; /** * Error while fetching the secrets. */ error: outputs.databox.CloudErrorResponse; /** * Whether passkey was provided by user. */ isPasskeyUserDefined: boolean; /** * Used to indicate what type of job secrets object. * Expected value is 'DataBoxDisk'. */ jobSecretsType: "DataBoxDisk"; /** * PassKey for the disk Job. */ passKey: string; } /** * Copy log details for a storage account for Databox heavy */ interface DataBoxHeavyAccountCopyLogDetailsResponse { /** * Account name. */ accountName: string; /** * Indicates the type of job details. * Expected value is 'DataBoxHeavy'. */ copyLogDetailsType: "DataBoxHeavy"; /** * Link for copy logs. */ copyLogLink: string[]; /** * Link for copy verbose logs. This will be set only when the LogCollectionLevel is set to verbose. */ copyVerboseLogLink: string[]; } /** * Databox Heavy Device Job Details */ interface DataBoxHeavyJobDetailsResponse { /** * Available actions on the job. */ actions: string[]; /** * Shared access key to download the chain of custody logs */ chainOfCustodySasKey: string; /** * Contact details for notification and shipping. */ contactDetails: outputs.databox.ContactDetailsResponse; /** * List of copy log details. */ copyLogDetails: (outputs.databox.DataBoxAccountCopyLogDetailsResponse | outputs.databox.DataBoxCustomerDiskCopyLogDetailsResponse | outputs.databox.DataBoxDiskCopyLogDetailsResponse | outputs.databox.DataBoxHeavyAccountCopyLogDetailsResponse)[]; /** * Copy progress per account. */ copyProgress: outputs.databox.CopyProgressResponse[]; /** * DataCenter code. */ dataCenterCode: string; /** * Details of the data to be exported from azure. */ dataExportDetails?: outputs.databox.DataExportDetailsResponse[]; /** * Details of the data to be imported into azure. */ dataImportDetails?: outputs.databox.DataImportDetailsResponse[]; /** * Datacenter address to ship to, for the given sku and storage location. */ datacenterAddress: outputs.databox.DatacenterAddressInstructionResponseResponse | outputs.databox.DatacenterAddressLocationResponseResponse; /** * Delivery package shipping details. */ deliveryPackage: outputs.databox.PackageShippingDetailsResponse; /** * Holds device data erasure details */ deviceErasureDetails: outputs.databox.DeviceErasureDetailsResponse; /** * Set Device password for unlocking Databox Heavy. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ */ devicePassword?: string; /** * The expected size of the data, which needs to be transferred in this job, in terabytes. */ expectedDataSizeInTeraBytes?: number; /** * Indicates the type of job details. * Expected value is 'DataBoxHeavy'. */ jobDetailsType: "DataBoxHeavy"; /** * List of stages that run in the job. */ jobStages: outputs.databox.JobStagesResponse[]; /** * Details about which key encryption type is being used. */ keyEncryptionKey?: outputs.databox.KeyEncryptionKeyResponse; /** * Last mitigation action performed on the job. */ lastMitigationActionOnJob: outputs.databox.LastMitigationActionOnJobResponse; /** * Preferences for the order. */ preferences?: outputs.databox.PreferencesResponse; /** * Return package shipping details. */ returnPackage: outputs.databox.PackageShippingDetailsResponse; /** * Shared access key to download the return shipment label */ reverseShipmentLabelSasKey: string; /** * Optional Reverse Shipping details for order. */ reverseShippingDetails?: outputs.databox.ReverseShippingDetailsResponse; /** * Shipping address of the customer. */ shippingAddress?: outputs.databox.ShippingAddressResponse; } /** * dataBoxHeavyJobDetailsResponseProvideDefaults sets the appropriate defaults for DataBoxHeavyJobDetailsResponse */ function dataBoxHeavyJobDetailsResponseProvideDefaults(val: DataBoxHeavyJobDetailsResponse): DataBoxHeavyJobDetailsResponse; /** * The secrets related to a databox heavy job. */ interface DataBoxHeavyJobSecretsResponse { /** * Contains the list of secret objects for a databox heavy job. */ cabinetPodSecrets: outputs.databox.DataBoxHeavySecretResponse[]; /** * Dc Access Security Code for Customer Managed Shipping */ dcAccessSecurityCode: outputs.databox.DcAccessSecurityCodeResponse; /** * Error while fetching the secrets. */ error: outputs.databox.CloudErrorResponse; /** * Used to indicate what type of job secrets object. * Expected value is 'DataBoxHeavy'. */ jobSecretsType: "DataBoxHeavy"; } /** * The secrets related to a databox heavy. */ interface DataBoxHeavySecretResponse { /** * Per account level access credentials. */ accountCredentialDetails: outputs.databox.AccountCredentialDetailsResponse[]; /** * Password for out of the box experience on device. */ devicePassword: string; /** * Serial number of the assigned device. */ deviceSerialNumber: string; /** * The base 64 encoded public key to authenticate with the device */ encodedValidationCertPubKey: string; /** * Network configuration of the appliance. */ networkConfigurations: outputs.databox.ApplianceNetworkConfigurationResponse[]; } /** * Databox Job Details */ interface DataBoxJobDetailsResponse { /** * Available actions on the job. */ actions: string[]; /** * Shared access key to download the chain of custody logs */ chainOfCustodySasKey: string; /** * Contact details for notification and shipping. */ contactDetails: outputs.databox.ContactDetailsResponse; /** * List of copy log details. */ copyLogDetails: (outputs.databox.DataBoxAccountCopyLogDetailsResponse | outputs.databox.DataBoxCustomerDiskCopyLogDetailsResponse | outputs.databox.DataBoxDiskCopyLogDetailsResponse | outputs.databox.DataBoxHeavyAccountCopyLogDetailsResponse)[]; /** * Copy progress per storage account. */ copyProgress: outputs.databox.CopyProgressResponse[]; /** * DataCenter code. */ dataCenterCode: string; /** * Details of the data to be exported from azure. */ dataExportDetails?: outputs.databox.DataExportDetailsResponse[]; /** * Details of the data to be imported into azure. */ dataImportDetails?: outputs.databox.DataImportDetailsResponse[]; /** * Datacenter address to ship to, for the given sku and storage location. */ datacenterAddress: outputs.databox.DatacenterAddressInstructionResponseResponse | outputs.databox.DatacenterAddressLocationResponseResponse; /** * Delivery package shipping details. */ deliveryPackage: outputs.databox.PackageShippingDetailsResponse; /** * Holds device data erasure details */ deviceErasureDetails: outputs.databox.DeviceErasureDetailsResponse; /** * Set Device password for unlocking Databox. Should not be passed for TransferType:ExportFromAzure jobs. If this is not passed, the service will generate password itself. This will not be returned in Get Call. Password Requirements : Password must be minimum of 12 and maximum of 64 characters. Password must have at least one uppercase alphabet, one number and one special character. Password cannot have the following characters : IilLoO0 Password can have only alphabets, numbers and these characters : @#\-$%^!+=;:_()]+ */ devicePassword?: string; /** * The expected size of the data, which needs to be transferred in this job, in terabytes. */ expectedDataSizeInTeraBytes?: number; /** * Indicates the type of job details. * Expected value is 'DataBox'. */ jobDetailsType: "DataBox"; /** * List of stages that run in the job. */ jobStages: outputs.databox.JobStagesResponse[]; /** * Details about which key encryption type is being used. */ keyEncryptionKey?: outputs.databox.KeyEncryptionKeyResponse; /** * Last mitigation action performed on the job. */ lastMitigationActionOnJob: outputs.databox.LastMitigationActionOnJobResponse; /** * Preferences for the order. */ preferences?: outputs.databox.PreferencesResponse; /** * Return package shipping details. */ returnPackage: outputs.databox.PackageShippingDetailsResponse; /** * Shared access key to download the return shipment label */ reverseShipmentLabelSasKey: string; /** * Optional Reverse Shipping details for order. */ reverseShippingDetails?: outputs.databox.ReverseShippingDetailsResponse; /** * Shipping address of the customer. */ shippingAddress?: outputs.databox.ShippingAddressResponse; } /** * dataBoxJobDetailsResponseProvideDefaults sets the appropriate defaults for DataBoxJobDetailsResponse */ function dataBoxJobDetailsResponseProvideDefaults(val: DataBoxJobDetailsResponse): DataBoxJobDetailsResponse; /** * The secrets related to a DataBox. */ interface DataBoxSecretResponse { /** * Per account level access credentials. */ accountCredentialDetails: outputs.databox.AccountCredentialDetailsResponse[]; /** * Password for out of the box experience on device. */ devicePassword: string; /** * Serial number of the assigned device. */ deviceSerialNumber: string; /** * The base 64 encoded public key to authenticate with the device */ encodedValidationCertPubKey: string; /** * Network configuration of the appliance. */ networkConfigurations: outputs.databox.ApplianceNetworkConfigurationResponse[]; } /** * Details of the data to be used for exporting data from azure. */ interface DataExportDetailsResponse { /** * Account details of the data to be transferred */ accountDetails: outputs.databox.ManagedDiskDetailsResponse | outputs.databox.StorageAccountDetailsResponse; /** * Level of the logs to be collected. */ logCollectionLevel?: string; /** * Configuration for the data transfer. */ transferConfiguration: outputs.databox.TransferConfigurationResponse; } /** * dataExportDetailsResponseProvideDefaults sets the appropriate defaults for DataExportDetailsResponse */ function dataExportDetailsResponseProvideDefaults(val: DataExportDetailsResponse): DataExportDetailsResponse; /** * Details of the data to be used for importing data to azure. */ interface DataImportDetailsResponse { /** * Account details of the data to be transferred */ accountDetails: outputs.databox.ManagedDiskDetailsResponse | outputs.databox.StorageAccountDetailsResponse; /** * Level of the logs to be collected. */ logCollectionLevel?: string; } /** * dataImportDetailsResponseProvideDefaults sets the appropriate defaults for DataImportDetailsResponse */ function dataImportDetailsResponseProvideDefaults(val: DataImportDetailsResponse): DataImportDetailsResponse; /** * The secrets related to a databox job. */ interface DataboxJobSecretsResponse { /** * Dc Access Security Code for Customer Managed Shipping */ dcAccessSecurityCode: outputs.databox.DcAccessSecurityCodeResponse; /** * Error while fetching the secrets. */ error: outputs.databox.CloudErrorResponse; /** * Used to indicate what type of job secrets object. * Expected value is 'DataBox'. */ jobSecretsType: "DataBox"; /** * Contains the list of secret objects for a job. */ podSecrets?: outputs.databox.DataBoxSecretResponse[]; } /** * Datacenter instruction for given storage location. */ interface DatacenterAddressInstructionResponseResponse { /** * Data center communication instruction */ communicationInstruction: string; /** * Azure Location where the Data Center serves primarily. */ dataCenterAzureLocation: string; /** * Data center address type * Expected value is 'DatacenterAddressInstruction'. */ datacenterAddressType: "DatacenterAddressInstruction"; /** * List of supported carriers for return shipment. */ supportedCarriersForReturnShipment: string[]; } /** * Datacenter address for given storage location. */ interface DatacenterAddressLocationResponseResponse { /** * Special instruction for shipping */ additionalShippingInformation: string; /** * Address type */ addressType: string; /** * City name */ city: string; /** * Company name */ company: string; /** * Contact person name */ contactPersonName: string; /** * name of the country */ country: string; /** * Azure Location where the Data Center serves primarily. */ dataCenterAzureLocation: string; /** * Data center address type * Expected value is 'DatacenterAddressLocation'. */ datacenterAddressType: "DatacenterAddressLocation"; /** * Phone number */ phone: string; /** * Phone extension */ phoneExtension: string; /** * name of the state */ state: string; /** * Street address line 1 */ street1: string; /** * Street address line 2 */ street2: string; /** * Street address line 3 */ street3: string; /** * List of supported carriers for return shipment. */ supportedCarriersForReturnShipment: string[]; /** * Zip code */ zip: string; } /** * Dc access security code */ interface DcAccessSecurityCodeResponse { /** * Forward Dc access security code. */ forwardDCAccessCode?: string; /** * Reverse Dc access security code. */ reverseDCAccessCode?: string; } /** * Device erasure details with erasure completion status and erasureordestructionlog sas key */ interface DeviceErasureDetailsResponse { /** * Holds the device erasure completion status */ deviceErasureStatus: string; /** * Shared access key to download cleanup or destruction certificate for device */ erasureOrDestructionCertificateSasKey: string; } /** * Contains all the secrets of a Disk. */ interface DiskSecretResponse { /** * Bit Locker key of the disk which can be used to unlock the disk to copy data. */ bitLockerKey: string; /** * Serial number of the assigned disk. */ diskSerialNumber: string; } /** * Preferences related to the Encryption. */ interface EncryptionPreferencesResponse { /** * Defines secondary layer of software-based encryption enablement. */ doubleEncryption?: string; /** * Defines Hardware level encryption (Only for disk) */ hardwareEncryption?: string; } /** * encryptionPreferencesResponseProvideDefaults sets the appropriate defaults for EncryptionPreferencesResponse */ function encryptionPreferencesResponseProvideDefaults(val: EncryptionPreferencesResponse): EncryptionPreferencesResponse; /** * Export disk details */ interface ExportDiskDetailsResponse { /** * Path to backed up manifest, only returned if enableManifestBackup is true. */ backupManifestCloudPath: string; /** * The relative path of the manifest file on the disk. */ manifestFile: string; /** * The Base16-encoded MD5 hash of the manifest file on the disk. */ manifestHash: string; } /** * Details of the filter files to be used for data transfer. */ interface FilterFileDetailsResponse { /** * Path of the file that contains the details of all items to transfer. */ filterFilePath: string; /** * Type of the filter file. */ filterFileType: string; } /** * Managed identity properties. */ interface IdentityPropertiesResponse { /** * Managed service identity type. */ type?: string; /** * User assigned identity properties. */ userAssigned?: outputs.databox.UserAssignedPropertiesResponse; } /** * Import disk details */ interface ImportDiskDetailsResponse { /** * Path to backed up manifest, only returned if enableManifestBackup is true. */ backupManifestCloudPath: string; /** * BitLocker key used to encrypt the disk. */ bitLockerKey: string; /** * The relative path of the manifest file on the disk. */ manifestFile: string; /** * The Base16-encoded MD5 hash of the manifest file on the disk. */ manifestHash: string; } /** * Job Delay Notification details */ interface JobDelayDetailsResponse { /** * Description of the delay. */ description: string; /** * Delay Error code */ errorCode: string; /** * Timestamp when the delay notification was resolved. */ resolutionTime: string; /** * Timestamp when the delay notification was created. */ startTime: string; /** * Status of notification */ status: string; } /** * Additional delivery info. */ interface JobDeliveryInfoResponse { /** * Scheduled date time. */ scheduledDateTime?: string; } /** * Job stages. */ interface JobStagesResponse { /** * Delay information for the job stages. */ delayInformation: outputs.databox.JobDelayDetailsResponse[]; /** * Display name of the job stage. */ displayName: string; /** * Job Stage Details */ jobStageDetails: any; /** * Name of the job stage. */ stageName: string; /** * Status of the job stage. */ stageStatus: string; /** * Time for the job stage in UTC ISO 8601 format. */ stageTime: string; } /** * Encryption key containing details about key to encrypt different keys. */ interface KeyEncryptionKeyResponse { /** * Managed identity properties used for key encryption. */ identityProperties?: outputs.databox.IdentityPropertiesResponse; /** * Type of encryption key used for key encryption. */ kekType: string; /** * Key encryption key. It is required in case of Customer managed KekType. */ kekUrl?: string; /** * Kek vault resource id. It is required in case of Customer managed KekType. */ kekVaultResourceID?: string; } /** * keyEncryptionKeyResponseProvideDefaults sets the appropriate defaults for KeyEncryptionKeyResponse */ function keyEncryptionKeyResponseProvideDefaults(val: KeyEncryptionKeyResponse): KeyEncryptionKeyResponse; /** * Last Mitigation Action Performed On Job */ interface LastMitigationActionOnJobResponse { /** * Action performed date time */ actionDateTimeInUtc?: string; /** * Resolution code provided by customer */ customerResolution?: string; /** * Action performed by customer, * possibility is that mitigation might happen by customer or service or by ops */ isPerformedByCustomer?: boolean; } /** * Details of the managed disks. */ interface ManagedDiskDetailsResponse { /** * Account Type of the data to be transferred. * Expected value is 'ManagedDisk'. */ dataAccountType: "ManagedDisk"; /** * Resource Group Id of the compute disks. */ resourceGroupId: string; /** * Resource Id of the storage account that can be used to copy the vhd for staging. */ stagingStorageAccountId: string; } /** * managedDiskDetailsResponseProvideDefaults sets the appropriate defaults for ManagedDiskDetailsResponse */ function managedDiskDetailsResponseProvideDefaults(val: ManagedDiskDetailsResponse): ManagedDiskDetailsResponse; /** * Notification preference for a job stage. */ interface NotificationPreferenceResponse { /** * Notification is required or not. */ sendNotification: boolean; /** * Name of the stage. */ stageName: string; } /** * notificationPreferenceResponseProvideDefaults sets the appropriate defaults for NotificationPreferenceResponse */ function notificationPreferenceResponseProvideDefaults(val: NotificationPreferenceResponse): NotificationPreferenceResponse; /** * Package carrier details. */ interface PackageCarrierDetailsResponse { /** * Carrier Account Number of customer for customer disk. */ carrierAccountNumber?: string; /** * Name of the carrier. */ carrierName?: string; /** * Tracking Id of shipment. */ trackingId?: string; } /** * package carrier info */ interface PackageCarrierInfoResponse { /** * Name of the carrier. */ carrierName?: string; /** * Tracking Id of shipment. */ trackingId?: string; } /** * package shipping details */ interface PackageShippingDetailsResponse { /** * Name of the carrier. */ carrierName: string; /** * Tracking Id of shipment. */ trackingId: string; /** * Url where shipment can be tracked. */ trackingUrl: string; } /** * Preferences related to the order */ interface PreferencesResponse { /** * Preferences related to the Encryption. */ encryptionPreferences?: outputs.databox.EncryptionPreferencesResponse; /** * Preferred data center region. */ preferredDataCenterRegion?: string[]; /** * Optional Preferences related to the reverse shipment logistics of the sku. */ reverseTransportPreferences?: outputs.databox.TransportPreferencesResponse; /** * Preferences related to the Access Tier of storage accounts. */ storageAccountAccessTierPreferences?: string[]; /** * Preferences related to the shipment logistics of the sku. */ transportPreferences?: outputs.databox.TransportPreferencesResponse; } /** * preferencesResponseProvideDefaults sets the appropriate defaults for PreferencesResponse */ function preferencesResponseProvideDefaults(val: PreferencesResponse): PreferencesResponse; /** * Msi identity details of the resource */ interface ResourceIdentityResponse { /** * Service Principal Id backing the Msi */ principalId: string; /** * Home Tenant Id */ tenantId: string; /** * Identity type */ type?: string; /** * User Assigned Identities */ userAssignedIdentities?: { [key: string]: outputs.databox.UserAssignedIdentityResponse; }; } /** * resourceIdentityResponseProvideDefaults sets the appropriate defaults for ResourceIdentityResponse */ function resourceIdentityResponseProvideDefaults(val: ResourceIdentityResponse): ResourceIdentityResponse; /** * Reverse Shipping Address and contact details for a job. */ interface ReverseShippingDetailsResponse { /** * Contact Info. */ contactDetails?: outputs.databox.ContactInfoResponse; /** * A flag to indicate whether Reverse Shipping details are updated or not after device has been prepared. * Read only field */ isUpdated: boolean; /** * Shipping address where customer wishes to receive the device. */ shippingAddress?: outputs.databox.ShippingAddressResponse; } /** * reverseShippingDetailsResponseProvideDefaults sets the appropriate defaults for ReverseShippingDetailsResponse */ function reverseShippingDetailsResponseProvideDefaults(val: ReverseShippingDetailsResponse): ReverseShippingDetailsResponse; /** * Credential details of the shares in account. */ interface ShareCredentialDetailsResponse { /** * Password for the share. */ password: string; /** * Name of the share. */ shareName: string; /** * Type of the share. */ shareType: string; /** * Access protocols supported on the device. */ supportedAccessProtocols: string[]; /** * User name for the share. */ userName: string; } /** * Shipping address where customer wishes to receive the device. */ interface ShippingAddressResponse { /** * Type of address. */ addressType?: string; /** * Name of the City. */ city?: string; /** * Name of the company. */ companyName?: string; /** * Name of the Country. */ country: string; /** * Postal code. */ postalCode?: string; /** * Flag to indicate if customer has chosen to skip default address validation */ skipAddressValidation?: boolean; /** * Name of the State or Province. */ stateOrProvince?: string; /** * Street Address line 1. */ streetAddress1: string; /** * Street Address line 2. */ streetAddress2?: string; /** * Street Address line 3. */ streetAddress3?: string; /** * Tax Identification Number */ taxIdentificationNumber?: string; /** * Extended Zip Code. */ zipExtendedCode?: string; } /** * shippingAddressResponseProvideDefaults sets the appropriate defaults for ShippingAddressResponse */ function shippingAddressResponseProvideDefaults(val: ShippingAddressResponse): ShippingAddressResponse; /** * The Sku. */ interface SkuResponse { /** * The display name of the sku. */ displayName?: string; /** * The sku family. */ family?: string; /** * The model name. */ model: string; /** * The sku name. */ name: string; } /** * Details for the storage account. */ interface StorageAccountDetailsResponse { /** * Account Type of the data to be transferred. * Expected value is 'StorageAccount'. */ dataAccountType: "StorageAccount"; /** * Storage Account Resource Id. */ storageAccountId: string; } /** * storageAccountDetailsResponseProvideDefaults sets the appropriate defaults for StorageAccountDetailsResponse */ function storageAccountDetailsResponseProvideDefaults(val: StorageAccountDetailsResponse): StorageAccountDetailsResponse; /** * Provides details about resource creation and update time */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC) */ createdAt: string; /** * A string identifier for the identity that created the resource */ createdBy: string; /** * The type of identity that created the resource: user, application, managedIdentity */ createdByType: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt: string; /** * A string identifier for the identity that last modified the resource */ lastModifiedBy: string; /** * The type of identity that last modified the resource: user, application, managedIdentity */ lastModifiedByType: string; } /** * Details to transfer all data. */ interface TransferAllDetailsResponse { /** * Type of the account of data */ dataAccountType: string; /** * To indicate if all Azure blobs have to be transferred */ transferAllBlobs?: boolean; /** * To indicate if all Azure Files have to be transferred */ transferAllFiles?: boolean; } /** * transferAllDetailsResponseProvideDefaults sets the appropriate defaults for TransferAllDetailsResponse */ function transferAllDetailsResponseProvideDefaults(val: TransferAllDetailsResponse): TransferAllDetailsResponse; /** * Configuration for defining the transfer of data. */ interface TransferConfigurationResponse { /** * Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll */ transferAllDetails?: outputs.databox.TransferConfigurationResponseTransferAllDetails; /** * Type of the configuration for transfer. */ transferConfigurationType: string; /** * Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. */ transferFilterDetails?: outputs.databox.TransferConfigurationResponseTransferFilterDetails; } /** * transferConfigurationResponseProvideDefaults sets the appropriate defaults for TransferConfigurationResponse */ function transferConfigurationResponseProvideDefaults(val: TransferConfigurationResponse): TransferConfigurationResponse; /** * Map of filter type and the details to transfer all data. This field is required only if the TransferConfigurationType is given as TransferAll */ interface TransferConfigurationResponseTransferAllDetails { /** * Details to transfer all data. */ include?: outputs.databox.TransferAllDetailsResponse; } /** * transferConfigurationResponseTransferAllDetailsProvideDefaults sets the appropriate defaults for TransferConfigurationResponseTransferAllDetails */ function transferConfigurationResponseTransferAllDetailsProvideDefaults(val: TransferConfigurationResponseTransferAllDetails): TransferConfigurationResponseTransferAllDetails; /** * Map of filter type and the details to filter. This field is required only if the TransferConfigurationType is given as TransferUsingFilter. */ interface TransferConfigurationResponseTransferFilterDetails { /** * Details of the filtering the transfer of data. */ include?: outputs.databox.TransferFilterDetailsResponse; } /** * transferConfigurationResponseTransferFilterDetailsProvideDefaults sets the appropriate defaults for TransferConfigurationResponseTransferFilterDetails */ function transferConfigurationResponseTransferFilterDetailsProvideDefaults(val: TransferConfigurationResponseTransferFilterDetails): TransferConfigurationResponseTransferFilterDetails; /** * Details of the filtering the transfer of data. */ interface TransferFilterDetailsResponse { /** * Filter details to transfer Azure files. */ azureFileFilterDetails?: outputs.databox.AzureFileFilterDetailsResponse; /** * Filter details to transfer blobs. */ blobFilterDetails?: outputs.databox.BlobFilterDetailsResponse; /** * Type of the account of data. */ dataAccountType: string; /** * Details of the filter files to be used for data transfer. */ filterFileDetails?: outputs.databox.FilterFileDetailsResponse[]; } /** * transferFilterDetailsResponseProvideDefaults sets the appropriate defaults for TransferFilterDetailsResponse */ function transferFilterDetailsResponseProvideDefaults(val: TransferFilterDetailsResponse): TransferFilterDetailsResponse; /** * Preferences related to the shipment logistics of the sku */ interface TransportPreferencesResponse { /** * Read only property which indicates whether transport preferences has been updated or not after device is prepared. */ isUpdated: boolean; /** * Indicates Shipment Logistics type that the customer preferred. */ preferredShipmentType: string; } /** * Unencrypted credentials for accessing device. */ interface UnencryptedCredentialsResponse { /** * Name of the job. */ jobName: string; /** * Secrets related to this job. */ jobSecrets: outputs.databox.CustomerDiskJobSecretsResponse | outputs.databox.DataBoxDiskJobSecretsResponse | outputs.databox.DataBoxHeavyJobSecretsResponse | outputs.databox.DataboxJobSecretsResponse; } /** * Class defining User assigned identity details. */ interface UserAssignedIdentityResponse { /** * The client id of user assigned identity. */ clientId: string; /** * The principal id of user assigned identity. */ principalId: string; } /** * User assigned identity properties. */ interface UserAssignedPropertiesResponse { /** * Arm resource id for user assigned identity to be used to fetch MSI token. */ resourceId?: string; } } export declare namespace databoxedge { /** * The shipping address of the customer. */ interface AddressResponse { /** * The address line1. */ addressLine1?: string; /** * The address line2. */ addressLine2?: string; /** * The address line3. */ addressLine3?: string; /** * The city name. */ city?: string; /** * The country name. */ country: string; /** * The postal code. */ postalCode?: string; /** * The state name. */ state?: string; } /** * Represent the secrets intended for encryption with asymmetric key pair. */ interface AsymmetricEncryptedSecretResponse { /** * The algorithm used to encrypt "Value". */ encryptionAlgorithm: string; /** * Thumbprint certificate used to encrypt \"Value\". If the value is unencrypted, it will be null. */ encryptionCertThumbprint?: string; /** * The value of the secret. */ value: string; } /** * Authentication mechanism for IoT devices. */ interface AuthenticationResponse { /** * Symmetric key for authentication. */ symmetricKey?: outputs.databoxedge.SymmetricKeyResponse; } /** * Azure container mapping of the endpoint. */ interface AzureContainerInfoResponse { /** * Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob). */ containerName: string; /** * Storage format used for the file represented by the share. */ dataFormat: string; /** * ID of the storage account credential used to access storage. */ storageAccountCredentialId: string; } /** * The mapping between a particular client IP and the type of access client has on the NFS share. */ interface ClientAccessRightResponse { /** * Type of access to be allowed for the client. */ accessPermission: string; /** * IP of the client. */ client: string; } /** * Cni configuration */ interface CniConfigResponse { /** * Pod Subnet */ podSubnet: string; /** * Service subnet */ serviceSubnet: string; /** * Cni type */ type: string; /** * Cni version */ version: string; } /** * Compute infrastructure Resource */ interface ComputeResourceResponse { /** * Memory in GB */ memoryInGB: number; /** * Processor count */ processorCount: number; } /** * Contains all the contact details of the customer. */ interface ContactDetailsResponse { /** * The name of the company. */ companyName: string; /** * The contact person name. */ contactPerson: string; /** * The email list. */ emailList: string[]; /** * The phone number. */ phone: string; } /** * Wraps data-residency related information for edge-resource and this should be used with ARM layer. */ interface DataResidencyResponse { /** * DataResidencyType enum */ type?: string; } /** * Details about Edge Profile for the resource */ interface EdgeProfileResponse { /** * Edge Profile Subscription */ subscription?: outputs.databoxedge.EdgeProfileSubscriptionResponse; } /** * Subscription details for the Edge Profile */ interface EdgeProfileSubscriptionResponse { /** * ARM ID of the subscription */ id?: string; locationPlacementId?: string; quotaId?: string; registeredFeatures?: outputs.databoxedge.SubscriptionRegisteredFeaturesResponse[]; registrationDate?: string; /** * Edge Subscription Registration ID */ registrationId?: string; serializedDetails?: string; state?: string; subscriptionId?: string; tenantId?: string; } /** * Etcd configuration */ interface EtcdInfoResponse { /** * Etcd type */ type: string; /** * Etcd version */ version: string; } /** * File source details. */ interface FileSourceInfoResponse { /** * File share ID. */ shareId: string; } /** * Image repository credential. */ interface ImageRepositoryCredentialResponse { /** * Image repository url (e.g.: mcr.microsoft.com). */ imageRepositoryUrl: string; /** * Repository user password. */ password?: outputs.databoxedge.AsymmetricEncryptedSecretResponse; /** * Repository user name. */ userName: string; } /** * Metadata of IoT device/IoT Edge device to be configured. */ interface IoTDeviceInfoResponse { /** * Encrypted IoT device/IoT edge device connection string. */ authentication?: outputs.databoxedge.AuthenticationResponse; /** * ID of the IoT device/edge device. */ deviceId: string; /** * Host name for the IoT hub associated to the device. */ ioTHostHub: string; /** * Id for the IoT hub associated to the device. */ ioTHostHubId?: string; } /** * IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified. */ interface IoTEdgeAgentInfoResponse { /** * Name of the IoT edge agent image. */ imageName: string; /** * Image repository details. */ imageRepository?: outputs.databoxedge.ImageRepositoryCredentialResponse; /** * Image Tag. */ tag: string; } /** * Kubernetes cluster configuration */ interface KubernetesClusterInfoResponse { /** * Etcd configuration */ etcdInfo: outputs.databoxedge.EtcdInfoResponse; /** * Kubernetes cluster nodes */ nodes: outputs.databoxedge.NodeInfoResponse[]; /** * Kubernetes cluster version */ version: string; } /** * Kubernetes node IP configuration */ interface KubernetesIPConfigurationResponse { /** * IP address of the Kubernetes node. */ ipAddress?: string; /** * Port of the Kubernetes node. */ port: string; } /** * Kubernetes role compute resource */ interface KubernetesRoleComputeResponse { /** * Memory in bytes */ memoryInBytes: number; /** * Processor count */ processorCount: number; /** * VM profile */ vmProfile: string; } /** * Kubernetes role network resource */ interface KubernetesRoleNetworkResponse { /** * Cni configuration */ cniConfig: outputs.databoxedge.CniConfigResponse; /** * Load balancer configuration */ loadBalancerConfig: outputs.databoxedge.LoadBalancerConfigResponse; } /** * Kubernetes role resources */ interface KubernetesRoleResourcesResponse { /** * Kubernetes role compute resource */ compute: outputs.databoxedge.KubernetesRoleComputeResponse; /** * Kubernetes role network resource */ network: outputs.databoxedge.KubernetesRoleNetworkResponse; /** * Kubernetes role storage resource */ storage?: outputs.databoxedge.KubernetesRoleStorageResponse; } /** * Kubernetes storage class info. */ interface KubernetesRoleStorageClassInfoResponse { /** * Storage class name. */ name: string; /** * If provisioned storage is posix compliant. */ posixCompliant: string; /** * Storage class type. */ type: string; } /** * Kubernetes role storage resource */ interface KubernetesRoleStorageResponse { /** * Mount points of shares in role(s). */ endpoints?: outputs.databoxedge.MountPointMapResponse[]; /** * Kubernetes storage class info. */ storageClasses: outputs.databoxedge.KubernetesRoleStorageClassInfoResponse[]; } /** * Load balancer configuration */ interface LoadBalancerConfigResponse { /** * Load balancer type */ type: string; /** * Load balancer version */ version: string; } /** * Metric configuration. */ interface MetricConfigurationResponse { /** * Host name for the IoT hub associated to the device. */ counterSets: outputs.databoxedge.MetricCounterSetResponse[]; /** * The MDM account to which the counters should be pushed. */ mdmAccount?: string; /** * The MDM namespace to which the counters should be pushed. This is required if MDMAccount is specified */ metricNameSpace?: string; /** * The Resource ID on which the metrics should be pushed. */ resourceId: string; } /** * The metric counter */ interface MetricCounterResponse { /** * The additional dimensions to be added to metric. */ additionalDimensions?: outputs.databoxedge.MetricDimensionResponse[]; /** * The dimension filter. */ dimensionFilter?: outputs.databoxedge.MetricDimensionResponse[]; /** * The instance from which counter should be collected. */ instance?: string; /** * The counter name. */ name: string; } /** * The metric counter set */ interface MetricCounterSetResponse { /** * The counters that should be collected in this set. */ counters: outputs.databoxedge.MetricCounterResponse[]; } /** * The metric dimension */ interface MetricDimensionResponse { /** * The dimension value. */ sourceName: string; /** * The dimension type. */ sourceType: string; } /** * The share mount point. */ interface MountPointMapResponse { /** * Mount point for the share. */ mountPoint: string; /** * Mounting type. */ mountType: string; /** * ID of the role to which share is mounted. */ roleId: string; /** * Role type. */ roleType: string; /** * ID of the share mounted to the role VM. */ shareId: string; } /** * Kubernetes node info */ interface NodeInfoResponse { /** * IP Configuration of the Kubernetes node. */ ipConfiguration?: outputs.databoxedge.KubernetesIPConfigurationResponse[]; /** * Node name. */ name: string; /** * Node type - Master/Worker */ type: string; } /** * Represents a single status change. */ interface OrderStatusResponse { /** * Dictionary to hold generic information which is not stored * by the already existing properties */ additionalOrderDetails: { [key: string]: string; }; /** * Comments related to this status change. */ comments?: string; /** * Status of the order as per the allowed status types. */ status: string; /** * Tracking information related to the state in the ordering flow */ trackingInformation: outputs.databoxedge.TrackingInfoResponse; /** * Time of status update. */ updateDateTime: string; } /** * Periodic timer event source. */ interface PeriodicTimerSourceInfoResponse { /** * Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds. */ schedule: string; /** * The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time. */ startTime: string; /** * Topic where periodic events are published to IoT device. */ topic?: string; } /** * Fields for tracking refresh job on the share or container. */ interface RefreshDetailsResponse { /** * Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job. */ errorManifestFile?: string; /** * If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress. */ inProgressRefreshJobId?: string; /** * Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job. */ lastCompletedRefreshJobTimeInUTC?: string; /** * Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job. */ lastJob?: string; } /** * Msi identity details of the resource */ interface ResourceIdentityResponse { /** * Service Principal Id backing the Msi */ principalId: string; /** * Home Tenant Id */ tenantId: string; /** * Identity type */ type?: string; } /** * Fields for tracking resource move */ interface ResourceMoveDetailsResponse { /** * Denotes whether move operation is in progress */ operationInProgress?: string; /** * Denotes the timeout of the operation to finish */ operationInProgressLockTimeoutInUTC?: string; } /** * Compute role against which events will be raised. */ interface RoleSinkInfoResponse { /** * Compute role ID. */ roleId: string; } /** * Holds device secret either as a KeyVault reference or as an encrypted value. */ interface SecretResponse { /** * Encrypted (using device public key) secret value. */ encryptedSecret?: outputs.databoxedge.AsymmetricEncryptedSecretResponse; /** * Id of the Key-Vault where secret is stored (ex: secrets/AuthClientSecret/82ef4346187a4033a10d629cde07d740). */ keyVaultId?: string; } /** * Specifies the mapping between this particular user and the type of access he has on shares on this device. */ interface ShareAccessRightResponse { /** * Type of access to be allowed on the share for this user. */ accessType: string; /** * The share ID. */ shareId: string; } /** * The SKU type. */ interface SkuResponse { /** * SKU name. */ name?: string; /** * The SKU tier. This is based on the SKU name. */ tier?: string; } interface SubscriptionRegisteredFeaturesResponse { name?: string; state?: string; } /** * Symmetric key for authentication. */ interface SymmetricKeyResponse { /** * Connection string based on the symmetric key. */ connectionString?: outputs.databoxedge.AsymmetricEncryptedSecretResponse; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Tracking courier information. */ interface TrackingInfoResponse { /** * Name of the carrier used in the delivery. */ carrierName?: string; /** * Serial number of the device being tracked. */ serialNumber?: string; /** * Tracking ID of the shipment. */ trackingId?: string; /** * Tracking URL of the shipment. */ trackingUrl?: string; } /** * The mapping between a particular user and the access type on the SMB share. */ interface UserAccessRightResponse { /** * Type of access to be allowed for the user. */ accessType: string; /** * User ID (already existing in the device). */ userId: string; } } export declare namespace databricks { interface AccessConnectorPropertiesResponse { /** * Provisioning status of the Access Connector. */ provisioningState: string; /** * List of workspaces referring this Access Connector. */ referedBy: string[]; } /** * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. */ interface AddressSpaceResponse { /** * A list of address blocks reserved for this virtual network in CIDR notation. */ addressPrefixes?: string[]; } /** * Status of automated cluster updates feature. */ interface AutomaticClusterUpdateDefinitionResponse { value?: string; } /** * Status of Compliance Security Profile feature. */ interface ComplianceSecurityProfileDefinitionResponse { /** * Compliance standards associated with the workspace. */ complianceStandards?: string[]; value?: string; } /** * Provides details of the entity that created/updated the workspace. */ interface CreatedByResponse { /** * The application ID of the application that initiated the creation of the workspace. For example, Azure Portal. */ applicationId: string; /** * The Object ID that created the workspace. */ oid: string; /** * The Personal Object ID corresponding to the object ID above */ puid: string; } /** * These properties lets user specify default catalog properties during workspace creation. Not allowed in Serverless ComputeMode workspace. */ interface DefaultCatalogPropertiesResponse { /** * Specifies the initial Name of default catalog. If not specified, the name of the workspace will be used. */ initialName?: string; /** * Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog */ initialType?: string; } /** * defaultCatalogPropertiesResponseProvideDefaults sets the appropriate defaults for DefaultCatalogPropertiesResponse */ function defaultCatalogPropertiesResponseProvideDefaults(val: DefaultCatalogPropertiesResponse): DefaultCatalogPropertiesResponse; /** * Encryption entities for databricks workspace resource. */ interface EncryptionEntitiesDefinitionResponse { /** * Encryption properties for the databricks managed disks. Not allowed in Serverless ComputeMode workspace. */ managedDisk?: outputs.databricks.ManagedDiskEncryptionResponse; /** * Encryption properties for the databricks managed services. Supported in both Serverless and Hybrid ComputeMode. */ managedServices?: outputs.databricks.EncryptionV2Response; } /** * The object that contains details of encryption used on the workspace. */ interface EncryptionResponse { /** * The name of KeyVault key. */ keyName?: string; /** * The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault */ keySource?: string; /** * The Uri of KeyVault. */ keyVaultUri?: string; /** * The version of KeyVault key. */ keyVersion?: string; } /** * encryptionResponseProvideDefaults sets the appropriate defaults for EncryptionResponse */ function encryptionResponseProvideDefaults(val: EncryptionResponse): EncryptionResponse; /** * Key Vault input properties for encryption. */ interface EncryptionV2KeyVaultPropertiesResponse { /** * The name of KeyVault key. */ keyName: string; /** * The Uri of KeyVault. */ keyVaultUri: string; /** * The version of KeyVault key. */ keyVersion: string; } /** * The object that contains details of encryption used on the workspace. */ interface EncryptionV2Response { /** * The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault */ keySource: string; /** * Key Vault input properties for encryption. */ keyVaultProperties?: outputs.databricks.EncryptionV2KeyVaultPropertiesResponse; } /** * Status of settings related to the Enhanced Security and Compliance Add-On. */ interface EnhancedSecurityComplianceDefinitionResponse { /** * Status of automated cluster updates feature. */ automaticClusterUpdate?: outputs.databricks.AutomaticClusterUpdateDefinitionResponse; /** * Status of Compliance Security Profile feature. */ complianceSecurityProfile?: outputs.databricks.ComplianceSecurityProfileDefinitionResponse; /** * Status of Enhanced Security Monitoring feature. */ enhancedSecurityMonitoring?: outputs.databricks.EnhancedSecurityMonitoringDefinitionResponse; } /** * Status of Enhanced Security Monitoring feature. */ interface EnhancedSecurityMonitoringDefinitionResponse { value?: string; } /** * Key Vault input properties for encryption. */ interface ManagedDiskEncryptionKeyVaultPropertiesResponse { /** * The name of KeyVault key. */ keyName: string; /** * The URI of KeyVault. */ keyVaultUri: string; /** * The version of KeyVault key. */ keyVersion: string; } /** * The object that contains details of encryption used on the workspace. */ interface ManagedDiskEncryptionResponse { /** * The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault. Not allowed in Serverless ComputeMode workspace. */ keySource: string; /** * Key Vault input properties for encryption. */ keyVaultProperties: outputs.databricks.ManagedDiskEncryptionKeyVaultPropertiesResponse; /** * Indicate whether the latest key version should be automatically used for Managed Disk Encryption. */ rotationToLatestKeyVersionEnabled?: boolean; } /** * The Managed Identity details for storage account. */ interface ManagedIdentityConfigurationResponse { /** * The objectId of the Managed Identity that is linked to the Managed Storage account. */ principalId: string; /** * The tenant Id where the Managed Identity is created. */ tenantId: string; /** * The type of Identity created. It can be either SystemAssigned or UserAssigned. */ type: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.databricks.UserAssignedIdentityResponse; }; } /** * The properties of a private endpoint connection. */ interface PrivateEndpointConnectionPropertiesResponse { /** * GroupIds from the private link service resource. */ groupIds?: string[]; /** * Private endpoint */ privateEndpoint?: outputs.databricks.PrivateEndpointResponse; /** * Private endpoint connection state */ privateLinkServiceConnectionState: outputs.databricks.PrivateLinkServiceConnectionStateResponse; /** * Provisioning state of the private endpoint connection. */ provisioningState: string; } /** * The private endpoint connection of a workspace. */ interface PrivateEndpointConnectionResponse { /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint connection properties. */ properties: outputs.databricks.PrivateEndpointConnectionPropertiesResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.databricks.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint property of a private endpoint connection. */ interface PrivateEndpointResponse { /** * The resource identifier. */ id: string; } /** * The current state of a private endpoint connection. */ interface PrivateLinkServiceConnectionStateResponse { /** * Actions required for a private endpoint connection */ actionsRequired?: string; /** * The description for the current state of a private endpoint connection */ description?: string; /** * The status of a private endpoint connection */ status: string; } /** * SKU for the resource. */ interface SkuResponse { /** * The SKU name. */ name: string; /** * The SKU tier. */ tier?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering). */ interface VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetworkResponse { /** * The Id of the databricks virtual network. */ id?: string; } /** * The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering). */ interface VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetworkResponse { /** * The Id of the remote virtual network. */ id?: string; } /** * The value which should be used for this field. */ interface WorkspaceCustomBooleanParameterResponse { /** * The type of variable that this is */ type?: string; /** * The value which should be used for this field. */ value: boolean; } /** * The value which should be used for this field. */ interface WorkspaceCustomObjectParameterResponse { /** * The type of variable that this is */ type?: string; /** * The value which should be used for this field. */ value: any; } /** * Custom Parameters used for Workspace Creation. Not allowed in Serverless ComputeMode workspace. */ interface WorkspaceCustomParametersResponse { /** * The ID of a Azure Machine Learning workspace to link with Databricks workspace. Not allowed in Serverless ComputeMode workspace. */ amlWorkspaceId?: outputs.databricks.WorkspaceCustomStringParameterResponse; /** * The name of the Private Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace. */ customPrivateSubnetName?: outputs.databricks.WorkspaceCustomStringParameterResponse; /** * The name of a Public Subnet within the Virtual Network. Not allowed in Serverless ComputeMode workspace. */ customPublicSubnetName?: outputs.databricks.WorkspaceCustomStringParameterResponse; /** * The ID of a Virtual Network where this Databricks Cluster should be created. Not allowed in Serverless ComputeMode workspace. */ customVirtualNetworkId?: outputs.databricks.WorkspaceCustomStringParameterResponse; /** * Boolean indicating whether the public IP should be disabled. Default value is true. Not allowed in Serverless ComputeMode workspace. */ enableNoPublicIp?: outputs.databricks.WorkspaceNoPublicIPBooleanParameterResponse; /** * Contains the encryption details for Customer-Managed Key (CMK) enabled workspace.Not allowed in Serverless ComputeMode workspace. */ encryption?: outputs.databricks.WorkspaceEncryptionParameterResponse; /** * Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP). Not allowed in Serverless ComputeMode workspace. */ loadBalancerBackendPoolName?: outputs.databricks.WorkspaceCustomStringParameterResponse; /** * Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace. Not allowed in Serverless ComputeMode workspace. */ loadBalancerId?: outputs.databricks.WorkspaceCustomStringParameterResponse; /** * Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets. Not allowed in Serverless ComputeMode workspace. */ natGatewayName?: outputs.databricks.WorkspaceCustomStringParameterResponse; /** * Prepare the workspace for encryption. Enables the Managed Identity for managed storage account. Not allowed in Serverless ComputeMode workspace. */ prepareEncryption?: outputs.databricks.WorkspaceCustomBooleanParameterResponse; /** * Name of the Public IP for No Public IP workspace with managed vNet. Not allowed in Serverless ComputeMode workspace. */ publicIpName?: outputs.databricks.WorkspaceCustomStringParameterResponse; /** * A boolean indicating whether or not the DBFS root file system will be enabled with secondary layer of encryption with platform managed keys for data at rest. Not allowed in Serverless ComputeMode workspace. */ requireInfrastructureEncryption?: outputs.databricks.WorkspaceCustomBooleanParameterResponse; /** * Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level. Not allowed in Serverless ComputeMode workspace. */ resourceTags: outputs.databricks.WorkspaceCustomObjectParameterResponse; /** * Default DBFS storage account name. Not allowed in Serverless ComputeMode workspace. */ storageAccountName?: outputs.databricks.WorkspaceCustomStringParameterResponse; /** * Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs. Not allowed in Serverless ComputeMode workspace. */ storageAccountSkuName?: outputs.databricks.WorkspaceCustomStringParameterResponse; /** * Address prefix for Managed virtual network. Default value for this input is 10.139. Not allowed in Serverless ComputeMode workspace. */ vnetAddressPrefix?: outputs.databricks.WorkspaceCustomStringParameterResponse; } /** * workspaceCustomParametersResponseProvideDefaults sets the appropriate defaults for WorkspaceCustomParametersResponse */ function workspaceCustomParametersResponseProvideDefaults(val: WorkspaceCustomParametersResponse): WorkspaceCustomParametersResponse; /** * The Value. */ interface WorkspaceCustomStringParameterResponse { /** * The type of variable that this is */ type?: string; /** * The value which should be used for this field. */ value: string; } /** * The object that contains details of encryption used on the workspace. */ interface WorkspaceEncryptionParameterResponse { /** * The type of variable that this is */ type?: string; /** * The value which should be used for this field. */ value?: outputs.databricks.EncryptionResponse; } /** * workspaceEncryptionParameterResponseProvideDefaults sets the appropriate defaults for WorkspaceEncryptionParameterResponse */ function workspaceEncryptionParameterResponseProvideDefaults(val: WorkspaceEncryptionParameterResponse): WorkspaceEncryptionParameterResponse; /** * The value which should be used for this field. */ interface WorkspaceNoPublicIPBooleanParameterResponse { /** * The type of variable that this is */ type?: string; /** * The value which should be used for this field. */ value: boolean; } /** * Access Connector Resource that is going to be associated with Databricks Workspace. Not allowed in Serverless ComputeMode workspace. */ interface WorkspacePropertiesAccessConnectorResponse { /** * The resource ID of Azure Databricks Access Connector Resource. */ id: string; /** * The identity type of the Access Connector Resource. */ identityType: string; /** * The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'. */ userAssignedIdentityId?: string; } /** * Encryption properties for databricks workspace. Supported in both Serverless and Hybrid ComputeMode workspace. */ interface WorkspacePropertiesEncryptionResponse { /** * Encryption entities definition for the workspace. */ entities: outputs.databricks.EncryptionEntitiesDefinitionResponse; } /** * The workspace provider authorization. */ interface WorkspaceProviderAuthorizationResponse { /** * The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. */ principalId: string; /** * The provider's role definition identifier. This role will define all the permissions that the provider must have on the workspace's container resource group. This role definition cannot have permission to delete the resource group. */ roleDefinitionId: string; } } export declare namespace datacatalog { /** * User principals. */ interface PrincipalsResponse { /** * Object Id for the user */ objectId?: string; /** * UPN of the user. */ upn?: string; } } export declare namespace datadog { interface DatadogApiKeyResponse { /** * The time of creation of the API key. */ created?: string; /** * The user that created the API key. */ createdBy?: string; /** * The value of the API key. */ key: string; /** * The name of the API key. */ name?: string; } interface DatadogHostMetadataResponse { /** * The agent version. */ agentVersion?: string; installMethod?: outputs.datadog.DatadogInstallMethodResponse; logsAgent?: outputs.datadog.DatadogLogsAgentResponse; } interface DatadogHostResponse { /** * The aliases for the host installed via the Datadog agent. */ aliases?: string[]; /** * The Datadog integrations reporting metrics for the host. */ apps?: string[]; meta?: outputs.datadog.DatadogHostMetadataResponse; /** * The name of the host. */ name?: string; } interface DatadogInstallMethodResponse { /** * The installer version. */ installerVersion?: string; /** * The tool. */ tool?: string; /** * The tool version. */ toolVersion?: string; } interface DatadogLogsAgentResponse { /** * The transport. */ transport?: string; } /** * Specify the Datadog organization name. In the case of linking to existing organizations, Id, ApiKey, and Applicationkey is required as well. */ interface DatadogOrganizationPropertiesResponse { /** * The configuration which describes the state of cloud security posture management. This collects configuration information for all resources in a subscription and track conformance to industry benchmarks. */ cspm?: boolean; /** * Id of the Datadog organization. */ id?: string; /** * Name of the Datadog organization. */ name?: string; } /** * The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored. */ interface FilteringTagResponse { /** * Valid actions for a filtering tag. Exclusion takes priority over inclusion. */ action?: string; /** * The name (also known as the key) of the tag. */ name?: string; /** * The value of the tag. */ value?: string; } interface IdentityPropertiesResponse { /** * The identity ID. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * Specifies the identity type of the Datadog Monitor. At this time the only allowed value is 'SystemAssigned'. */ type?: string; } /** * The definition of a linked resource. */ interface LinkedResourceResponse { /** * The ARM id of the linked resource. */ id?: string; /** * The location of the linked resource. */ location?: string; } /** * Set of rules for sending logs for the Monitor resource. */ interface LogRulesResponse { /** * List of filtering tags to be used for capturing logs. This only takes effect if SendResourceLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. */ filteringTags?: outputs.datadog.FilteringTagResponse[]; /** * Flag specifying if AAD logs should be sent for the Monitor resource. */ sendAadLogs?: boolean; /** * Flag specifying if Azure resource logs should be sent for the Monitor resource. */ sendResourceLogs?: boolean; /** * Flag specifying if Azure subscription logs should be sent for the Monitor resource. */ sendSubscriptionLogs?: boolean; } /** * Marketplace SAAS Info of the resource. */ interface MarketplaceSaaSInfoResponse { /** * The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into. */ billedAzureSubscriptionId?: string; /** * Marketplace Subscription Details: SAAS Name */ marketplaceName?: string; /** * Marketplace Subscription Details: SaaS Subscription Status */ marketplaceStatus?: string; /** * Marketplace Subscription Id. This is a GUID-formatted string. */ marketplaceSubscriptionId?: string; /** * Flag specifying if the Marketplace status is subscribed or not. */ subscribed?: boolean; } /** * Set of rules for sending metrics for the Monitor resource. */ interface MetricRulesResponse { /** * List of filtering tags to be used for capturing metrics. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. */ filteringTags?: outputs.datadog.FilteringTagResponse[]; } /** * Properties specific to the monitor resource. */ interface MonitorPropertiesResponse { /** * Specify the Datadog organization name. In the case of linking to existing organizations, Id, ApiKey, and Applicationkey is required as well. */ datadogOrganizationProperties?: outputs.datadog.DatadogOrganizationPropertiesResponse; liftrResourceCategory: string; /** * The priority of the resource. */ liftrResourcePreference: number; /** * Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. */ marketplaceSubscriptionStatus: string; /** * Flag specifying if the resource monitoring is enabled or disabled. */ monitoringStatus?: string; provisioningState: string; /** * Includes name, email and optionally, phone number. User Information can't be null. */ userInfo?: outputs.datadog.UserInfoResponse; } /** * The properties of a resource currently being monitored by the Datadog monitor resource. */ interface MonitoredResourceResponse { /** * The ARM id of the resource. */ id?: string; /** * Reason for why the resource is sending logs (or why it is not sending). */ reasonForLogsStatus?: string; /** * Reason for why the resource is sending metrics (or why it is not sending). */ reasonForMetricsStatus?: string; /** * Flag indicating if resource is sending logs to Datadog. */ sendingLogs?: boolean; /** * Flag indicating if resource is sending metrics to Datadog. */ sendingMetrics?: boolean; } /** * The list of subscriptions and it's monitoring status by current Datadog monitor. */ interface MonitoredSubscriptionResponse { /** * The reason of not monitoring the subscription. */ error?: string; /** * The state of monitoring. */ status?: string; /** * The subscriptionId to be monitored. */ subscriptionId?: string; /** * Definition of the properties for a TagRules resource. */ tagRules?: outputs.datadog.MonitoringTagRulesPropertiesResponse; } /** * Definition of the properties for a TagRules resource. */ interface MonitoringTagRulesPropertiesResponse { /** * Configuration to enable/disable auto-muting flag */ automuting?: boolean; /** * Configuration to enable/disable custom metrics. If enabled, custom metrics from app insights will be sent. */ customMetrics?: boolean; /** * Set of rules for sending logs for the Monitor resource. */ logRules?: outputs.datadog.LogRulesResponse; /** * Set of rules for sending metrics for the Monitor resource. */ metricRules?: outputs.datadog.MetricRulesResponse; provisioningState: string; } /** * Partner Billing details associated with the resource. */ interface PartnerBillingEntityResponse { /** * The Datadog Organization Id. */ id?: string; /** * The Datadog Organization Name. */ name?: string; /** * Link to the datadog organization page */ partnerEntityUri?: string; } interface ResourceSkuResponse { /** * Name of the SKU in {PlanId} format. For Terraform, the only allowed value is 'Linked'. */ name: string; } /** * The request to update subscriptions needed to be monitored by the Datadog monitor resource. */ interface SubscriptionListResponse { /** * List of subscriptions and the state of the monitoring. */ monitoredSubscriptionList?: outputs.datadog.MonitoredSubscriptionResponse[]; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Includes name, email and optionally, phone number. User Information can't be null. */ interface UserInfoResponse { /** * Email of the user used by Datadog for contacting them if needed */ emailAddress?: string; /** * Name of the user */ name?: string; /** * Phone number of the user used by Datadog for contacting them if needed */ phoneNumber?: string; } } export declare namespace datafactory { /** * Activity dependency information. */ interface ActivityDependencyResponse { /** * Activity name. */ activity: string; /** * Match-Condition for the dependency. */ dependencyConditions: string[]; } /** * Execution policy for an activity. */ interface ActivityPolicyResponse { /** * Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0. */ retry?: any; /** * Interval between each retry attempt (in seconds). The default is 30 sec. */ retryIntervalInSeconds?: number; /** * When set to true, Input from activity is considered as secure and will not be logged to monitoring. */ secureInput?: boolean; /** * When set to true, Output from activity is considered as secure and will not be logged to monitoring. */ secureOutput?: boolean; /** * Specifies the timeout for the activity to run. The default timeout is 7 days. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ timeout?: any; } /** * Amazon Marketplace Web Service linked service. */ interface AmazonMWSLinkedServiceResponse { /** * The access key id used to access data. */ accessKeyId: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The endpoint of the Amazon MWS server, (i.e. mws.amazonservices.com) */ endpoint: any; /** * The Amazon Marketplace ID you want to retrieve data from. To retrieve data from multiple Marketplace IDs, separate them with a comma (,). (i.e. A2EUQ1WTGCTBG2) */ marketplaceID: any; /** * The Amazon MWS authentication token. */ mwsAuthToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The secret key used to access data. */ secretKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The Amazon seller ID. */ sellerID: any; /** * Type of linked service. * Expected value is 'AmazonMWS'. */ type: "AmazonMWS"; /** * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. */ useEncryptedEndpoints?: any; /** * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. */ useHostVerification?: any; /** * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. */ usePeerVerification?: any; /** * Version of the linked service. */ version?: string; } /** * Amazon Marketplace Web Service dataset. */ interface AmazonMWSObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'AmazonMWSObject'. */ type: "AmazonMWSObject"; } /** * A copy activity Amazon Marketplace Web Service source. */ interface AmazonMWSSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'AmazonMWSSource'. */ type: "AmazonMWSSource"; } /** * AmazonRdsForOracle database. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features. */ interface AmazonRdsForOracleLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Authentication type for connecting to the AmazonRdsForOracle database. Only used for Version 2.0. */ authenticationType?: string; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only used for Version 1.0. */ connectionString?: any; /** * Specifies the desired data integrity behavior when this client connects to a server. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0. */ cryptoChecksumClient?: any; /** * Specifies the crypto-checksum algorithms that client can use. Supported values are SHA1, SHA256, SHA384, SHA512, default value is (SHA512). Type: string. Only used for Version 2.0. */ cryptoChecksumTypesClient?: any; /** * Linked service description. */ description?: string; /** * Specifies whether to use bulk copy or batch insert when loading data into the database, default value is true. Type: boolean. Only used for Version 2.0. */ enableBulkLoad?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Specifies the encryption client behavior. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0. */ encryptionClient?: any; /** * Specifies the encryption algorithms that client can use. Supported values are AES128, AES192, AES256, 3DES112, 3DES168, default value is (AES256). Type: string. Only used for Version 2.0. */ encryptionTypesClient?: any; /** * Specifies the number of bytes that the driver allocates to fetch the data in one database round-trip, default value is 10485760. Type: integer. Only used for Version 2.0. */ fetchSize?: any; /** * Specifies whether the driver returns column value with the TIMESTAMP WITH TIME ZONE data type as DateTime or string. This setting is ignored if supportV1DataTypes is not true, default value is true. Type: boolean. Only used for Version 2.0. */ fetchTswtzAsTimestamp?: any; /** * Specifies the amount that the source initially fetches for LOB columns, default value is 0. Type: integer. Only used for Version 2.0. */ initialLobFetchSize?: any; /** * Specifies a command that is issued immediately after connecting to the database to manage session settings. Type: string. Only used for Version 2.0. */ initializationString?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of password in connection string. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The location of AmazonRdsForOracle database you want to connect to, the supported forms include connector descriptor, Easy Connect (Plus) Naming and Oracle Net Services Name (Only self-hosted IR). Type: string. Only used for Version 2.0. */ server?: any; /** * Specifies the number of cursors or statements to be cached for each database connection, default value is 0. Type: integer. Only used for Version 2.0. */ statementCacheSize?: any; /** * Specifies whether to use the Version 1.0 data type mappings. Do not set this to true unless you want to keep backward compatibility with Version 1.0's data type mappings, default value is false. Type: boolean. Only used for Version 2.0. */ supportV1DataTypes?: any; /** * Type of linked service. * Expected value is 'AmazonRdsForOracle'. */ type: "AmazonRdsForOracle"; /** * The AmazonRdsForOracle database username. Type: string. Only used for Version 2.0. */ username?: any; /** * Version of the linked service. */ version?: string; } /** * The settings that will be leveraged for AmazonRdsForOracle source partitioning. */ interface AmazonRdsForOraclePartitionSettingsResponse { /** * The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string). */ partitionColumnName?: any; /** * The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string). */ partitionLowerBound?: any; /** * Names of the physical partitions of AmazonRdsForOracle table. */ partitionNames?: any; /** * The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string). */ partitionUpperBound?: any; } /** * A copy activity AmazonRdsForOracle source. */ interface AmazonRdsForOracleSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The decimal precision used to represent Oracle NUMBER type without precision and scale. The range is 1 to 256 and default value is 256 if not specified. Type: integer (or Expression with resultType integer). Only used for Version 2.0. */ numberPrecision?: any; /** * The decimal scale used to represent Oracle NUMBER type without precision and scale. The range is 0 to 130 and default value is 130 if not specified. Type: integer (or Expression with resultType integer). Only used for Version 2.0. */ numberScale?: any; /** * AmazonRdsForOracle reader query. Type: string (or Expression with resultType string). */ oracleReaderQuery?: any; /** * The partition mechanism that will be used for AmazonRdsForOracle read in parallel. Type: string (or Expression with resultType string). */ partitionOption?: any; /** * The settings that will be leveraged for AmazonRdsForOracle source partitioning. */ partitionSettings?: outputs.datafactory.AmazonRdsForOraclePartitionSettingsResponse; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'AmazonRdsForOracleSource'. */ type: "AmazonRdsForOracleSource"; } /** * The AmazonRdsForOracle database dataset. */ interface AmazonRdsForOracleTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the AmazonRdsForOracle database. Type: string (or Expression with resultType string). */ table?: any; /** * Type of dataset. * Expected value is 'AmazonRdsForOracleTable'. */ type: "AmazonRdsForOracleTable"; } /** * Amazon RDS for SQL Server linked service. */ interface AmazonRdsForSqlServerLinkedServiceResponse { /** * Sql always encrypted properties. */ alwaysEncryptedSettings?: outputs.datafactory.SqlAlwaysEncryptedPropertiesResponse; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The application workload type when connecting to a server, used by recommended version. Possible values are ReadOnly and ReadWrite. Type: string (or Expression with resultType string). */ applicationIntent?: any; /** * The type used for authentication. Type: string. */ authenticationType?: string; /** * The default wait time (in seconds) before terminating the attempt to execute a command and generating an error, used by recommended version. Type: integer (or Expression with resultType integer). */ commandTimeout?: any; /** * The number of re-connections attempted after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 0 and 255. Type: integer (or Expression with resultType integer). */ connectRetryCount?: any; /** * The amount of time (in seconds) between each re-connection attempt after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 1 and 60. Type: integer (or Expression with resultType integer). */ connectRetryInterval?: any; /** * The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error, used by recommended version. Type: integer (or Expression with resultType integer). */ connectTimeout?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * The name of the database, used by recommended version. Type: string (or Expression with resultType string). */ database?: any; /** * Linked service description. */ description?: string; /** * Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. Possible values are true/yes/mandatory, false/no/optional and strict. Type: string (or Expression with resultType string). */ encrypt?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The name or address of the partner server to connect to if the primary server is down, used by recommended version. Type: string (or Expression with resultType string). */ failoverPartner?: any; /** * The host name to use when validating the server certificate for the connection. When not specified, the server name from the Data Source is used for certificate validation, used by recommended version. Type: string (or Expression with resultType string). */ hostNameInCertificate?: any; /** * Indicate whether User ID and Password are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true), used by recommended version. Type: Boolean (or Expression with resultType boolean). */ integratedSecurity?: any; /** * The minimum time, in seconds, for the connection to live in the connection pool before being destroyed, used by recommended version. Type: integer (or Expression with resultType integer). */ loadBalanceTimeout?: any; /** * The maximum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer). */ maxPoolSize?: any; /** * The minimum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer). */ minPoolSize?: any; /** * If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ multiSubnetFailover?: any; /** * When true, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ multipleActiveResultSets?: any; /** * The size in bytes of the network packets used to communicate with an instance of server, used by recommended version. Type: integer (or Expression with resultType integer). */ packetSize?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The on-premises Windows authentication password. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ pooling?: any; /** * The name or network address of the instance of SQL Server to which to connect, used by recommended version. Type: string (or Expression with resultType string). */ server?: any; /** * Indicate whether the channel will be encrypted while bypassing walking the certificate chain to validate trust, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ trustServerCertificate?: any; /** * Type of linked service. * Expected value is 'AmazonRdsForSqlServer'. */ type: "AmazonRdsForSqlServer"; /** * The on-premises Windows authentication user name. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity Amazon RDS for SQL Server source. */ interface AmazonRdsForSqlServerSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string). */ isolationLevel?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange". */ partitionOption?: any; /** * The settings that will be leveraged for Sql source partitioning. */ partitionSettings?: outputs.datafactory.SqlPartitionSettingsResponse; /** * Which additional types to produce. */ produceAdditionalTypes?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * SQL reader query. Type: string (or Expression with resultType string). */ sqlReaderQuery?: any; /** * Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string). */ sqlReaderStoredProcedureName?: any; /** * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". */ storedProcedureParameters?: any; /** * Copy source type. * Expected value is 'AmazonRdsForSqlServerSource'. */ type: "AmazonRdsForSqlServerSource"; } /** * The Amazon RDS for SQL Server dataset. */ interface AmazonRdsForSqlServerTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the SQL Server dataset. Type: string (or Expression with resultType string). */ table?: any; /** * Type of dataset. * Expected value is 'AmazonRdsForSqlServerTable'. */ type: "AmazonRdsForSqlServerTable"; } /** * Linked service for Amazon Redshift. */ interface AmazonRedshiftLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The database name of the Amazon Redshift source. Type: string (or Expression with resultType string). */ database: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password of the Amazon Redshift source. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The TCP port number that the Amazon Redshift server uses to listen for client connections. The default value is 5439. Type: integer (or Expression with resultType integer). */ port?: any; /** * The name of the Amazon Redshift server. Type: string (or Expression with resultType string). */ server: any; /** * Type of linked service. * Expected value is 'AmazonRedshift'. */ type: "AmazonRedshift"; /** * The username of the Amazon Redshift source. Type: string (or Expression with resultType string). */ username?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity source for Amazon Redshift Source. */ interface AmazonRedshiftSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Database query. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3. */ redshiftUnloadSettings?: outputs.datafactory.RedshiftUnloadSettingsResponse; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'AmazonRedshiftSource'. */ type: "AmazonRedshiftSource"; } /** * The Amazon Redshift table dataset. */ interface AmazonRedshiftTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The Amazon Redshift table name. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using schema + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'AmazonRedshiftTable'. */ type: "AmazonRedshiftTable"; } /** * Linked service for Amazon S3 Compatible. */ interface AmazonS3CompatibleLinkedServiceResponse { /** * The access key identifier of the Amazon S3 Compatible Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). */ accessKeyId?: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * If true, use S3 path-style access instead of virtual hosted-style access. Default value is false. Type: boolean (or Expression with resultType boolean). */ forcePathStyle?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The secret access key of the Amazon S3 Compatible Identity and Access Management (IAM) user. */ secretAccessKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * This value specifies the endpoint to access with the Amazon S3 Compatible Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string). */ serviceUrl?: any; /** * Type of linked service. * Expected value is 'AmazonS3Compatible'. */ type: "AmazonS3Compatible"; /** * Version of the linked service. */ version?: string; } /** * The location of Amazon S3 Compatible dataset. */ interface AmazonS3CompatibleLocationResponse { /** * Specify the bucketName of Amazon S3 Compatible. Type: string (or Expression with resultType string) */ bucketName?: any; /** * Specify the file name of dataset. Type: string (or Expression with resultType string). */ fileName?: any; /** * Specify the folder path of dataset. Type: string (or Expression with resultType string) */ folderPath?: any; /** * Type of dataset storage location. * Expected value is 'AmazonS3CompatibleLocation'. */ type: "AmazonS3CompatibleLocation"; /** * Specify the version of Amazon S3 Compatible. Type: string (or Expression with resultType string). */ version?: any; } /** * Amazon S3 Compatible read settings. */ interface AmazonS3CompatibleReadSettingsResponse { /** * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean). */ deleteFilesAfterCompletion?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean). */ enablePartitionDiscovery?: any; /** * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string). */ fileListPath?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The end of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeEnd?: any; /** * The start of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeStart?: any; /** * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string). */ partitionRootPath?: any; /** * The prefix filter for the S3 Compatible object name. Type: string (or Expression with resultType string). */ prefix?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * The read setting type. * Expected value is 'AmazonS3CompatibleReadSettings'. */ type: "AmazonS3CompatibleReadSettings"; /** * Amazon S3 Compatible wildcardFileName. Type: string (or Expression with resultType string). */ wildcardFileName?: any; /** * Amazon S3 Compatible wildcardFolderPath. Type: string (or Expression with resultType string). */ wildcardFolderPath?: any; } /** * A single Amazon Simple Storage Service (S3) object or a set of S3 objects. */ interface AmazonS3DatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The name of the Amazon S3 bucket. Type: string (or Expression with resultType string). */ bucketName: any; /** * The data compression method used for the Amazon S3 object. */ compression?: outputs.datafactory.DatasetCompressionResponse; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * The format of files. */ format?: outputs.datafactory.AvroFormatResponse | outputs.datafactory.JsonFormatResponse | outputs.datafactory.OrcFormatResponse | outputs.datafactory.ParquetFormatResponse | outputs.datafactory.TextFormatResponse; /** * The key of the Amazon S3 object. Type: string (or Expression with resultType string). */ key?: any; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The end of S3 object's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeEnd?: any; /** * The start of S3 object's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeStart?: any; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The prefix filter for the S3 object name. Type: string (or Expression with resultType string). */ prefix?: any; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'AmazonS3Object'. */ type: "AmazonS3Object"; /** * The version for the S3 object. Type: string (or Expression with resultType string). */ version?: any; } /** * Linked service for Amazon S3. */ interface AmazonS3LinkedServiceResponse { /** * The access key identifier of the Amazon S3 Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). */ accessKeyId?: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The authentication type of S3. Allowed value: AccessKey (default) or TemporarySecurityCredentials. Type: string (or Expression with resultType string). */ authenticationType?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The secret access key of the Amazon S3 Identity and Access Management (IAM) user. */ secretAccessKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * This value specifies the endpoint to access with the S3 Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string). */ serviceUrl?: any; /** * The session token for the S3 temporary security credential. */ sessionToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'AmazonS3'. */ type: "AmazonS3"; /** * Version of the linked service. */ version?: string; } /** * The location of amazon S3 dataset. */ interface AmazonS3LocationResponse { /** * Specify the bucketName of amazon S3. Type: string (or Expression with resultType string) */ bucketName?: any; /** * Specify the file name of dataset. Type: string (or Expression with resultType string). */ fileName?: any; /** * Specify the folder path of dataset. Type: string (or Expression with resultType string) */ folderPath?: any; /** * Type of dataset storage location. * Expected value is 'AmazonS3Location'. */ type: "AmazonS3Location"; /** * Specify the version of amazon S3. Type: string (or Expression with resultType string). */ version?: any; } /** * Amazon S3 read settings. */ interface AmazonS3ReadSettingsResponse { /** * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean). */ deleteFilesAfterCompletion?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean). */ enablePartitionDiscovery?: any; /** * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string). */ fileListPath?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The end of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeEnd?: any; /** * The start of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeStart?: any; /** * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string). */ partitionRootPath?: any; /** * The prefix filter for the S3 object name. Type: string (or Expression with resultType string). */ prefix?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * The read setting type. * Expected value is 'AmazonS3ReadSettings'. */ type: "AmazonS3ReadSettings"; /** * AmazonS3 wildcardFileName. Type: string (or Expression with resultType string). */ wildcardFileName?: any; /** * AmazonS3 wildcardFolderPath. Type: string (or Expression with resultType string). */ wildcardFolderPath?: any; } /** * Linked service for AppFigures. */ interface AppFiguresLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The client key for the AppFigures source. */ clientKey: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password of the AppFigures source. */ password: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'AppFigures'. */ type: "AppFigures"; /** * The username of the Appfigures source. Type: string (or Expression with resultType string). */ userName: any; /** * Version of the linked service. */ version?: string; } /** * Append value for a Variable of type Array. */ interface AppendVariableActivityResponse { /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'AppendVariable'. */ type: "AppendVariable"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; /** * Value to be appended. Type: could be a static value matching type of the variable item or Expression with resultType matching type of the variable item */ value?: any; /** * Name of the variable whose value needs to be appended to. */ variableName?: string; } /** * A wrapper for an ARM resource id */ interface ArmIdWrapperResponse { id: string; } /** * Linked service for Asana. */ interface AsanaLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The api token for the Asana source. */ apiToken: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'Asana'. */ type: "Asana"; /** * Version of the linked service. */ version?: string; } /** * Avro dataset. */ interface AvroDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The data avroCompressionCodec. Type: string (or Expression with resultType string). */ avroCompressionCodec?: any; avroCompressionLevel?: number; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The location of the avro storage. */ location: outputs.datafactory.AmazonS3CompatibleLocationResponse | outputs.datafactory.AmazonS3LocationResponse | outputs.datafactory.AzureBlobFSLocationResponse | outputs.datafactory.AzureBlobStorageLocationResponse | outputs.datafactory.AzureDataLakeStoreLocationResponse | outputs.datafactory.AzureFileStorageLocationResponse | outputs.datafactory.FileServerLocationResponse | outputs.datafactory.FtpServerLocationResponse | outputs.datafactory.GoogleCloudStorageLocationResponse | outputs.datafactory.HdfsLocationResponse | outputs.datafactory.HttpServerLocationResponse | outputs.datafactory.LakeHouseLocationResponse | outputs.datafactory.OracleCloudStorageLocationResponse | outputs.datafactory.SftpLocationResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'Avro'. */ type: "Avro"; } /** * The data stored in Avro format. */ interface AvroFormatResponse { /** * Deserializer. Type: string (or Expression with resultType string). */ deserializer?: any; /** * Serializer. Type: string (or Expression with resultType string). */ serializer?: any; /** * Type of dataset storage format. * Expected value is 'AvroFormat'. */ type: "AvroFormat"; } /** * A copy activity Avro sink. */ interface AvroSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Avro format settings. */ formatSettings?: outputs.datafactory.AvroWriteSettingsResponse; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Avro store settings. */ storeSettings?: outputs.datafactory.AzureBlobFSWriteSettingsResponse | outputs.datafactory.AzureBlobStorageWriteSettingsResponse | outputs.datafactory.AzureDataLakeStoreWriteSettingsResponse | outputs.datafactory.AzureFileStorageWriteSettingsResponse | outputs.datafactory.FileServerWriteSettingsResponse | outputs.datafactory.LakeHouseWriteSettingsResponse | outputs.datafactory.SftpWriteSettingsResponse; /** * Copy sink type. * Expected value is 'AvroSink'. */ type: "AvroSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity Avro source. */ interface AvroSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Avro store settings. */ storeSettings?: outputs.datafactory.AmazonS3CompatibleReadSettingsResponse | outputs.datafactory.AmazonS3ReadSettingsResponse | outputs.datafactory.AzureBlobFSReadSettingsResponse | outputs.datafactory.AzureBlobStorageReadSettingsResponse | outputs.datafactory.AzureDataLakeStoreReadSettingsResponse | outputs.datafactory.AzureFileStorageReadSettingsResponse | outputs.datafactory.FileServerReadSettingsResponse | outputs.datafactory.FtpReadSettingsResponse | outputs.datafactory.GoogleCloudStorageReadSettingsResponse | outputs.datafactory.HdfsReadSettingsResponse | outputs.datafactory.HttpReadSettingsResponse | outputs.datafactory.LakeHouseReadSettingsResponse | outputs.datafactory.OracleCloudStorageReadSettingsResponse | outputs.datafactory.SftpReadSettingsResponse; /** * Copy source type. * Expected value is 'AvroSource'. */ type: "AvroSource"; } /** * Avro write settings. */ interface AvroWriteSettingsResponse { /** * Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string). */ fileNamePrefix?: any; /** * Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer). */ maxRowsPerFile?: any; /** * Top level record name in write result, which is required in AVRO spec. */ recordName?: string; /** * Record namespace in the write result. */ recordNamespace?: string; /** * The write setting type. * Expected value is 'AvroWriteSettings'. */ type: "AvroWriteSettings"; } /** * The express custom setup of installing Azure PowerShell. */ interface AzPowerShellSetupResponse { /** * The type of custom setup. * Expected value is 'AzPowerShellSetup'. */ type: "AzPowerShellSetup"; /** * The required version of Azure PowerShell to install. */ version: string; } /** * Azure Batch linked service. */ interface AzureBatchLinkedServiceResponse { /** * The Azure Batch account access key. */ accessKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The Azure Batch account name. Type: string (or Expression with resultType string). */ accountName: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The Azure Batch URI. Type: string (or Expression with resultType string). */ batchUri: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The Azure Storage linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure Batch pool name. Type: string (or Expression with resultType string). */ poolName: any; /** * Type of linked service. * Expected value is 'AzureBatch'. */ type: "AzureBatch"; /** * Version of the linked service. */ version?: string; } /** * The Azure Blob storage. */ interface AzureBlobDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The data compression method used for the blob storage. */ compression?: outputs.datafactory.DatasetCompressionResponse; /** * Dataset description. */ description?: string; /** * The name of the Azure Blob. Type: string (or Expression with resultType string). */ fileName?: any; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * The path of the Azure Blob storage. Type: string (or Expression with resultType string). */ folderPath?: any; /** * The format of the Azure Blob storage. */ format?: outputs.datafactory.AvroFormatResponse | outputs.datafactory.JsonFormatResponse | outputs.datafactory.OrcFormatResponse | outputs.datafactory.ParquetFormatResponse | outputs.datafactory.TextFormatResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The end of Azure Blob's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeEnd?: any; /** * The start of Azure Blob's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeStart?: any; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The root of blob path. Type: string (or Expression with resultType string). */ tableRootLocation?: any; /** * Type of dataset. * Expected value is 'AzureBlob'. */ type: "AzureBlob"; } /** * The Azure Data Lake Storage Gen2 storage. */ interface AzureBlobFSDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The data compression method used for the blob storage. */ compression?: outputs.datafactory.DatasetCompressionResponse; /** * Dataset description. */ description?: string; /** * The name of the Azure Data Lake Storage Gen2. Type: string (or Expression with resultType string). */ fileName?: any; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * The path of the Azure Data Lake Storage Gen2 storage. Type: string (or Expression with resultType string). */ folderPath?: any; /** * The format of the Azure Data Lake Storage Gen2 storage. */ format?: outputs.datafactory.AvroFormatResponse | outputs.datafactory.JsonFormatResponse | outputs.datafactory.OrcFormatResponse | outputs.datafactory.ParquetFormatResponse | outputs.datafactory.TextFormatResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'AzureBlobFSFile'. */ type: "AzureBlobFSFile"; } /** * Azure Data Lake Storage Gen2 linked service. */ interface AzureBlobFSLinkedServiceResponse { /** * Account key for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string). */ accountKey?: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). */ azureCloudType?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of sasToken in sas uri. */ sasToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * SAS URI of the Azure Data Lake Storage Gen2 service. Type: string, SecureString or AzureKeyVaultSecretReference. */ sasUri?: any; /** * The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. */ servicePrincipalCredential?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). */ servicePrincipalCredentialType?: any; /** * The ID of the application used to authenticate against the Azure Data Lake Storage Gen2 account. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The Key of the application used to authenticate against the Azure Data Lake Storage Gen2 account. */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). */ tenant?: any; /** * Type of linked service. * Expected value is 'AzureBlobFS'. */ type: "AzureBlobFS"; /** * Endpoint for the Azure Data Lake Storage Gen2 service. Type: string (or Expression with resultType string). */ url?: any; /** * Version of the linked service. */ version?: string; } /** * The location of azure blobFS dataset. */ interface AzureBlobFSLocationResponse { /** * Specify the file name of dataset. Type: string (or Expression with resultType string). */ fileName?: any; /** * Specify the fileSystem of azure blobFS. Type: string (or Expression with resultType string). */ fileSystem?: any; /** * Specify the folder path of dataset. Type: string (or Expression with resultType string) */ folderPath?: any; /** * Type of dataset storage location. * Expected value is 'AzureBlobFSLocation'. */ type: "AzureBlobFSLocation"; } /** * Azure blobFS read settings. */ interface AzureBlobFSReadSettingsResponse { /** * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean). */ deleteFilesAfterCompletion?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean). */ enablePartitionDiscovery?: any; /** * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string). */ fileListPath?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The end of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeEnd?: any; /** * The start of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeStart?: any; /** * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string). */ partitionRootPath?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * The read setting type. * Expected value is 'AzureBlobFSReadSettings'. */ type: "AzureBlobFSReadSettings"; /** * Azure blobFS wildcardFileName. Type: string (or Expression with resultType string). */ wildcardFileName?: any; /** * Azure blobFS wildcardFolderPath. Type: string (or Expression with resultType string). */ wildcardFolderPath?: any; } /** * A copy activity Azure Data Lake Storage Gen2 sink. */ interface AzureBlobFSSinkResponse { /** * The type of copy behavior for copy sink. Type: string (or Expression with resultType string). */ copyBehavior?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects). */ metadata?: outputs.datafactory.MetadataItemResponse[]; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'AzureBlobFSSink'. */ type: "AzureBlobFSSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity Azure BlobFS source. */ interface AzureBlobFSSourceResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer). */ skipHeaderLineCount?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Treat empty as null. Type: boolean (or Expression with resultType boolean). */ treatEmptyAsNull?: any; /** * Copy source type. * Expected value is 'AzureBlobFSSource'. */ type: "AzureBlobFSSource"; } /** * Azure blobFS write settings. */ interface AzureBlobFSWriteSettingsResponse { /** * Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer). */ blockSizeInMB?: any; /** * The type of copy behavior for copy sink. */ copyBehavior?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects). */ metadata?: outputs.datafactory.MetadataItemResponse[]; /** * The write setting type. * Expected value is 'AzureBlobFSWriteSettings'. */ type: "AzureBlobFSWriteSettings"; } /** * The azure blob storage linked service. */ interface AzureBlobStorageLinkedServiceResponse { /** * The Azure key vault secret reference of accountKey in connection string. */ accountKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * Specify the kind of your storage account. Allowed values are: Storage (general purpose v1), StorageV2 (general purpose v2), BlobStorage, or BlockBlobStorage. Type: string (or Expression with resultType string). */ accountKind?: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The type used for authentication. Type: string. */ authenticationType?: string; /** * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). */ azureCloudType?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * Container uri of the Azure Blob Storage resource only support for anonymous access. Type: string (or Expression with resultType string). */ containerUri?: any; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of sasToken in sas uri. */ sasToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * SAS URI of the Azure Blob Storage resource. It is mutually exclusive with connectionString, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference. */ sasUri?: any; /** * Blob service endpoint of the Azure Blob Storage resource. It is mutually exclusive with connectionString, sasUri property. */ serviceEndpoint?: any; /** * The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The key of the service principal used to authenticate against Azure SQL Data Warehouse. */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). */ tenant?: any; /** * Type of linked service. * Expected value is 'AzureBlobStorage'. */ type: "AzureBlobStorage"; /** * Version of the linked service. */ version?: string; } /** * The location of azure blob dataset. */ interface AzureBlobStorageLocationResponse { /** * Specify the container of azure blob. Type: string (or Expression with resultType string). */ container?: any; /** * Specify the file name of dataset. Type: string (or Expression with resultType string). */ fileName?: any; /** * Specify the folder path of dataset. Type: string (or Expression with resultType string) */ folderPath?: any; /** * Type of dataset storage location. * Expected value is 'AzureBlobStorageLocation'. */ type: "AzureBlobStorageLocation"; } /** * Azure blob read settings. */ interface AzureBlobStorageReadSettingsResponse { /** * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean). */ deleteFilesAfterCompletion?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean). */ enablePartitionDiscovery?: any; /** * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string). */ fileListPath?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The end of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeEnd?: any; /** * The start of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeStart?: any; /** * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string). */ partitionRootPath?: any; /** * The prefix filter for the Azure Blob name. Type: string (or Expression with resultType string). */ prefix?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * The read setting type. * Expected value is 'AzureBlobStorageReadSettings'. */ type: "AzureBlobStorageReadSettings"; /** * Azure blob wildcardFileName. Type: string (or Expression with resultType string). */ wildcardFileName?: any; /** * Azure blob wildcardFolderPath. Type: string (or Expression with resultType string). */ wildcardFolderPath?: any; } /** * Azure blob write settings. */ interface AzureBlobStorageWriteSettingsResponse { /** * Indicates the block size(MB) when writing data to blob. Type: integer (or Expression with resultType integer). */ blockSizeInMB?: any; /** * The type of copy behavior for copy sink. */ copyBehavior?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects). */ metadata?: outputs.datafactory.MetadataItemResponse[]; /** * The write setting type. * Expected value is 'AzureBlobStorageWriteSettings'. */ type: "AzureBlobStorageWriteSettings"; } /** * Azure Data Explorer command activity. */ interface AzureDataExplorerCommandActivityResponse { /** * A control command, according to the Azure Data Explorer command syntax. Type: string (or Expression with resultType string). */ command: any; /** * Control command timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9]))..) */ commandTimeout?: any; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'AzureDataExplorerCommand'. */ type: "AzureDataExplorerCommand"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Azure Data Explorer (Kusto) linked service. */ interface AzureDataExplorerLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Database name for connection. Type: string (or Expression with resultType string). */ database: any; /** * Linked service description. */ description?: string; /** * The endpoint of Azure Data Explorer (the engine's endpoint). URL will be in the format https://..kusto.windows.net. Type: string (or Expression with resultType string) */ endpoint: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The ID of the service principal used to authenticate against Azure Data Explorer. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The key of the service principal used to authenticate against Kusto. */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). */ tenant?: any; /** * Type of linked service. * Expected value is 'AzureDataExplorer'. */ type: "AzureDataExplorer"; /** * Version of the linked service. */ version?: string; } /** * A copy activity Azure Data Explorer sink. */ interface AzureDataExplorerSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * If set to true, any aggregation will be skipped. Default is false. Type: boolean. */ flushImmediately?: any; /** * An explicit column mapping description provided in a json format. Type: string. */ ingestionMappingAsJson?: any; /** * A name of a pre-created csv mapping that was defined on the target Kusto table. Type: string. */ ingestionMappingName?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'AzureDataExplorerSink'. */ type: "AzureDataExplorerSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity Azure Data Explorer (Kusto) source. */ interface AzureDataExplorerSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The name of the Boolean option that controls whether truncation is applied to result-sets that go beyond a certain row-count limit. */ noTruncation?: any; /** * Database query. Should be a Kusto Query Language (KQL) query. Type: string (or Expression with resultType string). */ query: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).. */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'AzureDataExplorerSource'. */ type: "AzureDataExplorerSource"; } /** * The Azure Data Explorer (Kusto) dataset. */ interface AzureDataExplorerTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Azure Data Explorer database. Type: string (or Expression with resultType string). */ table?: any; /** * Type of dataset. * Expected value is 'AzureDataExplorerTable'. */ type: "AzureDataExplorerTable"; } /** * Azure Data Lake Analytics linked service. */ interface AzureDataLakeAnalyticsLinkedServiceResponse { /** * The Azure Data Lake Analytics account name. Type: string (or Expression with resultType string). */ accountName: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Azure Data Lake Analytics URI Type: string (or Expression with resultType string). */ dataLakeAnalyticsUri?: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Data Lake Analytics account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string). */ resourceGroupName?: any; /** * The ID of the application used to authenticate against the Azure Data Lake Analytics account. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The Key of the application used to authenticate against the Azure Data Lake Analytics account. */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Data Lake Analytics account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string). */ subscriptionId?: any; /** * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). */ tenant: any; /** * Type of linked service. * Expected value is 'AzureDataLakeAnalytics'. */ type: "AzureDataLakeAnalytics"; /** * Version of the linked service. */ version?: string; } /** * Azure Data Lake Store dataset. */ interface AzureDataLakeStoreDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The data compression method used for the item(s) in the Azure Data Lake Store. */ compression?: outputs.datafactory.DatasetCompressionResponse; /** * Dataset description. */ description?: string; /** * The name of the file in the Azure Data Lake Store. Type: string (or Expression with resultType string). */ fileName?: any; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Path to the folder in the Azure Data Lake Store. Type: string (or Expression with resultType string). */ folderPath?: any; /** * The format of the Data Lake Store. */ format?: outputs.datafactory.AvroFormatResponse | outputs.datafactory.JsonFormatResponse | outputs.datafactory.OrcFormatResponse | outputs.datafactory.ParquetFormatResponse | outputs.datafactory.TextFormatResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'AzureDataLakeStoreFile'. */ type: "AzureDataLakeStoreFile"; } /** * Azure Data Lake Store linked service. */ interface AzureDataLakeStoreLinkedServiceResponse { /** * Data Lake Store account name. Type: string (or Expression with resultType string). */ accountName?: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). */ azureCloudType?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Data Lake Store service URI. Type: string (or Expression with resultType string). */ dataLakeStoreUri: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Data Lake Store account resource group name (if different from Data Factory account). Type: string (or Expression with resultType string). */ resourceGroupName?: any; /** * The ID of the application used to authenticate against the Azure Data Lake Store account. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The Key of the application used to authenticate against the Azure Data Lake Store account. */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Data Lake Store account subscription ID (if different from Data Factory account). Type: string (or Expression with resultType string). */ subscriptionId?: any; /** * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). */ tenant?: any; /** * Type of linked service. * Expected value is 'AzureDataLakeStore'. */ type: "AzureDataLakeStore"; /** * Version of the linked service. */ version?: string; } /** * The location of azure data lake store dataset. */ interface AzureDataLakeStoreLocationResponse { /** * Specify the file name of dataset. Type: string (or Expression with resultType string). */ fileName?: any; /** * Specify the folder path of dataset. Type: string (or Expression with resultType string) */ folderPath?: any; /** * Type of dataset storage location. * Expected value is 'AzureDataLakeStoreLocation'. */ type: "AzureDataLakeStoreLocation"; } /** * Azure data lake store read settings. */ interface AzureDataLakeStoreReadSettingsResponse { /** * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean). */ deleteFilesAfterCompletion?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean). */ enablePartitionDiscovery?: any; /** * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string). */ fileListPath?: any; /** * Lists files after the value (exclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string). */ listAfter?: any; /** * Lists files before the value (inclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string). */ listBefore?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The end of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeEnd?: any; /** * The start of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeStart?: any; /** * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string). */ partitionRootPath?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * The read setting type. * Expected value is 'AzureDataLakeStoreReadSettings'. */ type: "AzureDataLakeStoreReadSettings"; /** * ADLS wildcardFileName. Type: string (or Expression with resultType string). */ wildcardFileName?: any; /** * ADLS wildcardFolderPath. Type: string (or Expression with resultType string). */ wildcardFolderPath?: any; } /** * A copy activity Azure Data Lake Store sink. */ interface AzureDataLakeStoreSinkResponse { /** * The type of copy behavior for copy sink. Type: string (or Expression with resultType string). */ copyBehavior?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Single File Parallel. */ enableAdlsSingleFileParallel?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'AzureDataLakeStoreSink'. */ type: "AzureDataLakeStoreSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity Azure Data Lake source. */ interface AzureDataLakeStoreSourceResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'AzureDataLakeStoreSource'. */ type: "AzureDataLakeStoreSource"; } /** * Azure data lake store write settings. */ interface AzureDataLakeStoreWriteSettingsResponse { /** * The type of copy behavior for copy sink. */ copyBehavior?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Specifies the expiry time of the written files. The time is applied to the UTC time zone in the format of "2018-12-01T05:00:00Z". Default value is NULL. Type: string (or Expression with resultType string). */ expiryDateTime?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects). */ metadata?: outputs.datafactory.MetadataItemResponse[]; /** * The write setting type. * Expected value is 'AzureDataLakeStoreWriteSettings'. */ type: "AzureDataLakeStoreWriteSettings"; } /** * Azure Databricks Delta Lake dataset. */ interface AzureDatabricksDeltaLakeDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The database name of delta table. Type: string (or Expression with resultType string). */ database?: any; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The name of delta table. Type: string (or Expression with resultType string). */ table?: any; /** * Type of dataset. * Expected value is 'AzureDatabricksDeltaLakeDataset'. */ type: "AzureDatabricksDeltaLakeDataset"; } /** * Azure Databricks Delta Lake export command settings. */ interface AzureDatabricksDeltaLakeExportCommandResponse { /** * Specify the date format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string). */ dateFormat?: any; /** * Specify the timestamp format for the csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string). */ timestampFormat?: any; /** * The export setting type. * Expected value is 'AzureDatabricksDeltaLakeExportCommand'. */ type: "AzureDatabricksDeltaLakeExportCommand"; } /** * Azure Databricks Delta Lake import command settings. */ interface AzureDatabricksDeltaLakeImportCommandResponse { /** * Specify the date format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string). */ dateFormat?: any; /** * Specify the timestamp format for csv in Azure Databricks Delta Lake Copy. Type: string (or Expression with resultType string). */ timestampFormat?: any; /** * The import setting type. * Expected value is 'AzureDatabricksDeltaLakeImportCommand'. */ type: "AzureDatabricksDeltaLakeImportCommand"; } /** * Azure Databricks Delta Lake linked service. */ interface AzureDatabricksDeltaLakeLinkedServiceResponse { /** * Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string, SecureString or AzureKeyVaultSecretReference. */ accessToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The id of an existing interactive cluster that will be used for all runs of this job. Type: string (or Expression with resultType string). */ clusterId?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Linked service description. */ description?: string; /** * .azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string). */ domain: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'AzureDatabricksDeltaLake'. */ type: "AzureDatabricksDeltaLake"; /** * Version of the linked service. */ version?: string; /** * Workspace resource id for databricks REST API. Type: string (or Expression with resultType string). */ workspaceResourceId?: any; } /** * A copy activity Azure Databricks Delta Lake sink. */ interface AzureDatabricksDeltaLakeSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Azure Databricks Delta Lake import settings. */ importSettings?: outputs.datafactory.AzureDatabricksDeltaLakeImportCommandResponse; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * SQL pre-copy script. Type: string (or Expression with resultType string). */ preCopyScript?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'AzureDatabricksDeltaLakeSink'. */ type: "AzureDatabricksDeltaLakeSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity Azure Databricks Delta Lake source. */ interface AzureDatabricksDeltaLakeSourceResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Azure Databricks Delta Lake export settings. */ exportSettings?: outputs.datafactory.AzureDatabricksDeltaLakeExportCommandResponse; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Azure Databricks Delta Lake Sql query. Type: string (or Expression with resultType string). */ query?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'AzureDatabricksDeltaLakeSource'. */ type: "AzureDatabricksDeltaLakeSource"; } /** * Azure Databricks linked service. */ interface AzureDatabricksLinkedServiceResponse { /** * Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string). */ accessToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Required to specify MSI, if using Workspace resource id for databricks REST API. Type: string (or Expression with resultType string). */ authentication?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * The data security mode for the Databricks Cluster. Type: string (or Expression with resultType string). */ dataSecurityMode?: any; /** * Linked service description. */ description?: string; /** * .azuredatabricks.net, domain name of your Databricks deployment. Type: string (or Expression with resultType string). */ domain: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The id of an existing interactive cluster that will be used for all runs of this activity. Type: string (or Expression with resultType string). */ existingClusterId?: any; /** * The id of an existing instance pool that will be used for all runs of this activity. Type: string (or Expression with resultType string). */ instancePoolId?: any; /** * Additional tags for cluster resources. This property is ignored in instance pool configurations. */ newClusterCustomTags?: any; /** * The driver node type for the new job cluster. This property is ignored in instance pool configurations. Type: string (or Expression with resultType string). */ newClusterDriverNodeType?: any; /** * Enable the elastic disk on the new cluster. This property is now ignored, and takes the default elastic disk behavior in Databricks (elastic disks are always enabled). Type: boolean (or Expression with resultType boolean). */ newClusterEnableElasticDisk?: any; /** * User-defined initialization scripts for the new cluster. Type: array of strings (or Expression with resultType array of strings). */ newClusterInitScripts?: any; /** * Specify a location to deliver Spark driver, worker, and event logs. Type: string (or Expression with resultType string). */ newClusterLogDestination?: any; /** * The node type of the new job cluster. This property is required if newClusterVersion is specified and instancePoolId is not specified. If instancePoolId is specified, this property is ignored. Type: string (or Expression with resultType string). */ newClusterNodeType?: any; /** * If not using an existing interactive cluster, this specifies the number of worker nodes to use for the new job cluster or instance pool. For new job clusters, this a string-formatted Int32, like '1' means numOfWorker is 1 or '1:10' means auto-scale from 1 (min) to 10 (max). For instance pools, this is a string-formatted Int32, and can only specify a fixed number of worker nodes, such as '2'. Required if newClusterVersion is specified. Type: string (or Expression with resultType string). */ newClusterNumOfWorker?: any; /** * A set of optional, user-specified Spark configuration key-value pairs. */ newClusterSparkConf?: any; /** * A set of optional, user-specified Spark environment variables key-value pairs. */ newClusterSparkEnvVars?: any; /** * If not using an existing interactive cluster, this specifies the Spark version of a new job cluster or instance pool nodes created for each run of this activity. Required if instancePoolId is specified. Type: string (or Expression with resultType string). */ newClusterVersion?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The policy id for limiting the ability to configure clusters based on a user defined set of rules. Type: string (or Expression with resultType string). */ policyId?: any; /** * Type of linked service. * Expected value is 'AzureDatabricks'. */ type: "AzureDatabricks"; /** * Version of the linked service. */ version?: string; /** * Workspace resource id for databricks REST API. Type: string (or Expression with resultType string). */ workspaceResourceId?: any; } /** * Azure File Storage linked service. */ interface AzureFileStorageLinkedServiceResponse { /** * The Azure key vault secret reference of accountKey in connection string. */ accountKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The azure file share name. It is required when auth with accountKey/sasToken. Type: string (or Expression with resultType string). */ fileShare?: any; /** * Host name of the server. Type: string (or Expression with resultType string). */ host?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password to logon the server. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The Azure key vault secret reference of sasToken in sas uri. */ sasToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * SAS URI of the Azure File resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference. */ sasUri?: any; /** * File service endpoint of the Azure File Storage resource. It is mutually exclusive with connectionString, sasUri property. */ serviceEndpoint?: any; /** * The azure file share snapshot version. Type: string (or Expression with resultType string). */ snapshot?: any; /** * Type of linked service. * Expected value is 'AzureFileStorage'. */ type: "AzureFileStorage"; /** * User ID to logon the server. Type: string (or Expression with resultType string). */ userId?: any; /** * Version of the linked service. */ version?: string; } /** * The location of file server dataset. */ interface AzureFileStorageLocationResponse { /** * Specify the file name of dataset. Type: string (or Expression with resultType string). */ fileName?: any; /** * Specify the folder path of dataset. Type: string (or Expression with resultType string) */ folderPath?: any; /** * Type of dataset storage location. * Expected value is 'AzureFileStorageLocation'. */ type: "AzureFileStorageLocation"; } /** * Azure File Storage read settings. */ interface AzureFileStorageReadSettingsResponse { /** * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean). */ deleteFilesAfterCompletion?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean). */ enablePartitionDiscovery?: any; /** * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string). */ fileListPath?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The end of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeEnd?: any; /** * The start of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeStart?: any; /** * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string). */ partitionRootPath?: any; /** * The prefix filter for the Azure File name starting from root path. Type: string (or Expression with resultType string). */ prefix?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * The read setting type. * Expected value is 'AzureFileStorageReadSettings'. */ type: "AzureFileStorageReadSettings"; /** * Azure File Storage wildcardFileName. Type: string (or Expression with resultType string). */ wildcardFileName?: any; /** * Azure File Storage wildcardFolderPath. Type: string (or Expression with resultType string). */ wildcardFolderPath?: any; } /** * Azure File Storage write settings. */ interface AzureFileStorageWriteSettingsResponse { /** * The type of copy behavior for copy sink. */ copyBehavior?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects). */ metadata?: outputs.datafactory.MetadataItemResponse[]; /** * The write setting type. * Expected value is 'AzureFileStorageWriteSettings'. */ type: "AzureFileStorageWriteSettings"; } /** * Azure Function activity. */ interface AzureFunctionActivityResponse { /** * Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string). */ body?: any; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Name of the Function that the Azure Function Activity will call. Type: string (or Expression with resultType string) */ functionName: any; /** * Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string). */ headers?: any; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Rest API method for target endpoint. */ method: string; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'AzureFunctionActivity'. */ type: "AzureFunctionActivity"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Azure Function linked service. */ interface AzureFunctionLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Type of authentication (Required to specify MSI) used to connect to AzureFunction. Type: string (or Expression with resultType string). */ authentication?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The endpoint of the Azure Function App. URL will be in the format https://.azurewebsites.net. Type: string (or Expression with resultType string). */ functionAppUrl: any; /** * Function or Host key for Azure Function App. */ functionKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Allowed token audiences for azure function. Type: string (or Expression with resultType string). */ resourceId?: any; /** * Type of linked service. * Expected value is 'AzureFunction'. */ type: "AzureFunction"; /** * Version of the linked service. */ version?: string; } /** * Azure Key Vault linked service. */ interface AzureKeyVaultLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The base URL of the Azure Key Vault. e.g. https://myakv.vault.azure.net Type: string (or Expression with resultType string). */ baseUrl: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Linked service description. */ description?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'AzureKeyVault'. */ type: "AzureKeyVault"; /** * Version of the linked service. */ version?: string; } /** * Azure Key Vault secret reference. */ interface AzureKeyVaultSecretReferenceResponse { /** * The name of the secret in Azure Key Vault. Type: string (or Expression with resultType string). */ secretName: any; /** * The version of the secret in Azure Key Vault. The default value is the latest version of the secret. Type: string (or Expression with resultType string). */ secretVersion?: any; /** * The Azure Key Vault linked service reference. */ store: outputs.datafactory.LinkedServiceReferenceResponse; /** * Type of the secret. * Expected value is 'AzureKeyVaultSecret'. */ type: "AzureKeyVaultSecret"; } /** * Azure ML Batch Execution activity. */ interface AzureMLBatchExecutionActivityResponse { /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Key,Value pairs to be passed to the Azure ML Batch Execution Service endpoint. Keys must match the names of web service parameters defined in the published Azure ML web service. Values will be passed in the GlobalParameters property of the Azure ML batch execution request. */ globalParameters?: any; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'AzureMLBatchExecution'. */ type: "AzureMLBatchExecution"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; /** * Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Inputs to AzureMLWebServiceFile objects specifying the input Blob locations.. This information will be passed in the WebServiceInputs property of the Azure ML batch execution request. */ webServiceInputs?: { [key: string]: outputs.datafactory.AzureMLWebServiceFileResponse; }; /** * Key,Value pairs, mapping the names of Azure ML endpoint's Web Service Outputs to AzureMLWebServiceFile objects specifying the output Blob locations. This information will be passed in the WebServiceOutputs property of the Azure ML batch execution request. */ webServiceOutputs?: { [key: string]: outputs.datafactory.AzureMLWebServiceFileResponse; }; } /** * Azure ML Execute Pipeline activity. */ interface AzureMLExecutePipelineActivityResponse { /** * Whether to continue execution of other steps in the PipelineRun if a step fails. This information will be passed in the continueOnStepFailure property of the published pipeline execution request. Type: boolean (or Expression with resultType boolean). */ continueOnStepFailure?: any; /** * Dictionary used for changing data path assignments without retraining. Values will be passed in the dataPathAssignments property of the published pipeline execution request. Type: object (or Expression with resultType object). */ dataPathAssignments?: any; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Run history experiment name of the pipeline run. This information will be passed in the ExperimentName property of the published pipeline execution request. Type: string (or Expression with resultType string). */ experimentName?: any; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * The parent Azure ML Service pipeline run id. This information will be passed in the ParentRunId property of the published pipeline execution request. Type: string (or Expression with resultType string). */ mlParentRunId?: any; /** * ID of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string). */ mlPipelineEndpointId?: any; /** * ID of the published Azure ML pipeline. Type: string (or Expression with resultType string). */ mlPipelineId?: any; /** * Key,Value pairs to be passed to the published Azure ML pipeline endpoint. Keys must match the names of pipeline parameters defined in the published pipeline. Values will be passed in the ParameterAssignments property of the published pipeline execution request. Type: object with key value pairs (or Expression with resultType object). */ mlPipelineParameters?: any; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'AzureMLExecutePipeline'. */ type: "AzureMLExecutePipeline"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; /** * Version of the published Azure ML pipeline endpoint. Type: string (or Expression with resultType string). */ version?: any; } /** * Azure ML Studio Web Service linked service. */ interface AzureMLLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The API key for accessing the Azure ML model endpoint. */ apiKey: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string). */ authentication?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The Batch Execution REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string). */ mlEndpoint: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). */ tenant?: any; /** * Type of linked service. * Expected value is 'AzureML'. */ type: "AzureML"; /** * The Update Resource REST URL for an Azure ML Studio Web Service endpoint. Type: string (or Expression with resultType string). */ updateResourceEndpoint?: any; /** * Version of the linked service. */ version?: string; } /** * Azure ML Service linked service. */ interface AzureMLServiceLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Type of authentication (Required to specify MSI) used to connect to AzureML. Type: string (or Expression with resultType string). */ authentication?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Azure ML Service workspace name. Type: string (or Expression with resultType string). */ mlWorkspaceName: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Azure ML Service workspace resource group name. Type: string (or Expression with resultType string). */ resourceGroupName: any; /** * The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Azure ML Service workspace subscription ID. Type: string (or Expression with resultType string). */ subscriptionId: any; /** * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). */ tenant?: any; /** * Type of linked service. * Expected value is 'AzureMLService'. */ type: "AzureMLService"; /** * Version of the linked service. */ version?: string; } /** * Azure ML Update Resource management activity. */ interface AzureMLUpdateResourceActivityResponse { /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * The relative file path in trainedModelLinkedService to represent the .ilearner file that will be uploaded by the update operation. Type: string (or Expression with resultType string). */ trainedModelFilePath: any; /** * Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation. */ trainedModelLinkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Name of the Trained Model module in the Web Service experiment to be updated. Type: string (or Expression with resultType string). */ trainedModelName: any; /** * Type of activity. * Expected value is 'AzureMLUpdateResource'. */ type: "AzureMLUpdateResource"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Azure ML WebService Input/Output file */ interface AzureMLWebServiceFileResponse { /** * The relative file path, including container name, in the Azure Blob Storage specified by the LinkedService. Type: string (or Expression with resultType string). */ filePath: any; /** * Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; } /** * Azure Database for MariaDB linked service. */ interface AzureMariaDBLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of password in connection string. */ pwd?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * Type of linked service. * Expected value is 'AzureMariaDB'. */ type: "AzureMariaDB"; /** * Version of the linked service. */ version?: string; } /** * A copy activity Azure MariaDB source. */ interface AzureMariaDBSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'AzureMariaDBSource'. */ type: "AzureMariaDBSource"; } /** * Azure Database for MariaDB dataset. */ interface AzureMariaDBTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'AzureMariaDBTable'. */ type: "AzureMariaDBTable"; } /** * Azure MySQL database linked service. */ interface AzureMySqlLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of password in connection string. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * Type of linked service. * Expected value is 'AzureMySql'. */ type: "AzureMySql"; /** * Version of the linked service. */ version?: string; } /** * A copy activity Azure MySql sink. */ interface AzureMySqlSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to execute before starting the copy. Type: string (or Expression with resultType string). */ preCopyScript?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'AzureMySqlSink'. */ type: "AzureMySqlSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity Azure MySQL source. */ interface AzureMySqlSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Database query. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'AzureMySqlSource'. */ type: "AzureMySqlSource"; } /** * The Azure MySQL database dataset. */ interface AzureMySqlTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The name of Azure MySQL database table. Type: string (or Expression with resultType string). */ table?: any; /** * The Azure MySQL database table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'AzureMySqlTable'. */ type: "AzureMySqlTable"; } /** * Azure PostgreSQL linked service. */ interface AzurePostgreSqlLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). */ azureCloudType?: any; /** * The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error. Set to zero for infinity. Type: integer. */ commandTimeout?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Database name for connection. Type: string. */ database?: any; /** * Linked service description. */ description?: string; /** * Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. Type: string */ encoding?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of password in connection string. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * The port for the connection. Type: integer. */ port?: any; /** * Determines the size of the internal buffer uses when reading. Increasing may improve performance if transferring large values from the database. Type: integer. */ readBufferSize?: any; /** * Server name for connection. Type: string. */ server?: any; /** * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). */ servicePrincipalCredentialType?: any; /** * Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). */ servicePrincipalEmbeddedCert?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string). */ servicePrincipalEmbeddedCertPassword?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The ID of the service principal used to authenticate against Azure Database for PostgreSQL Flexible server. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The key of the service principal used to authenticate against Azure Database for PostgreSQL Flexible server. */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer. */ sslMode?: any; /** * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). */ tenant?: any; /** * The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer. */ timeout?: any; /** * Gets or sets the session timezone. Type: string. */ timezone?: any; /** * Whether to trust the server certificate without validating it. Type: boolean. */ trustServerCertificate?: any; /** * Type of linked service. * Expected value is 'AzurePostgreSql'. */ type: "AzurePostgreSql"; /** * Username for authentication. Type: string. */ username?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity Azure Database for PostgreSQL sink. */ interface AzurePostgreSqlSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to execute before starting the copy. Type: string (or Expression with resultType string). */ preCopyScript?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'AzurePostgreSqlSink'. */ type: "AzurePostgreSqlSink"; /** * Azure Database for PostgreSQL upsert option settings */ upsertSettings?: outputs.datafactory.AzurePostgreSqlSinkUpsertSettingsResponse; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * The write behavior for the operation. Default is Bulk Insert. */ writeMethod?: string; } /** * Azure Database for PostgreSQL upsert option settings */ interface AzurePostgreSqlSinkUpsertSettingsResponse { /** * Key column names for unique row identification. Type: array of strings (or Expression with resultType array of strings). */ keys?: any; } /** * A copy activity Azure Database for PostgreSQL source. */ interface AzurePostgreSqlSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'AzurePostgreSqlSource'. */ type: "AzurePostgreSqlSource"; } /** * Azure PostgreSQL dataset. */ interface AzurePostgreSqlTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Azure PostgreSQL database. Type: string (or Expression with resultType string). */ table?: any; /** * The table name of the Azure PostgreSQL database which includes both schema and table. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'AzurePostgreSqlTable'. */ type: "AzurePostgreSqlTable"; } /** * A copy activity Azure Queue sink. */ interface AzureQueueSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'AzureQueueSink'. */ type: "AzureQueueSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * The Azure Search Index. */ interface AzureSearchIndexDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * The name of the Azure Search Index. Type: string (or Expression with resultType string). */ indexName: any; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'AzureSearchIndex'. */ type: "AzureSearchIndex"; } /** * A copy activity Azure Search Index sink. */ interface AzureSearchIndexSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'AzureSearchIndexSink'. */ type: "AzureSearchIndexSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * Specify the write behavior when upserting documents into Azure Search Index. */ writeBehavior?: string; } /** * Linked service for Windows Azure Search Service. */ interface AzureSearchLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Admin Key for Azure Search service */ key?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'AzureSearch'. */ type: "AzureSearch"; /** * URL for Azure Search service. Type: string (or Expression with resultType string). */ url: any; /** * Version of the linked service. */ version?: string; } /** * Azure SQL Data Warehouse linked service. */ interface AzureSqlDWLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The application workload type when connecting to a server, used by recommended version. Possible values are ReadOnly and ReadWrite. Type: string (or Expression with resultType string). */ applicationIntent?: any; /** * The type used for authentication. Type: string. */ authenticationType?: string; /** * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). */ azureCloudType?: any; /** * The default wait time (in seconds) before terminating the attempt to execute a command and generating an error, used by recommended version. Type: integer (or Expression with resultType integer). */ commandTimeout?: any; /** * The number of re-connections attempted after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 0 and 255. Type: integer (or Expression with resultType integer). */ connectRetryCount?: any; /** * The amount of time (in seconds) between each re-connection attempt after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 1 and 60. Type: integer (or Expression with resultType integer). */ connectRetryInterval?: any; /** * The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error, used by recommended version. Type: integer (or Expression with resultType integer). */ connectTimeout?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * The name of the database, used by recommended version. Type: string (or Expression with resultType string). */ database?: any; /** * Linked service description. */ description?: string; /** * Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. Possible values are true/yes/mandatory, false/no/optional and strict. Type: string (or Expression with resultType string). */ encrypt?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The name or address of the partner server to connect to if the primary server is down, used by recommended version. Type: string (or Expression with resultType string). */ failoverPartner?: any; /** * The host name to use when validating the server certificate for the connection. When not specified, the server name from the Data Source is used for certificate validation, used by recommended version. Type: string (or Expression with resultType string). */ hostNameInCertificate?: any; /** * Indicate whether User ID and Password are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true), used by recommended version. Type: Boolean (or Expression with resultType boolean). */ integratedSecurity?: any; /** * The minimum time, in seconds, for the connection to live in the connection pool before being destroyed, used by recommended version. Type: integer (or Expression with resultType integer). */ loadBalanceTimeout?: any; /** * The maximum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer). */ maxPoolSize?: any; /** * The minimum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer). */ minPoolSize?: any; /** * If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ multiSubnetFailover?: any; /** * When true, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ multipleActiveResultSets?: any; /** * The size in bytes of the network packets used to communicate with an instance of server, used by recommended version. Type: integer (or Expression with resultType integer). */ packetSize?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of password in connection string. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ pooling?: any; /** * The name or network address of the instance of SQL Server to which to connect, used by recommended version. Type: string (or Expression with resultType string). */ server?: any; /** * The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. */ servicePrincipalCredential?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). */ servicePrincipalCredentialType?: any; /** * The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The key of the service principal used to authenticate against Azure SQL Data Warehouse. */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). */ tenant?: any; /** * Indicate whether the channel will be encrypted while bypassing walking the certificate chain to validate trust, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ trustServerCertificate?: any; /** * Type of linked service. * Expected value is 'AzureSqlDW'. */ type: "AzureSqlDW"; /** * The user name to be used when connecting to server. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * The Azure SQL Data Warehouse dataset. */ interface AzureSqlDWTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Azure SQL Data Warehouse. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using schema + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'AzureSqlDWTable'. */ type: "AzureSqlDWTable"; } /** * Microsoft Azure SQL Database linked service. */ interface AzureSqlDatabaseLinkedServiceResponse { /** * Sql always encrypted properties. */ alwaysEncryptedSettings?: outputs.datafactory.SqlAlwaysEncryptedPropertiesResponse; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The application workload type when connecting to a server, used by recommended version. Possible values are ReadOnly and ReadWrite. Type: string (or Expression with resultType string). */ applicationIntent?: any; /** * The type used for authentication. Type: string. */ authenticationType?: string; /** * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). */ azureCloudType?: any; /** * The default wait time (in seconds) before terminating the attempt to execute a command and generating an error, used by recommended version. Type: integer (or Expression with resultType integer). */ commandTimeout?: any; /** * The number of re-connections attempted after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 0 and 255. Type: integer (or Expression with resultType integer). */ connectRetryCount?: any; /** * The amount of time (in seconds) between each re-connection attempt after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 1 and 60. Type: integer (or Expression with resultType integer). */ connectRetryInterval?: any; /** * The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error, used by recommended version. Type: integer (or Expression with resultType integer). */ connectTimeout?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * The name of the database, used by recommended version. Type: string (or Expression with resultType string). */ database?: any; /** * Linked service description. */ description?: string; /** * Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. Possible values are true/yes/mandatory, false/no/optional and strict. Type: string (or Expression with resultType string). */ encrypt?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The name or address of the partner server to connect to if the primary server is down, used by recommended version. Type: string (or Expression with resultType string). */ failoverPartner?: any; /** * The host name to use when validating the server certificate for the connection. When not specified, the server name from the Data Source is used for certificate validation, used by recommended version. Type: string (or Expression with resultType string). */ hostNameInCertificate?: any; /** * Indicate whether User ID and Password are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true), used by recommended version. Type: Boolean (or Expression with resultType boolean). */ integratedSecurity?: any; /** * The minimum time, in seconds, for the connection to live in the connection pool before being destroyed, used by recommended version. Type: integer (or Expression with resultType integer). */ loadBalanceTimeout?: any; /** * The maximum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer). */ maxPoolSize?: any; /** * The minimum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer). */ minPoolSize?: any; /** * If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ multiSubnetFailover?: any; /** * When true, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ multipleActiveResultSets?: any; /** * The size in bytes of the network packets used to communicate with an instance of server, used by recommended version. Type: integer (or Expression with resultType integer). */ packetSize?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of password in connection string. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ pooling?: any; /** * The name or network address of the instance of SQL Server to which to connect, used by recommended version. Type: string (or Expression with resultType string). */ server?: any; /** * The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. */ servicePrincipalCredential?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). */ servicePrincipalCredentialType?: any; /** * The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The key of the service principal used to authenticate against Azure SQL Database. */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). */ tenant?: any; /** * Indicate whether the channel will be encrypted while bypassing walking the certificate chain to validate trust, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ trustServerCertificate?: any; /** * Type of linked service. * Expected value is 'AzureSqlDatabase'. */ type: "AzureSqlDatabase"; /** * The user name to be used when connecting to server. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * Azure SQL Managed Instance linked service. */ interface AzureSqlMILinkedServiceResponse { /** * Sql always encrypted properties. */ alwaysEncryptedSettings?: outputs.datafactory.SqlAlwaysEncryptedPropertiesResponse; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The application workload type when connecting to a server, used by recommended version. Possible values are ReadOnly and ReadWrite. Type: string (or Expression with resultType string). */ applicationIntent?: any; /** * The type used for authentication. Type: string. */ authenticationType?: string; /** * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). */ azureCloudType?: any; /** * The default wait time (in seconds) before terminating the attempt to execute a command and generating an error, used by recommended version. Type: integer (or Expression with resultType integer). */ commandTimeout?: any; /** * The number of re-connections attempted after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 0 and 255. Type: integer (or Expression with resultType integer). */ connectRetryCount?: any; /** * The amount of time (in seconds) between each re-connection attempt after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 1 and 60. Type: integer (or Expression with resultType integer). */ connectRetryInterval?: any; /** * The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error, used by recommended version. Type: integer (or Expression with resultType integer). */ connectTimeout?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * The name of the database, used by recommended version. Type: string (or Expression with resultType string). */ database?: any; /** * Linked service description. */ description?: string; /** * Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. Possible values are true/yes/mandatory, false/no/optional and strict. Type: string (or Expression with resultType string). */ encrypt?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The name or address of the partner server to connect to if the primary server is down, used by recommended version. Type: string (or Expression with resultType string). */ failoverPartner?: any; /** * The host name to use when validating the server certificate for the connection. When not specified, the server name from the Data Source is used for certificate validation, used by recommended version. Type: string (or Expression with resultType string). */ hostNameInCertificate?: any; /** * Indicate whether User ID and Password are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true), used by recommended version. Type: Boolean (or Expression with resultType boolean). */ integratedSecurity?: any; /** * The minimum time, in seconds, for the connection to live in the connection pool before being destroyed, used by recommended version. Type: integer (or Expression with resultType integer). */ loadBalanceTimeout?: any; /** * The maximum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer). */ maxPoolSize?: any; /** * The minimum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer). */ minPoolSize?: any; /** * If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ multiSubnetFailover?: any; /** * When true, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ multipleActiveResultSets?: any; /** * The size in bytes of the network packets used to communicate with an instance of server, used by recommended version. Type: integer (or Expression with resultType integer). */ packetSize?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of password in connection string. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ pooling?: any; /** * The name or network address of the instance of SQL Server to which to connect, used by recommended version. Type: string (or Expression with resultType string). */ server?: any; /** * The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. */ servicePrincipalCredential?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). */ servicePrincipalCredentialType?: any; /** * The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The key of the service principal used to authenticate against Azure SQL Managed Instance. */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). */ tenant?: any; /** * Indicate whether the channel will be encrypted while bypassing walking the certificate chain to validate trust, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ trustServerCertificate?: any; /** * Type of linked service. * Expected value is 'AzureSqlMI'. */ type: "AzureSqlMI"; /** * The user name to be used when connecting to server. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * The Azure SQL Managed Instance dataset. */ interface AzureSqlMITableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Azure SQL Managed Instance dataset. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using schema + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'AzureSqlMITable'. */ type: "AzureSqlMITable"; } /** * A copy activity Azure SQL sink. */ interface AzureSqlSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * SQL pre-copy script. Type: string (or Expression with resultType string). */ preCopyScript?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * SQL writer stored procedure name. Type: string (or Expression with resultType string). */ sqlWriterStoredProcedureName?: any; /** * SQL writer table type. Type: string (or Expression with resultType string). */ sqlWriterTableType?: any; /** * Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean). */ sqlWriterUseTableLock?: any; /** * SQL stored procedure parameters. */ storedProcedureParameters?: any; /** * The stored procedure parameter name of the table type. Type: string (or Expression with resultType string). */ storedProcedureTableTypeParameterName?: any; /** * The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string). */ tableOption?: any; /** * Copy sink type. * Expected value is 'AzureSqlSink'. */ type: "AzureSqlSink"; /** * SQL upsert settings. */ upsertSettings?: outputs.datafactory.SqlUpsertSettingsResponse; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * Write behavior when copying data into Azure SQL. Type: SqlWriteBehaviorEnum (or Expression with resultType SqlWriteBehaviorEnum) */ writeBehavior?: any; } /** * A copy activity Azure SQL source. */ interface AzureSqlSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string). */ isolationLevel?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange". Type: string (or Expression with resultType string). */ partitionOption?: any; /** * The settings that will be leveraged for Sql source partitioning. */ partitionSettings?: outputs.datafactory.SqlPartitionSettingsResponse; /** * Which additional types to produce. */ produceAdditionalTypes?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * SQL reader query. Type: string (or Expression with resultType string). */ sqlReaderQuery?: any; /** * Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string). */ sqlReaderStoredProcedureName?: any; /** * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". */ storedProcedureParameters?: any; /** * Copy source type. * Expected value is 'AzureSqlSource'. */ type: "AzureSqlSource"; } /** * The Azure SQL Server database dataset. */ interface AzureSqlTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Azure SQL database. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using schema + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'AzureSqlTable'. */ type: "AzureSqlTable"; } /** * The storage account linked service. */ interface AzureStorageLinkedServiceResponse { /** * The Azure key vault secret reference of accountKey in connection string. */ accountKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of sasToken in sas uri. */ sasToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference. */ sasUri?: any; /** * Type of linked service. * Expected value is 'AzureStorage'. */ type: "AzureStorage"; /** * Version of the linked service. */ version?: string; } /** * Azure Synapse Analytics (Artifacts) linked service. */ interface AzureSynapseArtifactsLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Required to specify MSI, if using system assigned managed identity as authentication method. Type: string (or Expression with resultType string). */ authentication?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * https://.dev.azuresynapse.net, Azure Synapse Analytics workspace URL. Type: string (or Expression with resultType string). */ endpoint: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'AzureSynapseArtifacts'. */ type: "AzureSynapseArtifacts"; /** * Version of the linked service. */ version?: string; /** * The resource ID of the Synapse workspace. The format should be: /subscriptions/{subscriptionID}/resourceGroups/{resourceGroup}/providers/Microsoft.Synapse/workspaces/{workspaceName}. Type: string (or Expression with resultType string). */ workspaceResourceId?: any; } /** * The Azure Table storage dataset. */ interface AzureTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Azure Table storage. Type: string (or Expression with resultType string). */ tableName: any; /** * Type of dataset. * Expected value is 'AzureTable'. */ type: "AzureTable"; } /** * A copy activity Azure Table sink. */ interface AzureTableSinkResponse { /** * Azure Table default partition key value. Type: string (or Expression with resultType string). */ azureTableDefaultPartitionKeyValue?: any; /** * Azure Table insert type. Type: string (or Expression with resultType string). */ azureTableInsertType?: any; /** * Azure Table partition key name. Type: string (or Expression with resultType string). */ azureTablePartitionKeyName?: any; /** * Azure Table row key name. Type: string (or Expression with resultType string). */ azureTableRowKeyName?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'AzureTableSink'. */ type: "AzureTableSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity Azure Table source. */ interface AzureTableSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * Azure Table source ignore table not found. Type: boolean (or Expression with resultType boolean). */ azureTableSourceIgnoreTableNotFound?: any; /** * Azure Table source query. Type: string (or Expression with resultType string). */ azureTableSourceQuery?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'AzureTableSource'. */ type: "AzureTableSource"; } /** * The azure table storage linked service. */ interface AzureTableStorageLinkedServiceResponse { /** * The Azure key vault secret reference of accountKey in connection string. */ accountKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The connection string. It is mutually exclusive with sasUri property. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of sasToken in sas uri. */ sasToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * SAS URI of the Azure Storage resource. It is mutually exclusive with connectionString property. Type: string, SecureString or AzureKeyVaultSecretReference. */ sasUri?: any; /** * Table service endpoint of the Azure Table Storage resource. It is mutually exclusive with connectionString, sasUri property. */ serviceEndpoint?: any; /** * Type of linked service. * Expected value is 'AzureTableStorage'. */ type: "AzureTableStorage"; /** * Version of the linked service. */ version?: string; } /** * Big data pool reference type. */ interface BigDataPoolParametrizationReferenceResponse { /** * Reference big data pool name. Type: string (or Expression with resultType string). */ referenceName: any; /** * Big data pool reference type. */ type: string; } /** * Binary dataset. */ interface BinaryDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The data compression method used for the binary dataset. */ compression?: outputs.datafactory.DatasetCompressionResponse; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The location of the Binary storage. */ location: outputs.datafactory.AmazonS3CompatibleLocationResponse | outputs.datafactory.AmazonS3LocationResponse | outputs.datafactory.AzureBlobFSLocationResponse | outputs.datafactory.AzureBlobStorageLocationResponse | outputs.datafactory.AzureDataLakeStoreLocationResponse | outputs.datafactory.AzureFileStorageLocationResponse | outputs.datafactory.FileServerLocationResponse | outputs.datafactory.FtpServerLocationResponse | outputs.datafactory.GoogleCloudStorageLocationResponse | outputs.datafactory.HdfsLocationResponse | outputs.datafactory.HttpServerLocationResponse | outputs.datafactory.LakeHouseLocationResponse | outputs.datafactory.OracleCloudStorageLocationResponse | outputs.datafactory.SftpLocationResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'Binary'. */ type: "Binary"; } /** * Binary read settings. */ interface BinaryReadSettingsResponse { /** * Compression settings. */ compressionProperties?: outputs.datafactory.TarGZipReadSettingsResponse | outputs.datafactory.TarReadSettingsResponse | outputs.datafactory.ZipDeflateReadSettingsResponse; /** * The read setting type. * Expected value is 'BinaryReadSettings'. */ type: "BinaryReadSettings"; } /** * A copy activity Binary sink. */ interface BinarySinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Binary store settings. */ storeSettings?: outputs.datafactory.AzureBlobFSWriteSettingsResponse | outputs.datafactory.AzureBlobStorageWriteSettingsResponse | outputs.datafactory.AzureDataLakeStoreWriteSettingsResponse | outputs.datafactory.AzureFileStorageWriteSettingsResponse | outputs.datafactory.FileServerWriteSettingsResponse | outputs.datafactory.LakeHouseWriteSettingsResponse | outputs.datafactory.SftpWriteSettingsResponse; /** * Copy sink type. * Expected value is 'BinarySink'. */ type: "BinarySink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity Binary source. */ interface BinarySourceResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Binary format settings. */ formatSettings?: outputs.datafactory.BinaryReadSettingsResponse; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Binary store settings. */ storeSettings?: outputs.datafactory.AmazonS3CompatibleReadSettingsResponse | outputs.datafactory.AmazonS3ReadSettingsResponse | outputs.datafactory.AzureBlobFSReadSettingsResponse | outputs.datafactory.AzureBlobStorageReadSettingsResponse | outputs.datafactory.AzureDataLakeStoreReadSettingsResponse | outputs.datafactory.AzureFileStorageReadSettingsResponse | outputs.datafactory.FileServerReadSettingsResponse | outputs.datafactory.FtpReadSettingsResponse | outputs.datafactory.GoogleCloudStorageReadSettingsResponse | outputs.datafactory.HdfsReadSettingsResponse | outputs.datafactory.HttpReadSettingsResponse | outputs.datafactory.LakeHouseReadSettingsResponse | outputs.datafactory.OracleCloudStorageReadSettingsResponse | outputs.datafactory.SftpReadSettingsResponse; /** * Copy source type. * Expected value is 'BinarySource'. */ type: "BinarySource"; } /** * Trigger that runs every time a Blob event occurs. */ interface BlobEventsTriggerResponse { /** * List of tags that can be used for describing the trigger. */ annotations?: any[]; /** * The blob path must begin with the pattern provided for trigger to fire. For example, '/records/blobs/december/' will only fire the trigger for blobs in the december folder under the records container. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith. */ blobPathBeginsWith?: string; /** * The blob path must end with the pattern provided for trigger to fire. For example, 'december/boxes.csv' will only fire the trigger for blobs named boxes in a december folder. At least one of these must be provided: blobPathBeginsWith, blobPathEndsWith. */ blobPathEndsWith?: string; /** * Trigger description. */ description?: string; /** * The type of events that cause this trigger to fire. */ events: string[]; /** * If set to true, blobs with zero bytes will be ignored. */ ignoreEmptyBlobs?: boolean; /** * Pipelines that need to be started. */ pipelines?: outputs.datafactory.TriggerPipelineReferenceResponse[]; /** * Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. */ runtimeState: string; /** * The ARM resource ID of the Storage Account. */ scope: string; /** * Trigger type. * Expected value is 'BlobEventsTrigger'. */ type: "BlobEventsTrigger"; } /** * A copy activity Azure Blob sink. */ interface BlobSinkResponse { /** * Blob writer add header. Type: boolean (or Expression with resultType boolean). */ blobWriterAddHeader?: any; /** * Blob writer date time format. Type: string (or Expression with resultType string). */ blobWriterDateTimeFormat?: any; /** * Blob writer overwrite files. Type: boolean (or Expression with resultType boolean). */ blobWriterOverwriteFiles?: any; /** * The type of copy behavior for copy sink. */ copyBehavior?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects). */ metadata?: outputs.datafactory.MetadataItemResponse[]; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'BlobSink'. */ type: "BlobSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity Azure Blob source. */ interface BlobSourceResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * Number of header lines to skip from each blob. Type: integer (or Expression with resultType integer). */ skipHeaderLineCount?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Treat empty as null. Type: boolean (or Expression with resultType boolean). */ treatEmptyAsNull?: any; /** * Copy source type. * Expected value is 'BlobSource'. */ type: "BlobSource"; } /** * Trigger that runs every time the selected Blob container changes. */ interface BlobTriggerResponse { /** * List of tags that can be used for describing the trigger. */ annotations?: any[]; /** * Trigger description. */ description?: string; /** * The path of the container/folder that will trigger the pipeline. */ folderPath: string; /** * The Azure Storage linked service reference. */ linkedService: outputs.datafactory.LinkedServiceReferenceResponse; /** * The max number of parallel files to handle when it is triggered. */ maxConcurrency: number; /** * Pipelines that need to be started. */ pipelines?: outputs.datafactory.TriggerPipelineReferenceResponse[]; /** * Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. */ runtimeState: string; /** * Trigger type. * Expected value is 'BlobTrigger'. */ type: "BlobTrigger"; } /** * Managed Identity used for CMK. */ interface CMKIdentityDefinitionResponse { /** * The resource id of the user assigned identity to authenticate to customer's key vault. */ userAssignedIdentity?: string; } /** * Linked service for Cassandra data source. */ interface CassandraLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * AuthenticationType to be used for connection. Type: string (or Expression with resultType string). */ authenticationType?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Host name for connection. Type: string (or Expression with resultType string). */ host: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password for authentication. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The port for the connection. Type: integer (or Expression with resultType integer). */ port?: any; /** * Type of linked service. * Expected value is 'Cassandra'. */ type: "Cassandra"; /** * Username for authentication. Type: string (or Expression with resultType string). */ username?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity source for a Cassandra database. */ interface CassandraSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * The consistency level specifies how many Cassandra servers must respond to a read request before returning data to the client application. Cassandra checks the specified number of Cassandra servers for data to satisfy the read request. Must be one of cassandraSourceReadConsistencyLevels. The default value is 'ONE'. It is case-insensitive. */ consistencyLevel?: string; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Database query. Should be a SQL-92 query expression or Cassandra Query Language (CQL) command. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'CassandraSource'. */ type: "CassandraSource"; } /** * The Cassandra database dataset. */ interface CassandraTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * The keyspace of the Cassandra database. Type: string (or Expression with resultType string). */ keyspace?: any; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Cassandra database. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'CassandraTable'. */ type: "CassandraTable"; } /** * Trigger that allows the referenced pipeline to depend on other pipeline runs based on runDimension Name/Value pairs. Upstream pipelines should declare the same runDimension Name and their runs should have the values for those runDimensions. The referenced pipeline run would be triggered if the values for the runDimension match for all upstream pipeline runs. */ interface ChainingTriggerResponse { /** * List of tags that can be used for describing the trigger. */ annotations?: any[]; /** * Upstream Pipelines. */ dependsOn: outputs.datafactory.PipelineReferenceResponse[]; /** * Trigger description. */ description?: string; /** * Pipeline for which runs are created when all upstream pipelines complete successfully. */ pipeline: outputs.datafactory.TriggerPipelineReferenceResponse; /** * Run Dimension property that needs to be emitted by upstream pipelines. */ runDimension: string; /** * Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. */ runtimeState: string; /** * Trigger type. * Expected value is 'ChainingTrigger'. */ type: "ChainingTrigger"; } /** * The folder that this CDC is in. If not specified, CDC will appear at the root level. */ interface ChangeDataCaptureFolderResponse { /** * The name of the folder that this CDC is in. */ name?: string; } /** * The custom setup of running cmdkey commands. */ interface CmdkeySetupResponse { /** * The password of data source access. */ password: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The server name of data source access. Type: string. */ targetName: any; /** * The type of custom setup. * Expected value is 'CmdkeySetup'. */ type: "CmdkeySetup"; /** * The user name of data source access. Type: string. */ userName: any; } /** * The Common Data Service for Apps entity dataset. */ interface CommonDataServiceForAppsEntityDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The logical name of the entity. Type: string (or Expression with resultType string). */ entityName?: any; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'CommonDataServiceForAppsEntity'. */ type: "CommonDataServiceForAppsEntity"; } /** * Common Data Service for Apps linked service. */ interface CommonDataServiceForAppsLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The authentication type to connect to Common Data Service for Apps server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario. 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string). */ authenticationType: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The deployment type of the Common Data Service for Apps instance. 'Online' for Common Data Service for Apps Online and 'OnPremisesWithIfd' for Common Data Service for Apps on-premises with Ifd. Type: string (or Expression with resultType string). */ deploymentType: any; /** * Linked service description. */ description?: string; /** * The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string). */ domain?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The host name of the on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string). */ hostName?: any; /** * The organization name of the Common Data Service for Apps instance. The property is required for on-prem and required for online when there are more than one Common Data Service for Apps instances associated with the user. Type: string (or Expression with resultType string). */ organizationName?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password to access the Common Data Service for Apps instance. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The port of on-premises Common Data Service for Apps server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0. */ port?: any; /** * The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. */ servicePrincipalCredential?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). */ servicePrincipalCredentialType?: any; /** * The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The URL to the Microsoft Common Data Service for Apps server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string). */ serviceUri?: any; /** * Type of linked service. * Expected value is 'CommonDataServiceForApps'. */ type: "CommonDataServiceForApps"; /** * User name to access the Common Data Service for Apps instance. Type: string (or Expression with resultType string). */ username?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity Common Data Service for Apps sink. */ interface CommonDataServiceForAppsSinkResponse { /** * The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string). */ alternateKeyName?: any; /** * Controls the bypass of Dataverse custom business logic. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string). */ bypassBusinessLogicExecution?: any; /** * Controls the bypass of Power Automate flows. Default is false. Type: boolean (or Expression with resultType boolean). */ bypassPowerAutomateFlows?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean). */ ignoreNullValues?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'CommonDataServiceForAppsSink'. */ type: "CommonDataServiceForAppsSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * The write behavior for the operation. */ writeBehavior: string; } /** * A copy activity Common Data Service for Apps source. */ interface CommonDataServiceForAppsSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * FetchXML is a proprietary query language that is used in Microsoft Common Data Service for Apps (online & on-premises). Type: string (or Expression with resultType string). */ query?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'CommonDataServiceForAppsSource'. */ type: "CommonDataServiceForAppsSource"; } /** * The custom setup of installing 3rd party components. */ interface ComponentSetupResponse { /** * The name of the 3rd party component. */ componentName: string; /** * The license key to activate the component. */ licenseKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The type of custom setup. * Expected value is 'ComponentSetup'. */ type: "ComponentSetup"; } /** * Concur Service linked service. */ interface ConcurLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Application client_id supplied by Concur App Management. */ clientId: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Properties used to connect to Concur. It is mutually exclusive with any other properties in the linked service. Type: object. */ connectionProperties?: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password corresponding to the user name that you provided in the username field. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'Concur'. */ type: "Concur"; /** * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. */ useEncryptedEndpoints?: any; /** * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. */ useHostVerification?: any; /** * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. */ usePeerVerification?: any; /** * The user name that you use to access Concur Service. */ username: any; /** * Version of the linked service. */ version?: string; } /** * Concur Service dataset. */ interface ConcurObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'ConcurObject'. */ type: "ConcurObject"; } /** * A copy activity Concur Service source. */ interface ConcurSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'ConcurSource'. */ type: "ConcurSource"; } /** * The connection state of a managed private endpoint */ interface ConnectionStatePropertiesResponse { /** * The actions required on the managed private endpoint */ actionsRequired: string; /** * The managed private endpoint description */ description: string; /** * The approval status */ status: string; } /** * Continuation settings for execute data flow activity. */ interface ContinuationSettingsReferenceResponse { /** * Continuation TTL in minutes. */ continuationTtlInMinutes?: any; /** * Customized checkpoint key. */ customizedCheckpointKey?: any; /** * Idle condition. */ idleCondition?: any; } /** * Base class for all control activities like IfCondition, ForEach , Until. */ interface ControlActivityResponse { /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'Container'. */ type: "Container"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Settings for copy activity log. */ interface CopyActivityLogSettingsResponse { /** * Specifies whether to enable reliable logging. Type: boolean (or Expression with resultType boolean). */ enableReliableLogging?: any; /** * Gets or sets the log level, support: Info, Warning. Type: string (or Expression with resultType string). */ logLevel?: any; } /** * Copy activity. */ interface CopyActivityResponse { /** * Maximum number of data integration units that can be used to perform this data movement. Type: integer (or Expression with resultType integer), minimum: 0. */ dataIntegrationUnits?: any; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Whether to skip incompatible row. Default value is false. Type: boolean (or Expression with resultType boolean). */ enableSkipIncompatibleRow?: any; /** * Specifies whether to copy data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean). */ enableStaging?: any; /** * List of inputs for the activity. */ inputs?: outputs.datafactory.DatasetReferenceResponse[]; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Log settings customer needs provide when enabling log. */ logSettings?: outputs.datafactory.LogSettingsResponse; /** * (Deprecated. Please use LogSettings) Log storage settings customer need to provide when enabling session log. */ logStorageSettings?: outputs.datafactory.LogStorageSettingsResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * List of outputs for the activity. */ outputs?: outputs.datafactory.DatasetReferenceResponse[]; /** * Maximum number of concurrent sessions opened on the source or sink to avoid overloading the data store. Type: integer (or Expression with resultType integer), minimum: 0. */ parallelCopies?: any; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Preserve rules. */ preserve?: any[]; /** * Preserve Rules. */ preserveRules?: any[]; /** * Redirect incompatible row settings when EnableSkipIncompatibleRow is true. */ redirectIncompatibleRowSettings?: outputs.datafactory.RedirectIncompatibleRowSettingsResponse; /** * Copy activity sink. */ sink: outputs.datafactory.AvroSinkResponse | outputs.datafactory.AzureBlobFSSinkResponse | outputs.datafactory.AzureDataExplorerSinkResponse | outputs.datafactory.AzureDataLakeStoreSinkResponse | outputs.datafactory.AzureDatabricksDeltaLakeSinkResponse | outputs.datafactory.AzureMySqlSinkResponse | outputs.datafactory.AzurePostgreSqlSinkResponse | outputs.datafactory.AzureQueueSinkResponse | outputs.datafactory.AzureSearchIndexSinkResponse | outputs.datafactory.AzureSqlSinkResponse | outputs.datafactory.AzureTableSinkResponse | outputs.datafactory.BinarySinkResponse | outputs.datafactory.BlobSinkResponse | outputs.datafactory.CommonDataServiceForAppsSinkResponse | outputs.datafactory.CosmosDbMongoDbApiSinkResponse | outputs.datafactory.CosmosDbSqlApiSinkResponse | outputs.datafactory.DelimitedTextSinkResponse | outputs.datafactory.DocumentDbCollectionSinkResponse | outputs.datafactory.DynamicsCrmSinkResponse | outputs.datafactory.DynamicsSinkResponse | outputs.datafactory.FileSystemSinkResponse | outputs.datafactory.IcebergSinkResponse | outputs.datafactory.InformixSinkResponse | outputs.datafactory.JsonSinkResponse | outputs.datafactory.LakeHouseTableSinkResponse | outputs.datafactory.MicrosoftAccessSinkResponse | outputs.datafactory.MongoDbAtlasSinkResponse | outputs.datafactory.MongoDbV2SinkResponse | outputs.datafactory.OdbcSinkResponse | outputs.datafactory.OracleSinkResponse | outputs.datafactory.OrcSinkResponse | outputs.datafactory.ParquetSinkResponse | outputs.datafactory.RestSinkResponse | outputs.datafactory.SalesforceServiceCloudSinkResponse | outputs.datafactory.SalesforceServiceCloudV2SinkResponse | outputs.datafactory.SalesforceSinkResponse | outputs.datafactory.SalesforceV2SinkResponse | outputs.datafactory.SapCloudForCustomerSinkResponse | outputs.datafactory.SnowflakeSinkResponse | outputs.datafactory.SnowflakeV2SinkResponse | outputs.datafactory.SqlDWSinkResponse | outputs.datafactory.SqlMISinkResponse | outputs.datafactory.SqlServerSinkResponse | outputs.datafactory.SqlSinkResponse | outputs.datafactory.TeradataSinkResponse | outputs.datafactory.WarehouseSinkResponse; /** * Specify the fault tolerance for data consistency. */ skipErrorFile?: outputs.datafactory.SkipErrorFileResponse; /** * Copy activity source. */ source: outputs.datafactory.AmazonMWSSourceResponse | outputs.datafactory.AmazonRdsForOracleSourceResponse | outputs.datafactory.AmazonRdsForSqlServerSourceResponse | outputs.datafactory.AmazonRedshiftSourceResponse | outputs.datafactory.AvroSourceResponse | outputs.datafactory.AzureBlobFSSourceResponse | outputs.datafactory.AzureDataExplorerSourceResponse | outputs.datafactory.AzureDataLakeStoreSourceResponse | outputs.datafactory.AzureDatabricksDeltaLakeSourceResponse | outputs.datafactory.AzureMariaDBSourceResponse | outputs.datafactory.AzureMySqlSourceResponse | outputs.datafactory.AzurePostgreSqlSourceResponse | outputs.datafactory.AzureSqlSourceResponse | outputs.datafactory.AzureTableSourceResponse | outputs.datafactory.BinarySourceResponse | outputs.datafactory.BlobSourceResponse | outputs.datafactory.CassandraSourceResponse | outputs.datafactory.CommonDataServiceForAppsSourceResponse | outputs.datafactory.ConcurSourceResponse | outputs.datafactory.CosmosDbMongoDbApiSourceResponse | outputs.datafactory.CosmosDbSqlApiSourceResponse | outputs.datafactory.CouchbaseSourceResponse | outputs.datafactory.Db2SourceResponse | outputs.datafactory.DelimitedTextSourceResponse | outputs.datafactory.DocumentDbCollectionSourceResponse | outputs.datafactory.DrillSourceResponse | outputs.datafactory.DynamicsAXSourceResponse | outputs.datafactory.DynamicsCrmSourceResponse | outputs.datafactory.DynamicsSourceResponse | outputs.datafactory.EloquaSourceResponse | outputs.datafactory.ExcelSourceResponse | outputs.datafactory.FileSystemSourceResponse | outputs.datafactory.GoogleAdWordsSourceResponse | outputs.datafactory.GoogleBigQuerySourceResponse | outputs.datafactory.GoogleBigQueryV2SourceResponse | outputs.datafactory.GreenplumSourceResponse | outputs.datafactory.HBaseSourceResponse | outputs.datafactory.HdfsSourceResponse | outputs.datafactory.HiveSourceResponse | outputs.datafactory.HttpSourceResponse | outputs.datafactory.HubspotSourceResponse | outputs.datafactory.ImpalaSourceResponse | outputs.datafactory.InformixSourceResponse | outputs.datafactory.JiraSourceResponse | outputs.datafactory.JsonSourceResponse | outputs.datafactory.LakeHouseTableSourceResponse | outputs.datafactory.MagentoSourceResponse | outputs.datafactory.MariaDBSourceResponse | outputs.datafactory.MarketoSourceResponse | outputs.datafactory.MicrosoftAccessSourceResponse | outputs.datafactory.MongoDbAtlasSourceResponse | outputs.datafactory.MongoDbSourceResponse | outputs.datafactory.MongoDbV2SourceResponse | outputs.datafactory.MySqlSourceResponse | outputs.datafactory.NetezzaSourceResponse | outputs.datafactory.ODataSourceResponse | outputs.datafactory.OdbcSourceResponse | outputs.datafactory.Office365SourceResponse | outputs.datafactory.OracleServiceCloudSourceResponse | outputs.datafactory.OracleSourceResponse | outputs.datafactory.OrcSourceResponse | outputs.datafactory.ParquetSourceResponse | outputs.datafactory.PaypalSourceResponse | outputs.datafactory.PhoenixSourceResponse | outputs.datafactory.PostgreSqlSourceResponse | outputs.datafactory.PostgreSqlV2SourceResponse | outputs.datafactory.PrestoSourceResponse | outputs.datafactory.QuickBooksSourceResponse | outputs.datafactory.RelationalSourceResponse | outputs.datafactory.ResponsysSourceResponse | outputs.datafactory.RestSourceResponse | outputs.datafactory.SalesforceMarketingCloudSourceResponse | outputs.datafactory.SalesforceServiceCloudSourceResponse | outputs.datafactory.SalesforceServiceCloudV2SourceResponse | outputs.datafactory.SalesforceSourceResponse | outputs.datafactory.SalesforceV2SourceResponse | outputs.datafactory.SapBwSourceResponse | outputs.datafactory.SapCloudForCustomerSourceResponse | outputs.datafactory.SapEccSourceResponse | outputs.datafactory.SapHanaSourceResponse | outputs.datafactory.SapOdpSourceResponse | outputs.datafactory.SapOpenHubSourceResponse | outputs.datafactory.SapTableSourceResponse | outputs.datafactory.ServiceNowSourceResponse | outputs.datafactory.ServiceNowV2SourceResponse | outputs.datafactory.SharePointOnlineListSourceResponse | outputs.datafactory.ShopifySourceResponse | outputs.datafactory.SnowflakeSourceResponse | outputs.datafactory.SnowflakeV2SourceResponse | outputs.datafactory.SparkSourceResponse | outputs.datafactory.SqlDWSourceResponse | outputs.datafactory.SqlMISourceResponse | outputs.datafactory.SqlServerSourceResponse | outputs.datafactory.SqlSourceResponse | outputs.datafactory.SquareSourceResponse | outputs.datafactory.SybaseSourceResponse | outputs.datafactory.TabularSourceResponse | outputs.datafactory.TeradataSourceResponse | outputs.datafactory.VerticaSourceResponse | outputs.datafactory.WarehouseSourceResponse | outputs.datafactory.WebSourceResponse | outputs.datafactory.XeroSourceResponse | outputs.datafactory.XmlSourceResponse | outputs.datafactory.ZohoSourceResponse; /** * Specifies interim staging settings when EnableStaging is true. */ stagingSettings?: outputs.datafactory.StagingSettingsResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Copy activity translator. If not specified, tabular translator is used. */ translator?: any; /** * Type of activity. * Expected value is 'Copy'. */ type: "Copy"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; /** * Whether to enable Data Consistency validation. Type: boolean (or Expression with resultType boolean). */ validateDataConsistency?: any; } /** * CopyComputeScale properties for managed integration runtime. */ interface CopyComputeScalePropertiesResponse { /** * DIU number setting reserved for copy activity execution. Supported values are multiples of 4 in range 4-256. */ dataIntegrationUnit?: number; /** * Time to live (in minutes) setting of integration runtime which will execute copy activity. */ timeToLive?: number; } /** * Microsoft Azure Cosmos Database (CosmosDB) linked service. */ interface CosmosDbLinkedServiceResponse { /** * The endpoint of the Azure CosmosDB account. Type: string (or Expression with resultType string) */ accountEndpoint?: any; /** * The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference. */ accountKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). */ azureCloudType?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The connection mode used to access CosmosDB account. Type: string. */ connectionMode?: string; /** * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * The name of the database. Type: string (or Expression with resultType string) */ database?: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. */ servicePrincipalCredential?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string. */ servicePrincipalCredentialType?: any; /** * The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). */ tenant?: any; /** * Type of linked service. * Expected value is 'CosmosDb'. */ type: "CosmosDb"; /** * Version of the linked service. */ version?: string; } /** * The CosmosDB (MongoDB API) database dataset. */ interface CosmosDbMongoDbApiCollectionDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The collection name of the CosmosDB (MongoDB API) database. Type: string (or Expression with resultType string). */ collection: any; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'CosmosDbMongoDbApiCollection'. */ type: "CosmosDbMongoDbApiCollection"; } /** * Linked service for CosmosDB (MongoDB API) data source. */ interface CosmosDbMongoDbApiLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The CosmosDB (MongoDB API) connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString: any; /** * The name of the CosmosDB (MongoDB API) database that you want to access. Type: string (or Expression with resultType string). */ database: any; /** * Linked service description. */ description?: string; /** * Whether the CosmosDB (MongoDB API) server version is higher than 3.2. The default value is false. Type: boolean (or Expression with resultType boolean). */ isServerVersionAbove32?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'CosmosDbMongoDbApi'. */ type: "CosmosDbMongoDbApi"; /** * Version of the linked service. */ version?: string; } /** * A copy activity sink for a CosmosDB (MongoDB API) database. */ interface CosmosDbMongoDbApiSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'CosmosDbMongoDbApiSink'. */ type: "CosmosDbMongoDbApiSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is "insert". Type: string (or Expression with resultType string). Type: string (or Expression with resultType string). */ writeBehavior?: any; } /** * A copy activity source for a CosmosDB (MongoDB API) database. */ interface CosmosDbMongoDbApiSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer). */ batchSize?: any; /** * Cursor methods for Mongodb query. */ cursorMethods?: outputs.datafactory.MongoDbCursorMethodsPropertiesResponse; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string). */ filter?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'CosmosDbMongoDbApiSource'. */ type: "CosmosDbMongoDbApiSource"; } /** * Microsoft Azure CosmosDB (SQL API) Collection dataset. */ interface CosmosDbSqlApiCollectionDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * CosmosDB (SQL API) collection name. Type: string (or Expression with resultType string). */ collectionName: any; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'CosmosDbSqlApiCollection'. */ type: "CosmosDbSqlApiCollection"; } /** * A copy activity Azure CosmosDB (SQL API) Collection sink. */ interface CosmosDbSqlApiSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'CosmosDbSqlApiSink'. */ type: "CosmosDbSqlApiSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert. */ writeBehavior?: any; } /** * A copy activity Azure CosmosDB (SQL API) Collection source. */ interface CosmosDbSqlApiSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * Whether detect primitive values as datetime values. Type: boolean (or Expression with resultType boolean). */ detectDatetime?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Page size of the result. Type: integer (or Expression with resultType integer). */ pageSize?: any; /** * Preferred regions. Type: array of strings (or Expression with resultType array of strings). */ preferredRegions?: any; /** * SQL API query. Type: string (or Expression with resultType string). */ query?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'CosmosDbSqlApiSource'. */ type: "CosmosDbSqlApiSource"; } /** * Couchbase server linked service. */ interface CouchbaseLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * The Azure key vault secret reference of credString in connection string. */ credString?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'Couchbase'. */ type: "Couchbase"; /** * Version of the linked service. */ version?: string; } /** * A copy activity Couchbase server source. */ interface CouchbaseSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'CouchbaseSource'. */ type: "CouchbaseSource"; } /** * Couchbase server dataset. */ interface CouchbaseTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'CouchbaseTable'. */ type: "CouchbaseTable"; } /** * Credential reference type. */ interface CredentialReferenceResponse { /** * Reference credential name. */ referenceName: string; /** * Credential reference type. */ type: string; } /** * Reference objects for custom activity */ interface CustomActivityReferenceObjectResponse { /** * Dataset references. */ datasets?: outputs.datafactory.DatasetReferenceResponse[]; /** * Linked service references. */ linkedServices?: outputs.datafactory.LinkedServiceReferenceResponse[]; } /** * Custom activity type. */ interface CustomActivityResponse { /** * Elevation level and scope for the user, default is nonadmin task. Type: string (or Expression with resultType double). */ autoUserSpecification?: any; /** * Command for custom activity Type: string (or Expression with resultType string). */ command: any; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * User defined property bag. There is no restriction on the keys or values that can be used. The user specified custom activity has the full responsibility to consume and interpret the content defined. */ extendedProperties?: any; /** * Folder path for resource files Type: string (or Expression with resultType string). */ folderPath?: any; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Reference objects */ referenceObjects?: outputs.datafactory.CustomActivityReferenceObjectResponse; /** * Resource linked service reference. */ resourceLinkedService?: outputs.datafactory.LinkedServiceReferenceResponse; /** * The retention time for the files submitted for custom activity. Type: double (or Expression with resultType double). */ retentionTimeInDays?: any; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'Custom'. */ type: "Custom"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Custom linked service. */ interface CustomDataSourceLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'CustomDataSource'. */ type: "CustomDataSource"; /** * Version of the linked service. */ version?: string; } /** * The custom dataset. */ interface CustomDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'CustomDataset'. */ type: "CustomDataset"; } /** * Trigger that runs every time a custom event is received. */ interface CustomEventsTriggerResponse { /** * List of tags that can be used for describing the trigger. */ annotations?: any[]; /** * Trigger description. */ description?: string; /** * The list of event types that cause this trigger to fire. */ events: any[]; /** * Pipelines that need to be started. */ pipelines?: outputs.datafactory.TriggerPipelineReferenceResponse[]; /** * Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. */ runtimeState: string; /** * The ARM resource ID of the Azure Event Grid Topic. */ scope: string; /** * The event subject must begin with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith. */ subjectBeginsWith?: string; /** * The event subject must end with the pattern provided for trigger to fire. At least one of these must be provided: subjectBeginsWith, subjectEndsWith. */ subjectEndsWith?: string; /** * Trigger type. * Expected value is 'CustomEventsTrigger'. */ type: "CustomEventsTrigger"; } /** * Default value. */ interface DWCopyCommandDefaultValueResponse { /** * Column name. Type: object (or Expression with resultType string). */ columnName?: any; /** * The default value of the column. Type: object (or Expression with resultType string). */ defaultValue?: any; } /** * DW Copy Command settings. */ interface DWCopyCommandSettingsResponse { /** * Additional options directly passed to SQL DW in Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: "additionalOptions": { "MAXERRORS": "1000", "DATEFORMAT": "'ymd'" } */ additionalOptions?: { [key: string]: string; }; /** * Specifies the default values for each target column in SQL DW. The default values in the property overwrite the DEFAULT constraint set in the DB, and identity column cannot have a default value. Type: array of objects (or Expression with resultType array of objects). */ defaultValues?: outputs.datafactory.DWCopyCommandDefaultValueResponse[]; } /** * The folder that this data flow is in. If not specified, Data flow will appear at the root level. */ interface DataFlowFolderResponse { /** * The name of the folder that this data flow is in. */ name?: string; } /** * Data flow reference type. */ interface DataFlowReferenceResponse { /** * Reference data flow parameters from dataset. */ datasetParameters?: any; /** * Data flow parameters */ parameters?: any; /** * Reference data flow name. */ referenceName: string; /** * Data flow reference type. */ type: string; } /** * Transformation for data flow sink. */ interface DataFlowSinkResponse { /** * Dataset reference. */ dataset?: outputs.datafactory.DatasetReferenceResponse; /** * Transformation description. */ description?: string; /** * Flowlet Reference */ flowlet?: outputs.datafactory.DataFlowReferenceResponse; /** * Linked service reference. */ linkedService?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Transformation name. */ name: string; /** * Rejected data linked service reference. */ rejectedDataLinkedService?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Schema linked service reference. */ schemaLinkedService?: outputs.datafactory.LinkedServiceReferenceResponse; } /** * Transformation for data flow source. */ interface DataFlowSourceResponse { /** * Dataset reference. */ dataset?: outputs.datafactory.DatasetReferenceResponse; /** * Transformation description. */ description?: string; /** * Flowlet Reference */ flowlet?: outputs.datafactory.DataFlowReferenceResponse; /** * Linked service reference. */ linkedService?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Transformation name. */ name: string; /** * Schema linked service reference. */ schemaLinkedService?: outputs.datafactory.LinkedServiceReferenceResponse; } /** * Staging info for execute data flow activity. */ interface DataFlowStagingInfoResponse { /** * Folder path for staging blob. Type: string (or Expression with resultType string) */ folderPath?: any; /** * Staging linked service reference. */ linkedService?: outputs.datafactory.LinkedServiceReferenceResponse; } /** * Data Lake Analytics U-SQL activity. */ interface DataLakeAnalyticsUSQLActivityResponse { /** * Compilation mode of U-SQL. Must be one of these values : Semantic, Full and SingleBox. Type: string (or Expression with resultType string). */ compilationMode?: any; /** * The maximum number of nodes simultaneously used to run the job. Default value is 1. Type: integer (or Expression with resultType integer), minimum: 1. */ degreeOfParallelism?: any; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Parameters for U-SQL job request. */ parameters?: any; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Determines which jobs out of all that are queued should be selected to run first. The lower the number, the higher the priority. Default value is 1000. Type: integer (or Expression with resultType integer), minimum: 1. */ priority?: any; /** * Runtime version of the U-SQL engine to use. Type: string (or Expression with resultType string). */ runtimeVersion?: any; /** * Script linked service reference. */ scriptLinkedService: outputs.datafactory.LinkedServiceReferenceResponse; /** * Case-sensitive path to folder that contains the U-SQL script. Type: string (or Expression with resultType string). */ scriptPath: any; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'DataLakeAnalyticsU-SQL'. */ type: "DataLakeAnalyticsU-SQL"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Source and target table mapping details. */ interface DataMapperMappingResponse { /** * This holds the user provided attribute mapping information. */ attributeMappingInfo?: outputs.datafactory.MapperAttributeMappingsResponse; /** * The connection reference for the source connection. */ sourceConnectionReference?: outputs.datafactory.MapperConnectionReferenceResponse; /** * This holds the source denormalization information used while joining multiple sources. */ sourceDenormalizeInfo?: any; /** * Name of the source table */ sourceEntityName?: string; /** * Name of the target table */ targetEntityName?: string; } /** * Databricks Job activity. */ interface DatabricksJobActivityResponse { /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * The Id of the Databricks Job to be executed. Type: string (or Expression with resultType string). */ jobId: any; /** * Job parameters to be used for each run of this job. If the job takes a parameter that is not specified, the default value from the job will be used. */ jobParameters?: any; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'DatabricksJob'. */ type: "DatabricksJob"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * DatabricksNotebook activity. */ interface DatabricksNotebookActivityResponse { /** * Base parameters to be used for each run of this job.If the notebook takes a parameter that is not specified, the default value from the notebook will be used. */ baseParameters?: any; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * A list of libraries to be installed on the cluster that will execute the job. */ libraries?: any[]; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * The absolute path of the notebook to be run in the Databricks Workspace. This path must begin with a slash. Type: string (or Expression with resultType string). */ notebookPath: any; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'DatabricksNotebook'. */ type: "DatabricksNotebook"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * DatabricksSparkJar activity. */ interface DatabricksSparkJarActivityResponse { /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * A list of libraries to be installed on the cluster that will execute the job. */ libraries?: any[]; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * The full name of the class containing the main method to be executed. This class must be contained in a JAR provided as a library. Type: string (or Expression with resultType string). */ mainClassName: any; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Parameters that will be passed to the main method. */ parameters?: any[]; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'DatabricksSparkJar'. */ type: "DatabricksSparkJar"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * DatabricksSparkPython activity. */ interface DatabricksSparkPythonActivityResponse { /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * A list of libraries to be installed on the cluster that will execute the job. */ libraries?: any[]; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Command line parameters that will be passed to the Python file. */ parameters?: any[]; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * The URI of the Python file to be executed. DBFS paths are supported. Type: string (or Expression with resultType string). */ pythonFile: any; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'DatabricksSparkPython'. */ type: "DatabricksSparkPython"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * The compression method used on a dataset. */ interface DatasetCompressionResponse { /** * The dataset compression level. Type: string (or Expression with resultType string). */ level?: any; /** * Type of dataset compression. Type: string (or Expression with resultType string). */ type: any; } /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ interface DatasetFolderResponse { /** * The name of the folder that this Dataset is in. */ name?: string; } /** * Dataset reference type. */ interface DatasetReferenceResponse { /** * Arguments for dataset. */ parameters?: any; /** * Reference dataset name. */ referenceName: string; /** * Dataset reference type. */ type: string; } /** * Linked service for Dataworld. */ interface DataworldLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The api token for the Dataworld source. */ apiToken: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'Dataworld'. */ type: "Dataworld"; /** * Version of the linked service. */ version?: string; } /** * Linked service for DB2 data source. */ interface Db2LinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * AuthenticationType to be used for connection. It is mutually exclusive with connectionString property. */ authenticationType?: string; /** * Certificate Common Name when TLS is enabled. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). */ certificateCommonName?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The connection string. It is mutually exclusive with server, database, authenticationType, userName, packageCollection and certificateCommonName property. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * Database name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). */ database?: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. It is mutually exclusive with connectionString property. Type: string. */ encryptedCredential?: string; /** * Under where packages are created when querying database. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). */ packageCollection?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password for authentication. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Server name for connection. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). */ server?: any; /** * Type of linked service. * Expected value is 'Db2'. */ type: "Db2"; /** * Username for authentication. It is mutually exclusive with connectionString property. Type: string (or Expression with resultType string). */ username?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity source for Db2 databases. */ interface Db2SourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Database query. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'Db2Source'. */ type: "Db2Source"; } /** * The Db2 table dataset. */ interface Db2TableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The Db2 table name. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using schema + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'Db2Table'. */ type: "Db2Table"; } /** * Delete activity. */ interface DeleteActivityResponse { /** * Delete activity dataset reference. */ dataset: outputs.datafactory.DatasetReferenceResponse; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Whether to record detailed logs of delete-activity execution. Default value is false. Type: boolean (or Expression with resultType boolean). */ enableLogging?: any; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Log storage settings customer need to provide when enableLogging is true. */ logStorageSettings?: outputs.datafactory.LogStorageSettingsResponse; /** * The max concurrent connections to connect data source at the same time. */ maxConcurrentConnections?: number; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * If true, files or sub-folders under current folder path will be deleted recursively. Default is false. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Delete activity store settings. */ storeSettings?: outputs.datafactory.AmazonS3CompatibleReadSettingsResponse | outputs.datafactory.AmazonS3ReadSettingsResponse | outputs.datafactory.AzureBlobFSReadSettingsResponse | outputs.datafactory.AzureBlobStorageReadSettingsResponse | outputs.datafactory.AzureDataLakeStoreReadSettingsResponse | outputs.datafactory.AzureFileStorageReadSettingsResponse | outputs.datafactory.FileServerReadSettingsResponse | outputs.datafactory.FtpReadSettingsResponse | outputs.datafactory.GoogleCloudStorageReadSettingsResponse | outputs.datafactory.HdfsReadSettingsResponse | outputs.datafactory.HttpReadSettingsResponse | outputs.datafactory.LakeHouseReadSettingsResponse | outputs.datafactory.OracleCloudStorageReadSettingsResponse | outputs.datafactory.SftpReadSettingsResponse; /** * Type of activity. * Expected value is 'Delete'. */ type: "Delete"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Delimited text dataset. */ interface DelimitedTextDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The column delimiter. Type: string (or Expression with resultType string). */ columnDelimiter?: any; /** * The data compressionCodec. Type: string (or Expression with resultType string). */ compressionCodec?: any; /** * The data compression method used for DelimitedText. */ compressionLevel?: any; /** * Dataset description. */ description?: string; /** * The code page name of the preferred encoding. If miss, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string). */ encodingName?: any; /** * The escape character. Type: string (or Expression with resultType string). */ escapeChar?: any; /** * When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean). */ firstRowAsHeader?: any; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The location of the delimited text storage. */ location: outputs.datafactory.AmazonS3CompatibleLocationResponse | outputs.datafactory.AmazonS3LocationResponse | outputs.datafactory.AzureBlobFSLocationResponse | outputs.datafactory.AzureBlobStorageLocationResponse | outputs.datafactory.AzureDataLakeStoreLocationResponse | outputs.datafactory.AzureFileStorageLocationResponse | outputs.datafactory.FileServerLocationResponse | outputs.datafactory.FtpServerLocationResponse | outputs.datafactory.GoogleCloudStorageLocationResponse | outputs.datafactory.HdfsLocationResponse | outputs.datafactory.HttpServerLocationResponse | outputs.datafactory.LakeHouseLocationResponse | outputs.datafactory.OracleCloudStorageLocationResponse | outputs.datafactory.SftpLocationResponse; /** * The null value string. Type: string (or Expression with resultType string). */ nullValue?: any; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The quote character. Type: string (or Expression with resultType string). */ quoteChar?: any; /** * The row delimiter. Type: string (or Expression with resultType string). */ rowDelimiter?: any; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'DelimitedText'. */ type: "DelimitedText"; } /** * Delimited text read settings. */ interface DelimitedTextReadSettingsResponse { /** * Compression settings. */ compressionProperties?: outputs.datafactory.TarGZipReadSettingsResponse | outputs.datafactory.TarReadSettingsResponse | outputs.datafactory.ZipDeflateReadSettingsResponse; /** * Indicates the number of non-empty rows to skip when reading data from input files. Type: integer (or Expression with resultType integer). */ skipLineCount?: any; /** * The read setting type. * Expected value is 'DelimitedTextReadSettings'. */ type: "DelimitedTextReadSettings"; } /** * A copy activity DelimitedText sink. */ interface DelimitedTextSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * DelimitedText format settings. */ formatSettings?: outputs.datafactory.DelimitedTextWriteSettingsResponse; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * DelimitedText store settings. */ storeSettings?: outputs.datafactory.AzureBlobFSWriteSettingsResponse | outputs.datafactory.AzureBlobStorageWriteSettingsResponse | outputs.datafactory.AzureDataLakeStoreWriteSettingsResponse | outputs.datafactory.AzureFileStorageWriteSettingsResponse | outputs.datafactory.FileServerWriteSettingsResponse | outputs.datafactory.LakeHouseWriteSettingsResponse | outputs.datafactory.SftpWriteSettingsResponse; /** * Copy sink type. * Expected value is 'DelimitedTextSink'. */ type: "DelimitedTextSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity DelimitedText source. */ interface DelimitedTextSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * DelimitedText format settings. */ formatSettings?: outputs.datafactory.DelimitedTextReadSettingsResponse; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * DelimitedText store settings. */ storeSettings?: outputs.datafactory.AmazonS3CompatibleReadSettingsResponse | outputs.datafactory.AmazonS3ReadSettingsResponse | outputs.datafactory.AzureBlobFSReadSettingsResponse | outputs.datafactory.AzureBlobStorageReadSettingsResponse | outputs.datafactory.AzureDataLakeStoreReadSettingsResponse | outputs.datafactory.AzureFileStorageReadSettingsResponse | outputs.datafactory.FileServerReadSettingsResponse | outputs.datafactory.FtpReadSettingsResponse | outputs.datafactory.GoogleCloudStorageReadSettingsResponse | outputs.datafactory.HdfsReadSettingsResponse | outputs.datafactory.HttpReadSettingsResponse | outputs.datafactory.LakeHouseReadSettingsResponse | outputs.datafactory.OracleCloudStorageReadSettingsResponse | outputs.datafactory.SftpReadSettingsResponse; /** * Copy source type. * Expected value is 'DelimitedTextSource'. */ type: "DelimitedTextSource"; } /** * Delimited text write settings. */ interface DelimitedTextWriteSettingsResponse { /** * The file extension used to create the files. Type: string (or Expression with resultType string). */ fileExtension: any; /** * Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string). */ fileNamePrefix?: any; /** * Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer). */ maxRowsPerFile?: any; /** * Indicates whether string values should always be enclosed with quotes. Type: boolean (or Expression with resultType boolean). */ quoteAllText?: any; /** * The write setting type. * Expected value is 'DelimitedTextWriteSettings'. */ type: "DelimitedTextWriteSettings"; } /** * Distcp settings. */ interface DistcpSettingsResponse { /** * Specifies the Distcp options. Type: string (or Expression with resultType string). */ distcpOptions?: any; /** * Specifies the Yarn ResourceManager endpoint. Type: string (or Expression with resultType string). */ resourceManagerEndpoint: any; /** * Specifies an existing folder path which will be used to store temp Distcp command script. The script file is generated by ADF and will be removed after Copy job finished. Type: string (or Expression with resultType string). */ tempScriptPath: any; } /** * Microsoft Azure Document Database Collection dataset. */ interface DocumentDbCollectionDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Document Database collection name. Type: string (or Expression with resultType string). */ collectionName: any; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'DocumentDbCollection'. */ type: "DocumentDbCollection"; } /** * A copy activity Document Database Collection sink. */ interface DocumentDbCollectionSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Nested properties separator. Default is . (dot). Type: string (or Expression with resultType string). */ nestingSeparator?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'DocumentDbCollectionSink'. */ type: "DocumentDbCollectionSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * Describes how to write data to Azure Cosmos DB. Type: string (or Expression with resultType string). Allowed values: insert and upsert. */ writeBehavior?: any; } /** * A copy activity Document Database Collection source. */ interface DocumentDbCollectionSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Nested properties separator. Type: string (or Expression with resultType string). */ nestingSeparator?: any; /** * Documents query. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'DocumentDbCollectionSource'. */ type: "DocumentDbCollectionSource"; } /** * Drill server linked service. */ interface DrillLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of password in connection string. */ pwd?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * Type of linked service. * Expected value is 'Drill'. */ type: "Drill"; /** * Version of the linked service. */ version?: string; } /** * A copy activity Drill server source. */ interface DrillSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'DrillSource'. */ type: "DrillSource"; } /** * Drill server dataset. */ interface DrillTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Drill. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using schema + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'DrillTable'. */ type: "DrillTable"; } /** * Dynamics AX linked service. */ interface DynamicsAXLinkedServiceResponse { /** * Specify the resource you are requesting authorization. Type: string (or Expression with resultType string). */ aadResourceId: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Specify the application's client ID. Type: string (or Expression with resultType string). */ servicePrincipalId: any; /** * Specify the application's key. Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Type: string (or Expression with resultType string). */ servicePrincipalKey: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Specify the tenant information (domain name or tenant ID) under which your application resides. Retrieve it by hovering the mouse in the top-right corner of the Azure portal. Type: string (or Expression with resultType string). */ tenant: any; /** * Type of linked service. * Expected value is 'DynamicsAX'. */ type: "DynamicsAX"; /** * The Dynamics AX (or Dynamics 365 Finance and Operations) instance OData endpoint. */ url: any; /** * Version of the linked service. */ version?: string; } /** * The path of the Dynamics AX OData entity. */ interface DynamicsAXResourceDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The path of the Dynamics AX OData entity. Type: string (or Expression with resultType string). */ path: any; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'DynamicsAXResource'. */ type: "DynamicsAXResource"; } /** * A copy activity Dynamics AX source. */ interface DynamicsAXSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ httpRequestTimeout?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'DynamicsAXSource'. */ type: "DynamicsAXSource"; } /** * The Dynamics CRM entity dataset. */ interface DynamicsCrmEntityDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The logical name of the entity. Type: string (or Expression with resultType string). */ entityName?: any; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'DynamicsCrmEntity'. */ type: "DynamicsCrmEntity"; } /** * Dynamics CRM linked service. */ interface DynamicsCrmLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The authentication type to connect to Dynamics CRM server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string). */ authenticationType: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * The deployment type of the Dynamics CRM instance. 'Online' for Dynamics CRM Online and 'OnPremisesWithIfd' for Dynamics CRM on-premises with Ifd. Type: string (or Expression with resultType string). */ deploymentType: any; /** * Linked service description. */ description?: string; /** * The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string). */ domain?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The host name of the on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string). */ hostName?: any; /** * The organization name of the Dynamics CRM instance. The property is required for on-prem and required for online when there are more than one Dynamics CRM instances associated with the user. Type: string (or Expression with resultType string). */ organizationName?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password to access the Dynamics CRM instance. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The port of on-premises Dynamics CRM server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0. */ port?: any; /** * The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. */ servicePrincipalCredential?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). */ servicePrincipalCredentialType?: any; /** * The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The URL to the Microsoft Dynamics CRM server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string). */ serviceUri?: any; /** * Type of linked service. * Expected value is 'DynamicsCrm'. */ type: "DynamicsCrm"; /** * User name to access the Dynamics CRM instance. Type: string (or Expression with resultType string). */ username?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity Dynamics CRM sink. */ interface DynamicsCrmSinkResponse { /** * The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string). */ alternateKeyName?: any; /** * Controls the bypass of Dataverse custom business logic. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string). */ bypassBusinessLogicExecution?: any; /** * Controls the bypass of Power Automate flows. Default is false. Type: boolean (or Expression with resultType boolean). */ bypassPowerAutomateFlows?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The flag indicating whether to ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean). */ ignoreNullValues?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'DynamicsCrmSink'. */ type: "DynamicsCrmSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * The write behavior for the operation. */ writeBehavior: string; } /** * A copy activity Dynamics CRM source. */ interface DynamicsCrmSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * FetchXML is a proprietary query language that is used in Microsoft Dynamics CRM (online & on-premises). Type: string (or Expression with resultType string). */ query?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'DynamicsCrmSource'. */ type: "DynamicsCrmSource"; } /** * The Dynamics entity dataset. */ interface DynamicsEntityDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The logical name of the entity. Type: string (or Expression with resultType string). */ entityName?: any; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'DynamicsEntity'. */ type: "DynamicsEntity"; } /** * Dynamics linked service. */ interface DynamicsLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The authentication type to connect to Dynamics server. 'Office365' for online scenario, 'Ifd' for on-premises with Ifd scenario, 'AADServicePrincipal' for Server-To-Server authentication in online scenario, 'Active Directory' for Dynamics on-premises with IFD. Type: string (or Expression with resultType string). */ authenticationType: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * The deployment type of the Dynamics instance. 'Online' for Dynamics Online and 'OnPremisesWithIfd' for Dynamics on-premises with Ifd. Type: string (or Expression with resultType string). */ deploymentType: any; /** * Linked service description. */ description?: string; /** * The Active Directory domain that will verify user credentials. Type: string (or Expression with resultType string). */ domain?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The host name of the on-premises Dynamics server. The property is required for on-prem and not allowed for online. Type: string (or Expression with resultType string). */ hostName?: any; /** * The organization name of the Dynamics instance. The property is required for on-prem and required for online when there are more than one Dynamics instances associated with the user. Type: string (or Expression with resultType string). */ organizationName?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password to access the Dynamics instance. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The port of on-premises Dynamics server. The property is required for on-prem and not allowed for online. Default is 443. Type: integer (or Expression with resultType integer), minimum: 0. */ port?: any; /** * The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. */ servicePrincipalCredential?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). */ servicePrincipalCredentialType?: any; /** * The client ID of the application in Azure Active Directory used for Server-To-Server authentication. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The URL to the Microsoft Dynamics server. The property is required for on-line and not allowed for on-prem. Type: string (or Expression with resultType string). */ serviceUri?: any; /** * Type of linked service. * Expected value is 'Dynamics'. */ type: "Dynamics"; /** * User name to access the Dynamics instance. Type: string (or Expression with resultType string). */ username?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity Dynamics sink. */ interface DynamicsSinkResponse { /** * The logical name of the alternate key which will be used when upserting records. Type: string (or Expression with resultType string). */ alternateKeyName?: any; /** * Controls the bypass of Dataverse custom business logic. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string). */ bypassBusinessLogicExecution?: any; /** * Controls the bypass of Power Automate flows. Default is false. Type: boolean (or Expression with resultType boolean). */ bypassPowerAutomateFlows?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The flag indicating whether ignore null values from input dataset (except key fields) during write operation. Default is false. Type: boolean (or Expression with resultType boolean). */ ignoreNullValues?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'DynamicsSink'. */ type: "DynamicsSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * The write behavior for the operation. */ writeBehavior: string; } /** * A copy activity Dynamics source. */ interface DynamicsSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * FetchXML is a proprietary query language that is used in Microsoft Dynamics (online & on-premises). Type: string (or Expression with resultType string). */ query?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'DynamicsSource'. */ type: "DynamicsSource"; } /** * Eloqua server linked service. */ interface EloquaLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The endpoint of the Eloqua server. (i.e. eloqua.example.com) */ endpoint: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password corresponding to the user name. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'Eloqua'. */ type: "Eloqua"; /** * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. */ useEncryptedEndpoints?: any; /** * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. */ useHostVerification?: any; /** * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. */ usePeerVerification?: any; /** * The site name and user name of your Eloqua account in the form: sitename/username. (i.e. Eloqua/Alice) */ username: any; /** * Version of the linked service. */ version?: string; } /** * Eloqua server dataset. */ interface EloquaObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'EloquaObject'. */ type: "EloquaObject"; } /** * A copy activity Eloqua server source. */ interface EloquaSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'EloquaSource'. */ type: "EloquaSource"; } /** * Definition of CMK for the factory. */ interface EncryptionConfigurationResponse { /** * User assigned identity to use to authenticate to customer's key vault. If not provided Managed Service Identity will be used. */ identity?: outputs.datafactory.CMKIdentityDefinitionResponse; /** * The name of the key in Azure Key Vault to use as Customer Managed Key. */ keyName: string; /** * The version of the key used for CMK. If not provided, latest version will be used. */ keyVersion?: string; /** * The url of the Azure Key Vault used for CMK. */ vaultBaseUrl: string; } /** * The entity reference. */ interface EntityReferenceResponse { /** * The name of this referenced entity. */ referenceName?: string; /** * The type of this referenced entity. */ type?: string; } /** * The custom setup of setting environment variable. */ interface EnvironmentVariableSetupResponse { /** * The type of custom setup. * Expected value is 'EnvironmentVariableSetup'. */ type: "EnvironmentVariableSetup"; /** * The name of the environment variable. */ variableName: string; /** * The value of the environment variable. */ variableValue: string; } /** * Excel dataset. */ interface ExcelDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The data compression method used for the json dataset. */ compression?: outputs.datafactory.DatasetCompressionResponse; /** * Dataset description. */ description?: string; /** * When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean). */ firstRowAsHeader?: any; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The location of the excel storage. */ location: outputs.datafactory.AmazonS3CompatibleLocationResponse | outputs.datafactory.AmazonS3LocationResponse | outputs.datafactory.AzureBlobFSLocationResponse | outputs.datafactory.AzureBlobStorageLocationResponse | outputs.datafactory.AzureDataLakeStoreLocationResponse | outputs.datafactory.AzureFileStorageLocationResponse | outputs.datafactory.FileServerLocationResponse | outputs.datafactory.FtpServerLocationResponse | outputs.datafactory.GoogleCloudStorageLocationResponse | outputs.datafactory.HdfsLocationResponse | outputs.datafactory.HttpServerLocationResponse | outputs.datafactory.LakeHouseLocationResponse | outputs.datafactory.OracleCloudStorageLocationResponse | outputs.datafactory.SftpLocationResponse; /** * The null value string. Type: string (or Expression with resultType string). */ nullValue?: any; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The partial data of one sheet. Type: string (or Expression with resultType string). */ range?: any; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer) */ sheetIndex?: any; /** * The sheet name of excel file. Type: string (or Expression with resultType string). */ sheetName?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'Excel'. */ type: "Excel"; } /** * A copy activity excel source. */ interface ExcelSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Excel store settings. */ storeSettings?: outputs.datafactory.AmazonS3CompatibleReadSettingsResponse | outputs.datafactory.AmazonS3ReadSettingsResponse | outputs.datafactory.AzureBlobFSReadSettingsResponse | outputs.datafactory.AzureBlobStorageReadSettingsResponse | outputs.datafactory.AzureDataLakeStoreReadSettingsResponse | outputs.datafactory.AzureFileStorageReadSettingsResponse | outputs.datafactory.FileServerReadSettingsResponse | outputs.datafactory.FtpReadSettingsResponse | outputs.datafactory.GoogleCloudStorageReadSettingsResponse | outputs.datafactory.HdfsReadSettingsResponse | outputs.datafactory.HttpReadSettingsResponse | outputs.datafactory.LakeHouseReadSettingsResponse | outputs.datafactory.OracleCloudStorageReadSettingsResponse | outputs.datafactory.SftpReadSettingsResponse; /** * Copy source type. * Expected value is 'ExcelSource'. */ type: "ExcelSource"; } /** * Execute data flow activity. */ interface ExecuteDataFlowActivityResponse { /** * Compute properties for data flow activity. */ compute?: outputs.datafactory.ExecuteDataFlowActivityTypePropertiesComputeResponse; /** * Continuation settings for execute data flow activity. */ continuationSettings?: outputs.datafactory.ContinuationSettingsReferenceResponse; /** * Continue on error setting used for data flow execution. Enables processing to continue if a sink fails. Type: boolean (or Expression with resultType boolean) */ continueOnError?: any; /** * Data flow reference. */ dataFlow: outputs.datafactory.DataFlowReferenceResponse; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * The integration runtime reference. */ integrationRuntime?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Concurrent run setting used for data flow execution. Allows sinks with the same save order to be processed concurrently. Type: boolean (or Expression with resultType boolean) */ runConcurrently?: any; /** * Specify number of parallel staging for sources applicable to the sink. Type: integer (or Expression with resultType integer) */ sourceStagingConcurrency?: any; /** * Staging info for execute data flow activity. */ staging?: outputs.datafactory.DataFlowStagingInfoResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Trace level setting used for data flow monitoring output. Supported values are: 'coarse', 'fine', and 'none'. Type: string (or Expression with resultType string) */ traceLevel?: any; /** * Type of activity. * Expected value is 'ExecuteDataFlow'. */ type: "ExecuteDataFlow"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Compute properties for data flow activity. */ interface ExecuteDataFlowActivityTypePropertiesComputeResponse { /** * Compute type of the cluster which will execute data flow job. Possible values include: 'General', 'MemoryOptimized', 'ComputeOptimized'. Type: string (or Expression with resultType string) */ computeType?: any; /** * Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272. Type: integer (or Expression with resultType integer) */ coreCount?: any; } /** * Execution policy for an execute pipeline activity. */ interface ExecutePipelineActivityPolicyResponse { /** * When set to true, Input from activity is considered as secure and will not be logged to monitoring. */ secureInput?: boolean; } /** * Execute pipeline activity. */ interface ExecutePipelineActivityResponse { /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Pipeline parameters. */ parameters?: any; /** * Pipeline reference. */ pipeline: outputs.datafactory.PipelineReferenceResponse; /** * Execute pipeline activity policy. */ policy?: outputs.datafactory.ExecutePipelineActivityPolicyResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'ExecutePipeline'. */ type: "ExecutePipeline"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; /** * Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false. */ waitOnCompletion?: boolean; } /** * Execute SSIS package activity. */ interface ExecuteSSISPackageActivityResponse { /** * The integration runtime reference. */ connectVia: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * The environment path to execute the SSIS package. Type: string (or Expression with resultType string). */ environmentPath?: any; /** * The package execution credential. */ executionCredential?: outputs.datafactory.SSISExecutionCredentialResponse; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * SSIS package execution log location. */ logLocation?: outputs.datafactory.SSISLogLocationResponse; /** * The logging level of SSIS package execution. Type: string (or Expression with resultType string). */ loggingLevel?: any; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * The package level connection managers to execute the SSIS package. */ packageConnectionManagers?: { [key: string]: { [key: string]: outputs.datafactory.SSISExecutionParameterResponse; }; }; /** * SSIS package location. */ packageLocation: outputs.datafactory.SSISPackageLocationResponse; /** * The package level parameters to execute the SSIS package. */ packageParameters?: { [key: string]: outputs.datafactory.SSISExecutionParameterResponse; }; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * The project level connection managers to execute the SSIS package. */ projectConnectionManagers?: { [key: string]: { [key: string]: outputs.datafactory.SSISExecutionParameterResponse; }; }; /** * The project level parameters to execute the SSIS package. */ projectParameters?: { [key: string]: outputs.datafactory.SSISExecutionParameterResponse; }; /** * The property overrides to execute the SSIS package. */ propertyOverrides?: { [key: string]: outputs.datafactory.SSISPropertyOverrideResponse; }; /** * Specifies the runtime to execute SSIS package. The value should be "x86" or "x64". Type: string (or Expression with resultType string). */ runtime?: any; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'ExecuteSSISPackage'. */ type: "ExecuteSSISPackage"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Execute power query activity. */ interface ExecuteWranglingDataflowActivityResponse { /** * Compute properties for data flow activity. */ compute?: outputs.datafactory.ExecuteDataFlowActivityTypePropertiesComputeResponse; /** * Continuation settings for execute data flow activity. */ continuationSettings?: outputs.datafactory.ContinuationSettingsReferenceResponse; /** * Continue on error setting used for data flow execution. Enables processing to continue if a sink fails. Type: boolean (or Expression with resultType boolean) */ continueOnError?: any; /** * Data flow reference. */ dataFlow: outputs.datafactory.DataFlowReferenceResponse; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * The integration runtime reference. */ integrationRuntime?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * List of mapping for Power Query mashup query to sink dataset(s). */ queries?: outputs.datafactory.PowerQuerySinkMappingResponse[]; /** * Concurrent run setting used for data flow execution. Allows sinks with the same save order to be processed concurrently. Type: boolean (or Expression with resultType boolean) */ runConcurrently?: any; /** * (Deprecated. Please use Queries). List of Power Query activity sinks mapped to a queryName. */ sinks?: { [key: string]: outputs.datafactory.PowerQuerySinkResponse; }; /** * Specify number of parallel staging for sources applicable to the sink. Type: integer (or Expression with resultType integer) */ sourceStagingConcurrency?: any; /** * Staging info for execute data flow activity. */ staging?: outputs.datafactory.DataFlowStagingInfoResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Trace level setting used for data flow monitoring output. Supported values are: 'coarse', 'fine', and 'none'. Type: string (or Expression with resultType string) */ traceLevel?: any; /** * Type of activity. * Expected value is 'ExecuteWranglingDataflow'. */ type: "ExecuteWranglingDataflow"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Base class for all execution activities. */ interface ExecutionActivityResponse { /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'Execution'. */ type: "Execution"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Azure Data Factory expression definition. */ interface ExpressionResponse { /** * Expression type. */ type: string; /** * Expression value. */ value: string; } /** * Nested representation of a complex expression. */ interface ExpressionV2Response { /** * List of nested expressions. */ operands?: outputs.datafactory.ExpressionV2Response[]; /** * Expression operator value Type: list of strings. */ operators?: string[]; /** * Type of expressions supported by the system. Type: string. */ type?: string; /** * Value for Constant/Field Type: object. */ value?: any; } /** * Factory's GitHub repo information. */ interface FactoryGitHubConfigurationResponse { /** * Account name. */ accountName: string; /** * GitHub bring your own app client id. */ clientId?: string; /** * GitHub bring your own app client secret information. */ clientSecret?: outputs.datafactory.GitHubClientSecretResponse; /** * Collaboration branch. */ collaborationBranch: string; /** * Disable manual publish operation in ADF studio to favor automated publish. */ disablePublish?: boolean; /** * GitHub Enterprise host name. For example: `https://github.mydomain.com` */ hostName?: string; /** * Last commit id. */ lastCommitId?: string; /** * Repository name. */ repositoryName: string; /** * Root folder. */ rootFolder: string; /** * Type of repo configuration. * Expected value is 'FactoryGitHubConfiguration'. */ type: "FactoryGitHubConfiguration"; } /** * Identity properties of the factory resource. */ interface FactoryIdentityResponse { /** * The principal id of the identity. */ principalId: string; /** * The client tenant id of the identity. */ tenantId: string; /** * The identity type. */ type: string; /** * List of user assigned identities for the factory. */ userAssignedIdentities?: any; } /** * Factory's VSTS repo information. */ interface FactoryVSTSConfigurationResponse { /** * Account name. */ accountName: string; /** * Collaboration branch. */ collaborationBranch: string; /** * Disable manual publish operation in ADF studio to favor automated publish. */ disablePublish?: boolean; /** * Last commit id. */ lastCommitId?: string; /** * VSTS project name. */ projectName: string; /** * Repository name. */ repositoryName: string; /** * Root folder. */ rootFolder: string; /** * VSTS tenant id. */ tenantId?: string; /** * Type of repo configuration. * Expected value is 'FactoryVSTSConfiguration'. */ type: "FactoryVSTSConfiguration"; } /** * This activity will fail within its own scope and output a custom error message and error code. The error message and code can provided either as a string literal or as an expression that can be evaluated to a string at runtime. The activity scope can be the whole pipeline or a control activity (e.g. foreach, switch, until), if the fail activity is contained in it. */ interface FailActivityResponse { /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * The error code that categorizes the error type of the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string). */ errorCode: any; /** * The error message that surfaced in the Fail activity. It can be dynamic content that's evaluated to a non empty/blank string at runtime. Type: string (or Expression with resultType string). */ message: any; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'Fail'. */ type: "Fail"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * File system linked service. */ interface FileServerLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Host name of the server. Type: string (or Expression with resultType string). */ host: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password to logon the server. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'FileServer'. */ type: "FileServer"; /** * User ID to logon the server. Type: string (or Expression with resultType string). */ userId?: any; /** * Version of the linked service. */ version?: string; } /** * The location of file server dataset. */ interface FileServerLocationResponse { /** * Specify the file name of dataset. Type: string (or Expression with resultType string). */ fileName?: any; /** * Specify the folder path of dataset. Type: string (or Expression with resultType string) */ folderPath?: any; /** * Type of dataset storage location. * Expected value is 'FileServerLocation'. */ type: "FileServerLocation"; } /** * File server read settings. */ interface FileServerReadSettingsResponse { /** * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean). */ deleteFilesAfterCompletion?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean). */ enablePartitionDiscovery?: any; /** * Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string). */ fileFilter?: any; /** * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string). */ fileListPath?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The end of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeEnd?: any; /** * The start of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeStart?: any; /** * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string). */ partitionRootPath?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * The read setting type. * Expected value is 'FileServerReadSettings'. */ type: "FileServerReadSettings"; /** * FileServer wildcardFileName. Type: string (or Expression with resultType string). */ wildcardFileName?: any; /** * FileServer wildcardFolderPath. Type: string (or Expression with resultType string). */ wildcardFolderPath?: any; } /** * File server write settings. */ interface FileServerWriteSettingsResponse { /** * The type of copy behavior for copy sink. */ copyBehavior?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects). */ metadata?: outputs.datafactory.MetadataItemResponse[]; /** * The write setting type. * Expected value is 'FileServerWriteSettings'. */ type: "FileServerWriteSettings"; } /** * An on-premises file system dataset. */ interface FileShareDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The data compression method used for the file system. */ compression?: outputs.datafactory.DatasetCompressionResponse; /** * Dataset description. */ description?: string; /** * Specify a filter to be used to select a subset of files in the folderPath rather than all files. Type: string (or Expression with resultType string). */ fileFilter?: any; /** * The name of the on-premises file system. Type: string (or Expression with resultType string). */ fileName?: any; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * The path of the on-premises file system. Type: string (or Expression with resultType string). */ folderPath?: any; /** * The format of the files. */ format?: outputs.datafactory.AvroFormatResponse | outputs.datafactory.JsonFormatResponse | outputs.datafactory.OrcFormatResponse | outputs.datafactory.ParquetFormatResponse | outputs.datafactory.TextFormatResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The end of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeEnd?: any; /** * The start of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeStart?: any; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'FileShare'. */ type: "FileShare"; } /** * A copy activity file system sink. */ interface FileSystemSinkResponse { /** * The type of copy behavior for copy sink. */ copyBehavior?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'FileSystemSink'. */ type: "FileSystemSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity file system source. */ interface FileSystemSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'FileSystemSource'. */ type: "FileSystemSource"; } /** * Filter and return results from input array based on the conditions. */ interface FilterActivityResponse { /** * Condition to be used for filtering the input. */ condition: outputs.datafactory.ExpressionResponse; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Input array on which filter should be applied. */ items: outputs.datafactory.ExpressionResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'Filter'. */ type: "Filter"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Data flow flowlet */ interface FlowletResponse { /** * List of tags that can be used for describing the data flow. */ annotations?: any[]; /** * The description of the data flow. */ description?: string; /** * The folder that this data flow is in. If not specified, Data flow will appear at the root level. */ folder?: outputs.datafactory.DataFlowFolderResponse; /** * Flowlet script. */ script?: string; /** * Flowlet script lines. */ scriptLines?: string[]; /** * List of sinks in Flowlet. */ sinks?: outputs.datafactory.DataFlowSinkResponse[]; /** * List of sources in Flowlet. */ sources?: outputs.datafactory.DataFlowSourceResponse[]; /** * List of transformations in Flowlet. */ transformations?: outputs.datafactory.TransformationResponse[]; /** * Type of data flow. * Expected value is 'Flowlet'. */ type: "Flowlet"; } /** * This activity is used for iterating over a collection and execute given activities. */ interface ForEachActivityResponse { /** * List of activities to execute . */ activities: (outputs.datafactory.AppendVariableActivityResponse | outputs.datafactory.AzureDataExplorerCommandActivityResponse | outputs.datafactory.AzureFunctionActivityResponse | outputs.datafactory.AzureMLBatchExecutionActivityResponse | outputs.datafactory.AzureMLExecutePipelineActivityResponse | outputs.datafactory.AzureMLUpdateResourceActivityResponse | outputs.datafactory.ControlActivityResponse | outputs.datafactory.CopyActivityResponse | outputs.datafactory.CustomActivityResponse | outputs.datafactory.DataLakeAnalyticsUSQLActivityResponse | outputs.datafactory.DatabricksJobActivityResponse | outputs.datafactory.DatabricksNotebookActivityResponse | outputs.datafactory.DatabricksSparkJarActivityResponse | outputs.datafactory.DatabricksSparkPythonActivityResponse | outputs.datafactory.DeleteActivityResponse | outputs.datafactory.ExecuteDataFlowActivityResponse | outputs.datafactory.ExecutePipelineActivityResponse | outputs.datafactory.ExecuteSSISPackageActivityResponse | outputs.datafactory.ExecuteWranglingDataflowActivityResponse | outputs.datafactory.ExecutionActivityResponse | outputs.datafactory.FailActivityResponse | outputs.datafactory.FilterActivityResponse | outputs.datafactory.ForEachActivityResponse | outputs.datafactory.GetMetadataActivityResponse | outputs.datafactory.HDInsightHiveActivityResponse | outputs.datafactory.HDInsightMapReduceActivityResponse | outputs.datafactory.HDInsightPigActivityResponse | outputs.datafactory.HDInsightSparkActivityResponse | outputs.datafactory.HDInsightStreamingActivityResponse | outputs.datafactory.IfConditionActivityResponse | outputs.datafactory.LookupActivityResponse | outputs.datafactory.ScriptActivityResponse | outputs.datafactory.SetVariableActivityResponse | outputs.datafactory.SqlServerStoredProcedureActivityResponse | outputs.datafactory.SwitchActivityResponse | outputs.datafactory.SynapseNotebookActivityResponse | outputs.datafactory.SynapseSparkJobDefinitionActivityResponse | outputs.datafactory.UntilActivityResponse | outputs.datafactory.ValidationActivityResponse | outputs.datafactory.WaitActivityResponse | outputs.datafactory.WebActivityResponse | outputs.datafactory.WebHookActivityResponse)[]; /** * Batch count to be used for controlling the number of parallel execution (when isSequential is set to false). */ batchCount?: number; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Should the loop be executed in sequence or in parallel (max 50) */ isSequential?: boolean; /** * Collection to iterate. */ items: outputs.datafactory.ExpressionResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'ForEach'. */ type: "ForEach"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Ftp read settings. */ interface FtpReadSettingsResponse { /** * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean). */ deleteFilesAfterCompletion?: any; /** * If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean). */ disableChunking?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean). */ enablePartitionDiscovery?: any; /** * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string). */ fileListPath?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string). */ partitionRootPath?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * The read setting type. * Expected value is 'FtpReadSettings'. */ type: "FtpReadSettings"; /** * Specify whether to use binary transfer mode for FTP stores. Type: boolean (or Expression with resultType boolean). */ useBinaryTransfer?: any; /** * Ftp wildcardFileName. Type: string (or Expression with resultType string). */ wildcardFileName?: any; /** * Ftp wildcardFolderPath. Type: string (or Expression with resultType string). */ wildcardFolderPath?: any; } /** * A FTP server Linked Service. */ interface FtpServerLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The authentication type to be used to connect to the FTP server. */ authenticationType?: string; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * If true, validate the FTP server SSL certificate when connect over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean). */ enableServerCertificateValidation?: any; /** * If true, connect to the FTP server over SSL/TLS channel. Default value is true. Type: boolean (or Expression with resultType boolean). */ enableSsl?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Host name of the FTP server. Type: string (or Expression with resultType string). */ host: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password to logon the FTP server. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The TCP port number that the FTP server uses to listen for client connections. Default value is 21. Type: integer (or Expression with resultType integer), minimum: 0. */ port?: any; /** * Type of linked service. * Expected value is 'FtpServer'. */ type: "FtpServer"; /** * Username to logon the FTP server. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * The location of ftp server dataset. */ interface FtpServerLocationResponse { /** * Specify the file name of dataset. Type: string (or Expression with resultType string). */ fileName?: any; /** * Specify the folder path of dataset. Type: string (or Expression with resultType string) */ folderPath?: any; /** * Type of dataset storage location. * Expected value is 'FtpServerLocation'. */ type: "FtpServerLocation"; } /** * Activity to get metadata of dataset */ interface GetMetadataActivityResponse { /** * GetMetadata activity dataset reference. */ dataset: outputs.datafactory.DatasetReferenceResponse; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Fields of metadata to get from dataset. */ fieldList?: any[]; /** * GetMetadata activity format settings. */ formatSettings?: outputs.datafactory.BinaryReadSettingsResponse | outputs.datafactory.DelimitedTextReadSettingsResponse | outputs.datafactory.JsonReadSettingsResponse | outputs.datafactory.ParquetReadSettingsResponse | outputs.datafactory.XmlReadSettingsResponse; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * GetMetadata activity store settings. */ storeSettings?: outputs.datafactory.AmazonS3CompatibleReadSettingsResponse | outputs.datafactory.AmazonS3ReadSettingsResponse | outputs.datafactory.AzureBlobFSReadSettingsResponse | outputs.datafactory.AzureBlobStorageReadSettingsResponse | outputs.datafactory.AzureDataLakeStoreReadSettingsResponse | outputs.datafactory.AzureFileStorageReadSettingsResponse | outputs.datafactory.FileServerReadSettingsResponse | outputs.datafactory.FtpReadSettingsResponse | outputs.datafactory.GoogleCloudStorageReadSettingsResponse | outputs.datafactory.HdfsReadSettingsResponse | outputs.datafactory.HttpReadSettingsResponse | outputs.datafactory.LakeHouseReadSettingsResponse | outputs.datafactory.OracleCloudStorageReadSettingsResponse | outputs.datafactory.SftpReadSettingsResponse; /** * Type of activity. * Expected value is 'GetMetadata'. */ type: "GetMetadata"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Client secret information for factory's bring your own app repository configuration. */ interface GitHubClientSecretResponse { /** * Bring your own app client secret AKV URL. */ byoaSecretAkvUrl?: string; /** * Bring your own app client secret name in AKV. */ byoaSecretName?: string; } /** * Definition of a single parameter for an entity. */ interface GlobalParameterSpecificationResponse { /** * Global Parameter type. */ type: string; /** * Value of parameter. */ value: any; } /** * Google AdWords service linked service. */ interface GoogleAdWordsLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. */ authenticationType?: string; /** * The Client customer ID of the AdWords account that you want to fetch report data for. Type: string (or Expression with resultType string). */ clientCustomerID?: any; /** * The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string). */ clientId?: any; /** * The client secret of the google application used to acquire the refresh token. */ clientSecret?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * (Deprecated) Properties used to connect to GoogleAds. It is mutually exclusive with any other properties in the linked service. Type: object. */ connectionProperties?: any; /** * Linked service description. */ description?: string; /** * The developer token associated with the manager account that you use to grant access to the AdWords API. */ developerToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR. Type: string (or Expression with resultType string). */ email?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The Google Ads API major version such as v14. The supported major versions could be found on https://developers.google.com/google-ads/api/docs/release-notes. Type: string (or Expression with resultType string). */ googleAdsApiVersion?: any; /** * (Deprecated) The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR. Type: string (or Expression with resultType string). */ keyFilePath?: any; /** * The customer ID of the Google Ads Manager account through which you want to fetch report data of specific Customer. Type: string (or Expression with resultType string). */ loginCustomerID?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The private key that is used to authenticate the service account email address and can only be used on self-hosted IR. */ privateKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication. */ refreshToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Specifies whether to use the legacy data type mappings, which maps float, int32 and int64 from Google to string. Do not set this to true unless you want to keep backward compatibility with legacy driver's data type mappings. Type: boolean (or Expression with resultType boolean). */ supportLegacyDataTypes?: any; /** * (Deprecated) The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. Type: string (or Expression with resultType string). */ trustedCertPath?: any; /** * Type of linked service. * Expected value is 'GoogleAdWords'. */ type: "GoogleAdWords"; /** * (Deprecated) Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. Type: boolean (or Expression with resultType boolean). */ useSystemTrustStore?: any; /** * Version of the linked service. */ version?: string; } /** * Google AdWords service dataset. */ interface GoogleAdWordsObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'GoogleAdWordsObject'. */ type: "GoogleAdWordsObject"; } /** * A copy activity Google AdWords service source. */ interface GoogleAdWordsSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'GoogleAdWordsSource'. */ type: "GoogleAdWordsSource"; } /** * Google BigQuery service linked service. */ interface GoogleBigQueryLinkedServiceResponse { /** * A comma-separated list of public BigQuery projects to access. Type: string (or Expression with resultType string). */ additionalProjects?: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. */ authenticationType: string; /** * The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string). */ clientId?: any; /** * The client secret of the google application used to acquire the refresh token. */ clientSecret?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR. Type: string (or Expression with resultType string). */ email?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR. Type: string (or Expression with resultType string). */ keyFilePath?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The default BigQuery project to query against. Type: string (or Expression with resultType string). */ project: any; /** * The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication. */ refreshToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false. Type: string (or Expression with resultType string). */ requestGoogleDriveScope?: any; /** * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. Type: string (or Expression with resultType string). */ trustedCertPath?: any; /** * Type of linked service. * Expected value is 'GoogleBigQuery'. */ type: "GoogleBigQuery"; /** * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.Type: boolean (or Expression with resultType boolean). */ useSystemTrustStore?: any; /** * Version of the linked service. */ version?: string; } /** * Google BigQuery service dataset. */ interface GoogleBigQueryObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The database name of the Google BigQuery. Type: string (or Expression with resultType string). */ dataset?: any; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Google BigQuery. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using database + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'GoogleBigQueryObject'. */ type: "GoogleBigQueryObject"; } /** * A copy activity Google BigQuery service source. */ interface GoogleBigQuerySourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'GoogleBigQuerySource'. */ type: "GoogleBigQuerySource"; } /** * Google BigQuery service linked service. */ interface GoogleBigQueryV2LinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The OAuth 2.0 authentication mechanism used for authentication. */ authenticationType: string; /** * The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string). */ clientId?: any; /** * The client secret of the google application used to acquire the refresh token. */ clientSecret?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The content of the .json key file that is used to authenticate the service account. Type: string (or Expression with resultType string). */ keyFileContent?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The default BigQuery project id to query against. Type: string (or Expression with resultType string). */ projectId: any; /** * The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication. */ refreshToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'GoogleBigQueryV2'. */ type: "GoogleBigQueryV2"; /** * Version of the linked service. */ version?: string; } /** * Google BigQuery service dataset. */ interface GoogleBigQueryV2ObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The database name of the Google BigQuery. Type: string (or Expression with resultType string). */ dataset?: any; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Google BigQuery. Type: string (or Expression with resultType string). */ table?: any; /** * Type of dataset. * Expected value is 'GoogleBigQueryV2Object'. */ type: "GoogleBigQueryV2Object"; } /** * A copy activity Google BigQuery service source. */ interface GoogleBigQueryV2SourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'GoogleBigQueryV2Source'. */ type: "GoogleBigQueryV2Source"; } /** * Linked service for Google Cloud Storage. */ interface GoogleCloudStorageLinkedServiceResponse { /** * The access key identifier of the Google Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). */ accessKeyId?: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The secret access key of the Google Cloud Storage Identity and Access Management (IAM) user. */ secretAccessKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * This value specifies the endpoint to access with the Google Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string). */ serviceUrl?: any; /** * Type of linked service. * Expected value is 'GoogleCloudStorage'. */ type: "GoogleCloudStorage"; /** * Version of the linked service. */ version?: string; } /** * The location of Google Cloud Storage dataset. */ interface GoogleCloudStorageLocationResponse { /** * Specify the bucketName of Google Cloud Storage. Type: string (or Expression with resultType string) */ bucketName?: any; /** * Specify the file name of dataset. Type: string (or Expression with resultType string). */ fileName?: any; /** * Specify the folder path of dataset. Type: string (or Expression with resultType string) */ folderPath?: any; /** * Type of dataset storage location. * Expected value is 'GoogleCloudStorageLocation'. */ type: "GoogleCloudStorageLocation"; /** * Specify the version of Google Cloud Storage. Type: string (or Expression with resultType string). */ version?: any; } /** * Google Cloud Storage read settings. */ interface GoogleCloudStorageReadSettingsResponse { /** * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean). */ deleteFilesAfterCompletion?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean). */ enablePartitionDiscovery?: any; /** * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string). */ fileListPath?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The end of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeEnd?: any; /** * The start of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeStart?: any; /** * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string). */ partitionRootPath?: any; /** * The prefix filter for the Google Cloud Storage object name. Type: string (or Expression with resultType string). */ prefix?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * The read setting type. * Expected value is 'GoogleCloudStorageReadSettings'. */ type: "GoogleCloudStorageReadSettings"; /** * Google Cloud Storage wildcardFileName. Type: string (or Expression with resultType string). */ wildcardFileName?: any; /** * Google Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string). */ wildcardFolderPath?: any; } /** * Linked service for GoogleSheets. */ interface GoogleSheetsLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The api token for the GoogleSheets source. */ apiToken: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'GoogleSheets'. */ type: "GoogleSheets"; /** * Version of the linked service. */ version?: string; } /** * Greenplum Database linked service. */ interface GreenplumLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The authentication type to use. Type: string. Only used for V2. */ authenticationType?: string; /** * The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error. Set to zero for infinity. Type: integer. Only used for V2. */ commandTimeout?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer. Only used for V2. */ connectionTimeout?: any; /** * Database name for connection. Type: string. Only used for V2. */ database?: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Host name for connection. Type: string. Only used for V2. */ host?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The port for the connection. Type: integer. Only used for V2. */ port?: any; /** * The Azure key vault secret reference of password in connection string. */ pwd?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer. Only used for V2. */ sslMode?: any; /** * Type of linked service. * Expected value is 'Greenplum'. */ type: "Greenplum"; /** * Username for authentication. Type: string. Only used for V2. */ username?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity Greenplum Database source. */ interface GreenplumSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'GreenplumSource'. */ type: "GreenplumSource"; } /** * Greenplum Database dataset. */ interface GreenplumTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of Greenplum. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using schema + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'GreenplumTable'. */ type: "GreenplumTable"; } /** * HBase server linked service. */ interface HBaseLinkedServiceResponse { /** * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false. */ allowHostNameCNMismatch?: any; /** * Specifies whether to allow self-signed certificates from the server. The default value is false. */ allowSelfSignedServerCert?: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The authentication mechanism to use to connect to the HBase server. */ authenticationType: string; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * Specifies whether the connections to the server are encrypted using SSL. The default value is false. */ enableSsl?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The IP address or host name of the HBase server. (i.e. 192.168.222.160) */ host: any; /** * The partial URL corresponding to the HBase server. (i.e. /gateway/sandbox/hbase/version) */ httpPath?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password corresponding to the user name. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The TCP port that the HBase instance uses to listen for client connections. The default value is 9090. */ port?: any; /** * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. */ trustedCertPath?: any; /** * Type of linked service. * Expected value is 'HBase'. */ type: "HBase"; /** * The user name used to connect to the HBase instance. */ username?: any; /** * Version of the linked service. */ version?: string; } /** * HBase server dataset. */ interface HBaseObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'HBaseObject'. */ type: "HBaseObject"; } /** * A copy activity HBase server source. */ interface HBaseSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'HBaseSource'. */ type: "HBaseSource"; } /** * HDInsight Hive activity type. */ interface HDInsightHiveActivityResponse { /** * User specified arguments to HDInsightActivity. */ arguments?: any[]; /** * Allows user to specify defines for Hive job request. */ defines?: any; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Debug info option. */ getDebugInfo?: string; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Query timeout value (in minutes). Effective when the HDInsight cluster is with ESP (Enterprise Security Package) */ queryTimeout?: number; /** * Script linked service reference. */ scriptLinkedService?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Script path. Type: string (or Expression with resultType string). */ scriptPath?: any; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Storage linked service references. */ storageLinkedServices?: outputs.datafactory.LinkedServiceReferenceResponse[]; /** * Type of activity. * Expected value is 'HDInsightHive'. */ type: "HDInsightHive"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; /** * User specified arguments under hivevar namespace. */ variables?: any; } /** * HDInsight linked service. */ interface HDInsightLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * HDInsight cluster authentication type. */ clusterAuthType?: string; /** * HDInsight cluster URI. Type: string (or Expression with resultType string). */ clusterUri: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The credential reference containing MI authentication information for the HDInsight cluster. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Specify the FileSystem if the main storage for the HDInsight is ADLS Gen2. Type: string (or Expression with resultType string). */ fileSystem?: any; /** * A reference to the Azure SQL linked service that points to the HCatalog database. */ hcatalogLinkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Specify if the HDInsight is created with ESP (Enterprise Security Package). Type: Boolean. */ isEspEnabled?: any; /** * The Azure Storage linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * HDInsight cluster password. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'HDInsight'. */ type: "HDInsight"; /** * HDInsight cluster user name. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * HDInsight MapReduce activity type. */ interface HDInsightMapReduceActivityResponse { /** * User specified arguments to HDInsightActivity. */ arguments?: any[]; /** * Class name. Type: string (or Expression with resultType string). */ className: any; /** * Allows user to specify defines for the MapReduce job request. */ defines?: any; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Debug info option. */ getDebugInfo?: string; /** * Jar path. Type: string (or Expression with resultType string). */ jarFilePath: any; /** * Jar libs. */ jarLibs?: any[]; /** * Jar linked service reference. */ jarLinkedService?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Storage linked service references. */ storageLinkedServices?: outputs.datafactory.LinkedServiceReferenceResponse[]; /** * Type of activity. * Expected value is 'HDInsightMapReduce'. */ type: "HDInsightMapReduce"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * HDInsight ondemand linked service. */ interface HDInsightOnDemandLinkedServiceResponse { /** * Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf. */ additionalLinkedServiceNames?: outputs.datafactory.LinkedServiceReferenceResponse[]; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The prefix of cluster name, postfix will be distinct with timestamp. Type: string (or Expression with resultType string). */ clusterNamePrefix?: any; /** * The password to access the cluster. */ clusterPassword?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The resource group where the cluster belongs. Type: string (or Expression with resultType string). */ clusterResourceGroup: any; /** * HDInsight On-demand cluster resource group authentication type. */ clusterResourceGroupAuthType?: string; /** * Number of worker/data nodes in the cluster. Suggestion value: 4. Type: int (or Expression with resultType int). */ clusterSize: any; /** * The password to SSH remotely connect cluster’s node (for Linux). */ clusterSshPassword?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The username to SSH remotely connect to cluster’s node (for Linux). Type: string (or Expression with resultType string). */ clusterSshUserName?: any; /** * The cluster type. Type: string (or Expression with resultType string). */ clusterType?: any; /** * The username to access the cluster. Type: string (or Expression with resultType string). */ clusterUserName?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Specifies the core configuration parameters (as in core-site.xml) for the HDInsight cluster to be created. */ coreConfiguration?: any; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Specifies the size of the data node for the HDInsight cluster. */ dataNodeSize?: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Specifies the HBase configuration parameters (hbase-site.xml) for the HDInsight cluster. */ hBaseConfiguration?: any; /** * The name of Azure SQL linked service that point to the HCatalog database. The on-demand HDInsight cluster is created by using the Azure SQL database as the metastore. */ hcatalogLinkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Specifies the HDFS configuration parameters (hdfs-site.xml) for the HDInsight cluster. */ hdfsConfiguration?: any; /** * Specifies the size of the head node for the HDInsight cluster. */ headNodeSize?: any; /** * Specifies the hive configuration parameters (hive-site.xml) for the HDInsight cluster. */ hiveConfiguration?: any; /** * The customer’s subscription to host the cluster. Type: string (or Expression with resultType string). */ hostSubscriptionId: any; /** * Azure Storage linked service to be used by the on-demand cluster for storing and processing data. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Specifies the MapReduce configuration parameters (mapred-site.xml) for the HDInsight cluster. */ mapReduceConfiguration?: any; /** * Specifies the Oozie configuration parameters (oozie-site.xml) for the HDInsight cluster. */ oozieConfiguration?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Custom script actions to run on HDI ondemand cluster once it's up. Please refer to https://docs.microsoft.com/en-us/azure/hdinsight/hdinsight-hadoop-customize-cluster-linux?toc=%2Fen-us%2Fazure%2Fhdinsight%2Fr-server%2FTOC.json&bc=%2Fen-us%2Fazure%2Fbread%2Ftoc.json#understanding-script-actions. */ scriptActions?: outputs.datafactory.ScriptActionResponse[]; /** * The service principal id for the hostSubscriptionId. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The key for the service principal id. */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The version of spark if the cluster type is 'spark'. Type: string (or Expression with resultType string). */ sparkVersion?: any; /** * Specifies the Storm configuration parameters (storm-site.xml) for the HDInsight cluster. */ stormConfiguration?: any; /** * The ARM resource ID for the subnet in the vNet. If virtualNetworkId was specified, then this property is required. Type: string (or Expression with resultType string). */ subnetName?: any; /** * The Tenant id/name to which the service principal belongs. Type: string (or Expression with resultType string). */ tenant: any; /** * The allowed idle time for the on-demand HDInsight cluster. Specifies how long the on-demand HDInsight cluster stays alive after completion of an activity run if there are no other active jobs in the cluster. The minimum value is 5 mins. Type: string (or Expression with resultType string). */ timeToLive: any; /** * Type of linked service. * Expected value is 'HDInsightOnDemand'. */ type: "HDInsightOnDemand"; /** * Version of the linked service. */ version: string; /** * The ARM resource ID for the vNet to which the cluster should be joined after creation. Type: string (or Expression with resultType string). */ virtualNetworkId?: any; /** * Specifies the Yarn configuration parameters (yarn-site.xml) for the HDInsight cluster. */ yarnConfiguration?: any; /** * Specifies the size of the Zoo Keeper node for the HDInsight cluster. */ zookeeperNodeSize?: any; } /** * HDInsight Pig activity type. */ interface HDInsightPigActivityResponse { /** * User specified arguments to HDInsightActivity. Type: array (or Expression with resultType array). */ arguments?: any; /** * Allows user to specify defines for Pig job request. */ defines?: any; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Debug info option. */ getDebugInfo?: string; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Script linked service reference. */ scriptLinkedService?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Script path. Type: string (or Expression with resultType string). */ scriptPath?: any; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Storage linked service references. */ storageLinkedServices?: outputs.datafactory.LinkedServiceReferenceResponse[]; /** * Type of activity. * Expected value is 'HDInsightPig'. */ type: "HDInsightPig"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * HDInsight Spark activity. */ interface HDInsightSparkActivityResponse { /** * The user-specified arguments to HDInsightSparkActivity. */ arguments?: any[]; /** * The application's Java/Spark main class. */ className?: string; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * The relative path to the root folder of the code/package to be executed. Type: string (or Expression with resultType string). */ entryFilePath: any; /** * Debug info option. */ getDebugInfo?: string; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * The user to impersonate that will execute the job. Type: string (or Expression with resultType string). */ proxyUser?: any; /** * The root path in 'sparkJobLinkedService' for all the job’s files. Type: string (or Expression with resultType string). */ rootPath: any; /** * Spark configuration property. */ sparkConfig?: any; /** * The storage linked service for uploading the entry file and dependencies, and for receiving logs. */ sparkJobLinkedService?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'HDInsightSpark'. */ type: "HDInsightSpark"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * HDInsight streaming activity type. */ interface HDInsightStreamingActivityResponse { /** * User specified arguments to HDInsightActivity. */ arguments?: any[]; /** * Combiner executable name. Type: string (or Expression with resultType string). */ combiner?: any; /** * Command line environment values. */ commandEnvironment?: any[]; /** * Allows user to specify defines for streaming job request. */ defines?: any; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Linked service reference where the files are located. */ fileLinkedService?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Paths to streaming job files. Can be directories. */ filePaths: any[]; /** * Debug info option. */ getDebugInfo?: string; /** * Input blob path. Type: string (or Expression with resultType string). */ input: any; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Mapper executable name. Type: string (or Expression with resultType string). */ mapper: any; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Output blob path. Type: string (or Expression with resultType string). */ output: any; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Reducer executable name. Type: string (or Expression with resultType string). */ reducer: any; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Storage linked service references. */ storageLinkedServices?: outputs.datafactory.LinkedServiceReferenceResponse[]; /** * Type of activity. * Expected value is 'HDInsightStreaming'. */ type: "HDInsightStreaming"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Hadoop Distributed File System (HDFS) linked service. */ interface HdfsLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Type of authentication used to connect to the HDFS. Possible values are: Anonymous and Windows. Type: string (or Expression with resultType string). */ authenticationType?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password for Windows authentication. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'Hdfs'. */ type: "Hdfs"; /** * The URL of the HDFS service endpoint, e.g. http://myhostname:50070/webhdfs/v1 . Type: string (or Expression with resultType string). */ url: any; /** * User name for Windows authentication. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * The location of HDFS. */ interface HdfsLocationResponse { /** * Specify the file name of dataset. Type: string (or Expression with resultType string). */ fileName?: any; /** * Specify the folder path of dataset. Type: string (or Expression with resultType string) */ folderPath?: any; /** * Type of dataset storage location. * Expected value is 'HdfsLocation'. */ type: "HdfsLocation"; } /** * HDFS read settings. */ interface HdfsReadSettingsResponse { /** * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean). */ deleteFilesAfterCompletion?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Specifies Distcp-related settings. */ distcpSettings?: outputs.datafactory.DistcpSettingsResponse; /** * Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean). */ enablePartitionDiscovery?: any; /** * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string). */ fileListPath?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The end of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeEnd?: any; /** * The start of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeStart?: any; /** * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string). */ partitionRootPath?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * The read setting type. * Expected value is 'HdfsReadSettings'. */ type: "HdfsReadSettings"; /** * HDFS wildcardFileName. Type: string (or Expression with resultType string). */ wildcardFileName?: any; /** * HDFS wildcardFolderPath. Type: string (or Expression with resultType string). */ wildcardFolderPath?: any; } /** * A copy activity HDFS source. */ interface HdfsSourceResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Specifies Distcp-related settings. */ distcpSettings?: outputs.datafactory.DistcpSettingsResponse; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'HdfsSource'. */ type: "HdfsSource"; } /** * Hive Server linked service. */ interface HiveLinkedServiceResponse { /** * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false. */ allowHostNameCNMismatch?: any; /** * Specifies whether to allow self-signed certificates from the server. The default value is false. */ allowSelfSignedServerCert?: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The authentication method used to access the Hive server. */ authenticationType: string; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * Specifies whether the connections to the server will validate server certificate, the default value is True. Only used for Version 2.0 */ enableServerCertificateValidation?: any; /** * Specifies whether the connections to the server are encrypted using SSL. The default value is false. */ enableSsl?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * IP address or host name of the Hive server, separated by ';' for multiple hosts (only when serviceDiscoveryMode is enable). */ host: any; /** * The partial URL corresponding to the Hive server. */ httpPath?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password corresponding to the user name that you provided in the Username field */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The TCP port that the Hive server uses to listen for client connections. */ port?: any; /** * The type of Hive server. */ serverType?: string; /** * true to indicate using the ZooKeeper service, false not. */ serviceDiscoveryMode?: any; /** * The transport protocol to use in the Thrift layer. */ thriftTransportProtocol?: string; /** * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. */ trustedCertPath?: any; /** * Type of linked service. * Expected value is 'Hive'. */ type: "Hive"; /** * Specifies whether the driver uses native HiveQL queries,or converts them into an equivalent form in HiveQL. */ useNativeQuery?: any; /** * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. */ useSystemTrustStore?: any; /** * The user name that you use to access Hive Server. */ username?: any; /** * Version of the linked service. */ version?: string; /** * The namespace on ZooKeeper under which Hive Server 2 nodes are added. */ zooKeeperNameSpace?: any; } /** * Hive Server dataset. */ interface HiveObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Hive. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using schema + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'HiveObject'. */ type: "HiveObject"; } /** * A copy activity Hive Server source. */ interface HiveSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'HiveSource'. */ type: "HiveSource"; } /** * A file in an HTTP web server. */ interface HttpDatasetResponse { /** * The headers for the HTTP Request. e.g. request-header-name-1:request-header-value-1 * ... * request-header-name-n:request-header-value-n Type: string (or Expression with resultType string). */ additionalHeaders?: any; /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The data compression method used on files. */ compression?: outputs.datafactory.DatasetCompressionResponse; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * The format of files. */ format?: outputs.datafactory.AvroFormatResponse | outputs.datafactory.JsonFormatResponse | outputs.datafactory.OrcFormatResponse | outputs.datafactory.ParquetFormatResponse | outputs.datafactory.TextFormatResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The relative URL based on the URL in the HttpLinkedService refers to an HTTP file Type: string (or Expression with resultType string). */ relativeUrl?: any; /** * The body for the HTTP request. Type: string (or Expression with resultType string). */ requestBody?: any; /** * The HTTP method for the HTTP request. Type: string (or Expression with resultType string). */ requestMethod?: any; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'HttpFile'. */ type: "HttpFile"; } /** * Linked service for an HTTP source. */ interface HttpLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type). */ authHeaders?: any; /** * The authentication type to be used to connect to the HTTP server. */ authenticationType?: string; /** * Thumbprint of certificate for ClientCertificate authentication. Only valid for on-premises copy. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string). */ certThumbprint?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * Base64 encoded certificate data for ClientCertificate authentication. For on-premises copy with ClientCertificate authentication, either CertThumbprint or EmbeddedCertData/Password should be specified. Type: string (or Expression with resultType string). */ embeddedCertData?: any; /** * If true, validate the HTTPS server SSL certificate. Default value is true. Type: boolean (or Expression with resultType boolean). */ enableServerCertificateValidation?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'HttpServer'. */ type: "HttpServer"; /** * The base URL of the HTTP endpoint, e.g. https://www.microsoft.com. Type: string (or Expression with resultType string). */ url: any; /** * User name for Basic, Digest, or Windows authentication. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * Http read settings. */ interface HttpReadSettingsResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string). */ additionalHeaders?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string). */ requestBody?: any; /** * The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string). */ requestMethod?: any; /** * Specifies the timeout for a HTTP client to get HTTP response from HTTP server. Type: string (or Expression with resultType string). */ requestTimeout?: any; /** * The read setting type. * Expected value is 'HttpReadSettings'. */ type: "HttpReadSettings"; } /** * The location of http server. */ interface HttpServerLocationResponse { /** * Specify the file name of dataset. Type: string (or Expression with resultType string). */ fileName?: any; /** * Specify the folder path of dataset. Type: string (or Expression with resultType string) */ folderPath?: any; /** * Specify the relativeUrl of http server. Type: string (or Expression with resultType string) */ relativeUrl?: any; /** * Type of dataset storage location. * Expected value is 'HttpServerLocation'. */ type: "HttpServerLocation"; } /** * A copy activity source for an HTTP file. */ interface HttpSourceResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Specifies the timeout for a HTTP client to get HTTP response from HTTP server. The default value is equivalent to System.Net.HttpWebRequest.Timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ httpRequestTimeout?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'HttpSource'. */ type: "HttpSource"; } /** * Hubspot Service linked service. */ interface HubspotLinkedServiceResponse { /** * The access token obtained when initially authenticating your OAuth integration. */ accessToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The client ID associated with your Hubspot application. */ clientId: any; /** * The client secret associated with your Hubspot application. */ clientSecret?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The refresh token obtained when initially authenticating your OAuth integration. */ refreshToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'Hubspot'. */ type: "Hubspot"; /** * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. */ useEncryptedEndpoints?: any; /** * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. */ useHostVerification?: any; /** * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. */ usePeerVerification?: any; /** * Version of the linked service. */ version?: string; } /** * Hubspot Service dataset. */ interface HubspotObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'HubspotObject'. */ type: "HubspotObject"; } /** * A copy activity Hubspot Service source. */ interface HubspotSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'HubspotSource'. */ type: "HubspotSource"; } /** * Iceberg dataset. */ interface IcebergDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The location of the iceberg storage. Setting a file name is not allowed for iceberg format. */ location: outputs.datafactory.AmazonS3CompatibleLocationResponse | outputs.datafactory.AmazonS3LocationResponse | outputs.datafactory.AzureBlobFSLocationResponse | outputs.datafactory.AzureBlobStorageLocationResponse | outputs.datafactory.AzureDataLakeStoreLocationResponse | outputs.datafactory.AzureFileStorageLocationResponse | outputs.datafactory.FileServerLocationResponse | outputs.datafactory.FtpServerLocationResponse | outputs.datafactory.GoogleCloudStorageLocationResponse | outputs.datafactory.HdfsLocationResponse | outputs.datafactory.HttpServerLocationResponse | outputs.datafactory.LakeHouseLocationResponse | outputs.datafactory.OracleCloudStorageLocationResponse | outputs.datafactory.SftpLocationResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'Iceberg'. */ type: "Iceberg"; } /** * A copy activity Iceberg sink. */ interface IcebergSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Iceberg format settings. */ formatSettings?: outputs.datafactory.IcebergWriteSettingsResponse; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Iceberg store settings. */ storeSettings?: outputs.datafactory.AzureBlobFSWriteSettingsResponse | outputs.datafactory.AzureBlobStorageWriteSettingsResponse | outputs.datafactory.AzureDataLakeStoreWriteSettingsResponse | outputs.datafactory.AzureFileStorageWriteSettingsResponse | outputs.datafactory.FileServerWriteSettingsResponse | outputs.datafactory.LakeHouseWriteSettingsResponse | outputs.datafactory.SftpWriteSettingsResponse; /** * Copy sink type. * Expected value is 'IcebergSink'. */ type: "IcebergSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * Iceberg write settings. */ interface IcebergWriteSettingsResponse { /** * The write setting type. * Expected value is 'IcebergWriteSettings'. */ type: "IcebergWriteSettings"; } /** * This activity evaluates a boolean expression and executes either the activities under the ifTrueActivities property or the ifFalseActivities property depending on the result of the expression. */ interface IfConditionActivityResponse { /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed. */ expression: outputs.datafactory.ExpressionResponse; /** * List of activities to execute if expression is evaluated to false. This is an optional property and if not provided, the activity will exit without any action. */ ifFalseActivities?: (outputs.datafactory.AppendVariableActivityResponse | outputs.datafactory.AzureDataExplorerCommandActivityResponse | outputs.datafactory.AzureFunctionActivityResponse | outputs.datafactory.AzureMLBatchExecutionActivityResponse | outputs.datafactory.AzureMLExecutePipelineActivityResponse | outputs.datafactory.AzureMLUpdateResourceActivityResponse | outputs.datafactory.ControlActivityResponse | outputs.datafactory.CopyActivityResponse | outputs.datafactory.CustomActivityResponse | outputs.datafactory.DataLakeAnalyticsUSQLActivityResponse | outputs.datafactory.DatabricksJobActivityResponse | outputs.datafactory.DatabricksNotebookActivityResponse | outputs.datafactory.DatabricksSparkJarActivityResponse | outputs.datafactory.DatabricksSparkPythonActivityResponse | outputs.datafactory.DeleteActivityResponse | outputs.datafactory.ExecuteDataFlowActivityResponse | outputs.datafactory.ExecutePipelineActivityResponse | outputs.datafactory.ExecuteSSISPackageActivityResponse | outputs.datafactory.ExecuteWranglingDataflowActivityResponse | outputs.datafactory.ExecutionActivityResponse | outputs.datafactory.FailActivityResponse | outputs.datafactory.FilterActivityResponse | outputs.datafactory.ForEachActivityResponse | outputs.datafactory.GetMetadataActivityResponse | outputs.datafactory.HDInsightHiveActivityResponse | outputs.datafactory.HDInsightMapReduceActivityResponse | outputs.datafactory.HDInsightPigActivityResponse | outputs.datafactory.HDInsightSparkActivityResponse | outputs.datafactory.HDInsightStreamingActivityResponse | outputs.datafactory.IfConditionActivityResponse | outputs.datafactory.LookupActivityResponse | outputs.datafactory.ScriptActivityResponse | outputs.datafactory.SetVariableActivityResponse | outputs.datafactory.SqlServerStoredProcedureActivityResponse | outputs.datafactory.SwitchActivityResponse | outputs.datafactory.SynapseNotebookActivityResponse | outputs.datafactory.SynapseSparkJobDefinitionActivityResponse | outputs.datafactory.UntilActivityResponse | outputs.datafactory.ValidationActivityResponse | outputs.datafactory.WaitActivityResponse | outputs.datafactory.WebActivityResponse | outputs.datafactory.WebHookActivityResponse)[]; /** * List of activities to execute if expression is evaluated to true. This is an optional property and if not provided, the activity will exit without any action. */ ifTrueActivities?: (outputs.datafactory.AppendVariableActivityResponse | outputs.datafactory.AzureDataExplorerCommandActivityResponse | outputs.datafactory.AzureFunctionActivityResponse | outputs.datafactory.AzureMLBatchExecutionActivityResponse | outputs.datafactory.AzureMLExecutePipelineActivityResponse | outputs.datafactory.AzureMLUpdateResourceActivityResponse | outputs.datafactory.ControlActivityResponse | outputs.datafactory.CopyActivityResponse | outputs.datafactory.CustomActivityResponse | outputs.datafactory.DataLakeAnalyticsUSQLActivityResponse | outputs.datafactory.DatabricksJobActivityResponse | outputs.datafactory.DatabricksNotebookActivityResponse | outputs.datafactory.DatabricksSparkJarActivityResponse | outputs.datafactory.DatabricksSparkPythonActivityResponse | outputs.datafactory.DeleteActivityResponse | outputs.datafactory.ExecuteDataFlowActivityResponse | outputs.datafactory.ExecutePipelineActivityResponse | outputs.datafactory.ExecuteSSISPackageActivityResponse | outputs.datafactory.ExecuteWranglingDataflowActivityResponse | outputs.datafactory.ExecutionActivityResponse | outputs.datafactory.FailActivityResponse | outputs.datafactory.FilterActivityResponse | outputs.datafactory.ForEachActivityResponse | outputs.datafactory.GetMetadataActivityResponse | outputs.datafactory.HDInsightHiveActivityResponse | outputs.datafactory.HDInsightMapReduceActivityResponse | outputs.datafactory.HDInsightPigActivityResponse | outputs.datafactory.HDInsightSparkActivityResponse | outputs.datafactory.HDInsightStreamingActivityResponse | outputs.datafactory.IfConditionActivityResponse | outputs.datafactory.LookupActivityResponse | outputs.datafactory.ScriptActivityResponse | outputs.datafactory.SetVariableActivityResponse | outputs.datafactory.SqlServerStoredProcedureActivityResponse | outputs.datafactory.SwitchActivityResponse | outputs.datafactory.SynapseNotebookActivityResponse | outputs.datafactory.SynapseSparkJobDefinitionActivityResponse | outputs.datafactory.UntilActivityResponse | outputs.datafactory.ValidationActivityResponse | outputs.datafactory.WaitActivityResponse | outputs.datafactory.WebActivityResponse | outputs.datafactory.WebHookActivityResponse)[]; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'IfCondition'. */ type: "IfCondition"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Impala server linked service. */ interface ImpalaLinkedServiceResponse { /** * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false. */ allowHostNameCNMismatch?: any; /** * Specifies whether to allow self-signed certificates from the server. The default value is false. */ allowSelfSignedServerCert?: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The authentication type to use. */ authenticationType: string; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * Specify whether to enable server SSL certificate validation when you connect.Always use System Trust Store (for V2 only). The default value is true. */ enableServerCertificateValidation?: any; /** * Specifies whether the connections to the server are encrypted using SSL. The default value is false. */ enableSsl?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The IP address or host name of the Impala server. (i.e. 192.168.222.160) */ host: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password corresponding to the user name when using UsernameAndPassword. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The TCP port that the Impala server uses to listen for client connections. The default value is 21050. */ port?: any; /** * The transport protocol to use in the Thrift layer (for V2 only). Default value is Binary. */ thriftTransportProtocol?: string; /** * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. */ trustedCertPath?: any; /** * Type of linked service. * Expected value is 'Impala'. */ type: "Impala"; /** * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. */ useSystemTrustStore?: any; /** * The user name used to access the Impala server. The default value is anonymous when using SASLUsername. */ username?: any; /** * Version of the linked service. */ version?: string; } /** * Impala server dataset. */ interface ImpalaObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Impala. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using schema + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'ImpalaObject'. */ type: "ImpalaObject"; } /** * A copy activity Impala server source. */ interface ImpalaSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'ImpalaSource'. */ type: "ImpalaSource"; } /** * Informix linked service. */ interface InformixLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Type of authentication used to connect to the Informix as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string). */ authenticationType?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string. */ connectionString: any; /** * The access credential portion of the connection string specified in driver-specific property-value format. */ credential?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password for Basic authentication. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'Informix'. */ type: "Informix"; /** * User name for Basic authentication. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity Informix sink. */ interface InformixSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to execute before starting the copy. Type: string (or Expression with resultType string). */ preCopyScript?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'InformixSink'. */ type: "InformixSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity source for Informix. */ interface InformixSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Database query. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'InformixSource'. */ type: "InformixSource"; } /** * The Informix table dataset. */ interface InformixTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The Informix table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'InformixTable'. */ type: "InformixTable"; } /** * The compute resource properties for managed integration runtime. */ interface IntegrationRuntimeComputePropertiesResponse { /** * CopyComputeScale properties for managed integration runtime. */ copyComputeScaleProperties?: outputs.datafactory.CopyComputeScalePropertiesResponse; /** * Data flow properties for managed integration runtime. */ dataFlowProperties?: outputs.datafactory.IntegrationRuntimeDataFlowPropertiesResponse; /** * The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities */ location?: string; /** * Maximum parallel executions count per node for managed integration runtime. */ maxParallelExecutionsPerNode?: number; /** * The node size requirement to managed integration runtime. */ nodeSize?: string; /** * The required number of nodes for managed integration runtime. */ numberOfNodes?: number; /** * PipelineExternalComputeScale properties for managed integration runtime. */ pipelineExternalComputeScaleProperties?: outputs.datafactory.PipelineExternalComputeScalePropertiesResponse; /** * VNet properties for managed integration runtime. */ vNetProperties?: outputs.datafactory.IntegrationRuntimeVNetPropertiesResponse; } /** * Custom setup script properties for a managed dedicated integration runtime. */ interface IntegrationRuntimeCustomSetupScriptPropertiesResponse { /** * The URI of the Azure blob container that contains the custom setup script. */ blobContainerUri?: string; /** * The SAS token of the Azure blob container. */ sasToken?: outputs.datafactory.SecureStringResponse; } /** * The definition and properties of virtual network to which Azure-SSIS integration runtime will join. */ interface IntegrationRuntimeCustomerVirtualNetworkResponse { /** * The ID of subnet to which Azure-SSIS integration runtime will join. */ subnetId?: string; } interface IntegrationRuntimeDataFlowPropertiesCustomPropertiesItemResponse { /** * Name of custom property. */ name?: string; /** * Value of custom property. */ value?: string; } /** * Data flow properties for managed integration runtime. */ interface IntegrationRuntimeDataFlowPropertiesResponse { /** * Cluster will not be recycled and it will be used in next data flow activity run until TTL (time to live) is reached if this is set as false. Default is true. */ cleanup?: boolean; /** * Compute type of the cluster which will execute data flow job. */ computeType?: string; /** * Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272. */ coreCount?: number; /** * Custom properties are used to tune the data flow runtime performance. */ customProperties?: outputs.datafactory.IntegrationRuntimeDataFlowPropertiesCustomPropertiesItemResponse[]; /** * Time to live (in minutes) setting of the cluster which will execute data flow job. */ timeToLive?: number; } /** * Data proxy properties for a managed dedicated integration runtime. */ interface IntegrationRuntimeDataProxyPropertiesResponse { /** * The self-hosted integration runtime reference. */ connectVia?: outputs.datafactory.EntityReferenceResponse; /** * The path to contain the staged data in the Blob storage. */ path?: string; /** * The staging linked service reference. */ stagingLinkedService?: outputs.datafactory.EntityReferenceResponse; } /** * Integration runtime reference type. */ interface IntegrationRuntimeReferenceResponse { /** * Arguments for integration runtime. */ parameters?: any; /** * Reference integration runtime name. */ referenceName: string; /** * Type of integration runtime. */ type: string; } /** * Catalog information for managed dedicated integration runtime. */ interface IntegrationRuntimeSsisCatalogInfoResponse { /** * The password of the administrator user account of the catalog database. */ catalogAdminPassword?: outputs.datafactory.SecureStringResponse; /** * The administrator user name of catalog database. */ catalogAdminUserName?: string; /** * The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/ */ catalogPricingTier?: string; /** * The catalog database server URL. */ catalogServerEndpoint?: string; /** * The dual standby pair name of Azure-SSIS Integration Runtimes to support SSISDB failover. */ dualStandbyPairName?: string; } /** * SSIS properties for managed integration runtime. */ interface IntegrationRuntimeSsisPropertiesResponse { /** * Catalog information for managed dedicated integration runtime. */ catalogInfo?: outputs.datafactory.IntegrationRuntimeSsisCatalogInfoResponse; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Custom setup script properties for a managed dedicated integration runtime. */ customSetupScriptProperties?: outputs.datafactory.IntegrationRuntimeCustomSetupScriptPropertiesResponse; /** * Data proxy properties for a managed dedicated integration runtime. */ dataProxyProperties?: outputs.datafactory.IntegrationRuntimeDataProxyPropertiesResponse; /** * The edition for the SSIS Integration Runtime */ edition?: string; /** * Custom setup without script properties for a SSIS integration runtime. */ expressCustomSetupProperties?: (outputs.datafactory.AzPowerShellSetupResponse | outputs.datafactory.CmdkeySetupResponse | outputs.datafactory.ComponentSetupResponse | outputs.datafactory.EnvironmentVariableSetupResponse)[]; /** * License type for bringing your own license scenario. */ licenseType?: string; /** * Package stores for the SSIS Integration Runtime. */ packageStores?: outputs.datafactory.PackageStoreResponse[]; } /** * VNet properties for managed integration runtime. */ interface IntegrationRuntimeVNetPropertiesResponse { /** * Resource IDs of the public IP addresses that this integration runtime will use. */ publicIPs?: string[]; /** * The name of the subnet this integration runtime will join. */ subnet?: string; /** * The ID of subnet, to which this Azure-SSIS integration runtime will be joined. */ subnetId?: string; /** * The ID of the VNet that this integration runtime will join. */ vNetId?: string; } /** * Interactive authoring capability type properties. */ interface InteractiveQueryPropertiesResponse { /** * The allowed idle time for interactive authoring. */ autoTerminationMinutes: number; /** * The interactive authoring capability status. Must be one of InteractiveCapabilityStatus. The default value is 'Enabling'. */ status: string; } /** * Jira Service linked service. */ interface JiraLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The IP address or host name of the Jira service. (e.g. jira.example.com) */ host: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password corresponding to the user name that you provided in the username field. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The TCP port that the Jira server uses to listen for client connections. The default value is 443 if connecting through HTTPS, or 8080 if connecting through HTTP. */ port?: any; /** * Type of linked service. * Expected value is 'Jira'. */ type: "Jira"; /** * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. */ useEncryptedEndpoints?: any; /** * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. */ useHostVerification?: any; /** * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. */ usePeerVerification?: any; /** * The user name that you use to access Jira Service. */ username: any; /** * Version of the linked service. */ version?: string; } /** * Jira Service dataset. */ interface JiraObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Jira, applies only for Jira V2 dataset. Type: string (or Expression with resultType string). */ table?: any; /** * This property is only supported in Jira V1 Dataset, please consider upgrading to V2 dataset. */ tableName?: any; /** * Type of dataset. * Expected value is 'JiraObject'. */ type: "JiraObject"; } /** * A copy activity Jira Service source. */ interface JiraSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'JiraSource'. */ type: "JiraSource"; } /** * Json dataset. */ interface JsonDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The data compression method used for the json dataset. */ compression?: outputs.datafactory.DatasetCompressionResponse; /** * Dataset description. */ description?: string; /** * The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string). */ encodingName?: any; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The location of the json data storage. */ location: outputs.datafactory.AmazonS3CompatibleLocationResponse | outputs.datafactory.AmazonS3LocationResponse | outputs.datafactory.AzureBlobFSLocationResponse | outputs.datafactory.AzureBlobStorageLocationResponse | outputs.datafactory.AzureDataLakeStoreLocationResponse | outputs.datafactory.AzureFileStorageLocationResponse | outputs.datafactory.FileServerLocationResponse | outputs.datafactory.FtpServerLocationResponse | outputs.datafactory.GoogleCloudStorageLocationResponse | outputs.datafactory.HdfsLocationResponse | outputs.datafactory.HttpServerLocationResponse | outputs.datafactory.LakeHouseLocationResponse | outputs.datafactory.OracleCloudStorageLocationResponse | outputs.datafactory.SftpLocationResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'Json'. */ type: "Json"; } /** * The data stored in JSON format. */ interface JsonFormatResponse { /** * Deserializer. Type: string (or Expression with resultType string). */ deserializer?: any; /** * The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string). */ encodingName?: any; /** * File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive. */ filePattern?: any; /** * The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string). */ jsonNodeReference?: any; /** * The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with "$"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {"Column1": "$.Column1Path", "Column2": "Column2PathInArray"}. Type: object (or Expression with resultType object). */ jsonPathDefinition?: any; /** * The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string). */ nestingSeparator?: any; /** * Serializer. Type: string (or Expression with resultType string). */ serializer?: any; /** * Type of dataset storage format. * Expected value is 'JsonFormat'. */ type: "JsonFormat"; } /** * Json read settings. */ interface JsonReadSettingsResponse { /** * Compression settings. */ compressionProperties?: outputs.datafactory.TarGZipReadSettingsResponse | outputs.datafactory.TarReadSettingsResponse | outputs.datafactory.ZipDeflateReadSettingsResponse; /** * The read setting type. * Expected value is 'JsonReadSettings'. */ type: "JsonReadSettings"; } /** * A copy activity Json sink. */ interface JsonSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Json format settings. */ formatSettings?: outputs.datafactory.JsonWriteSettingsResponse; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Json store settings. */ storeSettings?: outputs.datafactory.AzureBlobFSWriteSettingsResponse | outputs.datafactory.AzureBlobStorageWriteSettingsResponse | outputs.datafactory.AzureDataLakeStoreWriteSettingsResponse | outputs.datafactory.AzureFileStorageWriteSettingsResponse | outputs.datafactory.FileServerWriteSettingsResponse | outputs.datafactory.LakeHouseWriteSettingsResponse | outputs.datafactory.SftpWriteSettingsResponse; /** * Copy sink type. * Expected value is 'JsonSink'. */ type: "JsonSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity Json source. */ interface JsonSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Json format settings. */ formatSettings?: outputs.datafactory.JsonReadSettingsResponse; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Json store settings. */ storeSettings?: outputs.datafactory.AmazonS3CompatibleReadSettingsResponse | outputs.datafactory.AmazonS3ReadSettingsResponse | outputs.datafactory.AzureBlobFSReadSettingsResponse | outputs.datafactory.AzureBlobStorageReadSettingsResponse | outputs.datafactory.AzureDataLakeStoreReadSettingsResponse | outputs.datafactory.AzureFileStorageReadSettingsResponse | outputs.datafactory.FileServerReadSettingsResponse | outputs.datafactory.FtpReadSettingsResponse | outputs.datafactory.GoogleCloudStorageReadSettingsResponse | outputs.datafactory.HdfsReadSettingsResponse | outputs.datafactory.HttpReadSettingsResponse | outputs.datafactory.LakeHouseReadSettingsResponse | outputs.datafactory.OracleCloudStorageReadSettingsResponse | outputs.datafactory.SftpReadSettingsResponse; /** * Copy source type. * Expected value is 'JsonSource'. */ type: "JsonSource"; } /** * Json write settings. */ interface JsonWriteSettingsResponse { /** * File pattern of JSON. This setting controls the way a collection of JSON objects will be treated. The default value is 'setOfObjects'. It is case-sensitive. */ filePattern?: any; /** * The write setting type. * Expected value is 'JsonWriteSettings'. */ type: "JsonWriteSettings"; } /** * Microsoft Fabric Lakehouse linked service. */ interface LakeHouseLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The ID of Microsoft Fabric Lakehouse artifact. Type: string (or Expression with resultType string). */ artifactId?: any; /** * The authentication type to use. */ authenticationType?: string; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. */ servicePrincipalCredential?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). */ servicePrincipalCredentialType?: any; /** * The ID of the application used to authenticate against Microsoft Fabric Lakehouse. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The Key of the application used to authenticate against Microsoft Fabric Lakehouse. */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). */ tenant?: any; /** * Type of linked service. * Expected value is 'Lakehouse'. */ type: "Lakehouse"; /** * Version of the linked service. */ version?: string; /** * The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string). */ workspaceId?: any; } /** * The location of Microsoft Fabric Lakehouse Files dataset. */ interface LakeHouseLocationResponse { /** * Specify the file name of dataset. Type: string (or Expression with resultType string). */ fileName?: any; /** * Specify the folder path of dataset. Type: string (or Expression with resultType string) */ folderPath?: any; /** * Type of dataset storage location. * Expected value is 'LakeHouseLocation'. */ type: "LakeHouseLocation"; } /** * Microsoft Fabric Lakehouse Files read settings. */ interface LakeHouseReadSettingsResponse { /** * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean). */ deleteFilesAfterCompletion?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean). */ enablePartitionDiscovery?: any; /** * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string). */ fileListPath?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The end of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeEnd?: any; /** * The start of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeStart?: any; /** * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string). */ partitionRootPath?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * The read setting type. * Expected value is 'LakeHouseReadSettings'. */ type: "LakeHouseReadSettings"; /** * Microsoft Fabric Lakehouse Files wildcardFileName. Type: string (or Expression with resultType string). */ wildcardFileName?: any; /** * Microsoft Fabric Lakehouse Files wildcardFolderPath. Type: string (or Expression with resultType string). */ wildcardFolderPath?: any; } /** * Microsoft Fabric Lakehouse Table. */ interface LakeHouseTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The name of Microsoft Fabric Lakehouse Table. Type: string (or Expression with resultType string). */ table?: any; /** * Type of dataset. * Expected value is 'LakehouseTable'. */ type: "LakehouseTable"; } /** * A copy activity for Microsoft Fabric Lakehouse Table sink. */ interface LakeHouseTableSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Specify the partition column names from sink columns. Type: array of objects (or Expression with resultType array of objects). */ partitionNameList?: any; /** * Create partitions in folder structure based on one or multiple columns. Each distinct column value (pair) will be a new partition. Possible values include: "None", "PartitionByKey". */ partitionOption?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * The type of table action for Lakehouse Table sink. Possible values include: "None", "Append", "Overwrite". */ tableActionOption?: any; /** * Copy sink type. * Expected value is 'LakeHouseTableSink'. */ type: "LakeHouseTableSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity source for Microsoft Fabric Lakehouse Table. */ interface LakeHouseTableSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Query an older snapshot by timestamp. Type: string (or Expression with resultType string). */ timestampAsOf?: any; /** * Copy source type. * Expected value is 'LakeHouseTableSource'. */ type: "LakeHouseTableSource"; /** * Query an older snapshot by version. Type: integer (or Expression with resultType integer). */ versionAsOf?: any; } /** * Microsoft Fabric Lakehouse Files write settings. */ interface LakeHouseWriteSettingsResponse { /** * The type of copy behavior for copy sink. */ copyBehavior?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects). */ metadata?: outputs.datafactory.MetadataItemResponse[]; /** * The write setting type. * Expected value is 'LakeHouseWriteSettings'. */ type: "LakeHouseWriteSettings"; } /** * The key authorization type integration runtime. */ interface LinkedIntegrationRuntimeKeyAuthorizationResponse { /** * The authorization type for integration runtime sharing. * Expected value is 'Key'. */ authorizationType: "Key"; /** * The key used for authorization. */ key: outputs.datafactory.SecureStringResponse; } /** * The role based access control (RBAC) authorization type integration runtime. */ interface LinkedIntegrationRuntimeRbacAuthorizationResponse { /** * The authorization type for integration runtime sharing. * Expected value is 'RBAC'. */ authorizationType: "RBAC"; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * The resource identifier of the integration runtime to be shared. */ resourceId: string; } /** * The linked integration runtime information. */ interface LinkedIntegrationRuntimeResponse { /** * The creating time of the linked integration runtime. */ createTime: string; /** * The location of the data factory for which the linked integration runtime belong to. */ dataFactoryLocation: string; /** * The name of the data factory for which the linked integration runtime belong to. */ dataFactoryName: string; /** * The name of the linked integration runtime. */ name: string; /** * The subscription ID for which the linked integration runtime belong to. */ subscriptionId: string; } /** * Linked service reference type. */ interface LinkedServiceReferenceResponse { /** * Arguments for LinkedService. */ parameters?: any; /** * Reference LinkedService name. */ referenceName: string; /** * Linked service reference type. */ type: string; } /** * Log location settings. */ interface LogLocationSettingsResponse { /** * Log storage linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string). */ path?: any; } /** * Log settings. */ interface LogSettingsResponse { /** * Specifies settings for copy activity log. */ copyActivityLogSettings?: outputs.datafactory.CopyActivityLogSettingsResponse; /** * Specifies whether to enable copy activity log. Type: boolean (or Expression with resultType boolean). */ enableCopyActivityLog?: any; /** * Log location settings customer needs to provide when enabling log. */ logLocationSettings: outputs.datafactory.LogLocationSettingsResponse; } /** * (Deprecated. Please use LogSettings) Log storage settings. */ interface LogStorageSettingsResponse { /** * Specifies whether to enable reliable logging. Type: boolean (or Expression with resultType boolean). */ enableReliableLogging?: any; /** * Log storage linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Gets or sets the log level, support: Info, Warning. Type: string (or Expression with resultType string). */ logLevel?: any; /** * The path to storage for storing detailed logs of activity execution. Type: string (or Expression with resultType string). */ path?: any; } /** * Lookup activity. */ interface LookupActivityResponse { /** * Lookup activity dataset reference. */ dataset: outputs.datafactory.DatasetReferenceResponse; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Whether to return first row or all rows. Default value is true. Type: boolean (or Expression with resultType boolean). */ firstRowOnly?: any; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Dataset-specific source properties, same as copy activity source. */ source: outputs.datafactory.AmazonMWSSourceResponse | outputs.datafactory.AmazonRdsForOracleSourceResponse | outputs.datafactory.AmazonRdsForSqlServerSourceResponse | outputs.datafactory.AmazonRedshiftSourceResponse | outputs.datafactory.AvroSourceResponse | outputs.datafactory.AzureBlobFSSourceResponse | outputs.datafactory.AzureDataExplorerSourceResponse | outputs.datafactory.AzureDataLakeStoreSourceResponse | outputs.datafactory.AzureDatabricksDeltaLakeSourceResponse | outputs.datafactory.AzureMariaDBSourceResponse | outputs.datafactory.AzureMySqlSourceResponse | outputs.datafactory.AzurePostgreSqlSourceResponse | outputs.datafactory.AzureSqlSourceResponse | outputs.datafactory.AzureTableSourceResponse | outputs.datafactory.BinarySourceResponse | outputs.datafactory.BlobSourceResponse | outputs.datafactory.CassandraSourceResponse | outputs.datafactory.CommonDataServiceForAppsSourceResponse | outputs.datafactory.ConcurSourceResponse | outputs.datafactory.CosmosDbMongoDbApiSourceResponse | outputs.datafactory.CosmosDbSqlApiSourceResponse | outputs.datafactory.CouchbaseSourceResponse | outputs.datafactory.Db2SourceResponse | outputs.datafactory.DelimitedTextSourceResponse | outputs.datafactory.DocumentDbCollectionSourceResponse | outputs.datafactory.DrillSourceResponse | outputs.datafactory.DynamicsAXSourceResponse | outputs.datafactory.DynamicsCrmSourceResponse | outputs.datafactory.DynamicsSourceResponse | outputs.datafactory.EloquaSourceResponse | outputs.datafactory.ExcelSourceResponse | outputs.datafactory.FileSystemSourceResponse | outputs.datafactory.GoogleAdWordsSourceResponse | outputs.datafactory.GoogleBigQuerySourceResponse | outputs.datafactory.GoogleBigQueryV2SourceResponse | outputs.datafactory.GreenplumSourceResponse | outputs.datafactory.HBaseSourceResponse | outputs.datafactory.HdfsSourceResponse | outputs.datafactory.HiveSourceResponse | outputs.datafactory.HttpSourceResponse | outputs.datafactory.HubspotSourceResponse | outputs.datafactory.ImpalaSourceResponse | outputs.datafactory.InformixSourceResponse | outputs.datafactory.JiraSourceResponse | outputs.datafactory.JsonSourceResponse | outputs.datafactory.LakeHouseTableSourceResponse | outputs.datafactory.MagentoSourceResponse | outputs.datafactory.MariaDBSourceResponse | outputs.datafactory.MarketoSourceResponse | outputs.datafactory.MicrosoftAccessSourceResponse | outputs.datafactory.MongoDbAtlasSourceResponse | outputs.datafactory.MongoDbSourceResponse | outputs.datafactory.MongoDbV2SourceResponse | outputs.datafactory.MySqlSourceResponse | outputs.datafactory.NetezzaSourceResponse | outputs.datafactory.ODataSourceResponse | outputs.datafactory.OdbcSourceResponse | outputs.datafactory.Office365SourceResponse | outputs.datafactory.OracleServiceCloudSourceResponse | outputs.datafactory.OracleSourceResponse | outputs.datafactory.OrcSourceResponse | outputs.datafactory.ParquetSourceResponse | outputs.datafactory.PaypalSourceResponse | outputs.datafactory.PhoenixSourceResponse | outputs.datafactory.PostgreSqlSourceResponse | outputs.datafactory.PostgreSqlV2SourceResponse | outputs.datafactory.PrestoSourceResponse | outputs.datafactory.QuickBooksSourceResponse | outputs.datafactory.RelationalSourceResponse | outputs.datafactory.ResponsysSourceResponse | outputs.datafactory.RestSourceResponse | outputs.datafactory.SalesforceMarketingCloudSourceResponse | outputs.datafactory.SalesforceServiceCloudSourceResponse | outputs.datafactory.SalesforceServiceCloudV2SourceResponse | outputs.datafactory.SalesforceSourceResponse | outputs.datafactory.SalesforceV2SourceResponse | outputs.datafactory.SapBwSourceResponse | outputs.datafactory.SapCloudForCustomerSourceResponse | outputs.datafactory.SapEccSourceResponse | outputs.datafactory.SapHanaSourceResponse | outputs.datafactory.SapOdpSourceResponse | outputs.datafactory.SapOpenHubSourceResponse | outputs.datafactory.SapTableSourceResponse | outputs.datafactory.ServiceNowSourceResponse | outputs.datafactory.ServiceNowV2SourceResponse | outputs.datafactory.SharePointOnlineListSourceResponse | outputs.datafactory.ShopifySourceResponse | outputs.datafactory.SnowflakeSourceResponse | outputs.datafactory.SnowflakeV2SourceResponse | outputs.datafactory.SparkSourceResponse | outputs.datafactory.SqlDWSourceResponse | outputs.datafactory.SqlMISourceResponse | outputs.datafactory.SqlServerSourceResponse | outputs.datafactory.SqlSourceResponse | outputs.datafactory.SquareSourceResponse | outputs.datafactory.SybaseSourceResponse | outputs.datafactory.TabularSourceResponse | outputs.datafactory.TeradataSourceResponse | outputs.datafactory.VerticaSourceResponse | outputs.datafactory.WarehouseSourceResponse | outputs.datafactory.WebSourceResponse | outputs.datafactory.XeroSourceResponse | outputs.datafactory.XmlSourceResponse | outputs.datafactory.ZohoSourceResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Indicates whether to treat decimal values as strings to avoid value overflow issue. This option is enabled for SnowflakeV2 connector only. Type: boolean (or Expression with resultType boolean). */ treatDecimalAsString?: any; /** * Type of activity. * Expected value is 'Lookup'. */ type: "Lookup"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Magento server linked service. */ interface MagentoLinkedServiceResponse { /** * The access token from Magento. */ accessToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The URL of the Magento instance. (i.e. 192.168.222.110/magento3) */ host: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'Magento'. */ type: "Magento"; /** * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. */ useEncryptedEndpoints?: any; /** * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. */ useHostVerification?: any; /** * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. */ usePeerVerification?: any; /** * Version of the linked service. */ version?: string; } /** * Magento server dataset. */ interface MagentoObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'MagentoObject'. */ type: "MagentoObject"; } /** * A copy activity Magento server source. */ interface MagentoSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'MagentoSource'. */ type: "MagentoSource"; } /** * Managed identity credential. */ interface ManagedIdentityCredentialResponse { /** * List of tags that can be used for describing the Credential. */ annotations?: any[]; /** * Credential description. */ description?: string; /** * The resource id of user assigned managed identity */ resourceId?: string; /** * Type of credential. * Expected value is 'ManagedIdentity'. */ type: "ManagedIdentity"; } /** * Error definition for managed integration runtime. */ interface ManagedIntegrationRuntimeErrorResponse { /** * Error code. */ code: string; /** * Error message. */ message: string; /** * Managed integration runtime error parameters. */ parameters: string[]; /** * The time when the error occurred. */ time: string; } /** * Properties of integration runtime node. */ interface ManagedIntegrationRuntimeNodeResponse { /** * The errors that occurred on this integration runtime node. */ errors?: outputs.datafactory.ManagedIntegrationRuntimeErrorResponse[]; /** * The managed integration runtime node id. */ nodeId: string; /** * The managed integration runtime node status. */ status: string; } /** * Properties of managed integration runtime operation result. */ interface ManagedIntegrationRuntimeOperationResultResponse { /** * The activity id for the operation request. */ activityId: string; /** * The error code. */ errorCode: string; /** * Managed integration runtime error parameters. */ parameters: string[]; /** * The operation result. */ result: string; /** * The start time of the operation. */ startTime: string; /** * The operation type. Could be start or stop. */ type: string; } /** * Managed integration runtime, including managed elastic and managed dedicated integration runtimes. */ interface ManagedIntegrationRuntimeResponse { /** * The compute resource for managed integration runtime. */ computeProperties?: outputs.datafactory.IntegrationRuntimeComputePropertiesResponse; /** * The name of virtual network to which Azure-SSIS integration runtime will join */ customerVirtualNetwork?: outputs.datafactory.IntegrationRuntimeCustomerVirtualNetworkResponse; /** * Integration runtime description. */ description?: string; /** * Interactive authoring capability reference. */ interactiveQuery?: outputs.datafactory.InteractiveQueryPropertiesResponse; /** * Managed Virtual Network reference. */ managedVirtualNetwork?: outputs.datafactory.ManagedVirtualNetworkReferenceResponse; /** * SSIS properties for managed integration runtime. */ ssisProperties?: outputs.datafactory.IntegrationRuntimeSsisPropertiesResponse; /** * Integration runtime state, only valid for managed dedicated integration runtime. */ state: string; /** * The type of integration runtime. * Expected value is 'Managed'. */ type: "Managed"; } /** * Managed integration runtime status. */ interface ManagedIntegrationRuntimeStatusResponse { /** * The time at which the integration runtime was created, in ISO8601 format. */ createTime: string; /** * The data factory name which the integration runtime belong to. */ dataFactoryName: string; /** * The last operation result that occurred on this integration runtime. */ lastOperation: outputs.datafactory.ManagedIntegrationRuntimeOperationResultResponse; /** * The list of nodes for managed integration runtime. */ nodes: outputs.datafactory.ManagedIntegrationRuntimeNodeResponse[]; /** * The errors that occurred on this integration runtime. */ otherErrors: outputs.datafactory.ManagedIntegrationRuntimeErrorResponse[]; /** * The state of integration runtime. */ state: string; /** * The type of integration runtime. * Expected value is 'Managed'. */ type: "Managed"; } /** * Properties of a managed private endpoint */ interface ManagedPrivateEndpointResponse { /** * The managed private endpoint connection state */ connectionState?: outputs.datafactory.ConnectionStatePropertiesResponse; /** * Fully qualified domain names */ fqdns?: string[]; /** * The groupId to which the managed private endpoint is created */ groupId?: string; /** * Denotes whether the managed private endpoint is reserved */ isReserved: boolean; /** * The ARM resource ID of the resource to which the managed private endpoint is created */ privateLinkResourceId?: string; /** * The managed private endpoint provisioning state */ provisioningState: string; } /** * Managed Virtual Network reference type. */ interface ManagedVirtualNetworkReferenceResponse { /** * Reference ManagedVirtualNetwork name. */ referenceName: string; /** * Managed Virtual Network reference type. */ type: string; } /** * Source and target column mapping details. */ interface MapperAttributeMappingResponse { /** * Reference of the source column used in the mapping. It is used for 'Direct' mapping type only. */ attributeReference?: outputs.datafactory.MapperAttributeReferenceResponse; /** * List of references for source columns. It is used for 'Derived' and 'Aggregate' type mappings only. */ attributeReferences?: outputs.datafactory.MapperAttributeReferenceResponse[]; /** * Expression used for 'Aggregate' and 'Derived' type mapping. */ expression?: string; /** * Name of the function used for 'Aggregate' and 'Derived' (except 'Advanced') type mapping. */ functionName?: string; /** * Name of the target column. */ name?: string; /** * Type of the CDC attribute mapping. Note: 'Advanced' mapping type is also saved as 'Derived'. */ type?: string; } /** * Attribute mapping details. */ interface MapperAttributeMappingsResponse { /** * List of attribute mappings. */ attributeMappings?: outputs.datafactory.MapperAttributeMappingResponse[]; } /** * Attribute reference details for the referred column. */ interface MapperAttributeReferenceResponse { /** * Name of the table. */ entity?: string; /** * The connection reference for the connection. */ entityConnectionReference?: outputs.datafactory.MapperConnectionReferenceResponse; /** * Name of the column. */ name?: string; } /** * Source or target connection reference details. */ interface MapperConnectionReferenceResponse { /** * Name of the connection */ connectionName?: string; /** * Type of connection via linked service or dataset. */ type?: string; } /** * Source connection details. */ interface MapperConnectionResponse { /** * List of name/value pairs for connection properties. */ commonDslConnectorProperties?: outputs.datafactory.MapperDslConnectorPropertiesResponse[]; /** * A boolean indicating whether linked service is of type inline dataset. Currently only inline datasets are supported. */ isInlineDataset?: boolean; /** * Linked service reference. */ linkedService?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Type of the linked service e.g.: AzureBlobFS. */ linkedServiceType?: string; /** * Type of connection via linked service or dataset. */ type: string; } /** * Connector properties of a CDC table in terms of name / value pairs. */ interface MapperDslConnectorPropertiesResponse { /** * Name of the property. */ name?: string; /** * Value of the property. */ value?: any; } /** * CDC policy recurrence details. */ interface MapperPolicyRecurrenceResponse { /** * Frequency of period in terms of 'Hour', 'Minute' or 'Second'. */ frequency?: string; /** * Actual interval value as per chosen frequency. */ interval?: number; } /** * CDC Policy. */ interface MapperPolicyResponse { /** * Mode of running the CDC: batch vs continuous. */ mode?: string; /** * Defines the frequency and interval for running the CDC for batch mode. */ recurrence?: outputs.datafactory.MapperPolicyRecurrenceResponse; } /** * A object which contains list of tables and connection details for a source connection. */ interface MapperSourceConnectionsInfoResponse { /** * Source connection details. */ connection?: outputs.datafactory.MapperConnectionResponse; /** * List of source tables for a source connection. */ sourceEntities?: outputs.datafactory.MapperTableResponse[]; } /** * CDC table details. */ interface MapperTableResponse { /** * List of name/value pairs for connection properties. */ dslConnectorProperties?: outputs.datafactory.MapperDslConnectorPropertiesResponse[]; /** * Name of the table. */ name?: string; /** * List of columns for the source table. */ schema?: outputs.datafactory.MapperTableSchemaResponse[]; } /** * Schema of a CDC table in terms of column names and their corresponding data types. */ interface MapperTableSchemaResponse { /** * Data type of the column. */ dataType?: string; /** * Name of the column. */ name?: string; } /** * A object which contains list of tables and connection details for a target connection. */ interface MapperTargetConnectionsInfoResponse { /** * Source connection details. */ connection?: outputs.datafactory.MapperConnectionResponse; /** * List of table mappings. */ dataMapperMappings?: outputs.datafactory.DataMapperMappingResponse[]; /** * List of relationship info among the tables. */ relationships?: any[]; /** * List of source tables for a target connection. */ targetEntities?: outputs.datafactory.MapperTableResponse[]; } /** * Mapping data flow. */ interface MappingDataFlowResponse { /** * List of tags that can be used for describing the data flow. */ annotations?: any[]; /** * The description of the data flow. */ description?: string; /** * The folder that this data flow is in. If not specified, Data flow will appear at the root level. */ folder?: outputs.datafactory.DataFlowFolderResponse; /** * DataFlow script. */ script?: string; /** * Data flow script lines. */ scriptLines?: string[]; /** * List of sinks in data flow. */ sinks?: outputs.datafactory.DataFlowSinkResponse[]; /** * List of sources in data flow. */ sources?: outputs.datafactory.DataFlowSourceResponse[]; /** * List of transformations in data flow. */ transformations?: outputs.datafactory.TransformationResponse[]; /** * Type of data flow. * Expected value is 'MappingDataFlow'. */ type: "MappingDataFlow"; } /** * MariaDB server linked service. */ interface MariaDBLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * Database name for connection. Type: string. */ database?: any; /** * Linked service description. */ description?: string; /** * The version of the MariaDB driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string. The legacy driver is scheduled for deprecation by October 2024. */ driverVersion?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of password in connection string. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * The port for the connection. Type: integer. */ port?: any; /** * Server name for connection. Type: string. */ server?: any; /** * This option specifies whether the driver uses TLS encryption and verification when connecting to MariaDB. E.g., SSLMode=<0/1/2/3/4>. Options: DISABLED (0) / PREFERRED (1) (Default) / REQUIRED (2) / VERIFY_CA (3) / VERIFY_IDENTITY (4), REQUIRED (2) is recommended to only allow connections encrypted with SSL/TLS. */ sslMode?: any; /** * Type of linked service. * Expected value is 'MariaDB'. */ type: "MariaDB"; /** * This option specifies whether to use a CA certificate from the system trust store, or from a specified PEM file. E.g. UseSystemTrustStore=<0/1>; Options: Enabled (1) / Disabled (0) (Default) */ useSystemTrustStore?: any; /** * Username for authentication. Type: string. */ username?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity MariaDB server source. */ interface MariaDBSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'MariaDBSource'. */ type: "MariaDBSource"; } /** * MariaDB server dataset. */ interface MariaDBTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'MariaDBTable'. */ type: "MariaDBTable"; } /** * Marketo server linked service. */ interface MarketoLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The client Id of your Marketo service. */ clientId: any; /** * The client secret of your Marketo service. */ clientSecret?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The endpoint of the Marketo server. (i.e. 123-ABC-321.mktorest.com) */ endpoint: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'Marketo'. */ type: "Marketo"; /** * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. */ useEncryptedEndpoints?: any; /** * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. */ useHostVerification?: any; /** * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. */ usePeerVerification?: any; /** * Version of the linked service. */ version?: string; } /** * Marketo server dataset. */ interface MarketoObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'MarketoObject'. */ type: "MarketoObject"; } /** * A copy activity Marketo server source. */ interface MarketoSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'MarketoSource'. */ type: "MarketoSource"; } /** * Specify the name and value of custom metadata item. */ interface MetadataItemResponse { /** * Metadata item key name. Type: string (or Expression with resultType string). */ name?: any; /** * Metadata item value. Type: string (or Expression with resultType string). */ value?: any; } /** * Microsoft Access linked service. */ interface MicrosoftAccessLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Type of authentication used to connect to the Microsoft Access as ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string). */ authenticationType?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string. */ connectionString: any; /** * The access credential portion of the connection string specified in driver-specific property-value format. */ credential?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password for Basic authentication. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'MicrosoftAccess'. */ type: "MicrosoftAccess"; /** * User name for Basic authentication. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity Microsoft Access sink. */ interface MicrosoftAccessSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to execute before starting the copy. Type: string (or Expression with resultType string). */ preCopyScript?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'MicrosoftAccessSink'. */ type: "MicrosoftAccessSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity source for Microsoft Access. */ interface MicrosoftAccessSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Database query. Type: string (or Expression with resultType string). */ query?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'MicrosoftAccessSource'. */ type: "MicrosoftAccessSource"; } /** * The Microsoft Access table dataset. */ interface MicrosoftAccessTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The Microsoft Access table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'MicrosoftAccessTable'. */ type: "MicrosoftAccessTable"; } /** * The MongoDB Atlas database dataset. */ interface MongoDbAtlasCollectionDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The collection name of the MongoDB Atlas database. Type: string (or Expression with resultType string). */ collection: any; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'MongoDbAtlasCollection'. */ type: "MongoDbAtlasCollection"; } /** * Linked service for MongoDB Atlas data source. */ interface MongoDbAtlasLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The MongoDB Atlas connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString: any; /** * The name of the MongoDB Atlas database that you want to access. Type: string (or Expression with resultType string). */ database: any; /** * Linked service description. */ description?: string; /** * The driver version that you want to choose. Allowed value are v1 and v2. Type: string (or Expression with resultType string). */ driverVersion?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'MongoDbAtlas'. */ type: "MongoDbAtlas"; /** * Version of the linked service. */ version?: string; } /** * A copy activity MongoDB Atlas sink. */ interface MongoDbAtlasSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'MongoDbAtlasSink'. */ type: "MongoDbAtlasSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is "insert". Type: string (or Expression with resultType string). Type: string (or Expression with resultType string). */ writeBehavior?: any; } /** * A copy activity source for a MongoDB Atlas database. */ interface MongoDbAtlasSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * Specifies the number of documents to return in each batch of the response from MongoDB Atlas instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer). */ batchSize?: any; /** * Cursor methods for Mongodb query */ cursorMethods?: outputs.datafactory.MongoDbCursorMethodsPropertiesResponse; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string). */ filter?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'MongoDbAtlasSource'. */ type: "MongoDbAtlasSource"; } /** * The MongoDB database dataset. */ interface MongoDbCollectionDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The table name of the MongoDB database. Type: string (or Expression with resultType string). */ collectionName: any; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'MongoDbCollection'. */ type: "MongoDbCollection"; } /** * Cursor methods for Mongodb query */ interface MongoDbCursorMethodsPropertiesResponse { /** * Specifies the maximum number of documents the server returns. limit() is analogous to the LIMIT statement in a SQL database. Type: integer (or Expression with resultType integer). */ limit?: any; /** * Specifies the fields to return in the documents that match the query filter. To return all fields in the matching documents, omit this parameter. Type: string (or Expression with resultType string). */ project?: any; /** * Specifies the how many documents skipped and where MongoDB begins returning results. This approach may be useful in implementing paginated results. Type: integer (or Expression with resultType integer). */ skip?: any; /** * Specifies the order in which the query returns matching documents. Type: string (or Expression with resultType string). Type: string (or Expression with resultType string). */ sort?: any; } /** * Linked service for MongoDb data source. */ interface MongoDbLinkedServiceResponse { /** * Specifies whether to allow self-signed certificates from the server. The default value is false. Type: boolean (or Expression with resultType boolean). */ allowSelfSignedServerCert?: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Database to verify the username and password. Type: string (or Expression with resultType string). */ authSource?: any; /** * The authentication type to be used to connect to the MongoDB database. */ authenticationType?: string; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string). */ databaseName: any; /** * Linked service description. */ description?: string; /** * Specifies whether the connections to the server are encrypted using SSL. The default value is false. Type: boolean (or Expression with resultType boolean). */ enableSsl?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password for authentication. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The TCP port number that the MongoDB server uses to listen for client connections. The default value is 27017. Type: integer (or Expression with resultType integer), minimum: 0. */ port?: any; /** * The IP address or server name of the MongoDB server. Type: string (or Expression with resultType string). */ server: any; /** * Type of linked service. * Expected value is 'MongoDb'. */ type: "MongoDb"; /** * Username for authentication. Type: string (or Expression with resultType string). */ username?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity source for a MongoDB database. */ interface MongoDbSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Database query. Should be a SQL-92 query expression. Type: string (or Expression with resultType string). */ query?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'MongoDbSource'. */ type: "MongoDbSource"; } /** * The MongoDB database dataset. */ interface MongoDbV2CollectionDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The collection name of the MongoDB database. Type: string (or Expression with resultType string). */ collection: any; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'MongoDbV2Collection'. */ type: "MongoDbV2Collection"; } /** * Linked service for MongoDB data source. */ interface MongoDbV2LinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The MongoDB connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString: any; /** * The name of the MongoDB database that you want to access. Type: string (or Expression with resultType string). */ database: any; /** * Linked service description. */ description?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'MongoDbV2'. */ type: "MongoDbV2"; /** * Version of the linked service. */ version?: string; } /** * A copy activity MongoDB sink. */ interface MongoDbV2SinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'MongoDbV2Sink'. */ type: "MongoDbV2Sink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * Specifies whether the document with same key to be overwritten (upsert) rather than throw exception (insert). The default value is "insert". Type: string (or Expression with resultType string). Type: string (or Expression with resultType string). */ writeBehavior?: any; } /** * A copy activity source for a MongoDB database. */ interface MongoDbV2SourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * Specifies the number of documents to return in each batch of the response from MongoDB instance. In most cases, modifying the batch size will not affect the user or the application. This property's main purpose is to avoid hit the limitation of response size. Type: integer (or Expression with resultType integer). */ batchSize?: any; /** * Cursor methods for Mongodb query */ cursorMethods?: outputs.datafactory.MongoDbCursorMethodsPropertiesResponse; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document ({}). Type: string (or Expression with resultType string). */ filter?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'MongoDbV2Source'. */ type: "MongoDbV2Source"; } /** * Base class for all triggers that support one to many model for trigger to pipeline. */ interface MultiplePipelineTriggerResponse { /** * List of tags that can be used for describing the trigger. */ annotations?: any[]; /** * Trigger description. */ description?: string; /** * Pipelines that need to be started. */ pipelines?: outputs.datafactory.TriggerPipelineReferenceResponse[]; /** * Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. */ runtimeState: string; /** * Trigger type. * Expected value is 'MultiplePipelineTrigger'. */ type: "MultiplePipelineTrigger"; } /** * Linked service for MySQL data source. */ interface MySqlLinkedServiceResponse { /** * This allows the special “zero” date value 0000-00-00 to be retrieved from the database. Type: boolean. */ allowZeroDateTime?: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. Type: integer. */ connectionTimeout?: any; /** * True to return DateTime.MinValue for date or datetime columns that have disallowed values. Type: boolean. */ convertZeroDateTime?: any; /** * Database name for connection. Type: string. */ database?: any; /** * Linked service description. */ description?: string; /** * The version of the MySQL driver. Type: string. V1 or empty for legacy driver, V2 for new driver. V1 can support connection string and property bag, V2 can only support connection string. */ driverVersion?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Determines which column type (if any) should be read as a GUID. Type: string. None: No column types are automatically read as a Guid; Char36: All CHAR(36) columns are read/written as a Guid using lowercase hex with hyphens, which matches UUID. */ guidFormat?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of password in connection string. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * The port for the connection. Type: integer. */ port?: any; /** * Server name for connection. Type: string. */ server?: any; /** * The path to the client’s SSL certificate file in PEM format. SslKey must also be specified. Type: string. */ sslCert?: any; /** * The path to the client’s SSL private key in PEM format. SslCert must also be specified. Type: string. */ sslKey?: any; /** * SSL mode for connection. Type: integer. 0: disable, 1: prefer, 2: require, 3: verify-ca, 4: verify-full. */ sslMode?: any; /** * When set to true, TINYINT(1) values are returned as booleans. Type: bool. */ treatTinyAsBoolean?: any; /** * Type of linked service. * Expected value is 'MySql'. */ type: "MySql"; /** * Use system trust store for connection. Type: integer. 0: enable, 1: disable. */ useSystemTrustStore?: any; /** * Username for authentication. Type: string. */ username?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity source for MySQL databases. */ interface MySqlSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Database query. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'MySqlSource'. */ type: "MySqlSource"; } /** * The MySQL table dataset. */ interface MySqlTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The MySQL table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'MySqlTable'. */ type: "MySqlTable"; } /** * Netezza linked service. */ interface NetezzaLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * Database name for connection. Type: string. */ database?: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The port for the connection. Type: integer. */ port?: any; /** * The Azure key vault secret reference of password in connection string. */ pwd?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * Specifies the security level for the driver connection to the data store. PreferredUnSecured : prefer unsecured, allow fallback to secured connection if required. OnlyUnSecured : strictly unsecured, no fallback. */ securityLevel?: string; /** * Server name for connection. Type: string. */ server?: any; /** * Type of linked service. * Expected value is 'Netezza'. */ type: "Netezza"; /** * Username for authentication. Type: string. */ uid?: any; /** * Version of the linked service. */ version?: string; } /** * The settings that will be leveraged for Netezza source partitioning. */ interface NetezzaPartitionSettingsResponse { /** * The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string). */ partitionColumnName?: any; /** * The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string). */ partitionLowerBound?: any; /** * The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string). */ partitionUpperBound?: any; } /** * A copy activity Netezza source. */ interface NetezzaSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The partition mechanism that will be used for Netezza read in parallel. Possible values include: "None", "DataSlice", "DynamicRange". */ partitionOption?: any; /** * The settings that will be leveraged for Netezza source partitioning. */ partitionSettings?: outputs.datafactory.NetezzaPartitionSettingsResponse; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'NetezzaSource'. */ type: "NetezzaSource"; } /** * Netezza dataset. */ interface NetezzaTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Netezza. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using schema + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'NetezzaTable'. */ type: "NetezzaTable"; } /** * Notebook parameter. */ interface NotebookParameterResponse { /** * Notebook parameter type. */ type?: string; /** * Notebook parameter value. Type: string (or Expression with resultType string). */ value?: any; } /** * Open Data Protocol (OData) linked service. */ interface ODataLinkedServiceResponse { /** * Specify the resource you are requesting authorization to use Directory. Type: string (or Expression with resultType string). */ aadResourceId?: any; /** * Specify the credential type (key or cert) is used for service principal. */ aadServicePrincipalCredentialType?: string; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The additional HTTP headers in the request to RESTful API used for authorization. Type: key value pairs (value should be string type). */ authHeaders?: any; /** * Type of authentication used to connect to the OData service. */ authenticationType?: string; /** * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). */ azureCloudType?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password of the OData service. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). */ servicePrincipalEmbeddedCert?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string). */ servicePrincipalEmbeddedCertPassword?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Specify the application id of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Specify the tenant information (domain name or tenant ID) under which your application resides. Type: string (or Expression with resultType string). */ tenant?: any; /** * Type of linked service. * Expected value is 'OData'. */ type: "OData"; /** * The URL of the OData service endpoint. Type: string (or Expression with resultType string). */ url: any; /** * User name of the OData service. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * The Open Data Protocol (OData) resource dataset. */ interface ODataResourceDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The OData resource path. Type: string (or Expression with resultType string). */ path?: any; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'ODataResource'. */ type: "ODataResource"; } /** * A copy activity source for OData source. */ interface ODataSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ httpRequestTimeout?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * OData query. For example, "$top=1". Type: string (or Expression with resultType string). */ query?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'ODataSource'. */ type: "ODataSource"; } /** * Open Database Connectivity (ODBC) linked service. */ interface OdbcLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Type of authentication used to connect to the ODBC data store. Possible values are: Anonymous and Basic. Type: string (or Expression with resultType string). */ authenticationType?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The non-access credential portion of the connection string as well as an optional encrypted credential. Type: string, or SecureString, or AzureKeyVaultSecretReference, or Expression with resultType string. */ connectionString: any; /** * The access credential portion of the connection string specified in driver-specific property-value format. */ credential?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password for Basic authentication. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'Odbc'. */ type: "Odbc"; /** * User name for Basic authentication. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity ODBC sink. */ interface OdbcSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to execute before starting the copy. Type: string (or Expression with resultType string). */ preCopyScript?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'OdbcSink'. */ type: "OdbcSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity source for ODBC databases. */ interface OdbcSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Database query. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'OdbcSource'. */ type: "OdbcSource"; } /** * The ODBC table dataset. */ interface OdbcTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The ODBC table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'OdbcTable'. */ type: "OdbcTable"; } /** * The Office365 account. */ interface Office365DatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * A predicate expression that can be used to filter the specific rows to extract from Office 365. Type: string (or Expression with resultType string). */ predicate?: any; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Name of the dataset to extract from Office 365. Type: string (or Expression with resultType string). */ tableName: any; /** * Type of dataset. * Expected value is 'Office365Table'. */ type: "Office365Table"; } /** * Office365 linked service. */ interface Office365LinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Azure tenant ID to which the Office 365 account belongs. Type: string (or Expression with resultType string). */ office365TenantId: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The service principal credential type for authentication.'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. If not specified, 'ServicePrincipalKey' is in use. Type: string (or Expression with resultType string). */ servicePrincipalCredentialType?: any; /** * Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). */ servicePrincipalEmbeddedCert?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string). */ servicePrincipalEmbeddedCertPassword?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Specify the application's client ID. Type: string (or Expression with resultType string). */ servicePrincipalId: any; /** * Specify the application's key. */ servicePrincipalKey: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Specify the tenant information under which your Azure AD web application resides. Type: string (or Expression with resultType string). */ servicePrincipalTenantId: any; /** * Type of linked service. * Expected value is 'Office365'. */ type: "Office365"; /** * Version of the linked service. */ version?: string; } /** * A copy activity source for an Office 365 service. */ interface Office365SourceResponse { /** * The groups containing all the users. Type: array of strings (or Expression with resultType array of strings). */ allowedGroups?: any; /** * The Column to apply the and . Type: string (or Expression with resultType string). */ dateFilterColumn?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * End time of the requested range for this dataset. Type: string (or Expression with resultType string). */ endTime?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The columns to be read out from the Office 365 table. Type: array of objects (or Expression with resultType array of objects). itemType: OutputColumn. Example: [ { "name": "Id" }, { "name": "CreatedDateTime" } ] */ outputColumns?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Start time of the requested range for this dataset. Type: string (or Expression with resultType string). */ startTime?: any; /** * Copy source type. * Expected value is 'Office365Source'. */ type: "Office365Source"; /** * The user scope uri. Type: string (or Expression with resultType string). */ userScopeFilterUri?: any; } /** * Linked service for Oracle Cloud Storage. */ interface OracleCloudStorageLinkedServiceResponse { /** * The access key identifier of the Oracle Cloud Storage Identity and Access Management (IAM) user. Type: string (or Expression with resultType string). */ accessKeyId?: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The secret access key of the Oracle Cloud Storage Identity and Access Management (IAM) user. */ secretAccessKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * This value specifies the endpoint to access with the Oracle Cloud Storage Connector. This is an optional property; change it only if you want to try a different service endpoint or want to switch between https and http. Type: string (or Expression with resultType string). */ serviceUrl?: any; /** * Type of linked service. * Expected value is 'OracleCloudStorage'. */ type: "OracleCloudStorage"; /** * Version of the linked service. */ version?: string; } /** * The location of Oracle Cloud Storage dataset. */ interface OracleCloudStorageLocationResponse { /** * Specify the bucketName of Oracle Cloud Storage. Type: string (or Expression with resultType string) */ bucketName?: any; /** * Specify the file name of dataset. Type: string (or Expression with resultType string). */ fileName?: any; /** * Specify the folder path of dataset. Type: string (or Expression with resultType string) */ folderPath?: any; /** * Type of dataset storage location. * Expected value is 'OracleCloudStorageLocation'. */ type: "OracleCloudStorageLocation"; /** * Specify the version of Oracle Cloud Storage. Type: string (or Expression with resultType string). */ version?: any; } /** * Oracle Cloud Storage read settings. */ interface OracleCloudStorageReadSettingsResponse { /** * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean). */ deleteFilesAfterCompletion?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean). */ enablePartitionDiscovery?: any; /** * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string). */ fileListPath?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The end of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeEnd?: any; /** * The start of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeStart?: any; /** * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string). */ partitionRootPath?: any; /** * The prefix filter for the Oracle Cloud Storage object name. Type: string (or Expression with resultType string). */ prefix?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * The read setting type. * Expected value is 'OracleCloudStorageReadSettings'. */ type: "OracleCloudStorageReadSettings"; /** * Oracle Cloud Storage wildcardFileName. Type: string (or Expression with resultType string). */ wildcardFileName?: any; /** * Oracle Cloud Storage wildcardFolderPath. Type: string (or Expression with resultType string). */ wildcardFolderPath?: any; } /** * Oracle database. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features. */ interface OracleLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Authentication type for connecting to the Oracle database. Only used for Version 2.0. */ authenticationType?: string; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only used for Version 1.0. */ connectionString?: any; /** * Specifies the desired data integrity behavior when this client connects to a server. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0. */ cryptoChecksumClient?: any; /** * Specifies the crypto-checksum algorithms that client can use. Supported values are SHA1, SHA256, SHA384, SHA512, default value is (SHA512). Type: string. Only used for Version 2.0. */ cryptoChecksumTypesClient?: any; /** * Linked service description. */ description?: string; /** * Specifies whether to use bulk copy or batch insert when loading data into the database, default value is true. Type: boolean. Only used for Version 2.0. */ enableBulkLoad?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Specifies the encryption client behavior. Supported values are accepted, rejected, requested or required, default value is required. Type: string. Only used for Version 2.0. */ encryptionClient?: any; /** * Specifies the encryption algorithms that client can use. Supported values are AES128, AES192, AES256, 3DES112, 3DES168, default value is (AES256). Type: string. Only used for Version 2.0. */ encryptionTypesClient?: any; /** * Specifies the number of bytes that the driver allocates to fetch the data in one database round-trip, default value is 10485760. Type: integer. Only used for Version 2.0. */ fetchSize?: any; /** * Specifies whether the driver returns column value with the TIMESTAMP WITH TIME ZONE data type as DateTime or string. This setting is ignored if supportV1DataTypes is not true, default value is true. Type: boolean. Only used for Version 2.0. */ fetchTswtzAsTimestamp?: any; /** * Specifies the amount that the source initially fetches for LOB columns, default value is 0. Type: integer. Only used for Version 2.0. */ initialLobFetchSize?: any; /** * Specifies a command that is issued immediately after connecting to the database to manage session settings. Type: string. Only used for Version 2.0. */ initializationString?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of password in connection string. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * The location of Oracle database you want to connect to, the supported forms include connector descriptor, Easy Connect (Plus) Naming and Oracle Net Services Name (Only self-hosted IR). Type: string. Only used for Version 2.0. */ server?: any; /** * Specifies the number of cursors or statements to be cached for each database connection, default value is 0. Type: integer. Only used for Version 2.0. */ statementCacheSize?: any; /** * Specifies whether to use the Version 1.0 data type mappings. Do not set this to true unless you want to keep backward compatibility with Version 1.0's data type mappings, default value is false. Type: boolean. Only used for Version 2.0. */ supportV1DataTypes?: any; /** * Type of linked service. * Expected value is 'Oracle'. */ type: "Oracle"; /** * The Oracle database username. Type: string. Only used for Version 2.0. */ username?: any; /** * Version of the linked service. */ version?: string; } /** * The settings that will be leveraged for Oracle source partitioning. */ interface OraclePartitionSettingsResponse { /** * The name of the column in integer type that will be used for proceeding range partitioning. Type: string (or Expression with resultType string). */ partitionColumnName?: any; /** * The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string). */ partitionLowerBound?: any; /** * Names of the physical partitions of Oracle table. */ partitionNames?: any; /** * The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string). */ partitionUpperBound?: any; } /** * Oracle Service Cloud linked service. */ interface OracleServiceCloudLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The URL of the Oracle Service Cloud instance. */ host: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password corresponding to the user name that you provided in the username key. */ password: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'OracleServiceCloud'. */ type: "OracleServiceCloud"; /** * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean). */ useEncryptedEndpoints?: any; /** * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean). */ useHostVerification?: any; /** * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean). */ usePeerVerification?: any; /** * The user name that you use to access Oracle Service Cloud server. */ username: any; /** * Version of the linked service. */ version?: string; } /** * Oracle Service Cloud dataset. */ interface OracleServiceCloudObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'OracleServiceCloudObject'. */ type: "OracleServiceCloudObject"; } /** * A copy activity Oracle Service Cloud source. */ interface OracleServiceCloudSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'OracleServiceCloudSource'. */ type: "OracleServiceCloudSource"; } /** * A copy activity Oracle sink. */ interface OracleSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * SQL pre-copy script. Type: string (or Expression with resultType string). */ preCopyScript?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'OracleSink'. */ type: "OracleSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity Oracle source. */ interface OracleSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The decimal precision used to represent Oracle NUMBER type without precision and scale. The range is 1 to 256 and default value is 256 if not specified. Type: integer (or Expression with resultType integer). Only used for Version 2.0. */ numberPrecision?: any; /** * The decimal scale used to represent Oracle NUMBER type without precision and scale. The range is 0 to 130 and default value is 130 if not specified. Type: integer (or Expression with resultType integer). Only used for Version 2.0. */ numberScale?: any; /** * Oracle reader query. Type: string (or Expression with resultType string). */ oracleReaderQuery?: any; /** * The partition mechanism that will be used for Oracle read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange". */ partitionOption?: any; /** * The settings that will be leveraged for Oracle source partitioning. */ partitionSettings?: outputs.datafactory.OraclePartitionSettingsResponse; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'OracleSource'. */ type: "OracleSource"; } /** * The on-premises Oracle database dataset. */ interface OracleTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the on-premises Oracle database. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using schema + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'OracleTable'. */ type: "OracleTable"; } /** * ORC dataset. */ interface OrcDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The location of the ORC data storage. */ location: outputs.datafactory.AmazonS3CompatibleLocationResponse | outputs.datafactory.AmazonS3LocationResponse | outputs.datafactory.AzureBlobFSLocationResponse | outputs.datafactory.AzureBlobStorageLocationResponse | outputs.datafactory.AzureDataLakeStoreLocationResponse | outputs.datafactory.AzureFileStorageLocationResponse | outputs.datafactory.FileServerLocationResponse | outputs.datafactory.FtpServerLocationResponse | outputs.datafactory.GoogleCloudStorageLocationResponse | outputs.datafactory.HdfsLocationResponse | outputs.datafactory.HttpServerLocationResponse | outputs.datafactory.LakeHouseLocationResponse | outputs.datafactory.OracleCloudStorageLocationResponse | outputs.datafactory.SftpLocationResponse; /** * The data orcCompressionCodec. Type: string (or Expression with resultType string). */ orcCompressionCodec?: any; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'Orc'. */ type: "Orc"; } /** * The data stored in Optimized Row Columnar (ORC) format. */ interface OrcFormatResponse { /** * Deserializer. Type: string (or Expression with resultType string). */ deserializer?: any; /** * Serializer. Type: string (or Expression with resultType string). */ serializer?: any; /** * Type of dataset storage format. * Expected value is 'OrcFormat'. */ type: "OrcFormat"; } /** * A copy activity ORC sink. */ interface OrcSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * ORC format settings. */ formatSettings?: outputs.datafactory.OrcWriteSettingsResponse; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * ORC store settings. */ storeSettings?: outputs.datafactory.AzureBlobFSWriteSettingsResponse | outputs.datafactory.AzureBlobStorageWriteSettingsResponse | outputs.datafactory.AzureDataLakeStoreWriteSettingsResponse | outputs.datafactory.AzureFileStorageWriteSettingsResponse | outputs.datafactory.FileServerWriteSettingsResponse | outputs.datafactory.LakeHouseWriteSettingsResponse | outputs.datafactory.SftpWriteSettingsResponse; /** * Copy sink type. * Expected value is 'OrcSink'. */ type: "OrcSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity ORC source. */ interface OrcSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * ORC store settings. */ storeSettings?: outputs.datafactory.AmazonS3CompatibleReadSettingsResponse | outputs.datafactory.AmazonS3ReadSettingsResponse | outputs.datafactory.AzureBlobFSReadSettingsResponse | outputs.datafactory.AzureBlobStorageReadSettingsResponse | outputs.datafactory.AzureDataLakeStoreReadSettingsResponse | outputs.datafactory.AzureFileStorageReadSettingsResponse | outputs.datafactory.FileServerReadSettingsResponse | outputs.datafactory.FtpReadSettingsResponse | outputs.datafactory.GoogleCloudStorageReadSettingsResponse | outputs.datafactory.HdfsReadSettingsResponse | outputs.datafactory.HttpReadSettingsResponse | outputs.datafactory.LakeHouseReadSettingsResponse | outputs.datafactory.OracleCloudStorageReadSettingsResponse | outputs.datafactory.SftpReadSettingsResponse; /** * Copy source type. * Expected value is 'OrcSource'. */ type: "OrcSource"; } /** * Orc write settings. */ interface OrcWriteSettingsResponse { /** * Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string). */ fileNamePrefix?: any; /** * Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer). */ maxRowsPerFile?: any; /** * The write setting type. * Expected value is 'OrcWriteSettings'. */ type: "OrcWriteSettings"; } /** * Package store for the SSIS integration runtime. */ interface PackageStoreResponse { /** * The name of the package store */ name: string; /** * The package store linked service reference. */ packageStoreLinkedService: outputs.datafactory.EntityReferenceResponse; } /** * Definition of a single parameter for an entity. */ interface ParameterSpecificationResponse { /** * Default value of parameter. */ defaultValue?: any; /** * Parameter type. */ type: string; } /** * Parquet dataset. */ interface ParquetDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The data compressionCodec. Type: string (or Expression with resultType string). */ compressionCodec?: any; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The location of the parquet storage. */ location: outputs.datafactory.AmazonS3CompatibleLocationResponse | outputs.datafactory.AmazonS3LocationResponse | outputs.datafactory.AzureBlobFSLocationResponse | outputs.datafactory.AzureBlobStorageLocationResponse | outputs.datafactory.AzureDataLakeStoreLocationResponse | outputs.datafactory.AzureFileStorageLocationResponse | outputs.datafactory.FileServerLocationResponse | outputs.datafactory.FtpServerLocationResponse | outputs.datafactory.GoogleCloudStorageLocationResponse | outputs.datafactory.HdfsLocationResponse | outputs.datafactory.HttpServerLocationResponse | outputs.datafactory.LakeHouseLocationResponse | outputs.datafactory.OracleCloudStorageLocationResponse | outputs.datafactory.SftpLocationResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'Parquet'. */ type: "Parquet"; } /** * The data stored in Parquet format. */ interface ParquetFormatResponse { /** * Deserializer. Type: string (or Expression with resultType string). */ deserializer?: any; /** * Serializer. Type: string (or Expression with resultType string). */ serializer?: any; /** * Type of dataset storage format. * Expected value is 'ParquetFormat'. */ type: "ParquetFormat"; } /** * Parquet read settings. */ interface ParquetReadSettingsResponse { /** * Compression settings. */ compressionProperties?: outputs.datafactory.TarGZipReadSettingsResponse | outputs.datafactory.TarReadSettingsResponse | outputs.datafactory.ZipDeflateReadSettingsResponse; /** * The read setting type. * Expected value is 'ParquetReadSettings'. */ type: "ParquetReadSettings"; } /** * A copy activity Parquet sink. */ interface ParquetSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Parquet format settings. */ formatSettings?: outputs.datafactory.ParquetWriteSettingsResponse; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Parquet store settings. */ storeSettings?: outputs.datafactory.AzureBlobFSWriteSettingsResponse | outputs.datafactory.AzureBlobStorageWriteSettingsResponse | outputs.datafactory.AzureDataLakeStoreWriteSettingsResponse | outputs.datafactory.AzureFileStorageWriteSettingsResponse | outputs.datafactory.FileServerWriteSettingsResponse | outputs.datafactory.LakeHouseWriteSettingsResponse | outputs.datafactory.SftpWriteSettingsResponse; /** * Copy sink type. * Expected value is 'ParquetSink'. */ type: "ParquetSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity Parquet source. */ interface ParquetSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Parquet format settings. */ formatSettings?: outputs.datafactory.ParquetReadSettingsResponse; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Parquet store settings. */ storeSettings?: outputs.datafactory.AmazonS3CompatibleReadSettingsResponse | outputs.datafactory.AmazonS3ReadSettingsResponse | outputs.datafactory.AzureBlobFSReadSettingsResponse | outputs.datafactory.AzureBlobStorageReadSettingsResponse | outputs.datafactory.AzureDataLakeStoreReadSettingsResponse | outputs.datafactory.AzureFileStorageReadSettingsResponse | outputs.datafactory.FileServerReadSettingsResponse | outputs.datafactory.FtpReadSettingsResponse | outputs.datafactory.GoogleCloudStorageReadSettingsResponse | outputs.datafactory.HdfsReadSettingsResponse | outputs.datafactory.HttpReadSettingsResponse | outputs.datafactory.LakeHouseReadSettingsResponse | outputs.datafactory.OracleCloudStorageReadSettingsResponse | outputs.datafactory.SftpReadSettingsResponse; /** * Copy source type. * Expected value is 'ParquetSource'. */ type: "ParquetSource"; } /** * Parquet write settings. */ interface ParquetWriteSettingsResponse { /** * Specifies the file name pattern _. when copy from non-file based store without partitionOptions. Type: string (or Expression with resultType string). */ fileNamePrefix?: any; /** * Limit the written file's row count to be smaller than or equal to the specified count. Type: integer (or Expression with resultType integer). */ maxRowsPerFile?: any; /** * The write setting type. * Expected value is 'ParquetWriteSettings'. */ type: "ParquetWriteSettings"; } /** * Paypal Service linked service. */ interface PaypalLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The client ID associated with your PayPal application. */ clientId: any; /** * The client secret associated with your PayPal application. */ clientSecret?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The URL of the PayPal instance. (i.e. api.sandbox.paypal.com) */ host: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'Paypal'. */ type: "Paypal"; /** * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. */ useEncryptedEndpoints?: any; /** * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. */ useHostVerification?: any; /** * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. */ usePeerVerification?: any; /** * Version of the linked service. */ version?: string; } /** * Paypal Service dataset. */ interface PaypalObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'PaypalObject'. */ type: "PaypalObject"; } /** * A copy activity Paypal Service source. */ interface PaypalSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'PaypalSource'. */ type: "PaypalSource"; } /** * Phoenix server linked service. */ interface PhoenixLinkedServiceResponse { /** * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false. */ allowHostNameCNMismatch?: any; /** * Specifies whether to allow self-signed certificates from the server. The default value is false. */ allowSelfSignedServerCert?: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The authentication mechanism used to connect to the Phoenix server. */ authenticationType: string; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * Specifies whether the connections to the server are encrypted using SSL. The default value is false. */ enableSsl?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The IP address or host name of the Phoenix server. (i.e. 192.168.222.160) */ host: any; /** * The partial URL corresponding to the Phoenix server. (i.e. /gateway/sandbox/phoenix/version). The default value is hbasephoenix if using WindowsAzureHDInsightService. */ httpPath?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password corresponding to the user name. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The TCP port that the Phoenix server uses to listen for client connections. The default value is 8765. */ port?: any; /** * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. */ trustedCertPath?: any; /** * Type of linked service. * Expected value is 'Phoenix'. */ type: "Phoenix"; /** * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. */ useSystemTrustStore?: any; /** * The user name used to connect to the Phoenix server. */ username?: any; /** * Version of the linked service. */ version?: string; } /** * Phoenix server dataset. */ interface PhoenixObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Phoenix. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using schema + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'PhoenixObject'. */ type: "PhoenixObject"; } /** * A copy activity Phoenix server source. */ interface PhoenixSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'PhoenixSource'. */ type: "PhoenixSource"; } /** * Pipeline ElapsedTime Metric Policy. */ interface PipelineElapsedTimeMetricPolicyResponse { /** * TimeSpan value, after which an Azure Monitoring Metric is fired. */ duration?: any; } /** * PipelineExternalComputeScale properties for managed integration runtime. */ interface PipelineExternalComputeScalePropertiesResponse { /** * Number of the the external nodes, which should be greater than 0 and less than 11. */ numberOfExternalNodes?: number; /** * Number of the pipeline nodes, which should be greater than 0 and less than 11. */ numberOfPipelineNodes?: number; /** * Time to live (in minutes) setting of integration runtime which will execute pipeline and external activity. */ timeToLive?: number; } /** * The folder that this Pipeline is in. If not specified, Pipeline will appear at the root level. */ interface PipelineFolderResponse { /** * The name of the folder that this Pipeline is in. */ name?: string; } /** * Pipeline Policy. */ interface PipelinePolicyResponse { /** * Pipeline ElapsedTime Metric Policy. */ elapsedTimeMetric?: outputs.datafactory.PipelineElapsedTimeMetricPolicyResponse; } /** * Pipeline reference type. */ interface PipelineReferenceResponse { /** * Reference name. */ name?: string; /** * Reference pipeline name. */ referenceName: string; /** * Pipeline reference type. */ type: string; } /** * PolyBase settings. */ interface PolybaseSettingsResponse { /** * Determines the number of rows to attempt to retrieve before the PolyBase recalculates the percentage of rejected rows. Type: integer (or Expression with resultType integer), minimum: 0. */ rejectSampleValue?: any; /** * Reject type. */ rejectType?: string; /** * Specifies the value or the percentage of rows that can be rejected before the query fails. Type: number (or Expression with resultType number), minimum: 0. */ rejectValue?: any; /** * Specifies how to handle missing values in delimited text files when PolyBase retrieves data from the text file. Type: boolean (or Expression with resultType boolean). */ useTypeDefault?: any; } /** * Linked service for PostgreSQL data source. */ interface PostgreSqlLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of password in connection string. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * Type of linked service. * Expected value is 'PostgreSql'. */ type: "PostgreSql"; /** * Version of the linked service. */ version?: string; } /** * A copy activity source for PostgreSQL databases. */ interface PostgreSqlSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Database query. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'PostgreSqlSource'. */ type: "PostgreSqlSource"; } /** * The PostgreSQL table dataset. */ interface PostgreSqlTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The PostgreSQL table name. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using schema + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'PostgreSqlTable'. */ type: "PostgreSqlTable"; } /** * Linked service for PostgreSQLV2 data source. */ interface PostgreSqlV2LinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The authentication type to use. Type: string. */ authenticationType: any; /** * The time to wait (in seconds) while trying to execute a command before terminating the attempt and generating an error. Set to zero for infinity. Type: integer. */ commandTimeout?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The time to wait (in seconds) while trying to establish a connection before terminating the attempt and generating an error. Type: integer. */ connectionTimeout?: any; /** * Database name for connection. Type: string. */ database: any; /** * Linked service description. */ description?: string; /** * Gets or sets the .NET encoding that will be used to encode/decode PostgreSQL string data. Type: string */ encoding?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * When enabled, parameter values are logged when commands are executed. Type: boolean. */ logParameters?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of password in connection string. Type: string. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * Whether connection pooling should be used. Type: boolean. */ pooling?: any; /** * The port for the connection. Type: integer. */ port?: any; /** * Determines the size of the internal buffer uses when reading. Increasing may improve performance if transferring large values from the database. Type: integer. */ readBufferSize?: any; /** * Sets the schema search path. Type: string. */ schema?: any; /** * Server name for connection. Type: string. */ server: any; /** * Location of a client certificate to be sent to the server. Type: string. */ sslCertificate?: any; /** * Location of a client key for a client certificate to be sent to the server. Type: string. */ sslKey?: any; /** * SSL mode for connection. Type: integer. 0: disable, 1:allow, 2: prefer, 3: require, 4: verify-ca, 5: verify-full. Type: integer. */ sslMode: any; /** * Password for a key for a client certificate. Type: string. */ sslPassword?: any; /** * Gets or sets the session timezone. Type: string. */ timezone?: any; /** * Whether to trust the server certificate without validating it. Type: boolean. */ trustServerCertificate?: any; /** * Type of linked service. * Expected value is 'PostgreSqlV2'. */ type: "PostgreSqlV2"; /** * Username for authentication. Type: string. */ username: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity source for PostgreSQL databases. */ interface PostgreSqlV2SourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Database query. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'PostgreSqlV2Source'. */ type: "PostgreSqlV2Source"; } /** * The PostgreSQLV2 table dataset. */ interface PostgreSqlV2TableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The PostgreSQL table name. Type: string (or Expression with resultType string). */ table?: any; /** * Type of dataset. * Expected value is 'PostgreSqlV2Table'. */ type: "PostgreSqlV2Table"; } /** * Map Power Query mashup query to sink dataset(s). */ interface PowerQuerySinkMappingResponse { /** * List of sinks mapped to Power Query mashup query. */ dataflowSinks?: outputs.datafactory.PowerQuerySinkResponse[]; /** * Name of the query in Power Query mashup document. */ queryName?: string; } /** * Power query sink. */ interface PowerQuerySinkResponse { /** * Dataset reference. */ dataset?: outputs.datafactory.DatasetReferenceResponse; /** * Transformation description. */ description?: string; /** * Flowlet Reference */ flowlet?: outputs.datafactory.DataFlowReferenceResponse; /** * Linked service reference. */ linkedService?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Transformation name. */ name: string; /** * Rejected data linked service reference. */ rejectedDataLinkedService?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Schema linked service reference. */ schemaLinkedService?: outputs.datafactory.LinkedServiceReferenceResponse; /** * sink script. */ script?: string; } /** * Power query source. */ interface PowerQuerySourceResponse { /** * Dataset reference. */ dataset?: outputs.datafactory.DatasetReferenceResponse; /** * Transformation description. */ description?: string; /** * Flowlet Reference */ flowlet?: outputs.datafactory.DataFlowReferenceResponse; /** * Linked service reference. */ linkedService?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Transformation name. */ name: string; /** * Schema linked service reference. */ schemaLinkedService?: outputs.datafactory.LinkedServiceReferenceResponse; /** * source script. */ script?: string; } /** * Presto server linked service. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features. */ interface PrestoLinkedServiceResponse { /** * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false. Only used for Version 1.0. */ allowHostNameCNMismatch?: any; /** * Specifies whether to allow self-signed certificates from the server. The default value is false. Only used for Version 1.0. */ allowSelfSignedServerCert?: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The authentication mechanism used to connect to the Presto server. */ authenticationType: string; /** * The catalog context for all request against the server. */ catalog: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * Specifies whether the connections to the server will validate server certificate, the default value is True. Only used for Version 2.0 */ enableServerCertificateValidation?: any; /** * Specifies whether the connections to the server are encrypted using SSL. The default value for legacy version is False. The default value for version 2.0 is True. */ enableSsl?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The IP address or host name of the Presto server. (i.e. 192.168.222.160) */ host: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password corresponding to the user name. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The TCP port that the Presto server uses to listen for client connections. The default value is 8080 when disable SSL, default value is 443 when enable SSL. */ port?: any; /** * The version of the Presto server. (i.e. 0.148-t) Only used for Version 1.0. */ serverVersion?: any; /** * The local time zone used by the connection. Valid values for this option are specified in the IANA Time Zone Database. The default value for Version 1.0 is the client system time zone. The default value for Version 2.0 is server system timeZone */ timeZoneID?: any; /** * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. Only used for Version 1.0. */ trustedCertPath?: any; /** * Type of linked service. * Expected value is 'Presto'. */ type: "Presto"; /** * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. Only used for Version 1.0. */ useSystemTrustStore?: any; /** * The user name used to connect to the Presto server. */ username?: any; /** * Version of the linked service. */ version?: string; } /** * Presto server dataset. */ interface PrestoObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Presto. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using schema + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'PrestoObject'. */ type: "PrestoObject"; } /** * A copy activity Presto server source. */ interface PrestoSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'PrestoSource'. */ type: "PrestoSource"; } /** * The state of a private link connection */ interface PrivateLinkConnectionStateResponse { /** * ActionsRequired for a private link connection */ actionsRequired?: string; /** * Description of a private link connection */ description?: string; /** * Status of a private link connection */ status?: string; } /** * Purview configuration. */ interface PurviewConfigurationResponse { /** * Purview resource id. */ purviewResourceId?: string; } /** * QuickBooks server linked service. This linked service has supported version property. The Version 1.0 is scheduled for deprecation while your pipeline will continue to run after EOL but without any bug fix or new features. */ interface QuickBooksLinkedServiceResponse { /** * The access token for OAuth 2.0 authentication. */ accessToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The access token secret is deprecated for OAuth 1.0 authentication. Only used for version 1.0. */ accessTokenSecret?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The company ID of the QuickBooks company to authorize. */ companyId?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object. */ connectionProperties?: any; /** * The consumer key for OAuth 2.0 authentication. */ consumerKey?: any; /** * The consumer secret for OAuth 2.0 authentication. */ consumerSecret?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com) */ endpoint?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The refresh token for OAuth 2.0 authentication. */ refreshToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'QuickBooks'. */ type: "QuickBooks"; /** * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Only used for version 1.0. */ useEncryptedEndpoints?: any; /** * Version of the linked service. */ version?: string; } /** * QuickBooks server dataset. */ interface QuickBooksObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'QuickBooksObject'. */ type: "QuickBooksObject"; } /** * A copy activity QuickBooks server source. */ interface QuickBooksSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'QuickBooksSource'. */ type: "QuickBooksSource"; } /** * Linked service for Quickbase. */ interface QuickbaseLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'Quickbase'. */ type: "Quickbase"; /** * The url to connect Quickbase source. Type: string (or Expression with resultType string). */ url: any; /** * The user token for the Quickbase source. */ userToken: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Version of the linked service. */ version?: string; } /** * The recurrence schedule occurrence. */ interface RecurrenceScheduleOccurrenceResponse { /** * The day of the week. */ day?: string; /** * The occurrence. */ occurrence?: number; } /** * The recurrence schedule. */ interface RecurrenceScheduleResponse { /** * The hours. */ hours?: number[]; /** * The minutes. */ minutes?: number[]; /** * The month days. */ monthDays?: number[]; /** * The monthly occurrences. */ monthlyOccurrences?: outputs.datafactory.RecurrenceScheduleOccurrenceResponse[]; /** * The days of the week. */ weekDays?: string[]; } /** * Redirect incompatible row settings */ interface RedirectIncompatibleRowSettingsResponse { /** * Name of the Azure Storage, Storage SAS, or Azure Data Lake Store linked service used for redirecting incompatible row. Must be specified if redirectIncompatibleRowSettings is specified. Type: string (or Expression with resultType string). */ linkedServiceName: any; /** * The path for storing the redirect incompatible row data. Type: string (or Expression with resultType string). */ path?: any; } /** * The Amazon S3 settings needed for the interim Amazon S3 when copying from Amazon Redshift with unload. With this, data from Amazon Redshift source will be unloaded into S3 first and then copied into the targeted sink from the interim S3. */ interface RedshiftUnloadSettingsResponse { /** * The bucket of the interim Amazon S3 which will be used to store the unloaded data from Amazon Redshift source. The bucket must be in the same region as the Amazon Redshift source. Type: string (or Expression with resultType string). */ bucketName: any; /** * The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source. */ s3LinkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; } /** * A copy activity source for various relational databases. */ interface RelationalSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Database query. Type: string (or Expression with resultType string). */ query?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'RelationalSource'. */ type: "RelationalSource"; } /** * The relational table dataset. */ interface RelationalTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The relational table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'RelationalTable'. */ type: "RelationalTable"; } /** * A remote private endpoint connection */ interface RemotePrivateEndpointConnectionResponse { /** * PrivateEndpoint of a remote private endpoint connection */ privateEndpoint?: outputs.datafactory.ArmIdWrapperResponse; /** * The state of a private link connection */ privateLinkServiceConnectionState?: outputs.datafactory.PrivateLinkConnectionStateResponse; provisioningState: string; } /** * Trigger that schedules pipeline reruns for all fixed time interval windows from a requested start time to requested end time. */ interface RerunTumblingWindowTriggerResponse { /** * List of tags that can be used for describing the trigger. */ annotations?: any[]; /** * Trigger description. */ description?: string; /** * The parent trigger reference. */ parentTrigger: any; /** * The end time for the time period for which restatement is initiated. Only UTC time is currently supported. */ requestedEndTime: string; /** * The start time for the time period for which restatement is initiated. Only UTC time is currently supported. */ requestedStartTime: string; /** * The max number of parallel time windows (ready for execution) for which a rerun is triggered. */ rerunConcurrency: number; /** * Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. */ runtimeState: string; /** * Trigger type. * Expected value is 'RerunTumblingWindowTrigger'. */ type: "RerunTumblingWindowTrigger"; } /** * Responsys linked service. */ interface ResponsysLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The client ID associated with the Responsys application. Type: string (or Expression with resultType string). */ clientId: any; /** * The client secret associated with the Responsys application. Type: string (or Expression with resultType string). */ clientSecret?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The endpoint of the Responsys server. */ endpoint: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'Responsys'. */ type: "Responsys"; /** * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean). */ useEncryptedEndpoints?: any; /** * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean). */ useHostVerification?: any; /** * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean). */ usePeerVerification?: any; /** * Version of the linked service. */ version?: string; } /** * Responsys dataset. */ interface ResponsysObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'ResponsysObject'. */ type: "ResponsysObject"; } /** * A copy activity Responsys source. */ interface ResponsysSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'ResponsysSource'. */ type: "ResponsysSource"; } /** * A Rest service dataset. */ interface RestResourceDatasetResponse { /** * The additional HTTP headers in the request to the RESTful API. */ additionalHeaders?: any; /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The pagination rules to compose next page requests. */ paginationRules?: any; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The relative URL to the resource that the RESTful API provides. Type: string (or Expression with resultType string). */ relativeUrl?: any; /** * The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string). */ requestBody?: any; /** * The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string). */ requestMethod?: any; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'RestResource'. */ type: "RestResource"; } /** * Rest Service linked service. */ interface RestServiceLinkedServiceResponse { /** * The resource you are requesting authorization to use. Type: string (or Expression with resultType string). */ aadResourceId?: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The additional HTTP headers in the request to RESTful API used for authorization. Type: object (or Expression with resultType object). */ authHeaders?: any; /** * Type of authentication used to connect to the REST service. */ authenticationType: string; /** * Indicates the azure cloud type of the service principle auth. Allowed values are AzurePublic, AzureChina, AzureUsGovernment, AzureGermany. Default value is the data factory regions’ cloud type. Type: string (or Expression with resultType string). */ azureCloudType?: any; /** * The client ID associated with your application. Type: string (or Expression with resultType string). */ clientId?: any; /** * The client secret associated with your application. */ clientSecret?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Linked service description. */ description?: string; /** * Whether to validate server side SSL certificate when connecting to the endpoint.The default value is true. Type: boolean (or Expression with resultType boolean). */ enableServerCertificateValidation?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password used in Basic authentication type. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The target service or resource to which the access will be requested. Type: string (or Expression with resultType string). */ resource?: any; /** * The scope of the access required. It describes what kind of access will be requested. Type: string (or Expression with resultType string). */ scope?: any; /** * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). */ servicePrincipalCredentialType?: any; /** * Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). */ servicePrincipalEmbeddedCert?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string). */ servicePrincipalEmbeddedCertPassword?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The application's client ID used in AadServicePrincipal authentication type. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The application's key used in AadServicePrincipal authentication type. */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides. Type: string (or Expression with resultType string). */ tenant?: any; /** * The token endpoint of the authorization server to acquire access token. Type: string (or Expression with resultType string). */ tokenEndpoint?: any; /** * Type of linked service. * Expected value is 'RestService'. */ type: "RestService"; /** * The base URL of the REST service. Type: string (or Expression with resultType string). */ url: any; /** * The user name used in Basic authentication type. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity Rest service Sink. */ interface RestSinkResponse { /** * The additional HTTP headers in the request to the RESTful API. Type: key value pairs (value should be string type). */ additionalHeaders?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Http Compression Type to Send data in compressed format with Optimal Compression Level, Default is None. And The Only Supported option is Gzip. Type: string (or Expression with resultType string). */ httpCompressionType?: any; /** * The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ httpRequestTimeout?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The time to await before sending next request, in milliseconds */ requestInterval?: any; /** * The HTTP method used to call the RESTful API. The default is POST. Type: string (or Expression with resultType string). */ requestMethod?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'RestSink'. */ type: "RestSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity Rest service source. */ interface RestSourceResponse { /** * Specifies the additional columns to be added to source data. Type: key value pairs (value should be string type). */ additionalColumns?: any; /** * The additional HTTP headers in the request to the RESTful API. Type: string (or Expression with resultType string). */ additionalHeaders?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:01:40. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ httpRequestTimeout?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The pagination rules to compose next page requests. Type: string (or Expression with resultType string). */ paginationRules?: any; /** * The HTTP request body to the RESTful API if requestMethod is POST. Type: string (or Expression with resultType string). */ requestBody?: any; /** * The time to await before sending next page request. */ requestInterval?: any; /** * The HTTP method used to call the RESTful API. The default is GET. Type: string (or Expression with resultType string). */ requestMethod?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'RestSource'. */ type: "RestSource"; } /** * Execution policy for an activity. */ interface RetryPolicyResponse { /** * Maximum ordinary retry attempts. Default is 0. Type: integer (or Expression with resultType integer), minimum: 0. */ count?: any; /** * Interval between retries in seconds. Default is 30. */ intervalInSeconds?: number; } /** * SSIS access credential. */ interface SSISAccessCredentialResponse { /** * Domain for windows authentication. Type: string (or Expression with resultType string). */ domain: any; /** * Password for windows authentication. */ password: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * UseName for windows authentication. Type: string (or Expression with resultType string). */ userName: any; } /** * SSIS embedded child package. */ interface SSISChildPackageResponse { /** * Content for embedded child package. Type: string (or Expression with resultType string). */ packageContent: any; /** * Last modified date for embedded child package. */ packageLastModifiedDate?: string; /** * Name for embedded child package. */ packageName?: string; /** * Path for embedded child package. Type: string (or Expression with resultType string). */ packagePath: any; } /** * SSIS package execution credential. */ interface SSISExecutionCredentialResponse { /** * Domain for windows authentication. Type: string (or Expression with resultType string). */ domain: any; /** * Password for windows authentication. */ password: outputs.datafactory.SecureStringResponse; /** * UseName for windows authentication. Type: string (or Expression with resultType string). */ userName: any; } /** * SSIS execution parameter. */ interface SSISExecutionParameterResponse { /** * SSIS package execution parameter value. Type: string (or Expression with resultType string). */ value: any; } /** * SSIS package execution log location */ interface SSISLogLocationResponse { /** * The package execution log access credential. */ accessCredential?: outputs.datafactory.SSISAccessCredentialResponse; /** * The SSIS package execution log path. Type: string (or Expression with resultType string). */ logPath: any; /** * Specifies the interval to refresh log. The default interval is 5 minutes. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ logRefreshInterval?: any; /** * The type of SSIS log location. */ type: string; } /** * SSIS package location. */ interface SSISPackageLocationResponse { /** * The package access credential. */ accessCredential?: outputs.datafactory.SSISAccessCredentialResponse; /** * The embedded child package list. */ childPackages?: outputs.datafactory.SSISChildPackageResponse[]; /** * The configuration file access credential. */ configurationAccessCredential?: outputs.datafactory.SSISAccessCredentialResponse; /** * The configuration file of the package execution. Type: string (or Expression with resultType string). */ configurationPath?: any; /** * The embedded package content. Type: string (or Expression with resultType string). */ packageContent?: any; /** * The embedded package last modified date. */ packageLastModifiedDate?: string; /** * The package name. */ packageName?: string; /** * Password of the package. */ packagePassword?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The SSIS package path. Type: string (or Expression with resultType string). */ packagePath?: any; /** * The type of SSIS package location. */ type?: string; } /** * SSIS property override. */ interface SSISPropertyOverrideResponse { /** * Whether SSIS package property override value is sensitive data. Value will be encrypted in SSISDB if it is true */ isSensitive?: boolean; /** * SSIS package property override value. Type: string (or Expression with resultType string). */ value: any; } /** * Linked service for Salesforce. */ interface SalesforceLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The Salesforce API version used in ADF. Type: string (or Expression with resultType string). */ apiVersion?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The URL of Salesforce instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string). */ environmentUrl?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password for Basic authentication of the Salesforce instance. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The security token is optional to remotely access Salesforce instance. */ securityToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'Salesforce'. */ type: "Salesforce"; /** * The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string). */ username?: any; /** * Version of the linked service. */ version?: string; } /** * Salesforce Marketing Cloud linked service. */ interface SalesforceMarketingCloudLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The client ID associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string). */ clientId?: any; /** * The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string). */ clientSecret?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Properties used to connect to Salesforce Marketing Cloud. It is mutually exclusive with any other properties in the linked service. Type: object. */ connectionProperties?: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'SalesforceMarketingCloud'. */ type: "SalesforceMarketingCloud"; /** * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean). */ useEncryptedEndpoints?: any; /** * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean). */ useHostVerification?: any; /** * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. Type: boolean (or Expression with resultType boolean). */ usePeerVerification?: any; /** * Version of the linked service. */ version?: string; } /** * Salesforce Marketing Cloud dataset. */ interface SalesforceMarketingCloudObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'SalesforceMarketingCloudObject'. */ type: "SalesforceMarketingCloudObject"; } /** * A copy activity Salesforce Marketing Cloud source. */ interface SalesforceMarketingCloudSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'SalesforceMarketingCloudSource'. */ type: "SalesforceMarketingCloudSource"; } /** * The Salesforce object dataset. */ interface SalesforceObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The Salesforce object API name. Type: string (or Expression with resultType string). */ objectApiName?: any; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'SalesforceObject'. */ type: "SalesforceObject"; } /** * Linked service for Salesforce Service Cloud. */ interface SalesforceServiceCloudLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The Salesforce API version used in ADF. Type: string (or Expression with resultType string). */ apiVersion?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The URL of Salesforce Service Cloud instance. Default is 'https://login.salesforce.com'. To copy data from sandbox, specify 'https://test.salesforce.com'. To copy data from custom domain, specify, for example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string). */ environmentUrl?: any; /** * Extended properties appended to the connection string. Type: string (or Expression with resultType string). */ extendedProperties?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password for Basic authentication of the Salesforce instance. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The security token is optional to remotely access Salesforce instance. */ securityToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'SalesforceServiceCloud'. */ type: "SalesforceServiceCloud"; /** * The username for Basic authentication of the Salesforce instance. Type: string (or Expression with resultType string). */ username?: any; /** * Version of the linked service. */ version?: string; } /** * The Salesforce Service Cloud object dataset. */ interface SalesforceServiceCloudObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The Salesforce Service Cloud object API name. Type: string (or Expression with resultType string). */ objectApiName?: any; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'SalesforceServiceCloudObject'. */ type: "SalesforceServiceCloudObject"; } /** * A copy activity Salesforce Service Cloud sink. */ interface SalesforceServiceCloudSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string). */ externalIdFieldName?: any; /** * The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean). */ ignoreNullValues?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'SalesforceServiceCloudSink'. */ type: "SalesforceServiceCloudSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * The write behavior for the operation. Default is Insert. */ writeBehavior?: string; } /** * A copy activity Salesforce Service Cloud source. */ interface SalesforceServiceCloudSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Database query. Type: string (or Expression with resultType string). */ query?: any; /** * The read behavior for the operation. Default is Query. Allowed values: Query/QueryAll. Type: string (or Expression with resultType string). */ readBehavior?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'SalesforceServiceCloudSource'. */ type: "SalesforceServiceCloudSource"; } /** * Linked service for Salesforce Service Cloud V2. */ interface SalesforceServiceCloudV2LinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The Salesforce API version used in ADF. The version must be larger than or equal to 47.0 which is required by Salesforce BULK API 2.0. Type: string (or Expression with resultType string). */ apiVersion?: any; /** * The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value */ authenticationType?: any; /** * The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string). */ clientId?: any; /** * The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. */ clientSecret?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The URL of Salesforce Service Cloud instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string). */ environmentUrl?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'SalesforceServiceCloudV2'. */ type: "SalesforceServiceCloudV2"; /** * Version of the linked service. */ version?: string; } /** * The Salesforce Service Cloud V2 object dataset. */ interface SalesforceServiceCloudV2ObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The Salesforce Service Cloud V2 object API name. Type: string (or Expression with resultType string). */ objectApiName?: any; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Salesforce Service Cloud V2 reportId. Type: string (or Expression with resultType string). */ reportId?: any; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'SalesforceServiceCloudV2Object'. */ type: "SalesforceServiceCloudV2Object"; } /** * A copy activity Salesforce Service Cloud V2 sink. */ interface SalesforceServiceCloudV2SinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string). */ externalIdFieldName?: any; /** * The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean). */ ignoreNullValues?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'SalesforceServiceCloudV2Sink'. */ type: "SalesforceServiceCloudV2Sink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * The write behavior for the operation. Default is Insert. */ writeBehavior?: string; } /** * A copy activity Salesforce Service Cloud V2 source. */ interface SalesforceServiceCloudV2SourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * This property control whether query result contains Deleted objects. Default is false. Type: boolean (or Expression with resultType boolean). */ includeDeletedObjects?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * You can only use Salesforce Object Query Language (SOQL) query with limitations. For SOQL limitations, see this article: https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm#SOQL%20Considerations. If query is not specified, all the data of the Salesforce object specified in ObjectApiName/reportId in dataset will be retrieved. Type: string (or Expression with resultType string). */ query?: any; /** * Deprecating, please use 'query' property instead. Type: string (or Expression with resultType string). */ sOQLQuery?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'SalesforceServiceCloudV2Source'. */ type: "SalesforceServiceCloudV2Source"; } /** * A copy activity Salesforce sink. */ interface SalesforceSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string). */ externalIdFieldName?: any; /** * The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean). */ ignoreNullValues?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'SalesforceSink'. */ type: "SalesforceSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * The write behavior for the operation. Default is Insert. */ writeBehavior?: string; } /** * A copy activity Salesforce source. */ interface SalesforceSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Database query. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * The read behavior for the operation. Default is Query. Allowed values: Query/QueryAll. Type: string (or Expression with resultType string). */ readBehavior?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'SalesforceSource'. */ type: "SalesforceSource"; } /** * Linked service for Salesforce V2. */ interface SalesforceV2LinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The Salesforce API version used in ADF. The version must be larger than or equal to 47.0 which is required by Salesforce BULK API 2.0. Type: string (or Expression with resultType string). */ apiVersion?: any; /** * The authentication type to be used to connect to the Salesforce. Currently, we only support OAuth2ClientCredentials, it is also the default value */ authenticationType?: any; /** * The client Id for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. Type: string (or Expression with resultType string). */ clientId?: any; /** * The client secret for OAuth 2.0 Client Credentials Flow authentication of the Salesforce instance. */ clientSecret?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The URL of Salesforce instance. For example, 'https://[domain].my.salesforce.com'. Type: string (or Expression with resultType string). */ environmentUrl?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'SalesforceV2'. */ type: "SalesforceV2"; /** * Version of the linked service. */ version?: string; } /** * The Salesforce V2 object dataset. */ interface SalesforceV2ObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The Salesforce V2 object API name. Type: string (or Expression with resultType string). */ objectApiName?: any; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Salesforce V2 report Id. Type: string (or Expression with resultType string). */ reportId?: any; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'SalesforceV2Object'. */ type: "SalesforceV2Object"; } /** * A copy activity Salesforce V2 sink. */ interface SalesforceV2SinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The name of the external ID field for upsert operation. Default value is 'Id' column. Type: string (or Expression with resultType string). */ externalIdFieldName?: any; /** * The flag indicating whether or not to ignore null values from input dataset (except key fields) during write operation. Default value is false. If set it to true, it means ADF will leave the data in the destination object unchanged when doing upsert/update operation and insert defined default value when doing insert operation, versus ADF will update the data in the destination object to NULL when doing upsert/update operation and insert NULL value when doing insert operation. Type: boolean (or Expression with resultType boolean). */ ignoreNullValues?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'SalesforceV2Sink'. */ type: "SalesforceV2Sink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * The write behavior for the operation. Default is Insert. */ writeBehavior?: string; } /** * A copy activity Salesforce V2 source. */ interface SalesforceV2SourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * This property control whether query result contains Deleted objects. Default is false. Type: boolean (or Expression with resultType boolean). */ includeDeletedObjects?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Page size for each http request, too large pageSize will caused timeout, default 300,000. Type: integer (or Expression with resultType integer). */ pageSize?: any; /** * Partition option for the SalesforceV2 connector in copy activity, AutoDetect or None. Type: string (or Expression with resultType string). */ partitionOption?: any; /** * You can only use Salesforce Object Query Language (SOQL) query with limitations. For SOQL limitations, see this article: https://developer.salesforce.com/docs/atlas.en-us.api_asynch.meta/api_asynch/queries.htm#SOQL%20Considerations. If query is not specified, all the data of the Salesforce object specified in ObjectApiName/reportId in dataset will be retrieved. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Deprecating, please use 'query' property instead. Type: string (or Expression with resultType string). */ sOQLQuery?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'SalesforceV2Source'. */ type: "SalesforceV2Source"; } /** * SAP Business Warehouse Linked Service. */ interface SapBWLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Client ID of the client on the BW system. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string). */ clientId: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password to access the SAP BW server. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Host name of the SAP BW instance. Type: string (or Expression with resultType string). */ server: any; /** * System number of the BW system. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string). */ systemNumber: any; /** * Type of linked service. * Expected value is 'SapBW'. */ type: "SapBW"; /** * Username to access the SAP BW server. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * The SAP BW cube dataset. */ interface SapBwCubeDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'SapBwCube'. */ type: "SapBwCube"; } /** * A copy activity source for SapBW server via MDX. */ interface SapBwSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * MDX query. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'SapBwSource'. */ type: "SapBwSource"; } /** * Linked service for SAP Cloud for Customer. */ interface SapCloudForCustomerLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password for Basic authentication. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'SapCloudForCustomer'. */ type: "SapCloudForCustomer"; /** * The URL of SAP Cloud for Customer OData API. For example, '[https://[tenantname].crm.ondemand.com/sap/c4c/odata/v1]'. Type: string (or Expression with resultType string). */ url: any; /** * The username for Basic authentication. Type: string (or Expression with resultType string). */ username?: any; /** * Version of the linked service. */ version?: string; } /** * The path of the SAP Cloud for Customer OData entity. */ interface SapCloudForCustomerResourceDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The path of the SAP Cloud for Customer OData entity. Type: string (or Expression with resultType string). */ path: any; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'SapCloudForCustomerResource'. */ type: "SapCloudForCustomerResource"; } /** * A copy activity SAP Cloud for Customer sink. */ interface SapCloudForCustomerSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ httpRequestTimeout?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'SapCloudForCustomerSink'. */ type: "SapCloudForCustomerSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * The write behavior for the operation. Default is 'Insert'. */ writeBehavior?: string; } /** * A copy activity source for SAP Cloud for Customer source. */ interface SapCloudForCustomerSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ httpRequestTimeout?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * SAP Cloud for Customer OData query. For example, "$top=1". Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'SapCloudForCustomerSource'. */ type: "SapCloudForCustomerSource"; } /** * Linked service for SAP ERP Central Component(SAP ECC). */ interface SapEccLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Either encryptedCredential or username/password must be provided. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password for Basic authentication. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'SapEcc'. */ type: "SapEcc"; /** * The URL of SAP ECC OData API. For example, '[https://hostname:port/sap/opu/odata/sap/servicename/]'. Type: string (or Expression with resultType string). */ url: any; /** * The username for Basic authentication. Type: string (or Expression with resultType string). */ username?: any; /** * Version of the linked service. */ version?: string; } /** * The path of the SAP ECC OData entity. */ interface SapEccResourceDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The path of the SAP ECC OData entity. Type: string (or Expression with resultType string). */ path: any; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'SapEccResource'. */ type: "SapEccResource"; } /** * A copy activity source for SAP ECC source. */ interface SapEccSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The timeout (TimeSpan) to get an HTTP response. It is the timeout to get a response, not the timeout to read response data. Default value: 00:05:00. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ httpRequestTimeout?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * SAP ECC OData query. For example, "$top=1". Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'SapEccSource'. */ type: "SapEccSource"; } /** * SAP HANA Linked Service. */ interface SapHanaLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The authentication type to be used to connect to the SAP HANA server. */ authenticationType?: string; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * SAP HANA ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password to access the SAP HANA server. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Host name of the SAP HANA server. Type: string (or Expression with resultType string). */ server?: any; /** * Type of linked service. * Expected value is 'SapHana'. */ type: "SapHana"; /** * Username to access the SAP HANA server. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * The settings that will be leveraged for SAP HANA source partitioning. */ interface SapHanaPartitionSettingsResponse { /** * The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string). */ partitionColumnName?: any; } /** * A copy activity source for SAP HANA source. */ interface SapHanaSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The packet size of data read from SAP HANA. Type: integer(or Expression with resultType integer). */ packetSize?: any; /** * The partition mechanism that will be used for SAP HANA read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "SapHanaDynamicRange". */ partitionOption?: any; /** * The settings that will be leveraged for SAP HANA source partitioning. */ partitionSettings?: outputs.datafactory.SapHanaPartitionSettingsResponse; /** * SAP HANA Sql query. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'SapHanaSource'. */ type: "SapHanaSource"; } /** * SAP HANA Table properties. */ interface SapHanaTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of SAP HANA. Type: string (or Expression with resultType string). */ table?: any; /** * Type of dataset. * Expected value is 'SapHanaTable'. */ type: "SapHanaTable"; } /** * SAP ODP Linked Service. */ interface SapOdpLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string). */ clientId?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string). */ language?: any; /** * The Logon Group for the SAP System. Type: string (or Expression with resultType string). */ logonGroup?: any; /** * The hostname of the SAP Message Server. Type: string (or Expression with resultType string). */ messageServer?: any; /** * The service name or port number of the Message Server. Type: string (or Expression with resultType string). */ messageServerService?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password to access the SAP server where the table is located. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string). */ server?: any; /** * External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string). */ sncLibraryPath?: any; /** * SNC activation flag (Boolean) to access the SAP server where the table is located. Type: boolean (or Expression with resultType boolean). */ sncMode?: any; /** * Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). */ sncMyName?: any; /** * Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). */ sncPartnerName?: any; /** * SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string). */ sncQop?: any; /** * The subscriber name. Type: string (or Expression with resultType string). */ subscriberName?: any; /** * SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string). */ systemId?: any; /** * System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string). */ systemNumber?: any; /** * Type of linked service. * Expected value is 'SapOdp'. */ type: "SapOdp"; /** * Username to access the SAP server where the table is located. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; /** * SNC X509 certificate file path. Type: string (or Expression with resultType string). */ x509CertificatePath?: any; } /** * SAP ODP Resource properties. */ interface SapOdpResourceDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The context of the SAP ODP Object. Type: string (or Expression with resultType string). */ context: any; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The name of the SAP ODP Object. Type: string (or Expression with resultType string). */ objectName: any; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'SapOdpResource'. */ type: "SapOdpResource"; } /** * A copy activity source for SAP ODP source. */ interface SapOdpSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The extraction mode. Allowed value include: Full, Delta and Recovery. The default value is Full. Type: string (or Expression with resultType string). */ extractionMode?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Specifies the columns to be selected from source data. Type: array of objects(projection) (or Expression with resultType array of objects). */ projection?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Specifies the selection conditions from source data. Type: array of objects(selection) (or Expression with resultType array of objects). */ selection?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * The subscriber process to manage the delta process. Type: string (or Expression with resultType string). */ subscriberProcess?: any; /** * Copy source type. * Expected value is 'SapOdpSource'. */ type: "SapOdpSource"; } /** * SAP Business Warehouse Open Hub Destination Linked Service. */ interface SapOpenHubLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Client ID of the client on the BW system where the open hub destination is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string). */ clientId?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Language of the BW system where the open hub destination is located. The default value is EN. Type: string (or Expression with resultType string). */ language?: any; /** * The Logon Group for the SAP System. Type: string (or Expression with resultType string). */ logonGroup?: any; /** * The hostname of the SAP Message Server. Type: string (or Expression with resultType string). */ messageServer?: any; /** * The service name or port number of the Message Server. Type: string (or Expression with resultType string). */ messageServerService?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password to access the SAP BW server where the open hub destination is located. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Host name of the SAP BW instance where the open hub destination is located. Type: string (or Expression with resultType string). */ server?: any; /** * SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string). */ systemId?: any; /** * System number of the BW system where the open hub destination is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string). */ systemNumber?: any; /** * Type of linked service. * Expected value is 'SapOpenHub'. */ type: "SapOpenHub"; /** * Username to access the SAP BW server where the open hub destination is located. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity source for SAP Business Warehouse Open Hub Destination source. */ interface SapOpenHubSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer ). */ baseRequestId?: any; /** * Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string). */ customRfcReadTableFunctionModule?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean). */ excludeLastRequest?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string). */ sapDataColumnDelimiter?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'SapOpenHubSource'. */ type: "SapOpenHubSource"; } /** * Sap Business Warehouse Open Hub Destination Table properties. */ interface SapOpenHubTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The ID of request for delta loading. Once it is set, only data with requestId larger than the value of this property will be retrieved. The default value is 0. Type: integer (or Expression with resultType integer ). */ baseRequestId?: any; /** * Dataset description. */ description?: string; /** * Whether to exclude the records of the last request. The default value is true. Type: boolean (or Expression with resultType boolean). */ excludeLastRequest?: any; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The name of the Open Hub Destination with destination type as Database Table. Type: string (or Expression with resultType string). */ openHubDestinationName: any; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'SapOpenHubTable'. */ type: "SapOpenHubTable"; } /** * SAP Table Linked Service. */ interface SapTableLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * Client ID of the client on the SAP system where the table is located. (Usually a three-digit decimal number represented as a string) Type: string (or Expression with resultType string). */ clientId?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Language of the SAP system where the table is located. The default value is EN. Type: string (or Expression with resultType string). */ language?: any; /** * The Logon Group for the SAP System. Type: string (or Expression with resultType string). */ logonGroup?: any; /** * The hostname of the SAP Message Server. Type: string (or Expression with resultType string). */ messageServer?: any; /** * The service name or port number of the Message Server. Type: string (or Expression with resultType string). */ messageServerService?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password to access the SAP server where the table is located. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Host name of the SAP instance where the table is located. Type: string (or Expression with resultType string). */ server?: any; /** * External security product's library to access the SAP server where the table is located. Type: string (or Expression with resultType string). */ sncLibraryPath?: any; /** * SNC activation flag (Boolean) to access the SAP server where the table is located. Type: boolean (or Expression with resultType boolean). */ sncMode?: any; /** * Initiator's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). */ sncMyName?: any; /** * Communication partner's SNC name to access the SAP server where the table is located. Type: string (or Expression with resultType string). */ sncPartnerName?: any; /** * SNC Quality of Protection. Allowed value include: 1, 2, 3, 8, 9. Type: string (or Expression with resultType string). */ sncQop?: any; /** * SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string). */ systemId?: any; /** * System number of the SAP system where the table is located. (Usually a two-digit decimal number represented as a string.) Type: string (or Expression with resultType string). */ systemNumber?: any; /** * Type of linked service. * Expected value is 'SapTable'. */ type: "SapTable"; /** * Username to access the SAP server where the table is located. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * The settings that will be leveraged for SAP table source partitioning. */ interface SapTablePartitionSettingsResponse { /** * The maximum value of partitions the table will be split into. Type: integer (or Expression with resultType string). */ maxPartitionsNumber?: any; /** * The name of the column that will be used for proceeding range partitioning. Type: string (or Expression with resultType string). */ partitionColumnName?: any; /** * The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string). */ partitionLowerBound?: any; /** * The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string). */ partitionUpperBound?: any; } /** * SAP Table Resource properties. */ interface SapTableResourceDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The name of the SAP Table. Type: string (or Expression with resultType string). */ tableName: any; /** * Type of dataset. * Expected value is 'SapTableResource'. */ type: "SapTableResource"; } /** * A copy activity source for SAP Table source. */ interface SapTableSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer). */ batchSize?: any; /** * Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string). */ customRfcReadTableFunctionModule?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The partition mechanism that will be used for SAP table read in parallel. Possible values include: "None", "PartitionOnInt", "PartitionOnCalendarYear", "PartitionOnCalendarMonth", "PartitionOnCalendarDate", "PartitionOnTime". */ partitionOption?: any; /** * The settings that will be leveraged for SAP table source partitioning. */ partitionSettings?: outputs.datafactory.SapTablePartitionSettingsResponse; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string). */ rfcTableFields?: any; /** * The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string). */ rfcTableOptions?: any; /** * The number of rows to be retrieved. Type: integer(or Expression with resultType integer). */ rowCount?: any; /** * The number of rows that will be skipped. Type: integer (or Expression with resultType integer). */ rowSkips?: any; /** * The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string). */ sapDataColumnDelimiter?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'SapTableSource'. */ type: "SapTableSource"; } /** * The workflow trigger recurrence. */ interface ScheduleTriggerRecurrenceResponse { /** * The end time. */ endTime?: string; /** * The frequency. */ frequency?: string; /** * The interval. */ interval?: number; /** * The recurrence schedule. */ schedule?: outputs.datafactory.RecurrenceScheduleResponse; /** * The start time. */ startTime?: string; /** * The time zone. */ timeZone?: string; } /** * Trigger that creates pipeline runs periodically, on schedule. */ interface ScheduleTriggerResponse { /** * List of tags that can be used for describing the trigger. */ annotations?: any[]; /** * Trigger description. */ description?: string; /** * Pipelines that need to be started. */ pipelines?: outputs.datafactory.TriggerPipelineReferenceResponse[]; /** * Recurrence schedule configuration. */ recurrence: outputs.datafactory.ScheduleTriggerRecurrenceResponse; /** * Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. */ runtimeState: string; /** * Trigger type. * Expected value is 'ScheduleTrigger'. */ type: "ScheduleTrigger"; } /** * Custom script action to run on HDI ondemand cluster once it's up. */ interface ScriptActionResponse { /** * The user provided name of the script action. */ name: string; /** * The parameters for the script action. */ parameters?: string; /** * The node types on which the script action should be executed. */ roles: any; /** * The URI for the script action. */ uri: string; } /** * Parameters of a script block. */ interface ScriptActivityParameterResponse { /** * The direction of the parameter. */ direction?: string; /** * The name of the parameter. Type: string (or Expression with resultType string). */ name?: any; /** * The size of the output direction parameter. */ size?: number; /** * The type of the parameter. */ type?: string; /** * The value of the parameter. Type: string (or Expression with resultType string). */ value?: any; } /** * Script activity type. */ interface ScriptActivityResponse { /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Log settings of script activity. */ logSettings?: outputs.datafactory.ScriptActivityTypePropertiesLogSettingsResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Enable to retrieve result sets from multiple SQL statements and the number of rows affected by the DML statement. Supported connector: SnowflakeV2. Type: boolean (or Expression with resultType boolean). */ returnMultistatementResult?: any; /** * ScriptBlock execution timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ scriptBlockExecutionTimeout?: any; /** * Array of script blocks. Type: array. */ scripts?: outputs.datafactory.ScriptActivityScriptBlockResponse[]; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Indicates whether to treat decimal values as strings to avoid value overflow issue. This option is enabled for SnowflakeV2 connector only. Type: boolean (or Expression with resultType boolean). */ treatDecimalAsString?: any; /** * Type of activity. * Expected value is 'Script'. */ type: "Script"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Script block of scripts. */ interface ScriptActivityScriptBlockResponse { /** * Array of script parameters. Type: array. */ parameters?: outputs.datafactory.ScriptActivityParameterResponse[]; /** * The query text. Type: string (or Expression with resultType string). */ text: any; /** * The type of the query. Please refer to the ScriptType for valid options. Type: string (or Expression with resultType string). */ type: any; } /** * Log settings of script activity. */ interface ScriptActivityTypePropertiesLogSettingsResponse { /** * The destination of logs. Type: string. */ logDestination: string; /** * Log location settings customer needs to provide when enabling log. */ logLocationSettings?: outputs.datafactory.LogLocationSettingsResponse; } /** * Execution policy for an activity that supports secure input and output. */ interface SecureInputOutputPolicyResponse { /** * When set to true, Input from activity is considered as secure and will not be logged to monitoring. */ secureInput?: boolean; /** * When set to true, Output from activity is considered as secure and will not be logged to monitoring. */ secureOutput?: boolean; } /** * Azure Data Factory secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. */ interface SecureStringResponse { /** * Type of the secret. * Expected value is 'SecureString'. */ type: "SecureString"; /** * Value of secure string. */ value: string; } /** * Self referenced tumbling window trigger dependency. */ interface SelfDependencyTumblingWindowTriggerReferenceResponse { /** * Timespan applied to the start time of a tumbling window when evaluating dependency. */ offset: string; /** * The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used. */ size?: string; /** * The type of dependency reference. * Expected value is 'SelfDependencyTumblingWindowTriggerReference'. */ type: "SelfDependencyTumblingWindowTriggerReference"; } /** * Properties of Self-hosted integration runtime node. */ interface SelfHostedIntegrationRuntimeNodeResponse { /** * The integration runtime capabilities dictionary */ capabilities: { [key: string]: string; }; /** * Maximum concurrent jobs on the integration runtime node. */ concurrentJobsLimit: number; /** * The time at which the integration runtime will expire in ISO8601 format. */ expiryTime: string; /** * URI for the host machine of the integration runtime. */ hostServiceUri: string; /** * Indicates whether this node is the active dispatcher for integration runtime requests. */ isActiveDispatcher: boolean; /** * The most recent time at which the integration runtime was connected in ISO8601 format. */ lastConnectTime: string; /** * The last time for the integration runtime node update end. */ lastEndUpdateTime: string; /** * The time the node last started up. */ lastStartTime: string; /** * The last time for the integration runtime node update start. */ lastStartUpdateTime: string; /** * The integration runtime node last stop time. */ lastStopTime: string; /** * The result of the last integration runtime node update. */ lastUpdateResult: string; /** * Machine name of the integration runtime node. */ machineName: string; /** * The maximum concurrent jobs in this integration runtime. */ maxConcurrentJobs: number; /** * Name of the integration runtime node. */ nodeName: string; /** * The time at which the integration runtime node was registered in ISO8601 format. */ registerTime: string; /** * Status of the integration runtime node. */ status: string; /** * Version of the integration runtime node. */ version: string; /** * Status of the integration runtime node version. */ versionStatus: string; } /** * Self-hosted integration runtime. */ interface SelfHostedIntegrationRuntimeResponse { /** * Integration runtime description. */ description?: string; /** * The base definition of a linked integration runtime. */ linkedInfo?: outputs.datafactory.LinkedIntegrationRuntimeKeyAuthorizationResponse | outputs.datafactory.LinkedIntegrationRuntimeRbacAuthorizationResponse; /** * An alternative option to ensure interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay. */ selfContainedInteractiveAuthoringEnabled?: boolean; /** * The type of integration runtime. * Expected value is 'SelfHosted'. */ type: "SelfHosted"; } /** * Self-hosted integration runtime status. */ interface SelfHostedIntegrationRuntimeStatusResponse { /** * Whether Self-hosted integration runtime auto update has been turned on. */ autoUpdate: string; /** * The estimated time when the self-hosted integration runtime will be updated. */ autoUpdateETA: string; /** * Object with additional information about integration runtime capabilities. */ capabilities: { [key: string]: string; }; /** * The time at which the integration runtime was created, in ISO8601 format. */ createTime: string; /** * The data factory name which the integration runtime belong to. */ dataFactoryName: string; /** * It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist). */ internalChannelEncryption: string; /** * The latest version on download center. */ latestVersion: string; /** * The list of linked integration runtimes that are created to share with this integration runtime. */ links?: outputs.datafactory.LinkedIntegrationRuntimeResponse[]; /** * The local time zone offset in hours. */ localTimeZoneOffset: string; /** * The list of nodes for this integration runtime. */ nodes?: outputs.datafactory.SelfHostedIntegrationRuntimeNodeResponse[]; /** * The version that the integration runtime is going to update to. */ pushedVersion: string; /** * The date at which the integration runtime will be scheduled to update, in ISO8601 format. */ scheduledUpdateDate: string; /** * An alternative option to ensure interactive authoring function when your self-hosted integration runtime is unable to establish a connection with Azure Relay. */ selfContainedInteractiveAuthoringEnabled: boolean; /** * The URLs for the services used in integration runtime backend service. */ serviceUrls: string[]; /** * The state of integration runtime. */ state: string; /** * The task queue id of the integration runtime. */ taskQueueId: string; /** * The type of integration runtime. * Expected value is 'SelfHosted'. */ type: "SelfHosted"; /** * The time in the date scheduled by service to update the integration runtime, e.g., PT03H is 3 hours */ updateDelayOffset: string; /** * Version of the integration runtime. */ version: string; /** * Status of the integration runtime version. */ versionStatus: string; } /** * ServiceNow server linked service. */ interface ServiceNowLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The authentication type to use. */ authenticationType: string; /** * The client id for OAuth2 authentication. */ clientId?: any; /** * The client secret for OAuth2 authentication. */ clientSecret?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The endpoint of the ServiceNow server. (i.e. .service-now.com) */ endpoint: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password corresponding to the user name for Basic and OAuth2 authentication. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'ServiceNow'. */ type: "ServiceNow"; /** * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. */ useEncryptedEndpoints?: any; /** * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. */ useHostVerification?: any; /** * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. */ usePeerVerification?: any; /** * The user name used to connect to the ServiceNow server for Basic and OAuth2 authentication. */ username?: any; /** * Version of the linked service. */ version?: string; } /** * ServiceNow server dataset. */ interface ServiceNowObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'ServiceNowObject'. */ type: "ServiceNowObject"; } /** * A copy activity ServiceNow server source. */ interface ServiceNowSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'ServiceNowSource'. */ type: "ServiceNowSource"; } /** * ServiceNowV2 server linked service. */ interface ServiceNowV2LinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The authentication type to use. */ authenticationType: string; /** * The client id for OAuth2 authentication. */ clientId?: any; /** * The client secret for OAuth2 authentication. */ clientSecret?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The endpoint of the ServiceNowV2 server. (i.e. .service-now.com) */ endpoint: any; /** * GrantType for OAuth2 authentication. Default value is password. */ grantType?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password corresponding to the user name for Basic and OAuth2 authentication. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'ServiceNowV2'. */ type: "ServiceNowV2"; /** * The user name used to connect to the ServiceNowV2 server for Basic and OAuth2 authentication. */ username?: any; /** * Version of the linked service. */ version?: string; } /** * ServiceNowV2 server dataset. */ interface ServiceNowV2ObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'ServiceNowV2Object'. */ type: "ServiceNowV2Object"; /** * Type of value copied from source. */ valueType?: string; } /** * A copy activity ServiceNowV2 server source. */ interface ServiceNowV2SourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Expression to filter data from source. */ expression?: outputs.datafactory.ExpressionV2Response; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Page size of the result. Type: integer (or Expression with resultType integer). */ pageSize?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'ServiceNowV2Source'. */ type: "ServiceNowV2Source"; } /** * Service principal credential. */ interface ServicePrincipalCredentialResponse { /** * List of tags that can be used for describing the Credential. */ annotations?: any[]; /** * Credential description. */ description?: string; /** * The app ID of the service principal used to authenticate */ servicePrincipalId?: any; /** * The key of the service principal used to authenticate. */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * The ID of the tenant to which the service principal belongs */ tenant?: any; /** * Type of credential. * Expected value is 'ServicePrincipal'. */ type: "ServicePrincipal"; } /** * Set value for a Variable. */ interface SetVariableActivityResponse { /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.SecureInputOutputPolicyResponse; /** * If set to true, it sets the pipeline run return value. */ setSystemVariable?: boolean; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'SetVariable'. */ type: "SetVariable"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; /** * Value to be set. Could be a static value or Expression. */ value?: any; /** * Name of the variable whose value needs to be set. */ variableName?: string; } /** * The location of SFTP dataset. */ interface SftpLocationResponse { /** * Specify the file name of dataset. Type: string (or Expression with resultType string). */ fileName?: any; /** * Specify the folder path of dataset. Type: string (or Expression with resultType string) */ folderPath?: any; /** * Type of dataset storage location. * Expected value is 'SftpLocation'. */ type: "SftpLocation"; } /** * Sftp read settings. */ interface SftpReadSettingsResponse { /** * Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean). */ deleteFilesAfterCompletion?: any; /** * If true, disable parallel reading within each file. Default is false. Type: boolean (or Expression with resultType boolean). */ disableChunking?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Indicates whether to enable partition discovery. Type: boolean (or Expression with resultType boolean). */ enablePartitionDiscovery?: any; /** * Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string). */ fileListPath?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The end of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeEnd?: any; /** * The start of file's modified datetime. Type: string (or Expression with resultType string). */ modifiedDatetimeStart?: any; /** * Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string). */ partitionRootPath?: any; /** * If true, files under the folder path will be read recursively. Default is true. Type: boolean (or Expression with resultType boolean). */ recursive?: any; /** * The read setting type. * Expected value is 'SftpReadSettings'. */ type: "SftpReadSettings"; /** * Sftp wildcardFileName. Type: string (or Expression with resultType string). */ wildcardFileName?: any; /** * Sftp wildcardFolderPath. Type: string (or Expression with resultType string). */ wildcardFolderPath?: any; } /** * A linked service for an SSH File Transfer Protocol (SFTP) server. */ interface SftpServerLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The authentication type to be used to connect to the FTP server. */ authenticationType?: string; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The SFTP server host name. Type: string (or Expression with resultType string). */ host: any; /** * The host key finger-print of the SFTP server. When SkipHostKeyValidation is false, HostKeyFingerprint should be specified. Type: string (or Expression with resultType string). */ hostKeyFingerprint?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password to decrypt the SSH private key if the SSH private key is encrypted. */ passPhrase?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Password to logon the SFTP server for Basic authentication. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The TCP port number that the SFTP server uses to listen for client connections. Default value is 22. Type: integer (or Expression with resultType integer), minimum: 0. */ port?: any; /** * Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. */ privateKeyContent?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The SSH private key file path for SshPublicKey authentication. Only valid for on-premises copy. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format. Type: string (or Expression with resultType string). */ privateKeyPath?: any; /** * If true, skip the SSH host key validation. Default value is false. Type: boolean (or Expression with resultType boolean). */ skipHostKeyValidation?: any; /** * Type of linked service. * Expected value is 'Sftp'. */ type: "Sftp"; /** * The username used to log on to the SFTP server. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * Sftp write settings. */ interface SftpWriteSettingsResponse { /** * The type of copy behavior for copy sink. */ copyBehavior?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Specify the custom metadata to be added to sink data. Type: array of objects (or Expression with resultType array of objects). */ metadata?: outputs.datafactory.MetadataItemResponse[]; /** * Specifies the timeout for writing each chunk to SFTP server. Default value: 01:00:00 (one hour). Type: string (or Expression with resultType string). */ operationTimeout?: any; /** * The write setting type. * Expected value is 'SftpWriteSettings'. */ type: "SftpWriteSettings"; /** * Upload to temporary file(s) and rename. Disable this option if your SFTP server doesn't support rename operation. Type: boolean (or Expression with resultType boolean). */ useTempFileRename?: any; } /** * SharePoint Online List linked service. */ interface SharePointOnlineListLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). */ servicePrincipalCredentialType?: any; /** * Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). */ servicePrincipalEmbeddedCert?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string). */ servicePrincipalEmbeddedCertPassword?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The application (client) ID of your application registered in Azure Active Directory. Make sure to grant SharePoint site permission to this application. Type: string (or Expression with resultType string). */ servicePrincipalId: any; /** * The client secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string). */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The URL of the SharePoint Online site. For example, https://contoso.sharepoint.com/sites/siteName. Type: string (or Expression with resultType string). */ siteUrl: any; /** * The tenant ID under which your application resides. You can find it from Azure portal Active Directory overview page. Type: string (or Expression with resultType string). */ tenantId: any; /** * Type of linked service. * Expected value is 'SharePointOnlineList'. */ type: "SharePointOnlineList"; /** * Version of the linked service. */ version?: string; } /** * The sharepoint online list resource dataset. */ interface SharePointOnlineListResourceDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The name of the SharePoint Online list. Type: string (or Expression with resultType string). */ listName?: any; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'SharePointOnlineListResource'. */ type: "SharePointOnlineListResource"; } /** * A copy activity source for sharePoint online list source. */ interface SharePointOnlineListSourceResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The wait time to get a response from SharePoint Online. Default value is 5 minutes (00:05:00). Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ httpRequestTimeout?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The OData query to filter the data in SharePoint Online list. For example, "$top=1". Type: string (or Expression with resultType string). */ query?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'SharePointOnlineListSource'. */ type: "SharePointOnlineListSource"; } /** * Shopify Service linked service. */ interface ShopifyLinkedServiceResponse { /** * The API access token that can be used to access Shopify’s data. The token won't expire if it is offline mode. */ accessToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The endpoint of the Shopify server. (i.e. mystore.myshopify.com) */ host: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'Shopify'. */ type: "Shopify"; /** * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. */ useEncryptedEndpoints?: any; /** * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. */ useHostVerification?: any; /** * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. */ usePeerVerification?: any; /** * Version of the linked service. */ version?: string; } /** * Shopify Service dataset. */ interface ShopifyObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'ShopifyObject'. */ type: "ShopifyObject"; } /** * A copy activity Shopify Service source. */ interface ShopifySourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'ShopifySource'. */ type: "ShopifySource"; } /** * Skip error file. */ interface SkipErrorFileResponse { /** * Skip if source/sink file changed by other concurrent write. Default is false. Type: boolean (or Expression with resultType boolean). */ dataInconsistency?: any; /** * Skip if file is deleted by other client during copy. Default is true. Type: boolean (or Expression with resultType boolean). */ fileMissing?: any; } /** * Linked service for Smartsheet. */ interface SmartsheetLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The api token for the Smartsheet source. */ apiToken: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'Smartsheet'. */ type: "Smartsheet"; /** * Version of the linked service. */ version?: string; } /** * The snowflake dataset. */ interface SnowflakeDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Snowflake database. Type: string (or Expression with resultType string). */ table?: any; /** * Type of dataset. * Expected value is 'SnowflakeTable'. */ type: "SnowflakeTable"; } /** * Snowflake export command settings. */ interface SnowflakeExportCopyCommandResponse { /** * Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: "additionalCopyOptions": { "DATE_FORMAT": "MM/DD/YYYY", "TIME_FORMAT": "'HH24:MI:SS.FF'" } */ additionalCopyOptions?: any; /** * Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: "additionalFormatOptions": { "OVERWRITE": "TRUE", "MAX_FILE_SIZE": "'FALSE'" } */ additionalFormatOptions?: any; /** * The name of the snowflake storage integration to use for the copy operation. Type: string (or Expression with resultType string). */ storageIntegration?: any; /** * The export setting type. * Expected value is 'SnowflakeExportCopyCommand'. */ type: "SnowflakeExportCopyCommand"; } /** * Snowflake import command settings. */ interface SnowflakeImportCopyCommandResponse { /** * Additional copy options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: "additionalCopyOptions": { "DATE_FORMAT": "MM/DD/YYYY", "TIME_FORMAT": "'HH24:MI:SS.FF'" } */ additionalCopyOptions?: any; /** * Additional format options directly passed to snowflake Copy Command. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: "additionalFormatOptions": { "FORCE": "TRUE", "LOAD_UNCERTAIN_FILES": "'FALSE'" } */ additionalFormatOptions?: any; /** * The name of the snowflake storage integration to use for the copy operation. Type: string (or Expression with resultType string). */ storageIntegration?: any; /** * The import setting type. * Expected value is 'SnowflakeImportCopyCommand'. */ type: "SnowflakeImportCopyCommand"; } /** * Snowflake linked service. */ interface SnowflakeLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The connection string of snowflake. Type: string, SecureString. */ connectionString: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of password in connection string. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * Type of linked service. * Expected value is 'Snowflake'. */ type: "Snowflake"; /** * Version of the linked service. */ version?: string; } /** * A copy activity snowflake sink. */ interface SnowflakeSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Snowflake import settings. */ importSettings?: outputs.datafactory.SnowflakeImportCopyCommandResponse; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * SQL pre-copy script. Type: string (or Expression with resultType string). */ preCopyScript?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'SnowflakeSink'. */ type: "SnowflakeSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity snowflake source. */ interface SnowflakeSourceResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Snowflake export settings. */ exportSettings: outputs.datafactory.SnowflakeExportCopyCommandResponse; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Snowflake Sql query. Type: string (or Expression with resultType string). */ query?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'SnowflakeSource'. */ type: "SnowflakeSource"; } /** * The snowflake dataset. */ interface SnowflakeV2DatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Snowflake database. Type: string (or Expression with resultType string). */ table?: any; /** * Type of dataset. * Expected value is 'SnowflakeV2Table'. */ type: "SnowflakeV2Table"; } /** * Snowflake linked service. */ interface SnowflakeV2LinkedServiceResponse { /** * The account identifier of your Snowflake account, e.g. xy12345.east-us-2.azure */ accountIdentifier: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The type used for authentication. Type: string. */ authenticationType?: string; /** * The client ID of the application registered in Azure Active Directory for AADServicePrincipal authentication. */ clientId?: any; /** * The Azure key vault secret reference of client secret for AADServicePrincipal authentication. */ clientSecret?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The name of the Snowflake database. */ database: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The host name of the Snowflake account. Type: string (or Expression with resultType string). */ host?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The Azure key vault secret reference of password in connection string. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The Azure key vault secret reference of privateKey for KeyPair auth. */ privateKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The Azure key vault secret reference of private key password for KeyPair auth with encrypted private key. */ privateKeyPassphrase?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The default access control role to use in the Snowflake session. Type: string (or Expression with resultType string). */ role?: any; /** * Schema name for connection. Type: string (or Expression with resultType string). */ schema?: any; /** * The scope of the application registered in Azure Active Directory for AADServicePrincipal authentication. */ scope?: any; /** * The tenant ID of the application registered in Azure Active Directory for AADServicePrincipal authentication. */ tenantId?: any; /** * Type of linked service. * Expected value is 'SnowflakeV2'. */ type: "SnowflakeV2"; /** * Indicates whether to use UTC timezone for timestamp data types. Type: boolean. */ useUtcTimestamps?: any; /** * The name of the Snowflake user. */ user?: any; /** * Version of the linked service. */ version?: string; /** * The name of the Snowflake warehouse. */ warehouse: any; } /** * snowflakeV2LinkedServiceResponseProvideDefaults sets the appropriate defaults for SnowflakeV2LinkedServiceResponse */ function snowflakeV2LinkedServiceResponseProvideDefaults(val: SnowflakeV2LinkedServiceResponse): SnowflakeV2LinkedServiceResponse; /** * A copy activity snowflake sink. */ interface SnowflakeV2SinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Snowflake import settings. */ importSettings?: outputs.datafactory.SnowflakeImportCopyCommandResponse; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * SQL pre-copy script. Type: string (or Expression with resultType string). */ preCopyScript?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'SnowflakeV2Sink'. */ type: "SnowflakeV2Sink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity snowflake source. */ interface SnowflakeV2SourceResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Snowflake export settings. */ exportSettings: outputs.datafactory.SnowflakeExportCopyCommandResponse; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Snowflake Sql query. Type: string (or Expression with resultType string). */ query?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'SnowflakeV2Source'. */ type: "SnowflakeV2Source"; } /** * Spark configuration reference. */ interface SparkConfigurationParametrizationReferenceResponse { /** * Reference spark configuration name. Type: string (or Expression with resultType string). */ referenceName: any; /** * Spark configuration reference type. */ type: string; } /** * Spark Server linked service. */ interface SparkLinkedServiceResponse { /** * Specifies whether to require a CA-issued SSL certificate name to match the host name of the server when connecting over SSL. The default value is false. */ allowHostNameCNMismatch?: any; /** * Specifies whether to allow self-signed certificates from the server. The default value is false. */ allowSelfSignedServerCert?: any; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The authentication method used to access the Spark server. */ authenticationType: string; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * Specifies whether the connections to the server will validate server certificate, the default value is True. Only used for Version 2.0 */ enableServerCertificateValidation?: any; /** * Specifies whether the connections to the server are encrypted using SSL. The default value is false. */ enableSsl?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * IP address or host name of the Spark server */ host: any; /** * The partial URL corresponding to the Spark server. */ httpPath?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password corresponding to the user name that you provided in the Username field */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The TCP port that the Spark server uses to listen for client connections. */ port: any; /** * The type of Spark server. */ serverType?: string; /** * The transport protocol to use in the Thrift layer. */ thriftTransportProtocol?: string; /** * The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. */ trustedCertPath?: any; /** * Type of linked service. * Expected value is 'Spark'. */ type: "Spark"; /** * Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false. */ useSystemTrustStore?: any; /** * The user name that you use to access Spark Server. */ username?: any; /** * Version of the linked service. */ version?: string; } /** * Spark Server dataset. */ interface SparkObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Spark. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using schema + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'SparkObject'. */ type: "SparkObject"; } /** * A copy activity Spark Server source. */ interface SparkSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'SparkSource'. */ type: "SparkSource"; } /** * Sql always encrypted properties. */ interface SqlAlwaysEncryptedPropertiesResponse { /** * Sql always encrypted AKV authentication type. Type: string. */ alwaysEncryptedAkvAuthType: string; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * The client ID of the application in Azure Active Directory used for Azure Key Vault authentication. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The key of the service principal used to authenticate against Azure Key Vault. */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; } /** * A copy activity SQL Data Warehouse sink. */ interface SqlDWSinkResponse { /** * Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean). */ allowCopyCommand?: any; /** * Indicates to use PolyBase to copy data into SQL Data Warehouse when applicable. Type: boolean (or Expression with resultType boolean). */ allowPolyBase?: any; /** * Specifies Copy Command related settings when allowCopyCommand is true. */ copyCommandSettings?: outputs.datafactory.DWCopyCommandSettingsResponse; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Specifies PolyBase-related settings when allowPolyBase is true. */ polyBaseSettings?: outputs.datafactory.PolybaseSettingsResponse; /** * SQL pre-copy script. Type: string (or Expression with resultType string). */ preCopyScript?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean). */ sqlWriterUseTableLock?: any; /** * The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string). */ tableOption?: any; /** * Copy sink type. * Expected value is 'SqlDWSink'. */ type: "SqlDWSink"; /** * SQL DW upsert settings. */ upsertSettings?: outputs.datafactory.SqlDWUpsertSettingsResponse; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * Write behavior when copying data into azure SQL DW. Type: SqlDWWriteBehaviorEnum (or Expression with resultType SqlDWWriteBehaviorEnum) */ writeBehavior?: any; } /** * A copy activity SQL Data Warehouse source. */ interface SqlDWSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string). */ isolationLevel?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange". Type: string (or Expression with resultType string). */ partitionOption?: any; /** * The settings that will be leveraged for Sql source partitioning. */ partitionSettings?: outputs.datafactory.SqlPartitionSettingsResponse; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * SQL Data Warehouse reader query. Type: string (or Expression with resultType string). */ sqlReaderQuery?: any; /** * Name of the stored procedure for a SQL Data Warehouse source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string). */ sqlReaderStoredProcedureName?: any; /** * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter. */ storedProcedureParameters?: any; /** * Copy source type. * Expected value is 'SqlDWSource'. */ type: "SqlDWSource"; } /** * Sql DW upsert option settings */ interface SqlDWUpsertSettingsResponse { /** * Schema name for interim table. Type: string (or Expression with resultType string). */ interimSchemaName?: any; /** * Key column names for unique row identification. Type: array of strings (or Expression with resultType array of strings). */ keys?: any; } /** * A copy activity Azure SQL Managed Instance sink. */ interface SqlMISinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * SQL pre-copy script. Type: string (or Expression with resultType string). */ preCopyScript?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * SQL writer stored procedure name. Type: string (or Expression with resultType string). */ sqlWriterStoredProcedureName?: any; /** * SQL writer table type. Type: string (or Expression with resultType string). */ sqlWriterTableType?: any; /** * Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean). */ sqlWriterUseTableLock?: any; /** * SQL stored procedure parameters. */ storedProcedureParameters?: any; /** * The stored procedure parameter name of the table type. Type: string (or Expression with resultType string). */ storedProcedureTableTypeParameterName?: any; /** * The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string). */ tableOption?: any; /** * Copy sink type. * Expected value is 'SqlMISink'. */ type: "SqlMISink"; /** * SQL upsert settings. */ upsertSettings?: outputs.datafactory.SqlUpsertSettingsResponse; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * White behavior when copying data into azure SQL MI. Type: string (or Expression with resultType string) */ writeBehavior?: any; } /** * A copy activity Azure SQL Managed Instance source. */ interface SqlMISourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string). */ isolationLevel?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange". Type: string (or Expression with resultType string). */ partitionOption?: any; /** * The settings that will be leveraged for Sql source partitioning. */ partitionSettings?: outputs.datafactory.SqlPartitionSettingsResponse; /** * Which additional types to produce. */ produceAdditionalTypes?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * SQL reader query. Type: string (or Expression with resultType string). */ sqlReaderQuery?: any; /** * Name of the stored procedure for a Azure SQL Managed Instance source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string). */ sqlReaderStoredProcedureName?: any; /** * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". */ storedProcedureParameters?: any; /** * Copy source type. * Expected value is 'SqlMISource'. */ type: "SqlMISource"; } /** * The settings that will be leveraged for Sql source partitioning. */ interface SqlPartitionSettingsResponse { /** * The name of the column in integer or datetime type that will be used for proceeding partitioning. If not specified, the primary key of the table is auto-detected and used as the partition column. Type: string (or Expression with resultType string). */ partitionColumnName?: any; /** * The minimum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string). */ partitionLowerBound?: any; /** * The maximum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string). */ partitionUpperBound?: any; } /** * SQL Server linked service. */ interface SqlServerLinkedServiceResponse { /** * Sql always encrypted properties. */ alwaysEncryptedSettings?: outputs.datafactory.SqlAlwaysEncryptedPropertiesResponse; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The application workload type when connecting to a server, used by recommended version. Possible values are ReadOnly and ReadWrite. Type: string (or Expression with resultType string). */ applicationIntent?: any; /** * The type used for authentication. Type: string. */ authenticationType?: string; /** * The default wait time (in seconds) before terminating the attempt to execute a command and generating an error, used by recommended version. Type: integer (or Expression with resultType integer). */ commandTimeout?: any; /** * The number of re-connections attempted after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 0 and 255. Type: integer (or Expression with resultType integer). */ connectRetryCount?: any; /** * The amount of time (in seconds) between each re-connection attempt after identifying that there was an idle connection failure, used by recommended version. This must be an integer between 1 and 60. Type: integer (or Expression with resultType integer). */ connectRetryInterval?: any; /** * The length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error, used by recommended version. Type: integer (or Expression with resultType integer). */ connectTimeout?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The connection string. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * The name of the database, used by recommended version. Type: string (or Expression with resultType string). */ database?: any; /** * Linked service description. */ description?: string; /** * Indicate whether TLS encryption is required for all data sent between the client and server, used by recommended version. Possible values are true/yes/mandatory, false/no/optional and strict. Type: string (or Expression with resultType string). */ encrypt?: any; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The name or address of the partner server to connect to if the primary server is down, used by recommended version. Type: string (or Expression with resultType string). */ failoverPartner?: any; /** * The host name to use when validating the server certificate for the connection. When not specified, the server name from the Data Source is used for certificate validation, used by recommended version. Type: string (or Expression with resultType string). */ hostNameInCertificate?: any; /** * Indicate whether User ID and Password are specified in the connection (when false) or whether the current Windows account credentials are used for authentication (when true), used by recommended version. Type: Boolean (or Expression with resultType boolean). */ integratedSecurity?: any; /** * The minimum time, in seconds, for the connection to live in the connection pool before being destroyed, used by recommended version. Type: integer (or Expression with resultType integer). */ loadBalanceTimeout?: any; /** * The maximum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer). */ maxPoolSize?: any; /** * The minimum number of connections allowed in the connection pool for this specific connection string, used by recommended version. Type: integer (or Expression with resultType integer). */ minPoolSize?: any; /** * If your application is connecting to an AlwaysOn availability group (AG) on different subnets, setting MultiSubnetFailover=true provides faster detection of and connection to the (currently) active server, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ multiSubnetFailover?: any; /** * When true, an application can maintain multiple active result sets (MARS). When false, an application must process or cancel all result sets from one batch before it can execute any other batch on that connection, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ multipleActiveResultSets?: any; /** * The size in bytes of the network packets used to communicate with an instance of server, used by recommended version. Type: integer (or Expression with resultType integer). */ packetSize?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The on-premises Windows authentication password. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Indicate whether the connection will be pooled or explicitly opened every time that the connection is requested, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ pooling?: any; /** * The name or network address of the instance of SQL Server to which to connect, used by recommended version. Type: string (or Expression with resultType string). */ server?: any; /** * Indicate whether the channel will be encrypted while bypassing walking the certificate chain to validate trust, used by recommended version. Type: Boolean (or Expression with resultType boolean). */ trustServerCertificate?: any; /** * Type of linked service. * Expected value is 'SqlServer'. */ type: "SqlServer"; /** * The on-premises Windows authentication user name. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity SQL server sink. */ interface SqlServerSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * SQL pre-copy script. Type: string (or Expression with resultType string). */ preCopyScript?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * SQL writer stored procedure name. Type: string (or Expression with resultType string). */ sqlWriterStoredProcedureName?: any; /** * SQL writer table type. Type: string (or Expression with resultType string). */ sqlWriterTableType?: any; /** * Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean). */ sqlWriterUseTableLock?: any; /** * SQL stored procedure parameters. */ storedProcedureParameters?: any; /** * The stored procedure parameter name of the table type. Type: string (or Expression with resultType string). */ storedProcedureTableTypeParameterName?: any; /** * The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string). */ tableOption?: any; /** * Copy sink type. * Expected value is 'SqlServerSink'. */ type: "SqlServerSink"; /** * SQL upsert settings. */ upsertSettings?: outputs.datafactory.SqlUpsertSettingsResponse; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * Write behavior when copying data into sql server. Type: string (or Expression with resultType string). */ writeBehavior?: any; } /** * A copy activity SQL server source. */ interface SqlServerSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string). */ isolationLevel?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange". Type: string (or Expression with resultType string). */ partitionOption?: any; /** * The settings that will be leveraged for Sql source partitioning. */ partitionSettings?: outputs.datafactory.SqlPartitionSettingsResponse; /** * Which additional types to produce. */ produceAdditionalTypes?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * SQL reader query. Type: string (or Expression with resultType string). */ sqlReaderQuery?: any; /** * Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string). */ sqlReaderStoredProcedureName?: any; /** * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". */ storedProcedureParameters?: any; /** * Copy source type. * Expected value is 'SqlServerSource'. */ type: "SqlServerSource"; } /** * SQL stored procedure activity type. */ interface SqlServerStoredProcedureActivityResponse { /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Stored procedure name. Type: string (or Expression with resultType string). */ storedProcedureName: any; /** * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". */ storedProcedureParameters?: any; /** * Type of activity. * Expected value is 'SqlServerStoredProcedure'. */ type: "SqlServerStoredProcedure"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * The on-premises SQL Server dataset. */ interface SqlServerTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the SQL Server dataset. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using schema + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'SqlServerTable'. */ type: "SqlServerTable"; } /** * A copy activity SQL sink. */ interface SqlSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * SQL pre-copy script. Type: string (or Expression with resultType string). */ preCopyScript?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * SQL writer stored procedure name. Type: string (or Expression with resultType string). */ sqlWriterStoredProcedureName?: any; /** * SQL writer table type. Type: string (or Expression with resultType string). */ sqlWriterTableType?: any; /** * Whether to use table lock during bulk copy. Type: boolean (or Expression with resultType boolean). */ sqlWriterUseTableLock?: any; /** * SQL stored procedure parameters. */ storedProcedureParameters?: any; /** * The stored procedure parameter name of the table type. Type: string (or Expression with resultType string). */ storedProcedureTableTypeParameterName?: any; /** * The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string). */ tableOption?: any; /** * Copy sink type. * Expected value is 'SqlSink'. */ type: "SqlSink"; /** * SQL upsert settings. */ upsertSettings?: outputs.datafactory.SqlUpsertSettingsResponse; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * Write behavior when copying data into sql. Type: string (or Expression with resultType string). */ writeBehavior?: any; } /** * A copy activity SQL source. */ interface SqlSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string). */ isolationLevel?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange". Type: string (or Expression with resultType string). */ partitionOption?: any; /** * The settings that will be leveraged for Sql source partitioning. */ partitionSettings?: outputs.datafactory.SqlPartitionSettingsResponse; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * SQL reader query. Type: string (or Expression with resultType string). */ sqlReaderQuery?: any; /** * Name of the stored procedure for a SQL Database source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string). */ sqlReaderStoredProcedureName?: any; /** * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". */ storedProcedureParameters?: any; /** * Copy source type. * Expected value is 'SqlSource'. */ type: "SqlSource"; } /** * Sql upsert option settings */ interface SqlUpsertSettingsResponse { /** * Schema name for interim table. Type: string (or Expression with resultType string). */ interimSchemaName?: any; /** * Key column names for unique row identification. Type: array of strings (or Expression with resultType array of strings). */ keys?: any; /** * Specifies whether to use temp db for upsert interim table. Type: boolean (or Expression with resultType boolean). */ useTempDB?: any; } /** * Square Service linked service. */ interface SquareLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The client ID associated with your Square application. */ clientId?: any; /** * The client secret associated with your Square application. */ clientSecret?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Properties used to connect to Square. It is mutually exclusive with any other properties in the linked service. Type: object. */ connectionProperties?: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The URL of the Square instance. (i.e. mystore.mysquare.com) */ host?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500) */ redirectUri?: any; /** * Type of linked service. * Expected value is 'Square'. */ type: "Square"; /** * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. */ useEncryptedEndpoints?: any; /** * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. */ useHostVerification?: any; /** * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. */ usePeerVerification?: any; /** * Version of the linked service. */ version?: string; } /** * Square Service dataset. */ interface SquareObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'SquareObject'. */ type: "SquareObject"; } /** * A copy activity Square Service source. */ interface SquareSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'SquareSource'. */ type: "SquareSource"; } /** * Ssis environment reference. */ interface SsisEnvironmentReferenceResponse { /** * Environment folder name. */ environmentFolderName?: string; /** * Environment name. */ environmentName?: string; /** * Environment reference id. */ id?: number; /** * Reference type */ referenceType?: string; } /** * Ssis environment. */ interface SsisEnvironmentResponse { /** * Metadata description. */ description?: string; /** * Folder id which contains environment. */ folderId?: number; /** * Metadata id. */ id?: number; /** * Metadata name. */ name?: string; /** * The type of SSIS object metadata. * Expected value is 'Environment'. */ type: "Environment"; /** * Variable in environment */ variables?: outputs.datafactory.SsisVariableResponse[]; } /** * Ssis folder. */ interface SsisFolderResponse { /** * Metadata description. */ description?: string; /** * Metadata id. */ id?: number; /** * Metadata name. */ name?: string; /** * The type of SSIS object metadata. * Expected value is 'Folder'. */ type: "Folder"; } /** * Ssis Package. */ interface SsisPackageResponse { /** * Metadata description. */ description?: string; /** * Folder id which contains package. */ folderId?: number; /** * Metadata id. */ id?: number; /** * Metadata name. */ name?: string; /** * Parameters in package */ parameters?: outputs.datafactory.SsisParameterResponse[]; /** * Project id which contains package. */ projectId?: number; /** * Project version which contains package. */ projectVersion?: number; /** * The type of SSIS object metadata. * Expected value is 'Package'. */ type: "Package"; } /** * Ssis parameter. */ interface SsisParameterResponse { /** * Parameter type. */ dataType?: string; /** * Default value of parameter. */ defaultValue?: string; /** * Parameter description. */ description?: string; /** * Design default value of parameter. */ designDefaultValue?: string; /** * Parameter id. */ id?: number; /** * Parameter name. */ name?: string; /** * Whether parameter is required. */ required?: boolean; /** * Whether parameter is sensitive. */ sensitive?: boolean; /** * Default sensitive value of parameter. */ sensitiveDefaultValue?: string; /** * Parameter value set. */ valueSet?: boolean; /** * Parameter value type. */ valueType?: string; /** * Parameter reference variable. */ variable?: string; } /** * Ssis project. */ interface SsisProjectResponse { /** * Metadata description. */ description?: string; /** * Environment reference in project */ environmentRefs?: outputs.datafactory.SsisEnvironmentReferenceResponse[]; /** * Folder id which contains project. */ folderId?: number; /** * Metadata id. */ id?: number; /** * Metadata name. */ name?: string; /** * Parameters in project */ parameters?: outputs.datafactory.SsisParameterResponse[]; /** * The type of SSIS object metadata. * Expected value is 'Project'. */ type: "Project"; /** * Project version. */ version?: number; } /** * Ssis variable. */ interface SsisVariableResponse { /** * Variable type. */ dataType?: string; /** * Variable description. */ description?: string; /** * Variable id. */ id?: number; /** * Variable name. */ name?: string; /** * Whether variable is sensitive. */ sensitive?: boolean; /** * Variable sensitive value. */ sensitiveValue?: string; /** * Variable value. */ value?: string; } /** * Staging settings. */ interface StagingSettingsResponse { /** * Specifies whether to use compression when copying data via an interim staging. Default value is false. Type: boolean (or Expression with resultType boolean). */ enableCompression?: any; /** * Staging linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The path to storage for storing the interim data. Type: string (or Expression with resultType string). */ path?: any; } /** * This activity evaluates an expression and executes activities under the cases property that correspond to the expression evaluation expected in the equals property. */ interface SwitchActivityResponse { /** * List of cases that correspond to expected values of the 'on' property. This is an optional property and if not provided, the activity will execute activities provided in defaultActivities. */ cases?: outputs.datafactory.SwitchCaseResponse[]; /** * List of activities to execute if no case condition is satisfied. This is an optional property and if not provided, the activity will exit without any action. */ defaultActivities?: (outputs.datafactory.AppendVariableActivityResponse | outputs.datafactory.AzureDataExplorerCommandActivityResponse | outputs.datafactory.AzureFunctionActivityResponse | outputs.datafactory.AzureMLBatchExecutionActivityResponse | outputs.datafactory.AzureMLExecutePipelineActivityResponse | outputs.datafactory.AzureMLUpdateResourceActivityResponse | outputs.datafactory.ControlActivityResponse | outputs.datafactory.CopyActivityResponse | outputs.datafactory.CustomActivityResponse | outputs.datafactory.DataLakeAnalyticsUSQLActivityResponse | outputs.datafactory.DatabricksJobActivityResponse | outputs.datafactory.DatabricksNotebookActivityResponse | outputs.datafactory.DatabricksSparkJarActivityResponse | outputs.datafactory.DatabricksSparkPythonActivityResponse | outputs.datafactory.DeleteActivityResponse | outputs.datafactory.ExecuteDataFlowActivityResponse | outputs.datafactory.ExecutePipelineActivityResponse | outputs.datafactory.ExecuteSSISPackageActivityResponse | outputs.datafactory.ExecuteWranglingDataflowActivityResponse | outputs.datafactory.ExecutionActivityResponse | outputs.datafactory.FailActivityResponse | outputs.datafactory.FilterActivityResponse | outputs.datafactory.ForEachActivityResponse | outputs.datafactory.GetMetadataActivityResponse | outputs.datafactory.HDInsightHiveActivityResponse | outputs.datafactory.HDInsightMapReduceActivityResponse | outputs.datafactory.HDInsightPigActivityResponse | outputs.datafactory.HDInsightSparkActivityResponse | outputs.datafactory.HDInsightStreamingActivityResponse | outputs.datafactory.IfConditionActivityResponse | outputs.datafactory.LookupActivityResponse | outputs.datafactory.ScriptActivityResponse | outputs.datafactory.SetVariableActivityResponse | outputs.datafactory.SqlServerStoredProcedureActivityResponse | outputs.datafactory.SwitchActivityResponse | outputs.datafactory.SynapseNotebookActivityResponse | outputs.datafactory.SynapseSparkJobDefinitionActivityResponse | outputs.datafactory.UntilActivityResponse | outputs.datafactory.ValidationActivityResponse | outputs.datafactory.WaitActivityResponse | outputs.datafactory.WebActivityResponse | outputs.datafactory.WebHookActivityResponse)[]; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Activity name. */ name: string; /** * An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed. */ on: outputs.datafactory.ExpressionResponse; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'Switch'. */ type: "Switch"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Switch cases with have a value and corresponding activities. */ interface SwitchCaseResponse { /** * List of activities to execute for satisfied case condition. */ activities?: (outputs.datafactory.AppendVariableActivityResponse | outputs.datafactory.AzureDataExplorerCommandActivityResponse | outputs.datafactory.AzureFunctionActivityResponse | outputs.datafactory.AzureMLBatchExecutionActivityResponse | outputs.datafactory.AzureMLExecutePipelineActivityResponse | outputs.datafactory.AzureMLUpdateResourceActivityResponse | outputs.datafactory.ControlActivityResponse | outputs.datafactory.CopyActivityResponse | outputs.datafactory.CustomActivityResponse | outputs.datafactory.DataLakeAnalyticsUSQLActivityResponse | outputs.datafactory.DatabricksJobActivityResponse | outputs.datafactory.DatabricksNotebookActivityResponse | outputs.datafactory.DatabricksSparkJarActivityResponse | outputs.datafactory.DatabricksSparkPythonActivityResponse | outputs.datafactory.DeleteActivityResponse | outputs.datafactory.ExecuteDataFlowActivityResponse | outputs.datafactory.ExecutePipelineActivityResponse | outputs.datafactory.ExecuteSSISPackageActivityResponse | outputs.datafactory.ExecuteWranglingDataflowActivityResponse | outputs.datafactory.ExecutionActivityResponse | outputs.datafactory.FailActivityResponse | outputs.datafactory.FilterActivityResponse | outputs.datafactory.ForEachActivityResponse | outputs.datafactory.GetMetadataActivityResponse | outputs.datafactory.HDInsightHiveActivityResponse | outputs.datafactory.HDInsightMapReduceActivityResponse | outputs.datafactory.HDInsightPigActivityResponse | outputs.datafactory.HDInsightSparkActivityResponse | outputs.datafactory.HDInsightStreamingActivityResponse | outputs.datafactory.IfConditionActivityResponse | outputs.datafactory.LookupActivityResponse | outputs.datafactory.ScriptActivityResponse | outputs.datafactory.SetVariableActivityResponse | outputs.datafactory.SqlServerStoredProcedureActivityResponse | outputs.datafactory.SwitchActivityResponse | outputs.datafactory.SynapseNotebookActivityResponse | outputs.datafactory.SynapseSparkJobDefinitionActivityResponse | outputs.datafactory.UntilActivityResponse | outputs.datafactory.ValidationActivityResponse | outputs.datafactory.WaitActivityResponse | outputs.datafactory.WebActivityResponse | outputs.datafactory.WebHookActivityResponse)[]; /** * Expected value that satisfies the expression result of the 'on' property. */ value?: string; } /** * Linked service for Sybase data source. */ interface SybaseLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * AuthenticationType to be used for connection. */ authenticationType?: string; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Database name for connection. Type: string (or Expression with resultType string). */ database: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password for authentication. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Schema name for connection. Type: string (or Expression with resultType string). */ schema?: any; /** * Server name for connection. Type: string (or Expression with resultType string). */ server: any; /** * Type of linked service. * Expected value is 'Sybase'. */ type: "Sybase"; /** * Username for authentication. Type: string (or Expression with resultType string). */ username?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity source for Sybase databases. */ interface SybaseSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Database query. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'SybaseSource'. */ type: "SybaseSource"; } /** * The Sybase table dataset. */ interface SybaseTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The Sybase table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'SybaseTable'. */ type: "SybaseTable"; } /** * Execute Synapse notebook activity. */ interface SynapseNotebookActivityResponse { /** * Spark configuration properties, which will override the 'conf' of the notebook you provide. */ conf?: any; /** * The type of the spark config. */ configurationType?: string; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Number of core and memory to be used for driver allocated in the specified Spark pool for the session, which will be used for overriding 'driverCores' and 'driverMemory' of the notebook you provide. Type: string (or Expression with resultType string). */ driverSize?: any; /** * Number of core and memory to be used for executors allocated in the specified Spark pool for the session, which will be used for overriding 'executorCores' and 'executorMemory' of the notebook you provide. Type: string (or Expression with resultType string). */ executorSize?: any; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Synapse notebook reference. */ notebook: outputs.datafactory.SynapseNotebookReferenceResponse; /** * Number of executors to launch for this session, which will override the 'numExecutors' of the notebook you provide. Type: integer (or Expression with resultType integer). */ numExecutors?: any; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Notebook parameters. */ parameters?: { [key: string]: outputs.datafactory.NotebookParameterResponse; }; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Spark configuration property. */ sparkConfig?: any; /** * The name of the big data pool which will be used to execute the notebook. */ sparkPool?: outputs.datafactory.BigDataPoolParametrizationReferenceResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * The spark configuration of the spark job. */ targetSparkConfiguration?: outputs.datafactory.SparkConfigurationParametrizationReferenceResponse; /** * Type of activity. * Expected value is 'SynapseNotebook'. */ type: "SynapseNotebook"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Synapse notebook reference type. */ interface SynapseNotebookReferenceResponse { /** * Reference notebook name. Type: string (or Expression with resultType string). */ referenceName: any; /** * Synapse notebook reference type. */ type: string; } /** * Execute spark job activity. */ interface SynapseSparkJobDefinitionActivityResponse { /** * User specified arguments to SynapseSparkJobDefinitionActivity. */ arguments?: any[]; /** * The fully-qualified identifier or the main class that is in the main definition file, which will override the 'className' of the spark job definition you provide. Type: string (or Expression with resultType string). */ className?: any; /** * Spark configuration properties, which will override the 'conf' of the spark job definition you provide. */ conf?: any; /** * The type of the spark config. */ configurationType?: string; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Number of core and memory to be used for driver allocated in the specified Spark pool for the job, which will be used for overriding 'driverCores' and 'driverMemory' of the spark job definition you provide. Type: string (or Expression with resultType string). */ driverSize?: any; /** * Number of core and memory to be used for executors allocated in the specified Spark pool for the job, which will be used for overriding 'executorCores' and 'executorMemory' of the spark job definition you provide. Type: string (or Expression with resultType string). */ executorSize?: any; /** * The main file used for the job, which will override the 'file' of the spark job definition you provide. Type: string (or Expression with resultType string). */ file?: any; /** * (Deprecated. Please use pythonCodeReference and filesV2) Additional files used for reference in the main definition file, which will override the 'files' of the spark job definition you provide. */ files?: any[]; /** * Additional files used for reference in the main definition file, which will override the 'jars' and 'files' of the spark job definition you provide. */ filesV2?: any[]; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Activity name. */ name: string; /** * Number of executors to launch for this job, which will override the 'numExecutors' of the spark job definition you provide. Type: integer (or Expression with resultType integer). */ numExecutors?: any; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Additional python code files used for reference in the main definition file, which will override the 'pyFiles' of the spark job definition you provide. */ pythonCodeReference?: any[]; /** * Scanning subfolders from the root folder of the main definition file, these files will be added as reference files. The folders named 'jars', 'pyFiles', 'files' or 'archives' will be scanned, and the folders name are case sensitive. Type: boolean (or Expression with resultType boolean). */ scanFolder?: any; /** * Spark configuration property. */ sparkConfig?: any; /** * Synapse spark job reference. */ sparkJob: outputs.datafactory.SynapseSparkJobReferenceResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * The name of the big data pool which will be used to execute the spark batch job, which will override the 'targetBigDataPool' of the spark job definition you provide. */ targetBigDataPool?: outputs.datafactory.BigDataPoolParametrizationReferenceResponse; /** * The spark configuration of the spark job. */ targetSparkConfiguration?: outputs.datafactory.SparkConfigurationParametrizationReferenceResponse; /** * Type of activity. * Expected value is 'SparkJob'. */ type: "SparkJob"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Synapse spark job reference type. */ interface SynapseSparkJobReferenceResponse { /** * Reference spark job name. Expression with resultType string. */ referenceName: any; /** * Synapse spark job reference type. */ type: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Copy activity sources of tabular type. */ interface TabularSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'TabularSource'. */ type: "TabularSource"; } /** * The TarGZip compression read settings. */ interface TarGZipReadSettingsResponse { /** * Preserve the compression file name as folder path. Type: boolean (or Expression with resultType boolean). */ preserveCompressionFileNameAsFolder?: any; /** * The Compression setting type. * Expected value is 'TarGZipReadSettings'. */ type: "TarGZipReadSettings"; } /** * The Tar compression read settings. */ interface TarReadSettingsResponse { /** * Preserve the compression file name as folder path. Type: boolean (or Expression with resultType boolean). */ preserveCompressionFileNameAsFolder?: any; /** * The Compression setting type. * Expected value is 'TarReadSettings'. */ type: "TarReadSettings"; } /** * Linked service for TeamDesk. */ interface TeamDeskLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The api token for the TeamDesk source. */ apiToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The authentication type to use. */ authenticationType: string; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password of the TeamDesk source. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'TeamDesk'. */ type: "TeamDesk"; /** * The url to connect TeamDesk source. Type: string (or Expression with resultType string). */ url: any; /** * The username of the TeamDesk source. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * Teradata import command settings. */ interface TeradataImportCommandResponse { /** * Additional format options for Teradata Copy Command. The format options only applies to direct copy from CSV source. Type: key value pairs (value should be string type) (or Expression with resultType object). Example: "additionalFormatOptions": { "timeFormat": "HHhMImSSs" } */ additionalFormatOptions?: any; /** * The import setting type. * Expected value is 'TeradataImportCommand'. */ type: "TeradataImportCommand"; } /** * Linked service for Teradata data source. */ interface TeradataLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * AuthenticationType to be used for connection. */ authenticationType?: string; /** * The character set to use for the connection. Type: string (or Expression with resultType string). Only applied for version 2.0. */ characterSet?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Teradata ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. Only applied for version 1.0. */ connectionString?: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The port numbers when connecting to server through HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only applied for version 2.0. */ httpsPortNumber?: any; /** * The maximum size of the response buffer for SQL requests, in bytes. Type: integer. Only applied for version 2.0. */ maxRespSize?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Password for authentication. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The port numbers when connecting to server through non HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only used for V2. Only applied for version 2.0. */ portNumber?: any; /** * Server name for connection. Type: string (or Expression with resultType string). */ server?: any; /** * SSL mode for connection. Valid values including: “Disable”, “Allow”, “Prefer”, “Require”, “Verify-CA”, “Verify-Full”. Default value is “Verify-Full”. Type: string (or Expression with resultType string). Only applied for version 2.0. */ sslMode?: any; /** * Type of linked service. * Expected value is 'Teradata'. */ type: "Teradata"; /** * Specifies whether to encrypt all communication with the Teradata database. Allowed values are 0 or 1. This setting will be ignored for HTTPS/TLS connections. Type: integer (or Expression with resultType integer). Only applied for version 2.0. */ useDataEncryption?: any; /** * Username for authentication. Type: string (or Expression with resultType string). */ username?: any; /** * Version of the linked service. */ version?: string; } /** * The settings that will be leveraged for teradata source partitioning. */ interface TeradataPartitionSettingsResponse { /** * The name of the column that will be used for proceeding range or hash partitioning. Type: string (or Expression with resultType string). */ partitionColumnName?: any; /** * The minimum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string). */ partitionLowerBound?: any; /** * The maximum value of column specified in partitionColumnName that will be used for proceeding range partitioning. Type: string (or Expression with resultType string). */ partitionUpperBound?: any; } /** * A copy activity Teradata sink. */ interface TeradataSinkResponse { /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Teradata import settings. */ importSettings?: outputs.datafactory.TeradataImportCommandResponse; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * Copy sink type. * Expected value is 'TeradataSink'. */ type: "TeradataSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; } /** * A copy activity Teradata source. */ interface TeradataSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The partition mechanism that will be used for teradata read in parallel. Possible values include: "None", "Hash", "DynamicRange". */ partitionOption?: any; /** * The settings that will be leveraged for teradata source partitioning. */ partitionSettings?: outputs.datafactory.TeradataPartitionSettingsResponse; /** * Teradata query. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'TeradataSource'. */ type: "TeradataSource"; } /** * The Teradata database dataset. */ interface TeradataTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The database name of Teradata. Type: string (or Expression with resultType string). */ database?: any; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of Teradata. Type: string (or Expression with resultType string). */ table?: any; /** * Type of dataset. * Expected value is 'TeradataTable'. */ type: "TeradataTable"; } /** * The data stored in text format. */ interface TextFormatResponse { /** * The column delimiter. Type: string (or Expression with resultType string). */ columnDelimiter?: any; /** * Deserializer. Type: string (or Expression with resultType string). */ deserializer?: any; /** * The code page name of the preferred encoding. If miss, the default value is ΓÇ£utf-8ΓÇ¥, unless BOM denotes another Unicode encoding. Refer to the ΓÇ£NameΓÇ¥ column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string). */ encodingName?: any; /** * The escape character. Type: string (or Expression with resultType string). */ escapeChar?: any; /** * When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean). */ firstRowAsHeader?: any; /** * The null value string. Type: string (or Expression with resultType string). */ nullValue?: any; /** * The quote character. Type: string (or Expression with resultType string). */ quoteChar?: any; /** * The row delimiter. Type: string (or Expression with resultType string). */ rowDelimiter?: any; /** * Serializer. Type: string (or Expression with resultType string). */ serializer?: any; /** * The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer). */ skipLineCount?: any; /** * Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean). */ treatEmptyAsNull?: any; /** * Type of dataset storage format. * Expected value is 'TextFormat'. */ type: "TextFormat"; } /** * A data flow transformation. */ interface TransformationResponse { /** * Dataset reference. */ dataset?: outputs.datafactory.DatasetReferenceResponse; /** * Transformation description. */ description?: string; /** * Flowlet Reference */ flowlet?: outputs.datafactory.DataFlowReferenceResponse; /** * Linked service reference. */ linkedService?: outputs.datafactory.LinkedServiceReferenceResponse; /** * Transformation name. */ name: string; } /** * Trigger referenced dependency. */ interface TriggerDependencyReferenceResponse { /** * Referenced trigger. */ referenceTrigger: outputs.datafactory.TriggerReferenceResponse; /** * The type of dependency reference. * Expected value is 'TriggerDependencyReference'. */ type: "TriggerDependencyReference"; } /** * Pipeline that needs to be triggered with the given parameters. */ interface TriggerPipelineReferenceResponse { /** * Pipeline parameters. */ parameters?: any; /** * Pipeline reference. */ pipelineReference?: outputs.datafactory.PipelineReferenceResponse; } /** * Trigger reference type. */ interface TriggerReferenceResponse { /** * Reference trigger name. */ referenceName: string; /** * Trigger reference type. */ type: string; } /** * Referenced tumbling window trigger dependency. */ interface TumblingWindowTriggerDependencyReferenceResponse { /** * Timespan applied to the start time of a tumbling window when evaluating dependency. */ offset?: string; /** * Referenced trigger. */ referenceTrigger: outputs.datafactory.TriggerReferenceResponse; /** * The size of the window when evaluating the dependency. If undefined the frequency of the tumbling window will be used. */ size?: string; /** * The type of dependency reference. * Expected value is 'TumblingWindowTriggerDependencyReference'. */ type: "TumblingWindowTriggerDependencyReference"; } /** * Trigger that schedules pipeline runs for all fixed time interval windows from a start time without gaps and also supports backfill scenarios (when start time is in the past). */ interface TumblingWindowTriggerResponse { /** * List of tags that can be used for describing the trigger. */ annotations?: any[]; /** * Specifies how long the trigger waits past due time before triggering new run. It doesn't alter window start and end time. The default is 0. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ delay?: any; /** * Triggers that this trigger depends on. Only tumbling window triggers are supported. */ dependsOn?: (outputs.datafactory.SelfDependencyTumblingWindowTriggerReferenceResponse | outputs.datafactory.TriggerDependencyReferenceResponse | outputs.datafactory.TumblingWindowTriggerDependencyReferenceResponse)[]; /** * Trigger description. */ description?: string; /** * The end time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported. */ endTime?: string; /** * The frequency of the time windows. */ frequency: string; /** * The interval of the time windows. The minimum interval allowed is 15 Minutes. */ interval: number; /** * The max number of parallel time windows (ready for execution) for which a new run is triggered. */ maxConcurrency: number; /** * Pipeline for which runs are created when an event is fired for trigger window that is ready. */ pipeline: outputs.datafactory.TriggerPipelineReferenceResponse; /** * Retry policy that will be applied for failed pipeline runs. */ retryPolicy?: outputs.datafactory.RetryPolicyResponse; /** * Indicates if trigger is running or not. Updated when Start/Stop APIs are called on the Trigger. */ runtimeState: string; /** * The start time for the time period for the trigger during which events are fired for windows that are ready. Only UTC time is currently supported. */ startTime: string; /** * Trigger type. * Expected value is 'TumblingWindowTrigger'. */ type: "TumblingWindowTrigger"; } /** * Linked service for Twilio. */ interface TwilioLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The auth token of Twilio service. */ password: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'Twilio'. */ type: "Twilio"; /** * The Account SID of Twilio service. Type: string (or Expression with resultType string). */ userName: any; /** * Version of the linked service. */ version?: string; } /** * This activity executes inner activities until the specified boolean expression results to true or timeout is reached, whichever is earlier. */ interface UntilActivityResponse { /** * List of activities to execute. */ activities: (outputs.datafactory.AppendVariableActivityResponse | outputs.datafactory.AzureDataExplorerCommandActivityResponse | outputs.datafactory.AzureFunctionActivityResponse | outputs.datafactory.AzureMLBatchExecutionActivityResponse | outputs.datafactory.AzureMLExecutePipelineActivityResponse | outputs.datafactory.AzureMLUpdateResourceActivityResponse | outputs.datafactory.ControlActivityResponse | outputs.datafactory.CopyActivityResponse | outputs.datafactory.CustomActivityResponse | outputs.datafactory.DataLakeAnalyticsUSQLActivityResponse | outputs.datafactory.DatabricksJobActivityResponse | outputs.datafactory.DatabricksNotebookActivityResponse | outputs.datafactory.DatabricksSparkJarActivityResponse | outputs.datafactory.DatabricksSparkPythonActivityResponse | outputs.datafactory.DeleteActivityResponse | outputs.datafactory.ExecuteDataFlowActivityResponse | outputs.datafactory.ExecutePipelineActivityResponse | outputs.datafactory.ExecuteSSISPackageActivityResponse | outputs.datafactory.ExecuteWranglingDataflowActivityResponse | outputs.datafactory.ExecutionActivityResponse | outputs.datafactory.FailActivityResponse | outputs.datafactory.FilterActivityResponse | outputs.datafactory.ForEachActivityResponse | outputs.datafactory.GetMetadataActivityResponse | outputs.datafactory.HDInsightHiveActivityResponse | outputs.datafactory.HDInsightMapReduceActivityResponse | outputs.datafactory.HDInsightPigActivityResponse | outputs.datafactory.HDInsightSparkActivityResponse | outputs.datafactory.HDInsightStreamingActivityResponse | outputs.datafactory.IfConditionActivityResponse | outputs.datafactory.LookupActivityResponse | outputs.datafactory.ScriptActivityResponse | outputs.datafactory.SetVariableActivityResponse | outputs.datafactory.SqlServerStoredProcedureActivityResponse | outputs.datafactory.SwitchActivityResponse | outputs.datafactory.SynapseNotebookActivityResponse | outputs.datafactory.SynapseSparkJobDefinitionActivityResponse | outputs.datafactory.UntilActivityResponse | outputs.datafactory.ValidationActivityResponse | outputs.datafactory.WaitActivityResponse | outputs.datafactory.WebActivityResponse | outputs.datafactory.WebHookActivityResponse)[]; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true */ expression: outputs.datafactory.ExpressionResponse; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ timeout?: any; /** * Type of activity. * Expected value is 'Until'. */ type: "Until"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Get Data Plane read only token request definition. */ interface UserAccessPolicyResponse { /** * The resource path to get access relative to factory. Currently only empty string is supported which corresponds to the factory resource. */ accessResourcePath?: string; /** * Expiration time for the token. Maximum duration for the token is eight hours and by default the token will expire in eight hours. */ expireTime?: string; /** * The string with permissions for Data Plane access. Currently only 'r' is supported which grants read only access. */ permissions?: string; /** * The name of the profile. Currently only the default is supported. The default value is DefaultProfile. */ profileName?: string; /** * Start time for the token. If not specified the current time will be used. */ startTime?: string; } /** * User property. */ interface UserPropertyResponse { /** * User property name. */ name: string; /** * User property value. Type: string (or Expression with resultType string). */ value: any; } /** * This activity verifies that an external resource exists. */ interface ValidationActivityResponse { /** * Can be used if dataset points to a folder. If set to true, the folder must have at least one file. If set to false, the folder must be empty. Type: boolean (or Expression with resultType boolean). */ childItems?: any; /** * Validation activity dataset reference. */ dataset: outputs.datafactory.DatasetReferenceResponse; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Can be used if dataset points to a file. The file must be greater than or equal in size to the value specified. Type: integer (or Expression with resultType integer). */ minimumSize?: any; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * A delay in seconds between validation attempts. If no value is specified, 10 seconds will be used as the default. Type: integer (or Expression with resultType integer). */ sleep?: any; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Specifies the timeout for the activity to run. If there is no value specified, it takes the value of TimeSpan.FromDays(7) which is 1 week as default. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ timeout?: any; /** * Type of activity. * Expected value is 'Validation'. */ type: "Validation"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Definition of a single variable for a Pipeline. */ interface VariableSpecificationResponse { /** * Default value of variable. */ defaultValue?: any; /** * Variable type. */ type: string; } /** * Vertica linked service. */ interface VerticaLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * An ODBC connection string. Type: string, SecureString or AzureKeyVaultSecretReference. */ connectionString?: any; /** * Database name for connection. Type: string. */ database?: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The port for the connection. Type: integer. */ port?: any; /** * The Azure key vault secret reference of password in connection string. */ pwd?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse; /** * Server name for connection. Type: string. */ server?: any; /** * Type of linked service. * Expected value is 'Vertica'. */ type: "Vertica"; /** * Username for authentication. Type: string. */ uid?: any; /** * Version of the linked service. */ version?: string; } /** * A copy activity Vertica source. */ interface VerticaSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'VerticaSource'. */ type: "VerticaSource"; } /** * Vertica dataset. */ interface VerticaTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Vertica. Type: string (or Expression with resultType string). */ table?: any; /** * This property will be retired. Please consider using schema + table properties instead. */ tableName?: any; /** * Type of dataset. * Expected value is 'VerticaTable'. */ type: "VerticaTable"; } /** * This activity suspends pipeline execution for the specified interval. */ interface WaitActivityResponse { /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Type of activity. * Expected value is 'Wait'. */ type: "Wait"; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; /** * Duration in seconds. Type: integer (or Expression with resultType integer). */ waitTimeInSeconds: any; } /** * Microsoft Fabric Warehouse linked service. */ interface WarehouseLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The ID of Microsoft Fabric Warehouse artifact. Type: string (or Expression with resultType string). */ artifactId: any; /** * The authentication type to use. */ authenticationType?: string; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The endpoint of Microsoft Fabric Warehouse server. Type: string (or Expression with resultType string). */ endpoint: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference. */ servicePrincipalCredential?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string). */ servicePrincipalCredentialType?: any; /** * The ID of the application used to authenticate against Microsoft Fabric Warehouse. Type: string (or Expression with resultType string). */ servicePrincipalId?: any; /** * The Key of the application used to authenticate against Microsoft Fabric Warehouse. */ servicePrincipalKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The name or ID of the tenant to which the service principal belongs. Type: string (or Expression with resultType string). */ tenant?: any; /** * Type of linked service. * Expected value is 'Warehouse'. */ type: "Warehouse"; /** * Version of the linked service. */ version?: string; /** * The ID of Microsoft Fabric workspace. Type: string (or Expression with resultType string). */ workspaceId?: any; } /** * A copy activity Microsoft Fabric Warehouse sink. */ interface WarehouseSinkResponse { /** * Indicates to use Copy Command to copy data into SQL Data Warehouse. Type: boolean (or Expression with resultType boolean). */ allowCopyCommand?: any; /** * Specifies Copy Command related settings when allowCopyCommand is true. */ copyCommandSettings?: outputs.datafactory.DWCopyCommandSettingsResponse; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the sink data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * SQL pre-copy script. Type: string (or Expression with resultType string). */ preCopyScript?: any; /** * Sink retry count. Type: integer (or Expression with resultType integer). */ sinkRetryCount?: any; /** * Sink retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sinkRetryWait?: any; /** * The option to handle sink table, such as autoCreate. For now only 'autoCreate' value is supported. Type: string (or Expression with resultType string). */ tableOption?: any; /** * Copy sink type. * Expected value is 'WarehouseSink'. */ type: "WarehouseSink"; /** * Write batch size. Type: integer (or Expression with resultType integer), minimum: 0. */ writeBatchSize?: any; /** * Write batch timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ writeBatchTimeout?: any; /** * Write behavior when copying data into azure Microsoft Fabric Data Warehouse. Type: DWWriteBehaviorEnum (or Expression with resultType DWWriteBehaviorEnum) */ writeBehavior?: any; } /** * A copy activity Microsoft Fabric Warehouse source. */ interface WarehouseSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Specifies the transaction locking behavior for the Microsoft Fabric Warehouse source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string). */ isolationLevel?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * The partition mechanism that will be used for Sql read in parallel. Possible values include: "None", "PhysicalPartitionsOfTable", "DynamicRange". */ partitionOption?: any; /** * The settings that will be leveraged for Sql source partitioning. */ partitionSettings?: outputs.datafactory.SqlPartitionSettingsResponse; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Microsoft Fabric Warehouse reader query. Type: string (or Expression with resultType string). */ sqlReaderQuery?: any; /** * Name of the stored procedure for a Microsoft Fabric Warehouse source. This cannot be used at the same time as SqlReaderQuery. Type: string (or Expression with resultType string). */ sqlReaderStoredProcedureName?: any; /** * Value and type setting for stored procedure parameters. Example: "{Parameter1: {value: "1", type: "int"}}". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter. */ storedProcedureParameters?: any; /** * Copy source type. * Expected value is 'WarehouseSource'. */ type: "WarehouseSource"; } /** * Microsoft Fabric Warehouse dataset. */ interface WarehouseTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name of the Microsoft Fabric Warehouse. Type: string (or Expression with resultType string). */ table?: any; /** * Type of dataset. * Expected value is 'WarehouseTable'. */ type: "WarehouseTable"; } /** * Web activity authentication properties. */ interface WebActivityAuthenticationResponse { /** * The credential reference containing authentication information. */ credential?: outputs.datafactory.CredentialReferenceResponse; /** * Password for the PFX file or basic authentication / Secret when used for ServicePrincipal */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Base64-encoded contents of a PFX file or Certificate when used for ServicePrincipal */ pfx?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Resource for which Azure Auth token will be requested when using MSI Authentication. Type: string (or Expression with resultType string). */ resource?: any; /** * Web activity authentication (Basic/ClientCertificate/MSI/ServicePrincipal) */ type?: string; /** * TenantId for which Azure Auth token will be requested when using ServicePrincipal Authentication. Type: string (or Expression with resultType string). */ userTenant?: any; /** * Web activity authentication user name for basic authentication or ClientID when used for ServicePrincipal. Type: string (or Expression with resultType string). */ username?: any; } /** * Web activity. */ interface WebActivityResponse { /** * Authentication method used for calling the endpoint. */ authentication?: outputs.datafactory.WebActivityAuthenticationResponse; /** * Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string). */ body?: any; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * List of datasets passed to web endpoint. */ datasets?: outputs.datafactory.DatasetReferenceResponse[]; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * When set to true, Certificate validation will be disabled. */ disableCertValidation?: boolean; /** * Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string). */ headers?: any; /** * Timeout for the HTTP request to get a response. Format is in TimeSpan (hh:mm:ss). This value is the timeout to get a response, not the activity timeout. The default value is 00:01:00 (1 minute). The range is from 1 to 10 minutes */ httpRequestTimeout?: any; /** * Linked service reference. */ linkedServiceName?: outputs.datafactory.LinkedServiceReferenceResponse; /** * List of linked services passed to web endpoint. */ linkedServices?: outputs.datafactory.LinkedServiceReferenceResponse[]; /** * Rest API method for target endpoint. */ method: string; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.ActivityPolicyResponse; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * Option to disable invoking HTTP GET on location given in response header of a HTTP 202 Response. If set true, it stops invoking HTTP GET on http location given in response header. If set false then continues to invoke HTTP GET call on location given in http response headers. */ turnOffAsync?: boolean; /** * Type of activity. * Expected value is 'WebActivity'. */ type: "WebActivity"; /** * Web activity target endpoint and path. Type: string (or Expression with resultType string). */ url: any; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * A WebLinkedService that uses anonymous authentication to communicate with an HTTP endpoint. */ interface WebAnonymousAuthenticationResponse { /** * Type of authentication used to connect to the web table source. * Expected value is 'Anonymous'. */ authenticationType: "Anonymous"; /** * The URL of the web service endpoint, e.g. https://www.microsoft.com . Type: string (or Expression with resultType string). */ url: any; } /** * A WebLinkedService that uses basic authentication to communicate with an HTTP endpoint. */ interface WebBasicAuthenticationResponse { /** * Type of authentication used to connect to the web table source. * Expected value is 'Basic'. */ authenticationType: "Basic"; /** * The password for Basic authentication. */ password: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The URL of the web service endpoint, e.g. https://www.microsoft.com . Type: string (or Expression with resultType string). */ url: any; /** * User name for Basic authentication. Type: string (or Expression with resultType string). */ username: any; } /** * A WebLinkedService that uses client certificate based authentication to communicate with an HTTP endpoint. This scheme follows mutual authentication; the server must also provide valid credentials to the client. */ interface WebClientCertificateAuthenticationResponse { /** * Type of authentication used to connect to the web table source. * Expected value is 'ClientCertificate'. */ authenticationType: "ClientCertificate"; /** * Password for the PFX file. */ password: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Base64-encoded contents of a PFX file. */ pfx: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The URL of the web service endpoint, e.g. https://www.microsoft.com . Type: string (or Expression with resultType string). */ url: any; } /** * WebHook activity. */ interface WebHookActivityResponse { /** * Authentication method used for calling the endpoint. */ authentication?: outputs.datafactory.WebActivityAuthenticationResponse; /** * Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string). */ body?: any; /** * Activity depends on condition. */ dependsOn?: outputs.datafactory.ActivityDependencyResponse[]; /** * Activity description. */ description?: string; /** * Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string). */ headers?: any; /** * Rest API method for target endpoint. */ method: string; /** * Activity name. */ name: string; /** * Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default. */ onInactiveMarkAs?: string; /** * Activity policy. */ policy?: outputs.datafactory.SecureInputOutputPolicyResponse; /** * When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean). */ reportStatusOnCallBack?: any; /** * Activity state. This is an optional property and if not provided, the state will be Active by default. */ state?: string; /** * The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ timeout?: string; /** * Type of activity. * Expected value is 'WebHook'. */ type: "WebHook"; /** * WebHook activity target endpoint and path. Type: string (or Expression with resultType string). */ url: any; /** * Activity user properties. */ userProperties?: outputs.datafactory.UserPropertyResponse[]; } /** * Web linked service. */ interface WebLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'Web'. */ type: "Web"; /** * Web linked service properties. */ typeProperties: outputs.datafactory.WebAnonymousAuthenticationResponse | outputs.datafactory.WebBasicAuthenticationResponse | outputs.datafactory.WebClientCertificateAuthenticationResponse; /** * Version of the linked service. */ version?: string; } /** * A copy activity source for web page table. */ interface WebSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'WebSource'. */ type: "WebSource"; } /** * The dataset points to a HTML table in the web page. */ interface WebTableDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * The zero-based index of the table in the web page. Type: integer (or Expression with resultType integer), minimum: 0. */ index: any; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The relative URL to the web page from the linked service URL. Type: string (or Expression with resultType string). */ path?: any; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'WebTable'. */ type: "WebTable"; } /** * Power Query data flow. */ interface WranglingDataFlowResponse { /** * List of tags that can be used for describing the data flow. */ annotations?: any[]; /** * The description of the data flow. */ description?: string; /** * Locale of the Power query mashup document. */ documentLocale?: string; /** * The folder that this data flow is in. If not specified, Data flow will appear at the root level. */ folder?: outputs.datafactory.DataFlowFolderResponse; /** * Power query mashup script. */ script?: string; /** * List of sources in Power Query. */ sources?: outputs.datafactory.PowerQuerySourceResponse[]; /** * Type of data flow. * Expected value is 'WranglingDataFlow'. */ type: "WranglingDataFlow"; } /** * Xero Service linked service. */ interface XeroLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Properties used to connect to Xero. It is mutually exclusive with any other properties in the linked service. Type: object. */ connectionProperties?: any; /** * The consumer key associated with the Xero application. */ consumerKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The endpoint of the Xero server. (i.e. api.xero.com) */ host?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The private key from the .pem file that was generated for your Xero private application. You must include all the text from the .pem file, including the Unix line endings( * ). */ privateKey?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'Xero'. */ type: "Xero"; /** * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. */ useEncryptedEndpoints?: any; /** * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. */ useHostVerification?: any; /** * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. */ usePeerVerification?: any; /** * Version of the linked service. */ version?: string; } /** * Xero Service dataset. */ interface XeroObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'XeroObject'. */ type: "XeroObject"; } /** * A copy activity Xero Service source. */ interface XeroSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'XeroSource'. */ type: "XeroSource"; } /** * Xml dataset. */ interface XmlDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * The data compression method used for the json dataset. */ compression?: outputs.datafactory.DatasetCompressionResponse; /** * Dataset description. */ description?: string; /** * The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string). */ encodingName?: any; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * The location of the json data storage. */ location: outputs.datafactory.AmazonS3CompatibleLocationResponse | outputs.datafactory.AmazonS3LocationResponse | outputs.datafactory.AzureBlobFSLocationResponse | outputs.datafactory.AzureBlobStorageLocationResponse | outputs.datafactory.AzureDataLakeStoreLocationResponse | outputs.datafactory.AzureFileStorageLocationResponse | outputs.datafactory.FileServerLocationResponse | outputs.datafactory.FtpServerLocationResponse | outputs.datafactory.GoogleCloudStorageLocationResponse | outputs.datafactory.HdfsLocationResponse | outputs.datafactory.HttpServerLocationResponse | outputs.datafactory.LakeHouseLocationResponse | outputs.datafactory.OracleCloudStorageLocationResponse | outputs.datafactory.SftpLocationResponse; /** * The null value string. Type: string (or Expression with resultType string). */ nullValue?: any; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * Type of dataset. * Expected value is 'Xml'. */ type: "Xml"; } /** * Xml read settings. */ interface XmlReadSettingsResponse { /** * Compression settings. */ compressionProperties?: outputs.datafactory.TarGZipReadSettingsResponse | outputs.datafactory.TarReadSettingsResponse | outputs.datafactory.ZipDeflateReadSettingsResponse; /** * Indicates whether type detection is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean). */ detectDataType?: any; /** * Namespace uri to prefix mappings to override the prefixes in column names when namespace is enabled, if no prefix is defined for a namespace uri, the prefix of xml element/attribute name in the xml data file will be used. Example: "{"http://www.example.com/xml":"prefix"}" Type: object (or Expression with resultType object). */ namespacePrefixes?: any; /** * Indicates whether namespace is enabled when reading the xml files. Type: boolean (or Expression with resultType boolean). */ namespaces?: any; /** * The read setting type. * Expected value is 'XmlReadSettings'. */ type: "XmlReadSettings"; /** * Indicates what validation method is used when reading the xml files. Allowed values: 'none', 'xsd', or 'dtd'. Type: string (or Expression with resultType string). */ validationMode?: any; } /** * A copy activity Xml source. */ interface XmlSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * Xml format settings. */ formatSettings?: outputs.datafactory.XmlReadSettingsResponse; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Xml store settings. */ storeSettings?: outputs.datafactory.AmazonS3CompatibleReadSettingsResponse | outputs.datafactory.AmazonS3ReadSettingsResponse | outputs.datafactory.AzureBlobFSReadSettingsResponse | outputs.datafactory.AzureBlobStorageReadSettingsResponse | outputs.datafactory.AzureDataLakeStoreReadSettingsResponse | outputs.datafactory.AzureFileStorageReadSettingsResponse | outputs.datafactory.FileServerReadSettingsResponse | outputs.datafactory.FtpReadSettingsResponse | outputs.datafactory.GoogleCloudStorageReadSettingsResponse | outputs.datafactory.HdfsReadSettingsResponse | outputs.datafactory.HttpReadSettingsResponse | outputs.datafactory.LakeHouseReadSettingsResponse | outputs.datafactory.OracleCloudStorageReadSettingsResponse | outputs.datafactory.SftpReadSettingsResponse; /** * Copy source type. * Expected value is 'XmlSource'. */ type: "XmlSource"; } /** * Linked service for Zendesk. */ interface ZendeskLinkedServiceResponse { /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The api token for the Zendesk source. */ apiToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * The authentication type to use. */ authenticationType: string; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * The password of the Zendesk source. */ password?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * Type of linked service. * Expected value is 'Zendesk'. */ type: "Zendesk"; /** * The url to connect Zendesk source. Type: string (or Expression with resultType string). */ url: any; /** * The username of the Zendesk source. Type: string (or Expression with resultType string). */ userName?: any; /** * Version of the linked service. */ version?: string; } /** * The ZipDeflate compression read settings. */ interface ZipDeflateReadSettingsResponse { /** * Preserve the zip file name as folder path. Type: boolean (or Expression with resultType boolean). */ preserveZipFileNameAsFolder?: any; /** * The Compression setting type. * Expected value is 'ZipDeflateReadSettings'. */ type: "ZipDeflateReadSettings"; } /** * Zoho server linked service. */ interface ZohoLinkedServiceResponse { /** * The access token for Zoho authentication. */ accessToken?: outputs.datafactory.AzureKeyVaultSecretReferenceResponse | outputs.datafactory.SecureStringResponse; /** * List of tags that can be used for describing the linked service. */ annotations?: any[]; /** * The integration runtime reference. */ connectVia?: outputs.datafactory.IntegrationRuntimeReferenceResponse; /** * Properties used to connect to Zoho. It is mutually exclusive with any other properties in the linked service. Type: object. */ connectionProperties?: any; /** * Linked service description. */ description?: string; /** * The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string. */ encryptedCredential?: string; /** * The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private) */ endpoint?: any; /** * Parameters for linked service. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Type of linked service. * Expected value is 'Zoho'. */ type: "Zoho"; /** * Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. */ useEncryptedEndpoints?: any; /** * Specifies whether to require the host name in the server's certificate to match the host name of the server when connecting over SSL. The default value is true. */ useHostVerification?: any; /** * Specifies whether to verify the identity of the server when connecting over SSL. The default value is true. */ usePeerVerification?: any; /** * Version of the linked service. */ version?: string; } /** * Zoho server dataset. */ interface ZohoObjectDatasetResponse { /** * List of tags that can be used for describing the Dataset. */ annotations?: any[]; /** * Dataset description. */ description?: string; /** * The folder that this Dataset is in. If not specified, Dataset will appear at the root level. */ folder?: outputs.datafactory.DatasetFolderResponse; /** * Linked service reference. */ linkedServiceName: outputs.datafactory.LinkedServiceReferenceResponse; /** * Parameters for dataset. */ parameters?: { [key: string]: outputs.datafactory.ParameterSpecificationResponse; }; /** * Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. */ schema?: any; /** * Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. */ structure?: any; /** * The table name. Type: string (or Expression with resultType string). */ tableName?: any; /** * Type of dataset. * Expected value is 'ZohoObject'. */ type: "ZohoObject"; } /** * A copy activity Zoho server source. */ interface ZohoSourceResponse { /** * Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects). */ additionalColumns?: any; /** * If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean). */ disableMetricsCollection?: any; /** * The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer). */ maxConcurrentConnections?: any; /** * A query to retrieve data from source. Type: string (or Expression with resultType string). */ query?: any; /** * Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ queryTimeout?: any; /** * Source retry count. Type: integer (or Expression with resultType integer). */ sourceRetryCount?: any; /** * Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])). */ sourceRetryWait?: any; /** * Copy source type. * Expected value is 'ZohoSource'. */ type: "ZohoSource"; } } export declare namespace datalakeanalytics { /** * Data Lake Analytics compute policy information. */ interface ComputePolicyResponse { /** * The resource identifier. */ id: string; /** * The maximum degree of parallelism per job this user can use to submit jobs. */ maxDegreeOfParallelismPerJob: number; /** * The minimum priority per job this user can use to submit jobs. */ minPriorityPerJob: number; /** * The resource name. */ name: string; /** * The AAD object identifier for the entity to create a policy for. */ objectId: string; /** * The type of AAD object the object identifier refers to. */ objectType: string; /** * The resource type. */ type: string; } /** * Data Lake Store account information. */ interface DataLakeStoreAccountInformationResponse { /** * The resource identifier. */ id: string; /** * The resource name. */ name: string; /** * The optional suffix for the Data Lake Store account. */ suffix: string; /** * The resource type. */ type: string; } /** * Data Lake Analytics firewall rule information. */ interface FirewallRuleResponse { /** * The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. */ endIpAddress: string; /** * The resource identifier. */ id: string; /** * The resource name. */ name: string; /** * The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. */ startIpAddress: string; /** * The resource type. */ type: string; } interface HiveMetastoreResponse { /** * The databaseName for the Hive MetaStore */ databaseName: string; /** * The resource identifier. */ id: string; /** * The resource name. */ name: string; /** * The current state of the NestedResource */ nestedResourceProvisioningState: string; /** * The password for the Hive MetaStore */ password: string; /** * The runtimeVersion for the Hive MetaStore */ runtimeVersion: string; /** * The serverUri for the Hive MetaStore */ serverUri: string; /** * The resource type. */ type: string; /** * The userName for the Hive MetaStore */ userName: string; } /** * SAS token information. */ interface SasTokenInformationResponse { /** * The access token for the associated Azure Storage Container. */ accessToken: string; } /** * Azure Storage account information. */ interface StorageAccountInformationResponse { /** * The resource identifier. */ id: string; /** * The resource name. */ name: string; /** * The optional suffix for the storage account. */ suffix: string; /** * The resource type. */ type: string; } /** * Data Lake Analytics VirtualNetwork Rule information. */ interface VirtualNetworkRuleResponse { /** * The resource identifier. */ id: string; /** * The resource name. */ name: string; /** * The resource identifier for the subnet */ subnetId: string; /** * The resource type. */ type: string; /** * The current state of the VirtualNetwork Rule */ virtualNetworkRuleState: string; } } export declare namespace datalakestore { /** * The encryption configuration for the account. */ interface EncryptionConfigResponse { /** * The Key Vault information for connecting to user managed encryption keys. */ keyVaultMetaInfo?: outputs.datalakestore.KeyVaultMetaInfoResponse; /** * The type of encryption configuration being used. Currently the only supported types are 'UserManaged' and 'ServiceManaged'. */ type: string; } /** * The encryption identity properties. */ interface EncryptionIdentityResponse { /** * The principal identifier associated with the encryption. */ principalId: string; /** * The tenant identifier associated with the encryption. */ tenantId: string; /** * The type of encryption being used. Currently the only supported type is 'SystemAssigned'. */ type: string; } /** * Data Lake Store firewall rule information. */ interface FirewallRuleResponse { /** * The end IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. */ endIpAddress: string; /** * The resource identifier. */ id: string; /** * The resource name. */ name: string; /** * The start IP address for the firewall rule. This can be either ipv4 or ipv6. Start and End should be in the same protocol. */ startIpAddress: string; /** * The resource type. */ type: string; } /** * Metadata information used by account encryption. */ interface KeyVaultMetaInfoResponse { /** * The name of the user managed encryption key. */ encryptionKeyName: string; /** * The version of the user managed encryption key. */ encryptionKeyVersion: string; /** * The resource identifier for the user managed Key Vault being used to encrypt. */ keyVaultResourceId: string; } /** * Data Lake Store trusted identity provider information. */ interface TrustedIdProviderResponse { /** * The resource identifier. */ id: string; /** * The URL of this trusted identity provider. */ idProvider: string; /** * The resource name. */ name: string; /** * The resource type. */ type: string; } /** * Data Lake Store virtual network rule information. */ interface VirtualNetworkRuleResponse { /** * The resource identifier. */ id: string; /** * The resource name. */ name: string; /** * The resource identifier for the subnet. */ subnetId: string; /** * The resource type. */ type: string; } } export declare namespace datamigration { /** * Azure Active Directory Application */ interface AzureActiveDirectoryAppResponse { /** * Key used to authenticate to the Azure Active Directory Application */ appKey?: string; /** * Application ID of the Azure Active Directory Application */ applicationId?: string; /** * Ignore checking azure permissions on the AAD app */ ignoreAzurePermissions?: boolean; /** * Tenant id of the customer */ tenantId?: string; } /** * Azure Blob Details */ interface AzureBlobResponse { /** * Storage Account Key. */ accountKey?: string; /** * Authentication type used for accessing Azure Blob Storage. */ authType?: string; /** * Blob container name where backups are stored. */ blobContainerName?: string; /** * Identity details for authentication using a Managed Identity. */ identity?: outputs.datamigration.ManagedServiceIdentityResponse; /** * Resource Id of the storage account where backups are stored. */ storageAccountResourceId?: string; } /** * Backup Configuration */ interface BackupConfigurationResponse { /** * Source location of backups. */ sourceLocation?: outputs.datamigration.SourceLocationResponse; /** * Target location for copying backups. */ targetLocation?: outputs.datamigration.TargetLocationResponse; } /** * Information of the backup file */ interface BackupFileInfoResponse { /** * Sequence number of the backup file in the backup set */ familySequenceNumber?: number; /** * Location of the backup file in shared folder */ fileLocation?: string; /** * Status of the backup file during migration */ status?: string; } /** * Information of backup set */ interface BackupSetInfoResponse { /** * Date and time that the backup operation finished */ backupFinishedDate?: string; /** * Id for the set of backup files */ backupSetId?: string; /** * Date and time that the backup operation began */ backupStartDate?: string; /** * Enum of the different backup types */ backupType?: string; /** * Name of the database to which the backup set belongs */ databaseName?: string; /** * First log sequence number of the backup file */ firstLsn?: string; /** * Whether the backup set is restored or not */ isBackupRestored?: boolean; /** * Last log sequence number of the backup file */ lastLsn?: string; /** * Last modified time of the backup file in share location */ lastModifiedTime?: string; /** * List of files in the backup set */ listOfBackupFiles?: outputs.datamigration.BackupFileInfoResponse[]; } /** * Blob container storage information. */ interface BlobShareResponse { /** * SAS URI of Azure Storage Account Container. */ sasUri?: string; } /** * Properties for the task that validates the connection to and provides information about a MongoDB server */ interface ConnectToMongoDbTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Describes a connection to a MongoDB data source */ input?: outputs.datamigration.MongoDbConnectionInfoResponse; /** * An array containing a single MongoDbClusterInfo object */ output: outputs.datamigration.MongoDbClusterInfoResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'Connect.MongoDb'. */ taskType: "Connect.MongoDb"; } /** * connectToMongoDbTaskPropertiesResponseProvideDefaults sets the appropriate defaults for ConnectToMongoDbTaskPropertiesResponse */ function connectToMongoDbTaskPropertiesResponseProvideDefaults(val: ConnectToMongoDbTaskPropertiesResponse): ConnectToMongoDbTaskPropertiesResponse; /** * Input for the task that validates MySQL database connection */ interface ConnectToSourceMySqlTaskInputResponse { /** * Permission group for validations */ checkPermissionsGroup?: string; /** * Flag for whether or not the migration is offline */ isOfflineMigration?: boolean; /** * Information for connecting to MySQL source */ sourceConnectionInfo: outputs.datamigration.MySqlConnectionInfoResponse; /** * Target Platform for the migration */ targetPlatform?: string; } /** * connectToSourceMySqlTaskInputResponseProvideDefaults sets the appropriate defaults for ConnectToSourceMySqlTaskInputResponse */ function connectToSourceMySqlTaskInputResponseProvideDefaults(val: ConnectToSourceMySqlTaskInputResponse): ConnectToSourceMySqlTaskInputResponse; /** * Properties for the task that validates MySQL database connection */ interface ConnectToSourceMySqlTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.ConnectToSourceMySqlTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.ConnectToSourceNonSqlTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'ConnectToSource.MySql'. */ taskType: "ConnectToSource.MySql"; } /** * connectToSourceMySqlTaskPropertiesResponseProvideDefaults sets the appropriate defaults for ConnectToSourceMySqlTaskPropertiesResponse */ function connectToSourceMySqlTaskPropertiesResponseProvideDefaults(val: ConnectToSourceMySqlTaskPropertiesResponse): ConnectToSourceMySqlTaskPropertiesResponse; /** * Output for connect to MySQL type source */ interface ConnectToSourceNonSqlTaskOutputResponse { /** * List of databases on the server */ databases: string[]; /** * Result identifier */ id: string; /** * Server properties */ serverProperties: outputs.datamigration.ServerPropertiesResponse; /** * Server brand version */ sourceServerBrandVersion: string; /** * Validation errors associated with the task */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Input for the task that validates Oracle database connection */ interface ConnectToSourceOracleSyncTaskInputResponse { /** * Information for connecting to Oracle source */ sourceConnectionInfo: outputs.datamigration.OracleConnectionInfoResponse; } /** * Output for the task that validates Oracle database connection */ interface ConnectToSourceOracleSyncTaskOutputResponse { /** * List of schemas on source server */ databases: string[]; /** * Source server brand version */ sourceServerBrandVersion: string; /** * Version of the source server */ sourceServerVersion: string; /** * Validation errors associated with the task */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Properties for the task that validates Oracle database connection */ interface ConnectToSourceOracleSyncTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.ConnectToSourceOracleSyncTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.ConnectToSourceOracleSyncTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'ConnectToSource.Oracle.Sync'. */ taskType: "ConnectToSource.Oracle.Sync"; } /** * Input for the task that validates connection to PostgreSQL and source server requirements */ interface ConnectToSourcePostgreSqlSyncTaskInputResponse { /** * Connection information for source PostgreSQL server */ sourceConnectionInfo: outputs.datamigration.PostgreSqlConnectionInfoResponse; } /** * connectToSourcePostgreSqlSyncTaskInputResponseProvideDefaults sets the appropriate defaults for ConnectToSourcePostgreSqlSyncTaskInputResponse */ function connectToSourcePostgreSqlSyncTaskInputResponseProvideDefaults(val: ConnectToSourcePostgreSqlSyncTaskInputResponse): ConnectToSourcePostgreSqlSyncTaskInputResponse; /** * Output for the task that validates connection to PostgreSQL and source server requirements */ interface ConnectToSourcePostgreSqlSyncTaskOutputResponse { /** * List of databases on source server */ databases: string[]; /** * Result identifier */ id: string; /** * Source server brand version */ sourceServerBrandVersion: string; /** * Version of the source server */ sourceServerVersion: string; /** * Validation errors associated with the task */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Properties for the task that validates connection to PostgreSQL server and source server requirements for online migration */ interface ConnectToSourcePostgreSqlSyncTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.ConnectToSourcePostgreSqlSyncTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.ConnectToSourcePostgreSqlSyncTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'ConnectToSource.PostgreSql.Sync'. */ taskType: "ConnectToSource.PostgreSql.Sync"; } /** * connectToSourcePostgreSqlSyncTaskPropertiesResponseProvideDefaults sets the appropriate defaults for ConnectToSourcePostgreSqlSyncTaskPropertiesResponse */ function connectToSourcePostgreSqlSyncTaskPropertiesResponseProvideDefaults(val: ConnectToSourcePostgreSqlSyncTaskPropertiesResponse): ConnectToSourcePostgreSqlSyncTaskPropertiesResponse; /** * Properties for the task that validates connection to SQL Server and source server requirements for online migration */ interface ConnectToSourceSqlServerSyncTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.ConnectToSourceSqlServerTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: (outputs.datamigration.ConnectToSourceSqlServerTaskOutputAgentJobLevelResponse | outputs.datamigration.ConnectToSourceSqlServerTaskOutputDatabaseLevelResponse | outputs.datamigration.ConnectToSourceSqlServerTaskOutputLoginLevelResponse | outputs.datamigration.ConnectToSourceSqlServerTaskOutputTaskLevelResponse)[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'ConnectToSource.SqlServer.Sync'. */ taskType: "ConnectToSource.SqlServer.Sync"; } /** * connectToSourceSqlServerSyncTaskPropertiesResponseProvideDefaults sets the appropriate defaults for ConnectToSourceSqlServerSyncTaskPropertiesResponse */ function connectToSourceSqlServerSyncTaskPropertiesResponseProvideDefaults(val: ConnectToSourceSqlServerSyncTaskPropertiesResponse): ConnectToSourceSqlServerSyncTaskPropertiesResponse; /** * Input for the task that validates connection to SQL Server and also validates source server requirements */ interface ConnectToSourceSqlServerTaskInputResponse { /** * Permission group for validations */ checkPermissionsGroup?: string; /** * Flag for whether to collect agent jobs from source server. */ collectAgentJobs?: boolean; /** * Flag for whether to collect databases from source server. */ collectDatabases?: boolean; /** * Flag for whether to collect logins from source server. */ collectLogins?: boolean; /** * Flag for whether to collect TDE Certificate names from source server. */ collectTdeCertificateInfo?: boolean; /** * encrypted key for secure fields */ encryptedKeyForSecureFields?: string; /** * Connection information for Source SQL Server */ sourceConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; /** * Flag for whether to validate SSIS catalog is reachable on the source server. */ validateSsisCatalogOnly?: boolean; } /** * connectToSourceSqlServerTaskInputResponseProvideDefaults sets the appropriate defaults for ConnectToSourceSqlServerTaskInputResponse */ function connectToSourceSqlServerTaskInputResponseProvideDefaults(val: ConnectToSourceSqlServerTaskInputResponse): ConnectToSourceSqlServerTaskInputResponse; /** * Agent Job level output for the task that validates connection to SQL Server and also validates source server requirements */ interface ConnectToSourceSqlServerTaskOutputAgentJobLevelResponse { /** * Result identifier */ id: string; /** * The state of the original Agent Job. */ isEnabled: boolean; /** * The type of Agent Job. */ jobCategory: string; /** * The owner of the Agent Job */ jobOwner: string; /** * UTC Date and time when the Agent Job was last executed. */ lastExecutedOn: string; /** * Information about eligibility of agent job for migration. */ migrationEligibility: outputs.datamigration.MigrationEligibilityInfoResponse; /** * Agent Job name */ name: string; /** * Type of result - database level or task level * Expected value is 'AgentJobLevelOutput'. */ resultType: "AgentJobLevelOutput"; /** * Validation errors */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Database level output for the task that validates connection to SQL Server and also validates source server requirements */ interface ConnectToSourceSqlServerTaskOutputDatabaseLevelResponse { /** * SQL Server compatibility level of database */ compatibilityLevel: string; /** * The list of database files */ databaseFiles: outputs.datamigration.DatabaseFileInfoResponse[]; /** * State of the database */ databaseState: string; /** * Result identifier */ id: string; /** * Database name */ name: string; /** * Type of result - database level or task level * Expected value is 'DatabaseLevelOutput'. */ resultType: "DatabaseLevelOutput"; /** * Size of the file in megabytes */ sizeMB: number; } /** * Login level output for the task that validates connection to SQL Server and also validates source server requirements */ interface ConnectToSourceSqlServerTaskOutputLoginLevelResponse { /** * The default database for the login. */ defaultDatabase: string; /** * Result identifier */ id: string; /** * The state of the login. */ isEnabled: boolean; /** * The type of login. */ loginType: string; /** * Information about eligibility of login for migration. */ migrationEligibility: outputs.datamigration.MigrationEligibilityInfoResponse; /** * Login name. */ name: string; /** * Type of result - database level or task level * Expected value is 'LoginLevelOutput'. */ resultType: "LoginLevelOutput"; } /** * Task level output for the task that validates connection to SQL Server and also validates source server requirements */ interface ConnectToSourceSqlServerTaskOutputTaskLevelResponse { /** * Source agent jobs as a map from agent job name to id. */ agentJobs: { [key: string]: string; }; /** * Mapping from database name to TDE certificate name, if applicable */ databaseTdeCertificateMapping: { [key: string]: string; }; /** * Source databases as a map from database name to database id */ databases: { [key: string]: string; }; /** * Result identifier */ id: string; /** * Source logins as a map from login name to login id. */ logins: { [key: string]: string; }; /** * Type of result - database level or task level * Expected value is 'TaskLevelOutput'. */ resultType: "TaskLevelOutput"; /** * Source server brand version */ sourceServerBrandVersion: string; /** * Source server version */ sourceServerVersion: string; /** * Validation errors */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Properties for the task that validates connection to SQL Server and also validates source server requirements */ interface ConnectToSourceSqlServerTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.ConnectToSourceSqlServerTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: (outputs.datamigration.ConnectToSourceSqlServerTaskOutputAgentJobLevelResponse | outputs.datamigration.ConnectToSourceSqlServerTaskOutputDatabaseLevelResponse | outputs.datamigration.ConnectToSourceSqlServerTaskOutputLoginLevelResponse | outputs.datamigration.ConnectToSourceSqlServerTaskOutputTaskLevelResponse)[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task id */ taskId?: string; /** * Task type. * Expected value is 'ConnectToSource.SqlServer'. */ taskType: "ConnectToSource.SqlServer"; } /** * connectToSourceSqlServerTaskPropertiesResponseProvideDefaults sets the appropriate defaults for ConnectToSourceSqlServerTaskPropertiesResponse */ function connectToSourceSqlServerTaskPropertiesResponseProvideDefaults(val: ConnectToSourceSqlServerTaskPropertiesResponse): ConnectToSourceSqlServerTaskPropertiesResponse; /** * Input for the task that validates connection to Azure Database for MySQL and target server requirements */ interface ConnectToTargetAzureDbForMySqlTaskInputResponse { /** * Flag for whether or not the migration is offline */ isOfflineMigration?: boolean; /** * Connection information for source MySQL server */ sourceConnectionInfo: outputs.datamigration.MySqlConnectionInfoResponse; /** * Connection information for target Azure Database for MySQL server */ targetConnectionInfo: outputs.datamigration.MySqlConnectionInfoResponse; } /** * connectToTargetAzureDbForMySqlTaskInputResponseProvideDefaults sets the appropriate defaults for ConnectToTargetAzureDbForMySqlTaskInputResponse */ function connectToTargetAzureDbForMySqlTaskInputResponseProvideDefaults(val: ConnectToTargetAzureDbForMySqlTaskInputResponse): ConnectToTargetAzureDbForMySqlTaskInputResponse; /** * Output for the task that validates connection to Azure Database for MySQL and target server requirements */ interface ConnectToTargetAzureDbForMySqlTaskOutputResponse { /** * List of databases on target server */ databases: string[]; /** * Result identifier */ id: string; /** * Version of the target server */ serverVersion: string; /** * Target server brand version */ targetServerBrandVersion: string; /** * Validation errors associated with the task */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Properties for the task that validates connection to Azure Database for MySQL and target server requirements */ interface ConnectToTargetAzureDbForMySqlTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.ConnectToTargetAzureDbForMySqlTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.ConnectToTargetAzureDbForMySqlTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'ConnectToTarget.AzureDbForMySql'. */ taskType: "ConnectToTarget.AzureDbForMySql"; } /** * connectToTargetAzureDbForMySqlTaskPropertiesResponseProvideDefaults sets the appropriate defaults for ConnectToTargetAzureDbForMySqlTaskPropertiesResponse */ function connectToTargetAzureDbForMySqlTaskPropertiesResponseProvideDefaults(val: ConnectToTargetAzureDbForMySqlTaskPropertiesResponse): ConnectToTargetAzureDbForMySqlTaskPropertiesResponse; /** * Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements */ interface ConnectToTargetAzureDbForPostgreSqlSyncTaskInputResponse { /** * Connection information for source PostgreSQL server */ sourceConnectionInfo: outputs.datamigration.PostgreSqlConnectionInfoResponse; /** * Connection information for target Azure Database for PostgreSQL server */ targetConnectionInfo: outputs.datamigration.PostgreSqlConnectionInfoResponse; } /** * connectToTargetAzureDbForPostgreSqlSyncTaskInputResponseProvideDefaults sets the appropriate defaults for ConnectToTargetAzureDbForPostgreSqlSyncTaskInputResponse */ function connectToTargetAzureDbForPostgreSqlSyncTaskInputResponseProvideDefaults(val: ConnectToTargetAzureDbForPostgreSqlSyncTaskInputResponse): ConnectToTargetAzureDbForPostgreSqlSyncTaskInputResponse; /** * Output for the task that validates connection to Azure Database for PostgreSQL and target server requirements */ interface ConnectToTargetAzureDbForPostgreSqlSyncTaskOutputResponse { /** * List of databases on target server */ databases: string[]; /** * Result identifier */ id: string; /** * Target server brand version */ targetServerBrandVersion: string; /** * Version of the target server */ targetServerVersion: string; /** * Validation errors associated with the task */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Properties for the task that validates connection to Azure Database For PostgreSQL server and target server requirements for online migration */ interface ConnectToTargetAzureDbForPostgreSqlSyncTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.ConnectToTargetAzureDbForPostgreSqlSyncTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.ConnectToTargetAzureDbForPostgreSqlSyncTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'ConnectToTarget.AzureDbForPostgreSql.Sync'. */ taskType: "ConnectToTarget.AzureDbForPostgreSql.Sync"; } /** * connectToTargetAzureDbForPostgreSqlSyncTaskPropertiesResponseProvideDefaults sets the appropriate defaults for ConnectToTargetAzureDbForPostgreSqlSyncTaskPropertiesResponse */ function connectToTargetAzureDbForPostgreSqlSyncTaskPropertiesResponseProvideDefaults(val: ConnectToTargetAzureDbForPostgreSqlSyncTaskPropertiesResponse): ConnectToTargetAzureDbForPostgreSqlSyncTaskPropertiesResponse; /** * Input for the task that validates connection to Azure Database for PostgreSQL and target server requirements for Oracle source. */ interface ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInputResponse { /** * Connection information for target Azure Database for PostgreSQL server */ targetConnectionInfo: outputs.datamigration.PostgreSqlConnectionInfoResponse; } /** * connectToTargetOracleAzureDbForPostgreSqlSyncTaskInputResponseProvideDefaults sets the appropriate defaults for ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInputResponse */ function connectToTargetOracleAzureDbForPostgreSqlSyncTaskInputResponseProvideDefaults(val: ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInputResponse): ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInputResponse; /** * Output for the task that validates connection to Azure Database for PostgreSQL and target server requirements for Oracle source. */ interface ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputResponse { /** * Mapping of schemas per database */ databaseSchemaMap?: outputs.datamigration.ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputResponseDatabaseSchemaMap[]; /** * List of databases on target server */ databases: string[]; /** * Target server brand version */ targetServerBrandVersion: string; /** * Version of the target server */ targetServerVersion: string; /** * Validation errors associated with the task */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } interface ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputResponseDatabaseSchemaMap { database?: string; schemas?: string[]; } /** * Properties for the task that validates connection to Azure Database For PostgreSQL server and target server requirements for online migration for Oracle source. */ interface ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync'. */ taskType: "ConnectToTarget.Oracle.AzureDbForPostgreSql.Sync"; } /** * connectToTargetOracleAzureDbForPostgreSqlSyncTaskPropertiesResponseProvideDefaults sets the appropriate defaults for ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskPropertiesResponse */ function connectToTargetOracleAzureDbForPostgreSqlSyncTaskPropertiesResponseProvideDefaults(val: ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskPropertiesResponse): ConnectToTargetOracleAzureDbForPostgreSqlSyncTaskPropertiesResponse; /** * Input for the task that validates connection to SQL DB and target server requirements */ interface ConnectToTargetSqlDbTaskInputResponse { /** * Boolean flag indicating whether to query object counts for each database on the target server */ queryObjectCounts?: boolean; /** * Connection information for target SQL DB */ targetConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; } /** * connectToTargetSqlDbTaskInputResponseProvideDefaults sets the appropriate defaults for ConnectToTargetSqlDbTaskInputResponse */ function connectToTargetSqlDbTaskInputResponseProvideDefaults(val: ConnectToTargetSqlDbTaskInputResponse): ConnectToTargetSqlDbTaskInputResponse; /** * Output for the task that validates connection to SQL DB and target server requirements */ interface ConnectToTargetSqlDbTaskOutputResponse { /** * Source databases as a map from database name to database id */ databases: { [key: string]: string; }; /** * Result identifier */ id: string; /** * Target server brand version */ targetServerBrandVersion: string; /** * Version of the target server */ targetServerVersion: string; } /** * Properties for the task that validates connection to SQL DB and target server requirements */ interface ConnectToTargetSqlDbTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * DateTime in UTC when the task was created */ createdOn?: string; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.ConnectToTargetSqlDbTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.ConnectToTargetSqlDbTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'ConnectToTarget.SqlDb'. */ taskType: "ConnectToTarget.SqlDb"; } /** * connectToTargetSqlDbTaskPropertiesResponseProvideDefaults sets the appropriate defaults for ConnectToTargetSqlDbTaskPropertiesResponse */ function connectToTargetSqlDbTaskPropertiesResponseProvideDefaults(val: ConnectToTargetSqlDbTaskPropertiesResponse): ConnectToTargetSqlDbTaskPropertiesResponse; /** * Input for the task that validates connection to Azure SQL Database Managed Instance online scenario. */ interface ConnectToTargetSqlMISyncTaskInputResponse { /** * Azure Active Directory Application the DMS (classic) instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account */ azureApp: outputs.datamigration.AzureActiveDirectoryAppResponse; /** * Connection information for Azure SQL Database Managed Instance */ targetConnectionInfo: outputs.datamigration.MiSqlConnectionInfoResponse; } /** * Output for the task that validates connection to Azure SQL Database Managed Instance. */ interface ConnectToTargetSqlMISyncTaskOutputResponse { /** * Target server brand version */ targetServerBrandVersion: string; /** * Target server version */ targetServerVersion: string; /** * Validation errors */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Properties for the task that validates connection to Azure SQL Database Managed Instance */ interface ConnectToTargetSqlMISyncTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.ConnectToTargetSqlMISyncTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.ConnectToTargetSqlMISyncTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'ConnectToTarget.AzureSqlDbMI.Sync.LRS'. */ taskType: "ConnectToTarget.AzureSqlDbMI.Sync.LRS"; } /** * Input for the task that validates connection to Azure SQL Database Managed Instance. */ interface ConnectToTargetSqlMITaskInputResponse { /** * Flag for whether to collect agent jobs from target SQL MI server. */ collectAgentJobs?: boolean; /** * Flag for whether to collect logins from target SQL MI server. */ collectLogins?: boolean; /** * Connection information for target SQL Server */ targetConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; /** * Flag for whether to validate SSIS catalog is reachable on the target SQL MI server. */ validateSsisCatalogOnly?: boolean; } /** * connectToTargetSqlMITaskInputResponseProvideDefaults sets the appropriate defaults for ConnectToTargetSqlMITaskInputResponse */ function connectToTargetSqlMITaskInputResponseProvideDefaults(val: ConnectToTargetSqlMITaskInputResponse): ConnectToTargetSqlMITaskInputResponse; /** * Output for the task that validates connection to Azure SQL Database Managed Instance. */ interface ConnectToTargetSqlMITaskOutputResponse { /** * List of agent jobs on the target server. */ agentJobs: string[]; /** * Result identifier */ id: string; /** * List of logins on the target server. */ logins: string[]; /** * Target server brand version */ targetServerBrandVersion: string; /** * Target server version */ targetServerVersion: string; /** * Validation errors */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Properties for the task that validates connection to Azure SQL Database Managed Instance */ interface ConnectToTargetSqlMITaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.ConnectToTargetSqlMITaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.ConnectToTargetSqlMITaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'ConnectToTarget.AzureSqlDbMI'. */ taskType: "ConnectToTarget.AzureSqlDbMI"; } /** * connectToTargetSqlMITaskPropertiesResponseProvideDefaults sets the appropriate defaults for ConnectToTargetSqlMITaskPropertiesResponse */ function connectToTargetSqlMITaskPropertiesResponseProvideDefaults(val: ConnectToTargetSqlMITaskPropertiesResponse): ConnectToTargetSqlMITaskPropertiesResponse; /** * Input for the task that validates connection to Azure SQL DB and target server requirements */ interface ConnectToTargetSqlSqlDbSyncTaskInputResponse { /** * Connection information for source SQL Server */ sourceConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; /** * Connection information for target SQL DB */ targetConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; } /** * connectToTargetSqlSqlDbSyncTaskInputResponseProvideDefaults sets the appropriate defaults for ConnectToTargetSqlSqlDbSyncTaskInputResponse */ function connectToTargetSqlSqlDbSyncTaskInputResponseProvideDefaults(val: ConnectToTargetSqlSqlDbSyncTaskInputResponse): ConnectToTargetSqlSqlDbSyncTaskInputResponse; /** * Properties for the task that validates connection to SQL DB and target server requirements for online migration */ interface ConnectToTargetSqlSqlDbSyncTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.ConnectToTargetSqlSqlDbSyncTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.ConnectToTargetSqlDbTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'ConnectToTarget.SqlDb.Sync'. */ taskType: "ConnectToTarget.SqlDb.Sync"; } /** * connectToTargetSqlSqlDbSyncTaskPropertiesResponseProvideDefaults sets the appropriate defaults for ConnectToTargetSqlSqlDbSyncTaskPropertiesResponse */ function connectToTargetSqlSqlDbSyncTaskPropertiesResponseProvideDefaults(val: ConnectToTargetSqlSqlDbSyncTaskPropertiesResponse): ConnectToTargetSqlSqlDbSyncTaskPropertiesResponse; /** * Details on progress of ADF copy activity */ interface CopyProgressDetailsResponse { /** * Copy Duration in seconds */ copyDuration: number; /** * Copy Start */ copyStart: string; /** * Copy throughput in KBps */ copyThroughput: number; /** * Bytes read */ dataRead: number; /** * Bytes written */ dataWritten: number; /** * Type of parallel copy (Dynamic range, Physical partition, none). */ parallelCopyType: string; /** * Rows Copied */ rowsCopied: number; /** * Rows read */ rowsRead: number; /** * Status of the Copy activity (InProgress, Succeeded, Failed, Canceled). */ status: string; /** * Table Name */ tableName: string; /** * The degree of parallelization. */ usedParallelCopies: number; } /** * Results for checksum based Data Integrity validation results */ interface DataIntegrityValidationResultResponse { /** * List of failed table names of source and target pair */ failedObjects?: { [key: string]: string; }; /** * List of errors that happened while performing data integrity validation */ validationErrors?: outputs.datamigration.ValidationErrorResponse; } /** * Basic summary of a data item migration */ interface DataItemMigrationSummaryResultResponse { /** * Migration end time */ endedOn: string; /** * Wildcard string prefix to use for querying all errors of the item */ errorPrefix: string; /** * Number of successfully completed items */ itemsCompletedCount: number; /** * Number of items */ itemsCount: number; /** * Name of the item */ name: string; /** * Wildcard string prefix to use for querying all sub-tem results of the item */ resultPrefix: string; /** * Migration start time */ startedOn: string; /** * Current state of migration */ state: string; /** * Status message */ statusMessage: string; } /** * Information about backup files when existing backup mode is used. */ interface DatabaseBackupInfoResponse { /** * The list of backup files for the current database. */ backupFiles: string[]; /** * Date and time when the backup operation finished. */ backupFinishDate: string; /** * Backup Type. */ backupType: string; /** * Database name. */ databaseName: string; /** * Number of files in the backup set. */ familyCount: number; /** * Whether the backup set is compressed */ isCompressed: boolean; /** * Database was damaged when backed up, but the backup operation was requested to continue despite errors. */ isDamaged: boolean; /** * Position of current database backup in the file. */ position: number; } /** * Database file specific information */ interface DatabaseFileInfoResponse { /** * Name of the database */ databaseName?: string; /** * Database file type */ fileType?: string; /** * Unique identifier for database file */ id?: string; /** * Logical name of the file */ logicalName?: string; /** * Operating-system full path of the file */ physicalFullName?: string; /** * Suggested full path of the file for restoring */ restoreFullName?: string; /** * Size of the file in megabytes */ sizeMB?: number; } /** * Project Database Details */ interface DatabaseInfoResponse { /** * Name of the database */ sourceDatabaseName: string; } /** * Database Migration Resource properties for SQL database. */ interface DatabaseMigrationPropertiesSqlDbResponse { /** * Database migration end time. */ endedOn: string; /** * Expected value is 'SqlDb'. */ kind: "SqlDb"; /** * Error details in case of migration failure. */ migrationFailureError: outputs.datamigration.ErrorInfoResponse; /** * ID for current migration operation. */ migrationOperationId?: string; /** * Resource Id of the Migration Service. */ migrationService?: string; /** * Migration status. */ migrationStatus: string; /** * Detailed migration status. Not included by default. */ migrationStatusDetails: outputs.datamigration.SqlDbMigrationStatusDetailsResponse; /** * Offline configuration. */ offlineConfiguration: outputs.datamigration.SqlDbOfflineConfigurationResponse; /** * Error message for migration provisioning failure, if any. */ provisioningError?: string; /** * Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started. */ provisioningState: string; /** * Resource Id of the target resource. */ scope?: string; /** * Name of the source database. */ sourceDatabaseName?: string; /** * Name of the source sql server. */ sourceServerName: string; /** * Source SQL Server connection details. */ sourceSqlConnection?: outputs.datamigration.SqlConnectionInformationResponse; /** * Database migration start time. */ startedOn: string; /** * List of tables to copy. */ tableList?: string[]; /** * Database collation to be used for the target database. */ targetDatabaseCollation?: string; /** * Target SQL DB connection details. */ targetSqlConnection?: outputs.datamigration.SqlConnectionInformationResponse; } /** * Database Migration Resource properties for SQL Managed Instance. */ interface DatabaseMigrationPropertiesSqlMiResponse { /** * Backup configuration info. */ backupConfiguration?: outputs.datamigration.BackupConfigurationResponse; /** * Database migration end time. */ endedOn: string; /** * Expected value is 'SqlMi'. */ kind: "SqlMi"; /** * Error details in case of migration failure. */ migrationFailureError: outputs.datamigration.ErrorInfoResponse; /** * ID for current migration operation. */ migrationOperationId?: string; /** * Resource Id of the Migration Service. */ migrationService?: string; /** * Migration status. */ migrationStatus: string; /** * Detailed migration status. Not included by default. */ migrationStatusDetails: outputs.datamigration.MigrationStatusDetailsResponse; /** * Offline configuration. */ offlineConfiguration?: outputs.datamigration.OfflineConfigurationResponse; /** * Error message for migration provisioning failure, if any. */ provisioningError?: string; /** * Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started. */ provisioningState: string; /** * Resource Id of the target resource. */ scope?: string; /** * Name of the source database. */ sourceDatabaseName?: string; /** * Name of the source sql server. */ sourceServerName: string; /** * Source SQL Server connection details. */ sourceSqlConnection?: outputs.datamigration.SqlConnectionInformationResponse; /** * Database migration start time. */ startedOn: string; /** * Database collation to be used for the target database. */ targetDatabaseCollation?: string; } /** * Database Migration Resource properties for SQL Virtual Machine. */ interface DatabaseMigrationPropertiesSqlVmResponse { /** * Backup configuration info. */ backupConfiguration?: outputs.datamigration.BackupConfigurationResponse; /** * Database migration end time. */ endedOn: string; /** * Expected value is 'SqlVm'. */ kind: "SqlVm"; /** * Error details in case of migration failure. */ migrationFailureError: outputs.datamigration.ErrorInfoResponse; /** * ID for current migration operation. */ migrationOperationId?: string; /** * Resource Id of the Migration Service. */ migrationService?: string; /** * Migration status. */ migrationStatus: string; /** * Detailed migration status. Not included by default. */ migrationStatusDetails: outputs.datamigration.MigrationStatusDetailsResponse; /** * Offline configuration. */ offlineConfiguration?: outputs.datamigration.OfflineConfigurationResponse; /** * Error message for migration provisioning failure, if any. */ provisioningError?: string; /** * Provisioning State of migration. ProvisioningState as Succeeded implies that validations have been performed and migration has started. */ provisioningState: string; /** * Resource Id of the target resource. */ scope?: string; /** * Name of the source database. */ sourceDatabaseName?: string; /** * Name of the source sql server. */ sourceServerName: string; /** * Source SQL Server connection details. */ sourceSqlConnection?: outputs.datamigration.SqlConnectionInformationResponse; /** * Database migration start time. */ startedOn: string; /** * Database collation to be used for the target database. */ targetDatabaseCollation?: string; } /** * Summary of database results in the migration */ interface DatabaseSummaryResultResponse { /** * Migration end time */ endedOn: string; /** * Wildcard string prefix to use for querying all errors of the item */ errorPrefix: string; /** * Number of successfully completed items */ itemsCompletedCount: number; /** * Number of items */ itemsCount: number; /** * Name of the item */ name: string; /** * Wildcard string prefix to use for querying all sub-tem results of the item */ resultPrefix: string; /** * Size of the database in megabytes */ sizeMB: number; /** * Migration start time */ startedOn: string; /** * Current state of migration */ state: string; /** * Status message */ statusMessage: string; } /** * Table properties */ interface DatabaseTableResponse { /** * Indicates whether table is empty or not */ hasRows: boolean; /** * Schema-qualified name of the table */ name: string; } /** * Error details */ interface ErrorInfoResponse { /** * Error code. */ code: string; /** * Error message. */ message: string; } /** * Description about the errors happen while performing migration validation */ interface ExecutionStatisticsResponse { /** * CPU Time in millisecond(s) for the query execution */ cpuTimeMs?: number; /** * Time taken in millisecond(s) for executing the query */ elapsedTimeMs?: number; /** * No. of query executions */ executionCount?: number; /** * Indicates whether the query resulted in an error */ hasErrors?: boolean; /** * List of sql Errors */ sqlErrors?: string[]; /** * Dictionary of sql query execution wait types and the respective statistics */ waitStats?: { [key: string]: outputs.datamigration.WaitStatisticsResponse; }; } /** * File share information with Path, Username, and Password. */ interface FileShareResponse { /** * Password credential used to connect to the share location. */ password?: string; /** * The folder path for this share. */ path: string; /** * User name credential to connect to the share location */ userName?: string; } /** * Input for the task that gets TDE certificates in Base64 encoded format. */ interface GetTdeCertificatesSqlTaskInputResponse { /** * Backup file share information for file share to be used for temporarily storing files. */ backupFileShare: outputs.datamigration.FileShareResponse; /** * Connection information for SQL Server */ connectionInfo: outputs.datamigration.SqlConnectionInfoResponse; /** * List containing certificate names and corresponding password to use for encrypting the exported certificate. */ selectedCertificates: outputs.datamigration.SelectedCertificateInputResponse[]; } /** * getTdeCertificatesSqlTaskInputResponseProvideDefaults sets the appropriate defaults for GetTdeCertificatesSqlTaskInputResponse */ function getTdeCertificatesSqlTaskInputResponseProvideDefaults(val: GetTdeCertificatesSqlTaskInputResponse): GetTdeCertificatesSqlTaskInputResponse; /** * Output of the task that gets TDE certificates in Base64 encoded format. */ interface GetTdeCertificatesSqlTaskOutputResponse { /** * Mapping from certificate name to base 64 encoded format. */ base64EncodedCertificates: { [key: string]: string[]; }; /** * Validation errors */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Properties for the task that gets TDE certificates in Base64 encoded format. */ interface GetTdeCertificatesSqlTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.GetTdeCertificatesSqlTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.GetTdeCertificatesSqlTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'GetTDECertificates.Sql'. */ taskType: "GetTDECertificates.Sql"; } /** * getTdeCertificatesSqlTaskPropertiesResponseProvideDefaults sets the appropriate defaults for GetTdeCertificatesSqlTaskPropertiesResponse */ function getTdeCertificatesSqlTaskPropertiesResponseProvideDefaults(val: GetTdeCertificatesSqlTaskPropertiesResponse): GetTdeCertificatesSqlTaskPropertiesResponse; /** * Input for the task that collects user tables for the given list of databases */ interface GetUserTablesMySqlTaskInputResponse { /** * Connection information for SQL Server */ connectionInfo: outputs.datamigration.MySqlConnectionInfoResponse; /** * List of database names to collect tables for */ selectedDatabases: string[]; } /** * getUserTablesMySqlTaskInputResponseProvideDefaults sets the appropriate defaults for GetUserTablesMySqlTaskInputResponse */ function getUserTablesMySqlTaskInputResponseProvideDefaults(val: GetUserTablesMySqlTaskInputResponse): GetUserTablesMySqlTaskInputResponse; /** * Output of the task that collects user tables for the given list of databases */ interface GetUserTablesMySqlTaskOutputResponse { /** * Mapping from database name to list of tables */ databasesToTables: { [key: string]: outputs.datamigration.DatabaseTableResponse[]; }; /** * Result identifier */ id: string; /** * Validation errors */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Properties for the task that collects user tables for the given list of databases */ interface GetUserTablesMySqlTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.GetUserTablesMySqlTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.GetUserTablesMySqlTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'GetUserTablesMySql'. */ taskType: "GetUserTablesMySql"; } /** * getUserTablesMySqlTaskPropertiesResponseProvideDefaults sets the appropriate defaults for GetUserTablesMySqlTaskPropertiesResponse */ function getUserTablesMySqlTaskPropertiesResponseProvideDefaults(val: GetUserTablesMySqlTaskPropertiesResponse): GetUserTablesMySqlTaskPropertiesResponse; /** * Input for the task that gets the list of tables contained within a provided list of Oracle schemas. */ interface GetUserTablesOracleTaskInputResponse { /** * Information for connecting to Oracle source */ connectionInfo: outputs.datamigration.OracleConnectionInfoResponse; /** * List of Oracle schemas for which to collect tables */ selectedSchemas: string[]; } /** * Output for the task that gets the list of tables contained within a provided list of Oracle schemas. */ interface GetUserTablesOracleTaskOutputResponse { /** * The schema this result is for */ schemaName: string; /** * List of valid tables found for this schema */ tables: outputs.datamigration.DatabaseTableResponse[]; /** * Validation errors associated with the task */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Properties for the task that collects user tables for the given list of Oracle schemas */ interface GetUserTablesOracleTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.GetUserTablesOracleTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.GetUserTablesOracleTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'GetUserTablesOracle'. */ taskType: "GetUserTablesOracle"; } /** * Input for the task that gets the list of tables for a provided list of PostgreSQL databases. */ interface GetUserTablesPostgreSqlTaskInputResponse { /** * Information for connecting to PostgreSQL source */ connectionInfo: outputs.datamigration.PostgreSqlConnectionInfoResponse; /** * List of PostgreSQL databases for which to collect tables */ selectedDatabases: string[]; } /** * getUserTablesPostgreSqlTaskInputResponseProvideDefaults sets the appropriate defaults for GetUserTablesPostgreSqlTaskInputResponse */ function getUserTablesPostgreSqlTaskInputResponseProvideDefaults(val: GetUserTablesPostgreSqlTaskInputResponse): GetUserTablesPostgreSqlTaskInputResponse; /** * Output for the task that gets the list of tables for a provided list of PostgreSQL databases. */ interface GetUserTablesPostgreSqlTaskOutputResponse { /** * The database this result is for */ databaseName: string; /** * List of valid tables found for this database */ tables: outputs.datamigration.DatabaseTableResponse[]; /** * Validation errors associated with the task */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Properties for the task that collects user tables for the given list of databases */ interface GetUserTablesPostgreSqlTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.GetUserTablesPostgreSqlTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.GetUserTablesPostgreSqlTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'GetUserTablesPostgreSql'. */ taskType: "GetUserTablesPostgreSql"; } /** * getUserTablesPostgreSqlTaskPropertiesResponseProvideDefaults sets the appropriate defaults for GetUserTablesPostgreSqlTaskPropertiesResponse */ function getUserTablesPostgreSqlTaskPropertiesResponseProvideDefaults(val: GetUserTablesPostgreSqlTaskPropertiesResponse): GetUserTablesPostgreSqlTaskPropertiesResponse; /** * Input for the task that collects user tables for the given list of databases */ interface GetUserTablesSqlSyncTaskInputResponse { /** * List of source database names to collect tables for */ selectedSourceDatabases: string[]; /** * List of target database names to collect tables for */ selectedTargetDatabases: string[]; /** * Connection information for SQL Server */ sourceConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; /** * Connection information for SQL DB */ targetConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; } /** * getUserTablesSqlSyncTaskInputResponseProvideDefaults sets the appropriate defaults for GetUserTablesSqlSyncTaskInputResponse */ function getUserTablesSqlSyncTaskInputResponseProvideDefaults(val: GetUserTablesSqlSyncTaskInputResponse): GetUserTablesSqlSyncTaskInputResponse; /** * Output of the task that collects user tables for the given list of databases */ interface GetUserTablesSqlSyncTaskOutputResponse { /** * Mapping from database name to list of source tables */ databasesToSourceTables: { [key: string]: outputs.datamigration.DatabaseTableResponse[]; }; /** * Mapping from database name to list of target tables */ databasesToTargetTables: { [key: string]: outputs.datamigration.DatabaseTableResponse[]; }; /** * Mapping from database name to list of validation errors */ tableValidationErrors: { [key: string]: string[]; }; /** * Validation errors */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Properties for the task that collects user tables for the given list of databases */ interface GetUserTablesSqlSyncTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.GetUserTablesSqlSyncTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.GetUserTablesSqlSyncTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'GetUserTables.AzureSqlDb.Sync'. */ taskType: "GetUserTables.AzureSqlDb.Sync"; } /** * getUserTablesSqlSyncTaskPropertiesResponseProvideDefaults sets the appropriate defaults for GetUserTablesSqlSyncTaskPropertiesResponse */ function getUserTablesSqlSyncTaskPropertiesResponseProvideDefaults(val: GetUserTablesSqlSyncTaskPropertiesResponse): GetUserTablesSqlSyncTaskPropertiesResponse; /** * Input for the task that collects user tables for the given list of databases */ interface GetUserTablesSqlTaskInputResponse { /** * Connection information for SQL Server */ connectionInfo: outputs.datamigration.SqlConnectionInfoResponse; /** * encrypted key for secure fields */ encryptedKeyForSecureFields?: string; /** * List of database names to collect tables for */ selectedDatabases: string[]; } /** * getUserTablesSqlTaskInputResponseProvideDefaults sets the appropriate defaults for GetUserTablesSqlTaskInputResponse */ function getUserTablesSqlTaskInputResponseProvideDefaults(val: GetUserTablesSqlTaskInputResponse): GetUserTablesSqlTaskInputResponse; /** * Output of the task that collects user tables for the given list of databases */ interface GetUserTablesSqlTaskOutputResponse { /** * Mapping from database name to list of tables */ databasesToTables: { [key: string]: outputs.datamigration.DatabaseTableResponse[]; }; /** * Result identifier */ id: string; /** * Validation errors */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Properties for the task that collects user tables for the given list of databases */ interface GetUserTablesSqlTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.GetUserTablesSqlTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.GetUserTablesSqlTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task id */ taskId?: string; /** * Task type. * Expected value is 'GetUserTables.Sql'. */ taskType: "GetUserTables.Sql"; } /** * getUserTablesSqlTaskPropertiesResponseProvideDefaults sets the appropriate defaults for GetUserTablesSqlTaskPropertiesResponse */ function getUserTablesSqlTaskPropertiesResponseProvideDefaults(val: GetUserTablesSqlTaskPropertiesResponse): GetUserTablesSqlTaskPropertiesResponse; /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.datamigration.UserAssignedIdentityResponse; }; } /** * Properties required to create a connection to Azure SQL database Managed instance */ interface MiSqlConnectionInfoResponse { /** * Resource id for Azure SQL database Managed instance */ managedInstanceResourceId: string; /** * Password credential. */ password?: string; /** * Type of connection info * Expected value is 'MiSqlConnectionInfo'. */ type: "MiSqlConnectionInfo"; /** * User name */ userName?: string; } /** * Input for command that completes online migration for an Azure SQL Database Managed Instance. */ interface MigrateMISyncCompleteCommandInputResponse { /** * Name of managed instance database */ sourceDatabaseName: string; } /** * Output for command that completes online migration for an Azure SQL Database Managed Instance. */ interface MigrateMISyncCompleteCommandOutputResponse { /** * List of errors that happened during the command execution */ errors?: outputs.datamigration.ReportableExceptionResponse[]; } /** * Properties for the command that completes online migration for an Azure SQL Database Managed Instance. */ interface MigrateMISyncCompleteCommandPropertiesResponse { /** * Command type. * Expected value is 'Migrate.SqlServer.AzureDbSqlMi.Complete'. */ commandType: "Migrate.SqlServer.AzureDbSqlMi.Complete"; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Command input */ input?: outputs.datamigration.MigrateMISyncCompleteCommandInputResponse; /** * Command output. This is ignored if submitted. */ output: outputs.datamigration.MigrateMISyncCompleteCommandOutputResponse; /** * The state of the command. This is ignored if submitted. */ state: string; } /** * Properties for the task that migrates data between MongoDB data sources */ interface MigrateMongoDbTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Describes how a MongoDB data migration should be performed */ input?: outputs.datamigration.MongoDbMigrationSettingsResponse; output: (outputs.datamigration.MongoDbCollectionProgressResponse | outputs.datamigration.MongoDbDatabaseProgressResponse | outputs.datamigration.MongoDbMigrationProgressResponse)[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'Migrate.MongoDb'. */ taskType: "Migrate.MongoDb"; } /** * migrateMongoDbTaskPropertiesResponseProvideDefaults sets the appropriate defaults for MigrateMongoDbTaskPropertiesResponse */ function migrateMongoDbTaskPropertiesResponseProvideDefaults(val: MigrateMongoDbTaskPropertiesResponse): MigrateMongoDbTaskPropertiesResponse; /** * Database specific information for offline MySQL to Azure Database for MySQL migration task inputs */ interface MigrateMySqlAzureDbForMySqlOfflineDatabaseInputResponse { /** * Name of the database */ name?: string; /** * Mapping of source to target tables */ tableMap?: { [key: string]: string; }; /** * Name of target database. Note: Target database will be truncated before starting migration. */ targetDatabaseName?: string; } /** * Input for the task that migrates MySQL databases to Azure Database for MySQL for offline migrations */ interface MigrateMySqlAzureDbForMySqlOfflineTaskInputResponse { /** * encrypted key for secure fields */ encryptedKeyForSecureFields?: string; /** * Setting to set the source server read only */ makeSourceServerReadOnly?: boolean; /** * Optional parameters for fine tuning the data transfer rate during migration */ optionalAgentSettings?: { [key: string]: string; }; /** * Databases to migrate */ selectedDatabases: outputs.datamigration.MigrateMySqlAzureDbForMySqlOfflineDatabaseInputResponse[]; /** * Connection information for source MySQL */ sourceConnectionInfo: outputs.datamigration.MySqlConnectionInfoResponse; /** * Parameter to specify when the migration started */ startedOn?: string; /** * Connection information for target Azure Database for MySQL */ targetConnectionInfo: outputs.datamigration.MySqlConnectionInfoResponse; } /** * migrateMySqlAzureDbForMySqlOfflineTaskInputResponseProvideDefaults sets the appropriate defaults for MigrateMySqlAzureDbForMySqlOfflineTaskInputResponse */ function migrateMySqlAzureDbForMySqlOfflineTaskInputResponseProvideDefaults(val: MigrateMySqlAzureDbForMySqlOfflineTaskInputResponse): MigrateMySqlAzureDbForMySqlOfflineTaskInputResponse; interface MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevelResponse { /** * Name of the database */ databaseName: string; /** * Migration end time */ endedOn: string; /** * Number of database/object errors. */ errorCount: number; /** * Wildcard string prefix to use for querying all errors of the item */ errorPrefix: string; /** * Migration exceptions and warnings. */ exceptionsAndWarnings: outputs.datamigration.ReportableExceptionResponse[]; /** * Result identifier */ id: string; /** * Last time the storage was updated */ lastStorageUpdate: string; /** * Migration progress message */ message: string; /** * Number of objects */ numberOfObjects: number; /** * Number of successfully completed objects */ numberOfObjectsCompleted: number; /** * Summary of object results in the migration */ objectSummary: { [key: string]: outputs.datamigration.DataItemMigrationSummaryResultResponse; }; /** * Wildcard string prefix to use for querying all sub-tem results of the item */ resultPrefix: string; /** * Result type * Expected value is 'DatabaseLevelOutput'. */ resultType: "DatabaseLevelOutput"; /** * Migration stage that this database is in */ stage: string; /** * Migration start time */ startedOn: string; /** * Current state of migration */ state: string; /** * Status message */ statusMessage: string; } interface MigrateMySqlAzureDbForMySqlOfflineTaskOutputErrorResponse { /** * Migration error */ error: outputs.datamigration.ReportableExceptionResponse; /** * Result identifier */ id: string; /** * Result type * Expected value is 'ErrorOutput'. */ resultType: "ErrorOutput"; } interface MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevelResponse { /** * Summary of database results in the migration */ databaseSummary: { [key: string]: outputs.datamigration.DatabaseSummaryResultResponse; }; /** * Selected databases as a map from database name to database id */ databases?: { [key: string]: string; }; /** * Duration of task execution in seconds. */ durationInSeconds: number; /** * Migration end time */ endedOn: string; /** * Migration exceptions and warnings. */ exceptionsAndWarnings: outputs.datamigration.ReportableExceptionResponse[]; /** * Result identifier */ id: string; /** * Last time the storage was updated */ lastStorageUpdate: string; /** * Migration progress message */ message: string; /** * Migration Report Result, provides unique url for downloading your migration report. */ migrationReportResult?: outputs.datamigration.MigrationReportResultResponse; /** * Result type * Expected value is 'MigrationLevelOutput'. */ resultType: "MigrationLevelOutput"; /** * Source server brand version */ sourceServerBrandVersion: string; /** * Source server version */ sourceServerVersion: string; /** * Migration start time */ startedOn: string; /** * Current status of migration */ status: string; /** * Migration status message */ statusMessage: string; /** * Target server brand version */ targetServerBrandVersion: string; /** * Target server version */ targetServerVersion: string; } interface MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevelResponse { /** * Migration end time */ endedOn: string; /** * Wildcard string prefix to use for querying all errors of the item */ errorPrefix: string; /** * Result identifier */ id: string; /** * Number of successfully completed items */ itemsCompletedCount: number; /** * Number of items */ itemsCount: number; /** * Last time the storage was updated */ lastStorageUpdate: string; /** * Name of the item */ objectName: string; /** * Wildcard string prefix to use for querying all sub-tem results of the item */ resultPrefix: string; /** * Result type * Expected value is 'TableLevelOutput'. */ resultType: "TableLevelOutput"; /** * Migration start time */ startedOn: string; /** * Current state of migration */ state: string; /** * Status message */ statusMessage: string; } /** * Properties for the task that migrates MySQL databases to Azure Database for MySQL for offline migrations */ interface MigrateMySqlAzureDbForMySqlOfflineTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.MigrateMySqlAzureDbForMySqlOfflineTaskInputResponse; /** * whether the task can be cloned or not */ isCloneable?: boolean; /** * Task output. This is ignored if submitted. */ output: (outputs.datamigration.MigrateMySqlAzureDbForMySqlOfflineTaskOutputDatabaseLevelResponse | outputs.datamigration.MigrateMySqlAzureDbForMySqlOfflineTaskOutputErrorResponse | outputs.datamigration.MigrateMySqlAzureDbForMySqlOfflineTaskOutputMigrationLevelResponse | outputs.datamigration.MigrateMySqlAzureDbForMySqlOfflineTaskOutputTableLevelResponse)[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task id */ taskId?: string; /** * Task type. * Expected value is 'Migrate.MySql.AzureDbForMySql'. */ taskType: "Migrate.MySql.AzureDbForMySql"; } /** * migrateMySqlAzureDbForMySqlOfflineTaskPropertiesResponseProvideDefaults sets the appropriate defaults for MigrateMySqlAzureDbForMySqlOfflineTaskPropertiesResponse */ function migrateMySqlAzureDbForMySqlOfflineTaskPropertiesResponseProvideDefaults(val: MigrateMySqlAzureDbForMySqlOfflineTaskPropertiesResponse): MigrateMySqlAzureDbForMySqlOfflineTaskPropertiesResponse; /** * Database specific information for MySQL to Azure Database for MySQL migration task inputs */ interface MigrateMySqlAzureDbForMySqlSyncDatabaseInputResponse { /** * Migration settings which tune the migration behavior */ migrationSetting?: { [key: string]: string; }; /** * Name of the database */ name?: string; /** * Source settings to tune source endpoint migration behavior */ sourceSetting?: { [key: string]: string; }; /** * Mapping of source to target tables */ tableMap?: { [key: string]: string; }; /** * Name of target database. Note: Target database will be truncated before starting migration. */ targetDatabaseName?: string; /** * Target settings to tune target endpoint migration behavior */ targetSetting?: { [key: string]: string; }; } /** * Input for the task that migrates MySQL databases to Azure Database for MySQL for online migrations */ interface MigrateMySqlAzureDbForMySqlSyncTaskInputResponse { /** * Databases to migrate */ selectedDatabases: outputs.datamigration.MigrateMySqlAzureDbForMySqlSyncDatabaseInputResponse[]; /** * Connection information for source MySQL */ sourceConnectionInfo: outputs.datamigration.MySqlConnectionInfoResponse; /** * Connection information for target Azure Database for MySQL */ targetConnectionInfo: outputs.datamigration.MySqlConnectionInfoResponse; } /** * migrateMySqlAzureDbForMySqlSyncTaskInputResponseProvideDefaults sets the appropriate defaults for MigrateMySqlAzureDbForMySqlSyncTaskInputResponse */ function migrateMySqlAzureDbForMySqlSyncTaskInputResponseProvideDefaults(val: MigrateMySqlAzureDbForMySqlSyncTaskInputResponse): MigrateMySqlAzureDbForMySqlSyncTaskInputResponse; interface MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseErrorResponse { /** * Error message */ errorMessage?: string; /** * List of error events. */ events?: outputs.datamigration.SyncMigrationDatabaseErrorEventResponse[]; /** * Result identifier */ id: string; /** * Result type * Expected value is 'DatabaseLevelErrorOutput'. */ resultType: "DatabaseLevelErrorOutput"; } interface MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevelResponse { /** * Number of applied changes */ appliedChanges: number; /** * Number of cdc deletes */ cdcDeleteCounter: number; /** * Number of cdc inserts */ cdcInsertCounter: number; /** * Number of cdc updates */ cdcUpdateCounter: number; /** * Name of the database */ databaseName: string; /** * Migration end time */ endedOn: string; /** * Number of tables completed in full load */ fullLoadCompletedTables: number; /** * Number of tables errored in full load */ fullLoadErroredTables: number; /** * Number of tables loading in full load */ fullLoadLoadingTables: number; /** * Number of tables queued in full load */ fullLoadQueuedTables: number; /** * Result identifier */ id: string; /** * Number of incoming changes */ incomingChanges: number; /** * Indicates if initial load (full load) has been completed */ initializationCompleted: boolean; /** * CDC apply latency */ latency: number; /** * Migration state that this database is in */ migrationState: string; /** * Result type * Expected value is 'DatabaseLevelOutput'. */ resultType: "DatabaseLevelOutput"; /** * Migration start time */ startedOn: string; } interface MigrateMySqlAzureDbForMySqlSyncTaskOutputErrorResponse { /** * Migration error */ error: outputs.datamigration.ReportableExceptionResponse; /** * Result identifier */ id: string; /** * Result type * Expected value is 'ErrorOutput'. */ resultType: "ErrorOutput"; } interface MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevelResponse { /** * Migration end time */ endedOn: string; /** * Result identifier */ id: string; /** * Result type * Expected value is 'MigrationLevelOutput'. */ resultType: "MigrationLevelOutput"; /** * Source server name */ sourceServer: string; /** * Source server version */ sourceServerVersion: string; /** * Migration start time */ startedOn: string; /** * Target server name */ targetServer: string; /** * Target server version */ targetServerVersion: string; } interface MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevelResponse { /** * Number of applied deletes */ cdcDeleteCounter: string; /** * Number of applied inserts */ cdcInsertCounter: string; /** * Number of applied updates */ cdcUpdateCounter: string; /** * Number of data errors occurred */ dataErrorsCounter: number; /** * Name of the database */ databaseName: string; /** * Full load end time */ fullLoadEndedOn: string; /** * Estimate to finish full load */ fullLoadEstFinishTime: string; /** * Full load start time */ fullLoadStartedOn: string; /** * Number of rows applied in full load */ fullLoadTotalRows: number; /** * Result identifier */ id: string; /** * Last modified time on target */ lastModifiedTime: string; /** * Result type * Expected value is 'TableLevelOutput'. */ resultType: "TableLevelOutput"; /** * Current state of the table migration */ state: string; /** * Name of the table */ tableName: string; /** * Total number of applied changes */ totalChangesApplied: number; } /** * Properties for the task that migrates MySQL databases to Azure Database for MySQL for online migrations */ interface MigrateMySqlAzureDbForMySqlSyncTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.MigrateMySqlAzureDbForMySqlSyncTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: (outputs.datamigration.MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseErrorResponse | outputs.datamigration.MigrateMySqlAzureDbForMySqlSyncTaskOutputDatabaseLevelResponse | outputs.datamigration.MigrateMySqlAzureDbForMySqlSyncTaskOutputErrorResponse | outputs.datamigration.MigrateMySqlAzureDbForMySqlSyncTaskOutputMigrationLevelResponse | outputs.datamigration.MigrateMySqlAzureDbForMySqlSyncTaskOutputTableLevelResponse)[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'Migrate.MySql.AzureDbForMySql.Sync'. */ taskType: "Migrate.MySql.AzureDbForMySql.Sync"; } /** * migrateMySqlAzureDbForMySqlSyncTaskPropertiesResponseProvideDefaults sets the appropriate defaults for MigrateMySqlAzureDbForMySqlSyncTaskPropertiesResponse */ function migrateMySqlAzureDbForMySqlSyncTaskPropertiesResponseProvideDefaults(val: MigrateMySqlAzureDbForMySqlSyncTaskPropertiesResponse): MigrateMySqlAzureDbForMySqlSyncTaskPropertiesResponse; /** * Properties for the task that migrates Oracle to Azure Database for PostgreSQL for online migrations */ interface MigrateOracleAzureDbForPostgreSqlSyncTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.MigrateOracleAzureDbPostgreSqlSyncTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: (outputs.datamigration.MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseErrorResponse | outputs.datamigration.MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevelResponse | outputs.datamigration.MigrateOracleAzureDbPostgreSqlSyncTaskOutputErrorResponse | outputs.datamigration.MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevelResponse | outputs.datamigration.MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevelResponse)[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'Migrate.Oracle.AzureDbForPostgreSql.Sync'. */ taskType: "Migrate.Oracle.AzureDbForPostgreSql.Sync"; } /** * migrateOracleAzureDbForPostgreSqlSyncTaskPropertiesResponseProvideDefaults sets the appropriate defaults for MigrateOracleAzureDbForPostgreSqlSyncTaskPropertiesResponse */ function migrateOracleAzureDbForPostgreSqlSyncTaskPropertiesResponseProvideDefaults(val: MigrateOracleAzureDbForPostgreSqlSyncTaskPropertiesResponse): MigrateOracleAzureDbForPostgreSqlSyncTaskPropertiesResponse; /** * Database specific information for Oracle to Azure Database for PostgreSQL migration task inputs */ interface MigrateOracleAzureDbPostgreSqlSyncDatabaseInputResponse { /** * How to handle object name casing: either Preserve or ToLower */ caseManipulation?: string; /** * Migration settings which tune the migration behavior */ migrationSetting?: { [key: string]: string; }; /** * Name of the migration pipeline */ name?: string; /** * Name of the source schema */ schemaName?: string; /** * Source settings to tune source endpoint migration behavior */ sourceSetting?: { [key: string]: string; }; /** * Mapping of source to target tables */ tableMap?: { [key: string]: string; }; /** * Name of target database. Note: Target database will be truncated before starting migration. */ targetDatabaseName?: string; /** * Target settings to tune target endpoint migration behavior */ targetSetting?: { [key: string]: string; }; } /** * Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations */ interface MigrateOracleAzureDbPostgreSqlSyncTaskInputResponse { /** * Databases to migrate */ selectedDatabases: outputs.datamigration.MigrateOracleAzureDbPostgreSqlSyncDatabaseInputResponse[]; /** * Connection information for source Oracle */ sourceConnectionInfo: outputs.datamigration.OracleConnectionInfoResponse; /** * Connection information for target Azure Database for PostgreSQL */ targetConnectionInfo: outputs.datamigration.PostgreSqlConnectionInfoResponse; } /** * migrateOracleAzureDbPostgreSqlSyncTaskInputResponseProvideDefaults sets the appropriate defaults for MigrateOracleAzureDbPostgreSqlSyncTaskInputResponse */ function migrateOracleAzureDbPostgreSqlSyncTaskInputResponseProvideDefaults(val: MigrateOracleAzureDbPostgreSqlSyncTaskInputResponse): MigrateOracleAzureDbPostgreSqlSyncTaskInputResponse; interface MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseErrorResponse { /** * Error message */ errorMessage?: string; /** * List of error events. */ events?: outputs.datamigration.SyncMigrationDatabaseErrorEventResponse[]; /** * Result identifier */ id: string; /** * Result type * Expected value is 'DatabaseLevelErrorOutput'. */ resultType: "DatabaseLevelErrorOutput"; } interface MigrateOracleAzureDbPostgreSqlSyncTaskOutputDatabaseLevelResponse { /** * Number of applied changes */ appliedChanges: number; /** * Number of cdc deletes */ cdcDeleteCounter: number; /** * Number of cdc inserts */ cdcInsertCounter: number; /** * Number of cdc updates */ cdcUpdateCounter: number; /** * Name of the database */ databaseName: string; /** * Migration end time */ endedOn: string; /** * Number of tables completed in full load */ fullLoadCompletedTables: number; /** * Number of tables errored in full load */ fullLoadErroredTables: number; /** * Number of tables loading in full load */ fullLoadLoadingTables: number; /** * Number of tables queued in full load */ fullLoadQueuedTables: number; /** * Result identifier */ id: string; /** * Number of incoming changes */ incomingChanges: number; /** * Indicates if initial load (full load) has been completed */ initializationCompleted: boolean; /** * CDC apply latency */ latency: number; /** * Migration state that this database is in */ migrationState: string; /** * Result type * Expected value is 'DatabaseLevelOutput'. */ resultType: "DatabaseLevelOutput"; /** * Migration start time */ startedOn: string; } interface MigrateOracleAzureDbPostgreSqlSyncTaskOutputErrorResponse { /** * Migration error */ error: outputs.datamigration.ReportableExceptionResponse; /** * Result identifier */ id: string; /** * Result type * Expected value is 'ErrorOutput'. */ resultType: "ErrorOutput"; } interface MigrateOracleAzureDbPostgreSqlSyncTaskOutputMigrationLevelResponse { /** * Migration end time */ endedOn: string; /** * Result identifier */ id: string; /** * Result type * Expected value is 'MigrationLevelOutput'. */ resultType: "MigrationLevelOutput"; /** * Source server name */ sourceServer: string; /** * Source server version */ sourceServerVersion: string; /** * Migration start time */ startedOn: string; /** * Target server name */ targetServer: string; /** * Target server version */ targetServerVersion: string; } interface MigrateOracleAzureDbPostgreSqlSyncTaskOutputTableLevelResponse { /** * Number of applied deletes */ cdcDeleteCounter: number; /** * Number of applied inserts */ cdcInsertCounter: number; /** * Number of applied updates */ cdcUpdateCounter: number; /** * Number of data errors occurred */ dataErrorsCounter: number; /** * Name of the database */ databaseName: string; /** * Full load end time */ fullLoadEndedOn: string; /** * Estimate to finish full load */ fullLoadEstFinishTime: string; /** * Full load start time */ fullLoadStartedOn: string; /** * Number of rows applied in full load */ fullLoadTotalRows: number; /** * Result identifier */ id: string; /** * Last modified time on target */ lastModifiedTime: string; /** * Result type * Expected value is 'TableLevelOutput'. */ resultType: "TableLevelOutput"; /** * Current state of the table migration */ state: string; /** * Name of the table */ tableName: string; /** * Total number of applied changes */ totalChangesApplied: number; } /** * Database specific information for PostgreSQL to Azure Database for PostgreSQL migration task inputs */ interface MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputResponse { /** * Result identifier */ id: string; /** * Migration settings which tune the migration behavior */ migrationSetting?: any; /** * Name of the database */ name?: string; /** * Tables selected for migration */ selectedTables?: outputs.datamigration.MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInputResponse[]; /** * Source settings to tune source endpoint migration behavior */ sourceSetting?: { [key: string]: string; }; /** * Name of target database. Note: Target database will be truncated before starting migration. */ targetDatabaseName?: string; /** * Target settings to tune target endpoint migration behavior */ targetSetting?: { [key: string]: string; }; } /** * Selected tables for the migration */ interface MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseTableInputResponse { /** * Name of the table to migrate */ name?: string; } /** * Input for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations */ interface MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInputResponse { /** * encrypted key for secure fields */ encryptedKeyForSecureFields?: string; /** * Databases to migrate */ selectedDatabases: outputs.datamigration.MigratePostgreSqlAzureDbForPostgreSqlSyncDatabaseInputResponse[]; /** * Connection information for source PostgreSQL */ sourceConnectionInfo: outputs.datamigration.PostgreSqlConnectionInfoResponse; /** * Migration start time */ startedOn: string; /** * Connection information for target Azure Database for PostgreSQL */ targetConnectionInfo: outputs.datamigration.PostgreSqlConnectionInfoResponse; } /** * migratePostgreSqlAzureDbForPostgreSqlSyncTaskInputResponseProvideDefaults sets the appropriate defaults for MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInputResponse */ function migratePostgreSqlAzureDbForPostgreSqlSyncTaskInputResponseProvideDefaults(val: MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInputResponse): MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInputResponse; interface MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseErrorResponse { /** * Error message */ errorMessage?: string; /** * List of error events. */ events?: outputs.datamigration.SyncMigrationDatabaseErrorEventResponse[]; /** * Result identifier */ id: string; /** * Result type * Expected value is 'DatabaseLevelErrorOutput'. */ resultType: "DatabaseLevelErrorOutput"; } interface MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevelResponse { /** * Number of applied changes */ appliedChanges: number; /** * Number of cdc deletes */ cdcDeleteCounter: number; /** * Number of cdc inserts */ cdcInsertCounter: number; /** * Number of cdc updates */ cdcUpdateCounter: number; /** * Name of the database */ databaseName: string; /** * Migration end time */ endedOn: string; /** * Number of tables completed in full load */ fullLoadCompletedTables: number; /** * Number of tables errored in full load */ fullLoadErroredTables: number; /** * Number of tables loading in full load */ fullLoadLoadingTables: number; /** * Number of tables queued in full load */ fullLoadQueuedTables: number; /** * Result identifier */ id: string; /** * Number of incoming changes */ incomingChanges: number; /** * Indicates if initial load (full load) has been completed */ initializationCompleted: boolean; /** * CDC apply latency */ latency: number; /** * Migration state that this database is in */ migrationState: string; /** * Result type * Expected value is 'DatabaseLevelOutput'. */ resultType: "DatabaseLevelOutput"; /** * Migration start time */ startedOn: string; } interface MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputErrorResponse { /** * Migration error */ error: outputs.datamigration.ReportableExceptionResponse; /** * List of error events */ events?: outputs.datamigration.SyncMigrationDatabaseErrorEventResponse[]; /** * Result identifier */ id: string; /** * Result type * Expected value is 'ErrorOutput'. */ resultType: "ErrorOutput"; } interface MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevelResponse { /** * Number of databases to include */ databaseCount?: number; /** * Migration end time */ endedOn: string; /** * Result identifier */ id: string; /** * Result type * Expected value is 'MigrationLevelOutput'. */ resultType: "MigrationLevelOutput"; /** * Source server name */ sourceServer: string; /** * Source server type. */ sourceServerType: string; /** * Source server version */ sourceServerVersion: string; /** * Migration start time */ startedOn: string; /** * Migration status */ state: string; /** * Target server name */ targetServer: string; /** * Target server type. */ targetServerType: string; /** * Target server version */ targetServerVersion: string; } interface MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevelResponse { /** * Number of applied deletes */ cdcDeleteCounter: number; /** * Number of applied inserts */ cdcInsertCounter: number; /** * Number of applied updates */ cdcUpdateCounter: number; /** * Number of data errors occurred */ dataErrorsCounter: number; /** * Name of the database */ databaseName: string; /** * Full load end time */ fullLoadEndedOn: string; /** * Estimate to finish full load */ fullLoadEstFinishTime: string; /** * Full load start time */ fullLoadStartedOn: string; /** * Number of rows applied in full load */ fullLoadTotalRows: number; /** * Result identifier */ id: string; /** * Last modified time on target */ lastModifiedTime: string; /** * Result type * Expected value is 'TableLevelOutput'. */ resultType: "TableLevelOutput"; /** * Current state of the table migration */ state: string; /** * Name of the table */ tableName: string; /** * Total number of applied changes */ totalChangesApplied: number; } /** * Properties for the task that migrates PostgreSQL databases to Azure Database for PostgreSQL for online migrations */ interface MigratePostgreSqlAzureDbForPostgreSqlSyncTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * DateTime in UTC when the task was created */ createdOn?: string; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskInputResponse; /** * whether the task can be cloned or not */ isCloneable?: boolean; /** * Task output. This is ignored if submitted. */ output: (outputs.datamigration.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseErrorResponse | outputs.datamigration.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputDatabaseLevelResponse | outputs.datamigration.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputErrorResponse | outputs.datamigration.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputMigrationLevelResponse | outputs.datamigration.MigratePostgreSqlAzureDbForPostgreSqlSyncTaskOutputTableLevelResponse)[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * task id */ taskId?: string; /** * Task type. * Expected value is 'Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2'. */ taskType: "Migrate.PostgreSql.AzureDbForPostgreSql.SyncV2"; } /** * migratePostgreSqlAzureDbForPostgreSqlSyncTaskPropertiesResponseProvideDefaults sets the appropriate defaults for MigratePostgreSqlAzureDbForPostgreSqlSyncTaskPropertiesResponse */ function migratePostgreSqlAzureDbForPostgreSqlSyncTaskPropertiesResponseProvideDefaults(val: MigratePostgreSqlAzureDbForPostgreSqlSyncTaskPropertiesResponse): MigratePostgreSqlAzureDbForPostgreSqlSyncTaskPropertiesResponse; /** * Database specific information for SQL to Azure SQL DB migration task inputs */ interface MigrateSqlServerSqlDbDatabaseInputResponse { /** * id of the database */ id?: string; /** * Whether to set database read only before migration */ makeSourceDbReadOnly?: boolean; /** * Name of the database */ name?: string; /** * Settings selected for DB schema migration. */ schemaSetting?: any; /** * Mapping of source to target tables */ tableMap?: { [key: string]: string; }; /** * Name of target database. Note: Target database will be truncated before starting migration. */ targetDatabaseName?: string; } /** * Database specific information for SQL to Azure SQL DB sync migration task inputs */ interface MigrateSqlServerSqlDbSyncDatabaseInputResponse { /** * Unique identifier for database */ id?: string; /** * Migration settings which tune the migration behavior */ migrationSetting?: { [key: string]: string; }; /** * Name of database */ name?: string; /** * Schema name to be migrated */ schemaName?: string; /** * Source settings to tune source endpoint migration behavior */ sourceSetting?: { [key: string]: string; }; /** * Mapping of source to target tables */ tableMap?: { [key: string]: string; }; /** * Target database name */ targetDatabaseName?: string; /** * Target settings to tune target endpoint migration behavior */ targetSetting?: { [key: string]: string; }; } /** * Input for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations */ interface MigrateSqlServerSqlDbSyncTaskInputResponse { /** * Databases to migrate */ selectedDatabases: outputs.datamigration.MigrateSqlServerSqlDbSyncDatabaseInputResponse[]; /** * Information for connecting to source */ sourceConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; /** * Information for connecting to target */ targetConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; /** * Validation options */ validationOptions?: outputs.datamigration.MigrationValidationOptionsResponse; } /** * migrateSqlServerSqlDbSyncTaskInputResponseProvideDefaults sets the appropriate defaults for MigrateSqlServerSqlDbSyncTaskInputResponse */ function migrateSqlServerSqlDbSyncTaskInputResponseProvideDefaults(val: MigrateSqlServerSqlDbSyncTaskInputResponse): MigrateSqlServerSqlDbSyncTaskInputResponse; interface MigrateSqlServerSqlDbSyncTaskOutputDatabaseErrorResponse { /** * Error message */ errorMessage?: string; /** * List of error events. */ events?: outputs.datamigration.SyncMigrationDatabaseErrorEventResponse[]; /** * Result identifier */ id: string; /** * Result type * Expected value is 'DatabaseLevelErrorOutput'. */ resultType: "DatabaseLevelErrorOutput"; } interface MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevelResponse { /** * Number of applied changes */ appliedChanges: number; /** * Number of cdc deletes */ cdcDeleteCounter: number; /** * Number of cdc inserts */ cdcInsertCounter: number; /** * Number of cdc updates */ cdcUpdateCounter: number; /** * Name of the database */ databaseName: string; /** * Migration end time */ endedOn: string; /** * Number of tables completed in full load */ fullLoadCompletedTables: number; /** * Number of tables errored in full load */ fullLoadErroredTables: number; /** * Number of tables loading in full load */ fullLoadLoadingTables: number; /** * Number of tables queued in full load */ fullLoadQueuedTables: number; /** * Result identifier */ id: string; /** * Number of incoming changes */ incomingChanges: number; /** * Indicates if initial load (full load) has been completed */ initializationCompleted: boolean; /** * CDC apply latency */ latency: number; /** * Migration state that this database is in */ migrationState: string; /** * Result type * Expected value is 'DatabaseLevelOutput'. */ resultType: "DatabaseLevelOutput"; /** * Migration start time */ startedOn: string; } interface MigrateSqlServerSqlDbSyncTaskOutputErrorResponse { /** * Migration error */ error: outputs.datamigration.ReportableExceptionResponse; /** * Result identifier */ id: string; /** * Result type * Expected value is 'ErrorOutput'. */ resultType: "ErrorOutput"; } interface MigrateSqlServerSqlDbSyncTaskOutputMigrationLevelResponse { /** * Count of databases */ databaseCount: number; /** * Migration end time */ endedOn: string; /** * Result identifier */ id: string; /** * Result type * Expected value is 'MigrationLevelOutput'. */ resultType: "MigrationLevelOutput"; /** * Source server name */ sourceServer: string; /** * Source server version */ sourceServerVersion: string; /** * Migration start time */ startedOn: string; /** * Target server name */ targetServer: string; /** * Target server version */ targetServerVersion: string; } interface MigrateSqlServerSqlDbSyncTaskOutputTableLevelResponse { /** * Number of applied deletes */ cdcDeleteCounter: number; /** * Number of applied inserts */ cdcInsertCounter: number; /** * Number of applied updates */ cdcUpdateCounter: number; /** * Number of data errors occurred */ dataErrorsCounter: number; /** * Name of the database */ databaseName: string; /** * Full load end time */ fullLoadEndedOn: string; /** * Estimate to finish full load */ fullLoadEstFinishTime: string; /** * Full load start time */ fullLoadStartedOn: string; /** * Number of rows applied in full load */ fullLoadTotalRows: number; /** * Result identifier */ id: string; /** * Last modified time on target */ lastModifiedTime: string; /** * Result type * Expected value is 'TableLevelOutput'. */ resultType: "TableLevelOutput"; /** * Current state of the table migration */ state: string; /** * Name of the table */ tableName: string; /** * Total number of applied changes */ totalChangesApplied: number; } /** * Properties for the task that migrates on-prem SQL Server databases to Azure SQL Database for online migrations */ interface MigrateSqlServerSqlDbSyncTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.MigrateSqlServerSqlDbSyncTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: (outputs.datamigration.MigrateSqlServerSqlDbSyncTaskOutputDatabaseErrorResponse | outputs.datamigration.MigrateSqlServerSqlDbSyncTaskOutputDatabaseLevelResponse | outputs.datamigration.MigrateSqlServerSqlDbSyncTaskOutputErrorResponse | outputs.datamigration.MigrateSqlServerSqlDbSyncTaskOutputMigrationLevelResponse | outputs.datamigration.MigrateSqlServerSqlDbSyncTaskOutputTableLevelResponse)[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'Migrate.SqlServer.AzureSqlDb.Sync'. */ taskType: "Migrate.SqlServer.AzureSqlDb.Sync"; } /** * migrateSqlServerSqlDbSyncTaskPropertiesResponseProvideDefaults sets the appropriate defaults for MigrateSqlServerSqlDbSyncTaskPropertiesResponse */ function migrateSqlServerSqlDbSyncTaskPropertiesResponseProvideDefaults(val: MigrateSqlServerSqlDbSyncTaskPropertiesResponse): MigrateSqlServerSqlDbSyncTaskPropertiesResponse; /** * Input for the task that migrates on-prem SQL Server databases to Azure SQL Database */ interface MigrateSqlServerSqlDbTaskInputResponse { /** * encrypted key for secure fields */ encryptedKeyForSecureFields?: string; /** * Databases to migrate */ selectedDatabases: outputs.datamigration.MigrateSqlServerSqlDbDatabaseInputResponse[]; /** * Information for connecting to source */ sourceConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; /** * Date and time relative to UTC when the migration was started on */ startedOn?: string; /** * Information for connecting to target */ targetConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; /** * Options for enabling various post migration validations. Available options, * 1.) Data Integrity Check: Performs a checksum based comparison on source and target tables after the migration to ensure the correctness of the data. * 2.) Schema Validation: Performs a thorough schema comparison between the source and target tables and provides a list of differences between the source and target database, 3.) Query Analysis: Executes a set of queries picked up automatically either from the Query Plan Cache or Query Store and execute them and compares the execution time between the source and target database. */ validationOptions?: outputs.datamigration.MigrationValidationOptionsResponse; } /** * migrateSqlServerSqlDbTaskInputResponseProvideDefaults sets the appropriate defaults for MigrateSqlServerSqlDbTaskInputResponse */ function migrateSqlServerSqlDbTaskInputResponseProvideDefaults(val: MigrateSqlServerSqlDbTaskInputResponse): MigrateSqlServerSqlDbTaskInputResponse; interface MigrateSqlServerSqlDbTaskOutputDatabaseLevelResponse { /** * Name of the item */ databaseName: string; /** * Migration end time */ endedOn: string; /** * Number of database/object errors. */ errorCount: number; /** * Wildcard string prefix to use for querying all errors of the item */ errorPrefix: string; /** * Migration exceptions and warnings. */ exceptionsAndWarnings: outputs.datamigration.ReportableExceptionResponse[]; /** * Result identifier */ id: string; /** * Migration progress message */ message: string; /** * Number of objects */ numberOfObjects: number; /** * Number of successfully completed objects */ numberOfObjectsCompleted: number; /** * Summary of object results in the migration */ objectSummary: { [key: string]: outputs.datamigration.DataItemMigrationSummaryResultResponse; }; /** * Wildcard string prefix to use for querying all sub-tem results of the item */ resultPrefix: string; /** * Result type * Expected value is 'DatabaseLevelOutput'. */ resultType: "DatabaseLevelOutput"; /** * Migration stage that this database is in */ stage: string; /** * Migration start time */ startedOn: string; /** * Current state of migration */ state: string; /** * Status message */ statusMessage: string; } interface MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResultResponse { /** * Provides data integrity validation result between the source and target tables that are migrated. */ dataIntegrityValidationResult: outputs.datamigration.DataIntegrityValidationResultResponse; /** * Validation end time */ endedOn: string; /** * Result identifier */ id: string; /** * Migration Identifier */ migrationId: string; /** * Results of some of the query execution result between source and target database */ queryAnalysisValidationResult: outputs.datamigration.QueryAnalysisValidationResultResponse; /** * Result type * Expected value is 'MigrationDatabaseLevelValidationOutput'. */ resultType: "MigrationDatabaseLevelValidationOutput"; /** * Provides schema comparison result between source and target database */ schemaValidationResult: outputs.datamigration.SchemaComparisonValidationResultResponse; /** * Name of the source database */ sourceDatabaseName: string; /** * Validation start time */ startedOn: string; /** * Current status of validation at the database level */ status: string; /** * Name of the target database */ targetDatabaseName: string; } interface MigrateSqlServerSqlDbTaskOutputErrorResponse { /** * Migration error */ error: outputs.datamigration.ReportableExceptionResponse; /** * Result identifier */ id: string; /** * Result type * Expected value is 'ErrorOutput'. */ resultType: "ErrorOutput"; } interface MigrateSqlServerSqlDbTaskOutputMigrationLevelResponse { /** * Summary of database results in the migration */ databaseSummary: { [key: string]: outputs.datamigration.DatabaseSummaryResultResponse; }; /** * Selected databases as a map from database name to database id */ databases: { [key: string]: string; }; /** * Duration of task execution in seconds. */ durationInSeconds: number; /** * Migration end time */ endedOn: string; /** * Migration exceptions and warnings. */ exceptionsAndWarnings: outputs.datamigration.ReportableExceptionResponse[]; /** * Result identifier */ id: string; /** * Migration progress message */ message: string; /** * Migration Report Result, provides unique url for downloading your migration report. */ migrationReportResult?: outputs.datamigration.MigrationReportResultResponse; /** * Migration Validation Results */ migrationValidationResult?: outputs.datamigration.MigrationValidationResultResponse; /** * Result type * Expected value is 'MigrationLevelOutput'. */ resultType: "MigrationLevelOutput"; /** * Source server brand version */ sourceServerBrandVersion: string; /** * Source server version */ sourceServerVersion: string; /** * Migration start time */ startedOn: string; /** * Current status of migration */ status: string; /** * Migration status message */ statusMessage: string; /** * Target server brand version */ targetServerBrandVersion: string; /** * Target server version */ targetServerVersion: string; } interface MigrateSqlServerSqlDbTaskOutputTableLevelResponse { /** * Migration end time */ endedOn: string; /** * Wildcard string prefix to use for querying all errors of the item */ errorPrefix: string; /** * Result identifier */ id: string; /** * Number of successfully completed items */ itemsCompletedCount: number; /** * Number of items */ itemsCount: number; /** * Name of the item */ objectName: string; /** * Wildcard string prefix to use for querying all sub-tem results of the item */ resultPrefix: string; /** * Result type * Expected value is 'TableLevelOutput'. */ resultType: "TableLevelOutput"; /** * Migration start time */ startedOn: string; /** * Current state of migration */ state: string; /** * Status message */ statusMessage: string; } interface MigrateSqlServerSqlDbTaskOutputValidationResultResponse { /** * Migration validation result identifier */ id: string; /** * Migration Identifier */ migrationId: string; /** * Result type * Expected value is 'MigrationValidationOutput'. */ resultType: "MigrationValidationOutput"; /** * Current status of validation at the migration level. Status from the database validation result status will be aggregated here. */ status: string; /** * Validation summary results for each database */ summaryResults?: { [key: string]: outputs.datamigration.MigrationValidationDatabaseSummaryResultResponse; }; } /** * Properties for the task that migrates on-prem SQL Server databases to Azure SQL Database */ interface MigrateSqlServerSqlDbTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * DateTime in UTC when the task was created */ createdOn?: string; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.MigrateSqlServerSqlDbTaskInputResponse; /** * whether the task can be cloned or not */ isCloneable?: boolean; /** * Task output. This is ignored if submitted. */ output: (outputs.datamigration.MigrateSqlServerSqlDbTaskOutputDatabaseLevelResponse | outputs.datamigration.MigrateSqlServerSqlDbTaskOutputDatabaseLevelValidationResultResponse | outputs.datamigration.MigrateSqlServerSqlDbTaskOutputErrorResponse | outputs.datamigration.MigrateSqlServerSqlDbTaskOutputMigrationLevelResponse | outputs.datamigration.MigrateSqlServerSqlDbTaskOutputTableLevelResponse | outputs.datamigration.MigrateSqlServerSqlDbTaskOutputValidationResultResponse)[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * task id */ taskId?: string; /** * Task type. * Expected value is 'Migrate.SqlServer.SqlDb'. */ taskType: "Migrate.SqlServer.SqlDb"; } /** * migrateSqlServerSqlDbTaskPropertiesResponseProvideDefaults sets the appropriate defaults for MigrateSqlServerSqlDbTaskPropertiesResponse */ function migrateSqlServerSqlDbTaskPropertiesResponseProvideDefaults(val: MigrateSqlServerSqlDbTaskPropertiesResponse): MigrateSqlServerSqlDbTaskPropertiesResponse; /** * Database specific information for SQL to Azure SQL DB Managed Instance migration task inputs */ interface MigrateSqlServerSqlMIDatabaseInputResponse { /** * The list of backup files to be used in case of existing backups. */ backupFilePaths?: string[]; /** * Backup file share information for backing up this database. */ backupFileShare?: outputs.datamigration.FileShareResponse; /** * id of the database */ id?: string; /** * Name of the database */ name: string; /** * Name of the database at destination */ restoreDatabaseName: string; } /** * Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. */ interface MigrateSqlServerSqlMISyncTaskInputResponse { /** * Azure Active Directory Application the DMS (classic) instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account */ azureApp: outputs.datamigration.AzureActiveDirectoryAppResponse; /** * Backup file share information for all selected databases. */ backupFileShare?: outputs.datamigration.FileShareResponse; /** * Number of database migrations to start in parallel */ numberOfParallelDatabaseMigrations?: number; /** * Databases to migrate */ selectedDatabases: outputs.datamigration.MigrateSqlServerSqlMIDatabaseInputResponse[]; /** * Connection information for source SQL Server */ sourceConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; /** * Fully qualified resourceId of storage */ storageResourceId: string; /** * Connection information for Azure SQL Database Managed Instance */ targetConnectionInfo: outputs.datamigration.MiSqlConnectionInfoResponse; } /** * migrateSqlServerSqlMISyncTaskInputResponseProvideDefaults sets the appropriate defaults for MigrateSqlServerSqlMISyncTaskInputResponse */ function migrateSqlServerSqlMISyncTaskInputResponseProvideDefaults(val: MigrateSqlServerSqlMISyncTaskInputResponse): MigrateSqlServerSqlMISyncTaskInputResponse; interface MigrateSqlServerSqlMISyncTaskOutputDatabaseLevelResponse { /** * Backup sets that are currently active (Either being uploaded or getting restored) */ activeBackupSets: outputs.datamigration.BackupSetInfoResponse[]; /** * Name of container created in the Azure Storage account where backups are copied to */ containerName: string; /** * Database migration end time */ endedOn: string; /** * prefix string to use for querying errors for this database */ errorPrefix: string; /** * Migration exceptions and warnings */ exceptionsAndWarnings: outputs.datamigration.ReportableExceptionResponse[]; /** * Details of full backup set */ fullBackupSetInfo: outputs.datamigration.BackupSetInfoResponse; /** * Result identifier */ id: string; /** * Whether full backup has been applied to the target database or not */ isFullBackupRestored: boolean; /** * Last applied backup set information */ lastRestoredBackupSetInfo: outputs.datamigration.BackupSetInfoResponse; /** * Current state of database */ migrationState: string; /** * Result type * Expected value is 'DatabaseLevelOutput'. */ resultType: "DatabaseLevelOutput"; /** * Name of the database */ sourceDatabaseName: string; /** * Database migration start time */ startedOn: string; } interface MigrateSqlServerSqlMISyncTaskOutputErrorResponse { /** * Migration error */ error: outputs.datamigration.ReportableExceptionResponse; /** * Result identifier */ id: string; /** * Result type * Expected value is 'ErrorOutput'. */ resultType: "ErrorOutput"; } interface MigrateSqlServerSqlMISyncTaskOutputMigrationLevelResponse { /** * Count of databases */ databaseCount: number; /** * Number of database level errors */ databaseErrorCount: number; /** * Migration end time */ endedOn: string; /** * Result identifier */ id: string; /** * Result type * Expected value is 'MigrationLevelOutput'. */ resultType: "MigrationLevelOutput"; /** * Source server brand version */ sourceServerBrandVersion: string; /** * Source server name */ sourceServerName: string; /** * Source server version */ sourceServerVersion: string; /** * Migration start time */ startedOn: string; /** * Current state of migration */ state: string; /** * Target server brand version */ targetServerBrandVersion: string; /** * Target server name */ targetServerName: string; /** * Target server version */ targetServerVersion: string; } /** * Properties for task that migrates SQL Server databases to Azure SQL Database Managed Instance sync scenario */ interface MigrateSqlServerSqlMISyncTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * DateTime in UTC when the task was created */ createdOn?: string; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.MigrateSqlServerSqlMISyncTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: (outputs.datamigration.MigrateSqlServerSqlMISyncTaskOutputDatabaseLevelResponse | outputs.datamigration.MigrateSqlServerSqlMISyncTaskOutputErrorResponse | outputs.datamigration.MigrateSqlServerSqlMISyncTaskOutputMigrationLevelResponse)[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'Migrate.SqlServer.AzureSqlDbMI.Sync.LRS'. */ taskType: "Migrate.SqlServer.AzureSqlDbMI.Sync.LRS"; } /** * migrateSqlServerSqlMISyncTaskPropertiesResponseProvideDefaults sets the appropriate defaults for MigrateSqlServerSqlMISyncTaskPropertiesResponse */ function migrateSqlServerSqlMISyncTaskPropertiesResponseProvideDefaults(val: MigrateSqlServerSqlMISyncTaskPropertiesResponse): MigrateSqlServerSqlMISyncTaskPropertiesResponse; /** * Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance. */ interface MigrateSqlServerSqlMITaskInputResponse { /** * Azure Active Directory domain name in the format of 'contoso.com' for federated Azure AD or 'contoso.onmicrosoft.com' for managed domain, required if and only if Windows logins are selected */ aadDomainName?: string; /** * SAS URI of Azure Storage Account Container to be used for storing backup files. */ backupBlobShare: outputs.datamigration.BlobShareResponse; /** * Backup file share information for all selected databases. */ backupFileShare?: outputs.datamigration.FileShareResponse; /** * Backup Mode to specify whether to use existing backup or create new backup. If using existing backups, backup file paths are required to be provided in selectedDatabases. */ backupMode?: string; /** * encrypted key for secure fields */ encryptedKeyForSecureFields?: string; /** * Agent Jobs to migrate. */ selectedAgentJobs?: string[]; /** * Databases to migrate */ selectedDatabases: outputs.datamigration.MigrateSqlServerSqlMIDatabaseInputResponse[]; /** * Logins to migrate. */ selectedLogins?: string[]; /** * Information for connecting to source */ sourceConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; /** * Date and time relative to UTC when the migration was started on */ startedOn?: string; /** * Information for connecting to target */ targetConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; } /** * migrateSqlServerSqlMITaskInputResponseProvideDefaults sets the appropriate defaults for MigrateSqlServerSqlMITaskInputResponse */ function migrateSqlServerSqlMITaskInputResponseProvideDefaults(val: MigrateSqlServerSqlMITaskInputResponse): MigrateSqlServerSqlMITaskInputResponse; interface MigrateSqlServerSqlMITaskOutputAgentJobLevelResponse { /** * Migration end time */ endedOn: string; /** * Migration errors and warnings per job */ exceptionsAndWarnings: outputs.datamigration.ReportableExceptionResponse[]; /** * Result identifier */ id: string; /** * The state of the original Agent Job. */ isEnabled: boolean; /** * Migration progress message */ message: string; /** * Agent Job name. */ name: string; /** * Result type * Expected value is 'AgentJobLevelOutput'. */ resultType: "AgentJobLevelOutput"; /** * Migration start time */ startedOn: string; /** * Current state of migration */ state: string; } interface MigrateSqlServerSqlMITaskOutputDatabaseLevelResponse { /** * Name of the database */ databaseName: string; /** * Migration end time */ endedOn: string; /** * Migration exceptions and warnings */ exceptionsAndWarnings: outputs.datamigration.ReportableExceptionResponse[]; /** * Result identifier */ id: string; /** * Migration progress message */ message: string; /** * Result type * Expected value is 'DatabaseLevelOutput'. */ resultType: "DatabaseLevelOutput"; /** * Size of the database in megabytes */ sizeMB: number; /** * Current stage of migration */ stage: string; /** * Migration start time */ startedOn: string; /** * Current state of migration */ state: string; } interface MigrateSqlServerSqlMITaskOutputErrorResponse { /** * Migration error */ error: outputs.datamigration.ReportableExceptionResponse; /** * Result identifier */ id: string; /** * Result type * Expected value is 'ErrorOutput'. */ resultType: "ErrorOutput"; } interface MigrateSqlServerSqlMITaskOutputLoginLevelResponse { /** * Login migration end time */ endedOn: string; /** * Login migration errors and warnings per login */ exceptionsAndWarnings: outputs.datamigration.ReportableExceptionResponse[]; /** * Result identifier */ id: string; /** * Login name. */ loginName: string; /** * Login migration progress message */ message: string; /** * Result type * Expected value is 'LoginLevelOutput'. */ resultType: "LoginLevelOutput"; /** * Current stage of login */ stage: string; /** * Login migration start time */ startedOn: string; /** * Current state of login */ state: string; } interface MigrateSqlServerSqlMITaskOutputMigrationLevelResponse { /** * Selected agent jobs as a map from name to id */ agentJobs: { [key: string]: string; }; /** * Selected databases as a map from database name to database id */ databases: { [key: string]: string; }; /** * Migration end time */ endedOn: string; /** * Migration exceptions and warnings. */ exceptionsAndWarnings: outputs.datamigration.ReportableExceptionResponse[]; /** * Result identifier */ id: string; /** * Selected logins as a map from name to id */ logins: { [key: string]: string; }; /** * Migration progress message */ message: string; /** * List of orphaned users. */ orphanedUsersInfo: outputs.datamigration.OrphanedUserInfoResponse[]; /** * Result type * Expected value is 'MigrationLevelOutput'. */ resultType: "MigrationLevelOutput"; /** * Map of server role migration results. */ serverRoleResults: { [key: string]: outputs.datamigration.StartMigrationScenarioServerRoleResultResponse; }; /** * Source server brand version */ sourceServerBrandVersion: string; /** * Source server version */ sourceServerVersion: string; /** * Migration start time */ startedOn: string; /** * Current state of migration */ state: string; /** * Current status of migration */ status: string; /** * Target server brand version */ targetServerBrandVersion: string; /** * Target server version */ targetServerVersion: string; } /** * Properties for task that migrates SQL Server databases to Azure SQL Database Managed Instance */ interface MigrateSqlServerSqlMITaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * DateTime in UTC when the task was created */ createdOn?: string; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.MigrateSqlServerSqlMITaskInputResponse; /** * whether the task can be cloned or not */ isCloneable?: boolean; /** * Task output. This is ignored if submitted. */ output: (outputs.datamigration.MigrateSqlServerSqlMITaskOutputAgentJobLevelResponse | outputs.datamigration.MigrateSqlServerSqlMITaskOutputDatabaseLevelResponse | outputs.datamigration.MigrateSqlServerSqlMITaskOutputErrorResponse | outputs.datamigration.MigrateSqlServerSqlMITaskOutputLoginLevelResponse | outputs.datamigration.MigrateSqlServerSqlMITaskOutputMigrationLevelResponse)[]; /** * parent task id */ parentTaskId?: string; /** * The state of the task. This is ignored if submitted. */ state: string; /** * task id */ taskId?: string; /** * Task type. * Expected value is 'Migrate.SqlServer.AzureSqlDbMI'. */ taskType: "Migrate.SqlServer.AzureSqlDbMI"; } /** * migrateSqlServerSqlMITaskPropertiesResponseProvideDefaults sets the appropriate defaults for MigrateSqlServerSqlMITaskPropertiesResponse */ function migrateSqlServerSqlMITaskPropertiesResponseProvideDefaults(val: MigrateSqlServerSqlMITaskPropertiesResponse): MigrateSqlServerSqlMITaskPropertiesResponse; /** * Input for task that migrates SSIS packages from SQL Server to Azure SQL Database Managed Instance. */ interface MigrateSsisTaskInputResponse { /** * Information for connecting to source */ sourceConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; /** * SSIS package migration information. */ ssisMigrationInfo: outputs.datamigration.SsisMigrationInfoResponse; /** * Information for connecting to target */ targetConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; } /** * migrateSsisTaskInputResponseProvideDefaults sets the appropriate defaults for MigrateSsisTaskInputResponse */ function migrateSsisTaskInputResponseProvideDefaults(val: MigrateSsisTaskInputResponse): MigrateSsisTaskInputResponse; interface MigrateSsisTaskOutputMigrationLevelResponse { /** * Migration end time */ endedOn: string; /** * Migration exceptions and warnings. */ exceptionsAndWarnings: outputs.datamigration.ReportableExceptionResponse[]; /** * Result identifier */ id: string; /** * Migration progress message */ message: string; /** * Result type * Expected value is 'MigrationLevelOutput'. */ resultType: "MigrationLevelOutput"; /** * Source server brand version */ sourceServerBrandVersion: string; /** * Source server version */ sourceServerVersion: string; /** * Stage of SSIS migration. */ stage: string; /** * Migration start time */ startedOn: string; /** * Current status of migration */ status: string; /** * Target server brand version */ targetServerBrandVersion: string; /** * Target server version */ targetServerVersion: string; } interface MigrateSsisTaskOutputProjectLevelResponse { /** * Migration end time */ endedOn: string; /** * Migration exceptions and warnings */ exceptionsAndWarnings: outputs.datamigration.ReportableExceptionResponse[]; /** * Name of the folder */ folderName: string; /** * Result identifier */ id: string; /** * Migration progress message */ message: string; /** * Name of the project */ projectName: string; /** * Result type * Expected value is 'SsisProjectLevelOutput'. */ resultType: "SsisProjectLevelOutput"; /** * Stage of SSIS migration. */ stage: string; /** * Migration start time */ startedOn: string; /** * Current state of migration */ state: string; } /** * Properties for task that migrates SSIS packages from SQL Server databases to Azure SQL Database Managed Instance. */ interface MigrateSsisTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.MigrateSsisTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: (outputs.datamigration.MigrateSsisTaskOutputMigrationLevelResponse | outputs.datamigration.MigrateSsisTaskOutputProjectLevelResponse)[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'Migrate.Ssis'. */ taskType: "Migrate.Ssis"; } /** * migrateSsisTaskPropertiesResponseProvideDefaults sets the appropriate defaults for MigrateSsisTaskPropertiesResponse */ function migrateSsisTaskPropertiesResponseProvideDefaults(val: MigrateSsisTaskPropertiesResponse): MigrateSsisTaskPropertiesResponse; /** * Input for command that completes sync migration for a database. */ interface MigrateSyncCompleteCommandInputResponse { /** * Time stamp to complete */ commitTimeStamp?: string; /** * Name of database */ databaseName: string; } /** * Output for command that completes sync migration for a database. */ interface MigrateSyncCompleteCommandOutputResponse { /** * List of errors that happened during the command execution */ errors: outputs.datamigration.ReportableExceptionResponse[]; /** * Result identifier */ id: string; } /** * Properties for the command that completes sync migration for a database. */ interface MigrateSyncCompleteCommandPropertiesResponse { /** * Command id */ commandId?: string; /** * Command type. * Expected value is 'Migrate.Sync.Complete.Database'. */ commandType: "Migrate.Sync.Complete.Database"; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Command input */ input?: outputs.datamigration.MigrateSyncCompleteCommandInputResponse; /** * Command output. This is ignored if submitted. */ output: outputs.datamigration.MigrateSyncCompleteCommandOutputResponse; /** * The state of the command. This is ignored if submitted. */ state: string; } /** * Information about migration eligibility of a server object */ interface MigrationEligibilityInfoResponse { /** * Whether object is eligible for migration or not. */ isEligibleForMigration: boolean; /** * Information about eligibility failure for the server object. */ validationMessages: string[]; } /** * Migration validation report result, contains the url for downloading the generated report. */ interface MigrationReportResultResponse { /** * Migration validation result identifier */ id?: string; /** * The url of the report. */ reportUrl?: string; } /** * Detailed status of current migration. */ interface MigrationStatusDetailsResponse { /** * Backup sets that are currently active. */ activeBackupSets: outputs.datamigration.SqlBackupSetInfoResponse[]; /** * Name of blob container. */ blobContainerName: string; /** * Complete restore error message, if any */ completeRestoreErrorMessage: string; /** * File name that is currently being restored. */ currentRestoringFilename: string; /** * File upload blocking errors, if any. */ fileUploadBlockingErrors: string[]; /** * Details of full backup set. */ fullBackupSetInfo: outputs.datamigration.SqlBackupSetInfoResponse; /** * Files that are not valid backup files. */ invalidFiles: string[]; /** * Whether full backup has been applied to the target database or not. */ isFullBackupRestored: boolean; /** * Last applied backup set information. */ lastRestoredBackupSetInfo: outputs.datamigration.SqlBackupSetInfoResponse; /** * Last restored file name. */ lastRestoredFilename: string; /** * Current State of Migration. */ migrationState: string; /** * Total pending log backups. */ pendingLogBackupsCount: number; /** * Restore blocking reason, if any */ restoreBlockingReason: string; } /** * Migration Validation Database level summary result */ interface MigrationValidationDatabaseSummaryResultResponse { /** * Validation end time */ endedOn: string; /** * Result identifier */ id: string; /** * Migration Identifier */ migrationId: string; /** * Name of the source database */ sourceDatabaseName: string; /** * Validation start time */ startedOn: string; /** * Current status of validation at the database level */ status: string; /** * Name of the target database */ targetDatabaseName: string; } /** * Types of validations to run after the migration */ interface MigrationValidationOptionsResponse { /** * Allows to perform a checksum based data integrity validation between source and target for the selected database / tables . */ enableDataIntegrityValidation?: boolean; /** * Allows to perform a quick and intelligent query analysis by retrieving queries from the source database and executes them in the target. The result will have execution statistics for executions in source and target databases for the extracted queries. */ enableQueryAnalysisValidation?: boolean; /** * Allows to compare the schema information between source and target. */ enableSchemaValidation?: boolean; } /** * Migration Validation Result */ interface MigrationValidationResultResponse { /** * Migration validation result identifier */ id: string; /** * Migration Identifier */ migrationId: string; /** * Current status of validation at the migration level. Status from the database validation result status will be aggregated here. */ status: string; /** * Validation summary results for each database */ summaryResults?: { [key: string]: outputs.datamigration.MigrationValidationDatabaseSummaryResultResponse; }; } /** * Mongo Connection */ interface MongoConnectionInformationResponse { /** * Host of mongo connection. */ host?: string; /** * Port of mongo connection. */ port?: number; } /** * Describes a MongoDB data source */ interface MongoDbClusterInfoResponse { /** * A list of non-system databases in the cluster */ databases: outputs.datamigration.MongoDbDatabaseInfoResponse[]; /** * Whether the cluster supports sharded collections */ supportsSharding: boolean; /** * The type of data source */ type: string; /** * The version of the data source in the form x.y.z (e.g. 3.6.7). Not used if Type is BlobContainer. */ version: string; } /** * Describes a supported collection within a MongoDB database */ interface MongoDbCollectionInfoResponse { /** * The average document size, or -1 if the average size is unknown */ averageDocumentSize: number; /** * The estimated total data size, in bytes, or -1 if the size is unknown. */ dataSize: number; /** * The name of the database containing the collection */ databaseName: string; /** * The estimated total number of documents, or -1 if the document count is unknown */ documentCount: number; /** * Whether the collection is a capped collection (i.e. whether it has a fixed size and acts like a circular buffer) */ isCapped: boolean; /** * Whether the collection is system collection */ isSystemCollection: boolean; /** * Whether the collection is a view of another collection */ isView: boolean; /** * The unqualified name of the database or collection */ name: string; /** * The qualified name of the database or collection. For a collection, this is the database-qualified name. */ qualifiedName: string; /** * The shard key on the collection, or null if the collection is not sharded */ shardKey?: outputs.datamigration.MongoDbShardKeyInfoResponse; /** * Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. */ supportsSharding: boolean; /** * The name of the collection that this is a view of, if IsView is true */ viewOf?: string; } /** * Describes the progress of a collection */ interface MongoDbCollectionProgressResponse { /** * The number of document bytes copied during the Copying stage */ bytesCopied: number; /** * The number of documents copied during the Copying stage */ documentsCopied: number; /** * The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) */ elapsedTime: string; /** * The errors and warnings that have occurred for the current object. The keys are the error codes. */ errors: { [key: string]: outputs.datamigration.MongoDbErrorResponse; }; /** * The number of oplog events awaiting replay */ eventsPending: number; /** * The number of oplog events replayed so far */ eventsReplayed: number; /** * The timestamp of the last oplog event received, or null if no oplog event has been received yet */ lastEventTime?: string; /** * The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet */ lastReplayTime?: string; /** * The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. */ name?: string; /** * The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. */ qualifiedName?: string; /** * The type of progress object * Expected value is 'Collection'. */ resultType: "Collection"; state: string; /** * The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown */ totalBytes: number; /** * The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown */ totalDocuments: number; } /** * Describes how an individual MongoDB collection should be migrated */ interface MongoDbCollectionSettingsResponse { /** * Whether the migrator is allowed to drop the target collection in the course of performing a migration. The default is true. */ canDelete?: boolean; /** * Describes a MongoDB shard key */ shardKey?: outputs.datamigration.MongoDbShardKeySettingResponse; /** * The RUs that should be configured on a CosmosDB target, or null to use the default. This has no effect on non-CosmosDB targets. */ targetRUs?: number; } /** * Describes a connection to a MongoDB data source */ interface MongoDbConnectionInfoResponse { /** * Additional connection settings */ additionalSettings?: string; /** * Authentication type to use for connection */ authentication?: string; /** * A MongoDB connection string or blob container URL. The user name and password can be specified here or in the userName and password properties */ connectionString: string; /** * Data source */ dataSource?: string; /** * Whether to encrypt the connection */ encryptConnection?: boolean; enforceSSL?: boolean; /** * Password credential. */ password?: string; /** * port for server */ port?: number; /** * server brand version */ serverBrandVersion?: string; /** * name of the server */ serverName?: string; /** * server version */ serverVersion?: string; /** * Whether to trust the server certificate */ trustServerCertificate?: boolean; /** * Type of connection info * Expected value is 'MongoDbConnectionInfo'. */ type: "MongoDbConnectionInfo"; /** * User name */ userName?: string; } /** * mongoDbConnectionInfoResponseProvideDefaults sets the appropriate defaults for MongoDbConnectionInfoResponse */ function mongoDbConnectionInfoResponseProvideDefaults(val: MongoDbConnectionInfoResponse): MongoDbConnectionInfoResponse; /** * Describes a database within a MongoDB data source */ interface MongoDbDatabaseInfoResponse { /** * The average document size, or -1 if the average size is unknown */ averageDocumentSize: number; /** * A list of supported collections in a MongoDB database */ collections: outputs.datamigration.MongoDbCollectionInfoResponse[]; /** * The estimated total data size, in bytes, or -1 if the size is unknown. */ dataSize: number; /** * The estimated total number of documents, or -1 if the document count is unknown */ documentCount: number; /** * The unqualified name of the database or collection */ name: string; /** * The qualified name of the database or collection. For a collection, this is the database-qualified name. */ qualifiedName: string; /** * Whether the database has sharding enabled. Note that the migration task will enable sharding on the target if necessary. */ supportsSharding: boolean; } /** * Describes the progress of a database */ interface MongoDbDatabaseProgressResponse { /** * The number of document bytes copied during the Copying stage */ bytesCopied: number; /** * The progress of the collections in the database. The keys are the unqualified names of the collections */ collections?: { [key: string]: outputs.datamigration.MongoDbCollectionProgressResponse; }; /** * The number of documents copied during the Copying stage */ documentsCopied: number; /** * The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) */ elapsedTime: string; /** * The errors and warnings that have occurred for the current object. The keys are the error codes. */ errors: { [key: string]: outputs.datamigration.MongoDbErrorResponse; }; /** * The number of oplog events awaiting replay */ eventsPending: number; /** * The number of oplog events replayed so far */ eventsReplayed: number; /** * The timestamp of the last oplog event received, or null if no oplog event has been received yet */ lastEventTime?: string; /** * The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet */ lastReplayTime?: string; /** * The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. */ name?: string; /** * The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. */ qualifiedName?: string; /** * The type of progress object * Expected value is 'Database'. */ resultType: "Database"; state: string; /** * The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown */ totalBytes: number; /** * The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown */ totalDocuments: number; } /** * Describes how an individual MongoDB database should be migrated */ interface MongoDbDatabaseSettingsResponse { /** * The collections on the source database to migrate to the target. The keys are the unqualified names of the collections. */ collections: { [key: string]: outputs.datamigration.MongoDbCollectionSettingsResponse; }; /** * The RUs that should be configured on a CosmosDB target, or null to use the default, or 0 if throughput should not be provisioned for the database. This has no effect on non-CosmosDB targets. */ targetRUs?: number; } /** * Describes an error or warning that occurred during a MongoDB migration */ interface MongoDbErrorResponse { /** * The non-localized, machine-readable code that describes the error or warning */ code?: string; /** * The number of times the error or warning has occurred */ count?: number; /** * The localized, human-readable message that describes the error or warning */ message?: string; /** * The type of error or warning */ type?: string; } /** * Describes the progress of the overall migration */ interface MongoDbMigrationProgressResponse { /** * The number of document bytes copied during the Copying stage */ bytesCopied: number; /** * The progress of the databases in the migration. The keys are the names of the databases */ databases?: { [key: string]: outputs.datamigration.MongoDbDatabaseProgressResponse; }; /** * The number of documents copied during the Copying stage */ documentsCopied: number; /** * The elapsed time in the format [ddd.]hh:mm:ss[.fffffff] (i.e. TimeSpan format) */ elapsedTime: string; /** * The errors and warnings that have occurred for the current object. The keys are the error codes. */ errors: { [key: string]: outputs.datamigration.MongoDbErrorResponse; }; /** * The number of oplog events awaiting replay */ eventsPending: number; /** * The number of oplog events replayed so far */ eventsReplayed: number; /** * The timestamp of the last oplog event received, or null if no oplog event has been received yet */ lastEventTime?: string; /** * The timestamp of the last oplog event replayed, or null if no oplog event has been replayed yet */ lastReplayTime?: string; /** * The name of the progress object. For a collection, this is the unqualified collection name. For a database, this is the database name. For the overall migration, this is null. */ name?: string; /** * The qualified name of the progress object. For a collection, this is the database-qualified name. For a database, this is the database name. For the overall migration, this is null. */ qualifiedName?: string; /** * The type of progress object * Expected value is 'Migration'. */ resultType: "Migration"; state: string; /** * The total number of document bytes on the source at the beginning of the Copying stage, or -1 if the total size was unknown */ totalBytes: number; /** * The total number of documents on the source at the beginning of the Copying stage, or -1 if the total count was unknown */ totalDocuments: number; } /** * Describes how a MongoDB data migration should be performed */ interface MongoDbMigrationSettingsResponse { /** * The RU limit on a CosmosDB target that collections will be temporarily increased to (if lower) during the initial copy of a migration, from 10,000 to 1,000,000, or 0 to use the default boost (which is generally the maximum), or null to not boost the RUs. This setting has no effect on non-CosmosDB targets. */ boostRUs?: number; /** * The databases on the source cluster to migrate to the target. The keys are the names of the databases. */ databases: { [key: string]: outputs.datamigration.MongoDbDatabaseSettingsResponse; }; /** * Describes how changes will be replicated from the source to the target. The default is OneTime. */ replication?: string; /** * Settings used to connect to the source cluster */ source: outputs.datamigration.MongoDbConnectionInfoResponse; /** * Settings used to connect to the target cluster */ target: outputs.datamigration.MongoDbConnectionInfoResponse; /** * Settings used to limit the resource usage of the migration */ throttling?: outputs.datamigration.MongoDbThrottlingSettingsResponse; } /** * mongoDbMigrationSettingsResponseProvideDefaults sets the appropriate defaults for MongoDbMigrationSettingsResponse */ function mongoDbMigrationSettingsResponseProvideDefaults(val: MongoDbMigrationSettingsResponse): MongoDbMigrationSettingsResponse; /** * Describes a field reference within a MongoDB shard key */ interface MongoDbShardKeyFieldResponse { /** * The name of the field */ name: string; /** * The field ordering */ order: string; } /** * Describes a MongoDB shard key */ interface MongoDbShardKeyInfoResponse { /** * The fields within the shard key */ fields: outputs.datamigration.MongoDbShardKeyFieldResponse[]; /** * Whether the shard key is unique */ isUnique: boolean; } /** * Describes a MongoDB shard key */ interface MongoDbShardKeySettingResponse { /** * The fields within the shard key */ fields: outputs.datamigration.MongoDbShardKeyFieldResponse[]; /** * Whether the shard key is unique */ isUnique?: boolean; } /** * Specifies resource limits for the migration */ interface MongoDbThrottlingSettingsResponse { /** * The maximum number of work items (e.g. collection copies) that will be processed in parallel */ maxParallelism?: number; /** * The percentage of CPU time that the migrator will try to avoid using, from 0 to 100 */ minFreeCpu?: number; /** * The number of megabytes of RAM that the migrator will try to avoid using */ minFreeMemoryMb?: number; } /** * Mongo source and target database and collection details. */ interface MongoMigrationCollectionResponse { /** * Detailed migration status. Not included by default. */ migrationProgressDetails: outputs.datamigration.MongoMigrationProgressDetailsResponse; /** * Source collection name. */ sourceCollection?: string; /** * Source database name. */ sourceDatabase?: string; /** * Target collection name. */ targetCollection?: string; /** * Target database name. */ targetDatabase?: string; } /** * Detailed status of collection migration. */ interface MongoMigrationProgressDetailsResponse { /** * Migration duration */ durationInSeconds: number; /** * Migration Error */ migrationError: string; /** * Migration Status */ migrationStatus: string; /** * Processed Document Count */ processedDocumentCount: number; /** * Source Document Count */ sourceDocumentCount: number; } /** * Information for connecting to MySQL server */ interface MySqlConnectionInfoResponse { /** * Additional connection settings */ additionalSettings?: string; /** * Authentication type to use for connection */ authentication?: string; /** * Data source */ dataSource?: string; /** * Whether to encrypt the connection */ encryptConnection?: boolean; /** * Password credential. */ password?: string; /** * Port for Server */ port: number; /** * Name of the server */ serverName: string; /** * Type of connection info * Expected value is 'MySqlConnectionInfo'. */ type: "MySqlConnectionInfo"; /** * User name */ userName?: string; } /** * mySqlConnectionInfoResponseProvideDefaults sets the appropriate defaults for MySqlConnectionInfoResponse */ function mySqlConnectionInfoResponseProvideDefaults(val: MySqlConnectionInfoResponse): MySqlConnectionInfoResponse; interface NodeMonitoringDataResponse { /** * Unmatched properties from the message are deserialized in this collection. */ additionalProperties: { [key: string]: any; }; /** * Available memory (MB) on the integration runtime node. */ availableMemoryInMB: number; /** * Maximum concurrent jobs on the integration runtime node. */ concurrentJobsLimit: number; /** * The number of jobs currently running on the integration runtime node. */ concurrentJobsRunning: number; /** * CPU percentage on the integration runtime node. */ cpuUtilization: number; /** * The maximum concurrent jobs in this integration runtime. */ maxConcurrentJobs: number; /** * Name of the integration runtime node. */ nodeName: string; /** * Received bytes on the integration runtime node. */ receivedBytes: number; /** * Sent bytes on the integration runtime node. */ sentBytes: number; } /** * Error information in OData format. */ interface ODataErrorResponse { /** * The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError' */ code?: string; /** * Inner errors that caused this error */ details?: outputs.datamigration.ODataErrorResponse[]; /** * The human-readable description of the error */ message?: string; } /** * Offline configuration */ interface OfflineConfigurationResponse { /** * Last backup name for offline migration. This is optional for migrations from file share. If it is not provided, then the service will determine the last backup file name based on latest backup files present in file share. */ lastBackupName?: string; /** * Offline migration */ offline?: boolean; } /** * Information for connecting to Oracle server */ interface OracleConnectionInfoResponse { /** * Authentication type to use for connection */ authentication?: string; /** * EZConnect or TNSName connection string. */ dataSource: string; /** * Password credential. */ password?: string; /** * port for server */ port?: number; /** * name of the server */ serverName?: string; /** * server version */ serverVersion?: string; /** * Type of connection info * Expected value is 'OracleConnectionInfo'. */ type: "OracleConnectionInfo"; /** * User name */ userName?: string; } /** * Information of orphaned users on the SQL server database. */ interface OrphanedUserInfoResponse { /** * Parent database of the user */ databaseName?: string; /** * Name of the orphaned user */ name?: string; } /** * Information for connecting to PostgreSQL server */ interface PostgreSqlConnectionInfoResponse { /** * Additional connection settings */ additionalSettings?: string; /** * Authentication type to use for connection */ authentication?: string; /** * Data source */ dataSource?: string; /** * Name of the database */ databaseName?: string; /** * Whether to encrypt the connection */ encryptConnection?: boolean; /** * Password credential. */ password?: string; /** * Port for Server */ port: number; /** * server brand version */ serverBrandVersion?: string; /** * Name of the server */ serverName: string; /** * server version */ serverVersion?: string; /** * Whether to trust the server certificate */ trustServerCertificate?: boolean; /** * Type of connection info * Expected value is 'PostgreSqlConnectionInfo'. */ type: "PostgreSqlConnectionInfo"; /** * User name */ userName?: string; } /** * postgreSqlConnectionInfoResponseProvideDefaults sets the appropriate defaults for PostgreSqlConnectionInfoResponse */ function postgreSqlConnectionInfoResponseProvideDefaults(val: PostgreSqlConnectionInfoResponse): PostgreSqlConnectionInfoResponse; /** * Base class for file properties. */ interface ProjectFilePropertiesResponse { /** * Optional File extension. If submitted it should not have a leading period and must match the extension from filePath. */ extension?: string; /** * Relative path of this file resource. This property can be set when creating or updating the file resource. */ filePath?: string; /** * Modification DateTime. */ lastModified: string; /** * File content type. This property can be modified to reflect the file content type. */ mediaType?: string; /** * File size. */ size: number; } /** * Results for query analysis comparison between the source and target */ interface QueryAnalysisValidationResultResponse { /** * List of queries executed and it's execution results in source and target */ queryResults?: outputs.datamigration.QueryExecutionResultResponse; /** * Errors that are part of the execution */ validationErrors?: outputs.datamigration.ValidationErrorResponse; } /** * Describes query analysis results for execution in source and target */ interface QueryExecutionResultResponse { /** * Query text retrieved from the source server */ queryText?: string; /** * Query analysis result from the source */ sourceResult?: outputs.datamigration.ExecutionStatisticsResponse; /** * Total no. of statements in the batch */ statementsInBatch?: number; /** * Query analysis result from the target */ targetResult?: outputs.datamigration.ExecutionStatisticsResponse; } /** * Exception object for all custom exceptions */ interface ReportableExceptionResponse { /** * Actionable steps for this exception */ actionableMessage?: string; /** * The path to the file where exception occurred */ filePath?: string; /** * Coded numerical value that is assigned to a specific exception */ hResult?: number; /** * The line number where exception occurred */ lineNumber?: string; /** * Error message */ message?: string; /** * Stack trace */ stackTrace?: string; } /** * Results for schema comparison between the source and target */ interface SchemaComparisonValidationResultResponse { /** * List of schema differences between the source and target databases */ schemaDifferences?: outputs.datamigration.SchemaComparisonValidationResultTypeResponse; /** * Count of source database objects */ sourceDatabaseObjectCount?: { [key: string]: number; }; /** * Count of target database objects */ targetDatabaseObjectCount?: { [key: string]: number; }; /** * List of errors that happened while performing schema compare validation */ validationErrors?: outputs.datamigration.ValidationErrorResponse; } /** * Description about the errors happen while performing migration validation */ interface SchemaComparisonValidationResultTypeResponse { /** * Name of the object that has the difference */ objectName?: string; /** * Type of the object that has the difference. e.g (Table/View/StoredProcedure) */ objectType?: string; /** * Update action type with respect to target */ updateAction?: string; } /** * Info for certificate to be exported for TDE enabled databases. */ interface SelectedCertificateInputResponse { /** * Name of certificate to be exported. */ certificateName: string; /** * Password to use for encrypting the exported certificate. */ password: string; } /** * Server properties for MySQL type source */ interface ServerPropertiesResponse { /** * Number of databases in the server */ serverDatabaseCount: number; /** * Edition of the database server */ serverEdition: string; /** * Name of the server */ serverName: string; /** * Version of the operating system */ serverOperatingSystemVersion: string; /** * Name of the server platform */ serverPlatform: string; /** * Version of the database server */ serverVersion: string; } /** * An Azure SKU instance */ interface ServiceSkuResponse { /** * The capacity of the SKU, if it supports scaling */ capacity?: number; /** * The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines */ family?: string; /** * The unique name of the SKU, such as 'P3' */ name?: string; /** * The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines */ size?: string; /** * The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical' */ tier?: string; } /** * Source Location details of backups. */ interface SourceLocationResponse { /** * Source Azure Blob. */ azureBlob?: outputs.datamigration.AzureBlobResponse; /** * Source File share. */ fileShare?: outputs.datamigration.SqlFileShareResponse; /** * Backup storage Type. */ fileStorageType: string; } /** * Information of backup file */ interface SqlBackupFileInfoResponse { /** * Copy Duration in seconds */ copyDuration: number; /** * Copy throughput in KBps */ copyThroughput: number; /** * Bytes read */ dataRead: number; /** * Bytes written */ dataWritten: number; /** * Media family sequence number */ familySequenceNumber: number; /** * File name. */ fileName: string; /** * Status of the file. (Initial, Uploading, Uploaded, Restoring, Restored or Skipped) */ status: string; /** * File size in bytes */ totalSize: number; } /** * Information of backup set */ interface SqlBackupSetInfoResponse { /** * Backup end time. */ backupFinishDate: string; /** * Backup set id. */ backupSetId: string; /** * Backup start date. */ backupStartDate: string; /** * Backup type. */ backupType: string; /** * Media family count */ familyCount: number; /** * First LSN of the backup set. */ firstLSN: string; /** * Has Backup Checksums */ hasBackupChecksums: boolean; /** * The reasons why the backup set is ignored */ ignoreReasons: string[]; /** * Whether this backup set has been restored or not. */ isBackupRestored: boolean; /** * Last LSN of the backup set. */ lastLSN: string; /** * List of files in the backup set. */ listOfBackupFiles: outputs.datamigration.SqlBackupFileInfoResponse[]; } /** * Information for connecting to SQL database server */ interface SqlConnectionInfoResponse { /** * Additional connection settings */ additionalSettings?: string; /** * Authentication type to use for connection */ authentication?: string; /** * Data source in the format Protocol:MachineName\SQLServerInstanceName,PortNumber */ dataSource: string; /** * Whether to encrypt the connection */ encryptConnection?: boolean; /** * Password credential. */ password?: string; /** * Server platform type for connection */ platform?: string; /** * Port for Server */ port?: number; /** * Represents the ID of an HTTP resource represented by an Azure resource provider. */ resourceId?: string; /** * server brand version */ serverBrandVersion?: string; /** * name of the server */ serverName?: string; /** * server version */ serverVersion?: string; /** * Whether to trust the server certificate */ trustServerCertificate?: boolean; /** * Type of connection info * Expected value is 'SqlConnectionInfo'. */ type: "SqlConnectionInfo"; /** * User name */ userName?: string; } /** * sqlConnectionInfoResponseProvideDefaults sets the appropriate defaults for SqlConnectionInfoResponse */ function sqlConnectionInfoResponseProvideDefaults(val: SqlConnectionInfoResponse): SqlConnectionInfoResponse; /** * Source SQL Connection */ interface SqlConnectionInformationResponse { /** * Authentication type. */ authentication?: string; /** * Data source. */ dataSource?: string; /** * Whether to encrypt connection or not. */ encryptConnection?: boolean; /** * Password to connect to source SQL. */ password?: string; /** * Whether to trust server certificate or not. */ trustServerCertificate?: boolean; /** * User name to connect to source SQL. */ userName?: string; } /** * Detailed status of current Sql Db migration. */ interface SqlDbMigrationStatusDetailsResponse { /** * Details on progress of ADF copy activities. */ listOfCopyProgressDetails: outputs.datamigration.CopyProgressDetailsResponse[]; /** * Current State of Migration. */ migrationState: string; /** * Sql Data Copy errors, if any. */ sqlDataCopyErrors: string[]; } /** * Offline configuration */ interface SqlDbOfflineConfigurationResponse { /** * Offline migration */ offline: boolean; } /** * File share */ interface SqlFileShareResponse { /** * Location as SMB share or local drive where backups are placed. */ path?: string; /** * Username to access the file share location for backups. */ username?: string; } /** * SSIS migration info with SSIS store type, overwrite policy. */ interface SsisMigrationInfoResponse { /** * The overwrite option for the SSIS environment migration */ environmentOverwriteOption?: string; /** * The overwrite option for the SSIS project migration */ projectOverwriteOption?: string; /** * The SSIS store type of source, only SSIS catalog is supported now in DMS (classic) */ ssisStoreType?: string; } /** * Server role migration result */ interface StartMigrationScenarioServerRoleResultResponse { /** * Migration exceptions and warnings. */ exceptionsAndWarnings: outputs.datamigration.ReportableExceptionResponse[]; /** * Name of server role. */ name: string; /** * Current state of migration */ state: string; } /** * Database migration errors for online migration */ interface SyncMigrationDatabaseErrorEventResponse { /** * Event text. */ eventText: string; /** * Event type. */ eventTypeString: string; /** * String value of timestamp. */ timestampString: string; } interface SystemDataResponse { createdAt?: string; createdBy?: string; createdByType?: string; lastModifiedAt?: string; lastModifiedBy?: string; lastModifiedByType?: string; } /** * Target Location details for optional copy of backups */ interface TargetLocationResponse { /** * Storage Account Key. */ accountKey?: string; /** * Resource Id of the storage account copying backups. */ storageAccountResourceId?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Properties for task that validates migration input for SQL to Azure SQL DB sync migrations */ interface ValidateMigrationInputSqlServerSqlDbSyncTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.ValidateSyncMigrationInputSqlServerTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.ValidateSyncMigrationInputSqlServerTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'ValidateMigrationInput.SqlServer.SqlDb.Sync'. */ taskType: "ValidateMigrationInput.SqlServer.SqlDb.Sync"; } /** * validateMigrationInputSqlServerSqlDbSyncTaskPropertiesResponseProvideDefaults sets the appropriate defaults for ValidateMigrationInputSqlServerSqlDbSyncTaskPropertiesResponse */ function validateMigrationInputSqlServerSqlDbSyncTaskPropertiesResponseProvideDefaults(val: ValidateMigrationInputSqlServerSqlDbSyncTaskPropertiesResponse): ValidateMigrationInputSqlServerSqlDbSyncTaskPropertiesResponse; /** * Input for task that migrates SQL Server databases to Azure SQL Database Managed Instance online scenario. */ interface ValidateMigrationInputSqlServerSqlMISyncTaskInputResponse { /** * Azure Active Directory Application the DMS (classic) instance will use to connect to the target instance of Azure SQL Database Managed Instance and the Azure Storage Account */ azureApp: outputs.datamigration.AzureActiveDirectoryAppResponse; /** * Backup file share information for all selected databases. */ backupFileShare?: outputs.datamigration.FileShareResponse; /** * Databases to migrate */ selectedDatabases: outputs.datamigration.MigrateSqlServerSqlMIDatabaseInputResponse[]; /** * Connection information for source SQL Server */ sourceConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; /** * Fully qualified resourceId of storage */ storageResourceId: string; /** * Connection information for Azure SQL Database Managed Instance */ targetConnectionInfo: outputs.datamigration.MiSqlConnectionInfoResponse; } /** * validateMigrationInputSqlServerSqlMISyncTaskInputResponseProvideDefaults sets the appropriate defaults for ValidateMigrationInputSqlServerSqlMISyncTaskInputResponse */ function validateMigrationInputSqlServerSqlMISyncTaskInputResponseProvideDefaults(val: ValidateMigrationInputSqlServerSqlMISyncTaskInputResponse): ValidateMigrationInputSqlServerSqlMISyncTaskInputResponse; /** * Output for task that validates migration input for Azure SQL Database Managed Instance online migration */ interface ValidateMigrationInputSqlServerSqlMISyncTaskOutputResponse { /** * Database identifier */ id: string; /** * Name of database */ name: string; /** * Errors associated with a selected database object */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Properties for task that validates migration input for SQL to Azure SQL Database Managed Instance sync scenario */ interface ValidateMigrationInputSqlServerSqlMISyncTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.ValidateMigrationInputSqlServerSqlMISyncTaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.ValidateMigrationInputSqlServerSqlMISyncTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS'. */ taskType: "ValidateMigrationInput.SqlServer.AzureSqlDbMI.Sync.LRS"; } /** * validateMigrationInputSqlServerSqlMISyncTaskPropertiesResponseProvideDefaults sets the appropriate defaults for ValidateMigrationInputSqlServerSqlMISyncTaskPropertiesResponse */ function validateMigrationInputSqlServerSqlMISyncTaskPropertiesResponseProvideDefaults(val: ValidateMigrationInputSqlServerSqlMISyncTaskPropertiesResponse): ValidateMigrationInputSqlServerSqlMISyncTaskPropertiesResponse; /** * Input for task that validates migration input for SQL to Azure SQL Managed Instance */ interface ValidateMigrationInputSqlServerSqlMITaskInputResponse { /** * SAS URI of Azure Storage Account Container to be used for storing backup files. */ backupBlobShare: outputs.datamigration.BlobShareResponse; /** * Backup file share information for all selected databases. */ backupFileShare?: outputs.datamigration.FileShareResponse; /** * Backup Mode to specify whether to use existing backup or create new backup. */ backupMode?: string; /** * Databases to migrate */ selectedDatabases: outputs.datamigration.MigrateSqlServerSqlMIDatabaseInputResponse[]; /** * Logins to migrate */ selectedLogins?: string[]; /** * Information for connecting to source */ sourceConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; /** * Information for connecting to target */ targetConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; } /** * validateMigrationInputSqlServerSqlMITaskInputResponseProvideDefaults sets the appropriate defaults for ValidateMigrationInputSqlServerSqlMITaskInputResponse */ function validateMigrationInputSqlServerSqlMITaskInputResponseProvideDefaults(val: ValidateMigrationInputSqlServerSqlMITaskInputResponse): ValidateMigrationInputSqlServerSqlMITaskInputResponse; /** * Output for task that validates migration input for SQL to Azure SQL Managed Instance migrations */ interface ValidateMigrationInputSqlServerSqlMITaskOutputResponse { /** * Errors associated with the BackupFolder path */ backupFolderErrors: outputs.datamigration.ReportableExceptionResponse[]; /** * Errors associated with backup share user name and password credentials */ backupShareCredentialsErrors: outputs.datamigration.ReportableExceptionResponse[]; /** * Errors associated with the storage account provided. */ backupStorageAccountErrors: outputs.datamigration.ReportableExceptionResponse[]; /** * Information about backup files when existing backup mode is used. */ databaseBackupInfo?: outputs.datamigration.DatabaseBackupInfoResponse; /** * Errors associated with existing backup files. */ existingBackupErrors: outputs.datamigration.ReportableExceptionResponse[]; /** * Result identifier */ id: string; /** * Name of database */ name: string; /** * Errors associated with the RestoreDatabaseName */ restoreDatabaseNameErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Properties for task that validates migration input for SQL to Azure SQL Database Managed Instance */ interface ValidateMigrationInputSqlServerSqlMITaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Task input */ input?: outputs.datamigration.ValidateMigrationInputSqlServerSqlMITaskInputResponse; /** * Task output. This is ignored if submitted. */ output: outputs.datamigration.ValidateMigrationInputSqlServerSqlMITaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'ValidateMigrationInput.SqlServer.AzureSqlDbMI'. */ taskType: "ValidateMigrationInput.SqlServer.AzureSqlDbMI"; } /** * validateMigrationInputSqlServerSqlMITaskPropertiesResponseProvideDefaults sets the appropriate defaults for ValidateMigrationInputSqlServerSqlMITaskPropertiesResponse */ function validateMigrationInputSqlServerSqlMITaskPropertiesResponseProvideDefaults(val: ValidateMigrationInputSqlServerSqlMITaskPropertiesResponse): ValidateMigrationInputSqlServerSqlMITaskPropertiesResponse; /** * Properties for the task that validates a migration between MongoDB data sources */ interface ValidateMongoDbTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Describes how a MongoDB data migration should be performed */ input?: outputs.datamigration.MongoDbMigrationSettingsResponse; /** * An array containing a single MongoDbMigrationProgress object */ output: outputs.datamigration.MongoDbMigrationProgressResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'Validate.MongoDb'. */ taskType: "Validate.MongoDb"; } /** * validateMongoDbTaskPropertiesResponseProvideDefaults sets the appropriate defaults for ValidateMongoDbTaskPropertiesResponse */ function validateMongoDbTaskPropertiesResponseProvideDefaults(val: ValidateMongoDbTaskPropertiesResponse): ValidateMongoDbTaskPropertiesResponse; /** * Properties for the task that validates a migration for Oracle to Azure Database for PostgreSQL for online migrations */ interface ValidateOracleAzureDbForPostgreSqlSyncTaskPropertiesResponse { /** * Key value pairs of client data to attach meta data information to task */ clientData?: { [key: string]: string; }; /** * Array of command properties. */ commands: (outputs.datamigration.MigrateMISyncCompleteCommandPropertiesResponse | outputs.datamigration.MigrateSyncCompleteCommandPropertiesResponse)[]; /** * Array of errors. This is ignored if submitted. */ errors: outputs.datamigration.ODataErrorResponse[]; /** * Input for the task that migrates Oracle databases to Azure Database for PostgreSQL for online migrations */ input?: outputs.datamigration.MigrateOracleAzureDbPostgreSqlSyncTaskInputResponse; /** * An array containing a single validation error response object */ output: outputs.datamigration.ValidateOracleAzureDbPostgreSqlSyncTaskOutputResponse[]; /** * The state of the task. This is ignored if submitted. */ state: string; /** * Task type. * Expected value is 'Validate.Oracle.AzureDbPostgreSql.Sync'. */ taskType: "Validate.Oracle.AzureDbPostgreSql.Sync"; } /** * validateOracleAzureDbForPostgreSqlSyncTaskPropertiesResponseProvideDefaults sets the appropriate defaults for ValidateOracleAzureDbForPostgreSqlSyncTaskPropertiesResponse */ function validateOracleAzureDbForPostgreSqlSyncTaskPropertiesResponseProvideDefaults(val: ValidateOracleAzureDbForPostgreSqlSyncTaskPropertiesResponse): ValidateOracleAzureDbForPostgreSqlSyncTaskPropertiesResponse; /** * Output for task that validates migration input for Oracle to Azure Database for PostgreSQL for online migrations */ interface ValidateOracleAzureDbPostgreSqlSyncTaskOutputResponse { /** * Errors associated with a selected database object */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Input for task that validates migration input for SQL sync migrations */ interface ValidateSyncMigrationInputSqlServerTaskInputResponse { /** * Databases to migrate */ selectedDatabases: outputs.datamigration.MigrateSqlServerSqlDbSyncDatabaseInputResponse[]; /** * Information for connecting to source SQL server */ sourceConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; /** * Information for connecting to target */ targetConnectionInfo: outputs.datamigration.SqlConnectionInfoResponse; } /** * validateSyncMigrationInputSqlServerTaskInputResponseProvideDefaults sets the appropriate defaults for ValidateSyncMigrationInputSqlServerTaskInputResponse */ function validateSyncMigrationInputSqlServerTaskInputResponseProvideDefaults(val: ValidateSyncMigrationInputSqlServerTaskInputResponse): ValidateSyncMigrationInputSqlServerTaskInputResponse; /** * Output for task that validates migration input for SQL sync migrations */ interface ValidateSyncMigrationInputSqlServerTaskOutputResponse { /** * Database identifier */ id: string; /** * Name of database */ name: string; /** * Errors associated with a selected database object */ validationErrors: outputs.datamigration.ReportableExceptionResponse[]; } /** * Description about the errors happen while performing migration validation */ interface ValidationErrorResponse { /** * Severity of the error */ severity?: string; /** * Error Text */ text?: string; } /** * Wait statistics gathered during query batch execution */ interface WaitStatisticsResponse { /** * Total no. of waits */ waitCount?: number; /** * Total wait time in millisecond(s) */ waitTimeMs?: number; /** * Type of the Wait */ waitType?: string; } /** * waitStatisticsResponseProvideDefaults sets the appropriate defaults for WaitStatisticsResponse */ function waitStatisticsResponseProvideDefaults(val: WaitStatisticsResponse): WaitStatisticsResponse; } export declare namespace dataprotection { /** * Delete option with duration */ interface AbsoluteDeleteOptionResponse { /** * Duration of deletion after given timespan */ duration: string; /** * Type of the specific object - used for deserializing * Expected value is 'AbsoluteDeleteOption'. */ objectType: "AbsoluteDeleteOption"; } /** * Adhoc backup tagging criteria */ interface AdhocBasedTaggingCriteriaResponse { /** * Retention tag information */ tagInfo?: outputs.dataprotection.RetentionTagResponse; } /** * Adhoc trigger context */ interface AdhocBasedTriggerContextResponse { /** * Type of the specific object - used for deserializing * Expected value is 'AdhocBasedTriggerContext'. */ objectType: "AdhocBasedTriggerContext"; /** * Tagging Criteria containing retention tag for adhoc backup. */ taggingCriteria: outputs.dataprotection.AdhocBasedTaggingCriteriaResponse; } /** * Azure backup parameters */ interface AzureBackupParamsResponse { /** * BackupType ; Full/Incremental etc */ backupType: string; /** * Type of the specific object - used for deserializing * Expected value is 'AzureBackupParams'. */ objectType: "AzureBackupParams"; } /** * Azure backup rule */ interface AzureBackupRuleResponse { /** * BackupParameters base */ backupParameters?: outputs.dataprotection.AzureBackupParamsResponse; /** * DataStoreInfo base */ dataStore: outputs.dataprotection.DataStoreInfoBaseResponse; name: string; /** * Expected value is 'AzureBackupRule'. */ objectType: "AzureBackupRule"; /** * Trigger context */ trigger: outputs.dataprotection.AdhocBasedTriggerContextResponse | outputs.dataprotection.ScheduleBasedTriggerContextResponse; } /** * Settings for Azure Monitor based alerts */ interface AzureMonitorAlertSettingsResponse { alertsForAllJobFailures?: string; } /** * Parameters for Operational-Tier DataStore */ interface AzureOperationalStoreParametersResponse { /** * type of datastore; Operational/Vault/Archive */ dataStoreType: string; /** * Type of the specific object - used for deserializing * Expected value is 'AzureOperationalStoreParameters'. */ objectType: "AzureOperationalStoreParameters"; /** * Gets or sets the Snapshot Resource Group Uri. */ resourceGroupId?: string; } /** * Azure retention rule */ interface AzureRetentionRuleResponse { isDefault?: boolean; lifecycles: outputs.dataprotection.SourceLifeCycleResponse[]; name: string; /** * Expected value is 'AzureRetentionRule'. */ objectType: "AzureRetentionRule"; } /** * Backup Instance */ interface BackupInstanceResponse { /** * Specifies the current protection state of the resource */ currentProtectionState: string; /** * Gets or sets the data source information. */ dataSourceInfo: outputs.dataprotection.DatasourceResponse; /** * Gets or sets the data source set information. */ dataSourceSetInfo?: outputs.dataprotection.DatasourceSetResponse; /** * Credentials to use to authenticate with data source provider. */ datasourceAuthCredentials?: outputs.dataprotection.SecretStoreBasedAuthCredentialsResponse; /** * Gets or sets the Backup Instance friendly name. */ friendlyName?: string; /** * Contains information of the Identity Details for the BI. * If it is null, default will be considered as System Assigned. */ identityDetails?: outputs.dataprotection.IdentityDetailsResponse; objectType: string; /** * Gets or sets the policy information. */ policyInfo: outputs.dataprotection.PolicyInfoResponse; /** * Specifies the protection error of the resource */ protectionErrorDetails: outputs.dataprotection.UserFacingErrorResponse; /** * Specifies the protection status of the resource */ protectionStatus: outputs.dataprotection.ProtectionStatusDetailsResponse; /** * Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed */ provisioningState: string; /** * ResourceGuardOperationRequests on which LAC check will be performed */ resourceGuardOperationRequests?: string[]; /** * Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. */ validationType?: string; } /** * Rule based backup policy */ interface BackupPolicyResponse { /** * Type of datasource for the backup management */ datasourceTypes: string[]; /** * Expected value is 'BackupPolicy'. */ objectType: "BackupPolicy"; /** * Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc */ policyRules: (outputs.dataprotection.AzureBackupRuleResponse | outputs.dataprotection.AzureRetentionRuleResponse)[]; } /** * Schedule for backup */ interface BackupScheduleResponse { /** * Repeating time intervals that define the backup schedule. * * Each value must follow the format: `R/YYYY-MM-DDThh:mm:ss[.fff][Z|(+/-)hh:mm]/Duration` * * Only the exact formats listed below are supported. Other ISO 8601 variations are not accepted. * * Supported time formats: * - `Thh:mm:ss.fff` (with milliseconds) * - `Thh:mm:ss` (with seconds) * - `Thh:mm` (hours and minutes only) * * A timezone indicator (`Z`, `+hh:mm`, or `-hh:mm`) may be appended to any of the above. * * Unsupported formats include compact notation such as `T1430`, `T143045`, or `T14.5`. * * Examples: * - `R/2023-10-15T14:30:00Z/P1W` * - `R/2023-10-15T14:30:45.123+05:30/P1D` * - `R/2023-10-15T14:30Z/P1D` */ repeatingTimeIntervals: string[]; /** * Time Zone for a schedule. * * Supported timezone indicators include: * - 'Z' for UTC * - '+00:00' * - '+05:30' * - '-08:00' * * Examples: * - 2023-10-15T14:30:45Z * - 2023-10-15T14:30:45.123+05:30 * - 2023-10-15T14:30-08:00 */ timeZone?: string; } /** * Backup Vault */ interface BackupVaultResponse { /** * Security Level of Backup Vault */ bcdrSecurityLevel: string; /** * Feature Settings */ featureSettings?: outputs.dataprotection.FeatureSettingsResponse; /** * Is vault protected by resource guard */ isVaultProtectedByResourceGuard: boolean; /** * Monitoring Settings */ monitoringSettings?: outputs.dataprotection.MonitoringSettingsResponse; /** * Provisioning state of the BackupVault resource */ provisioningState: string; /** * List of replicated regions for Backup Vault */ replicatedRegions?: string[]; /** * ResourceGuardOperationRequests on which LAC check will be performed */ resourceGuardOperationRequests?: string[]; /** * Resource move details for backup vault */ resourceMoveDetails: outputs.dataprotection.ResourceMoveDetailsResponse; /** * Resource move state for backup vault */ resourceMoveState: string; /** * Secure Score of Backup Vault */ secureScore: string; /** * Security Settings */ securitySettings?: outputs.dataprotection.SecuritySettingsResponse; /** * Storage Settings */ storageSettings: outputs.dataprotection.StorageSettingResponse[]; } /** * Parameters to be used during configuration of backup of blobs */ interface BlobBackupDatasourceParametersResponse { /** * List of containers to be backed up during configuration of backup of blobs */ containersList: string[]; /** * Type of the specific object - used for deserializing * Expected value is 'BlobBackupDatasourceParameters'. */ objectType: "BlobBackupDatasourceParameters"; } /** * The details of the managed identity used for CMK */ interface CmkKekIdentityResponse { /** * The managed identity to be used which has access permissions to the Key Vault. Provide a value here in case identity types: 'UserAssigned' only. */ identityId?: string; /** * The identity type. 'SystemAssigned' and 'UserAssigned' are mutually exclusive. 'SystemAssigned' will use implicitly created managed identity. */ identityType?: string; } /** * The properties of the Key Vault which hosts CMK */ interface CmkKeyVaultPropertiesResponse { /** * The key uri of the Customer Managed Key */ keyUri?: string; } /** * Copy on Expiry Option */ interface CopyOnExpiryOptionResponse { /** * Type of the specific object - used for deserializing * Expected value is 'CopyOnExpiryOption'. */ objectType: "CopyOnExpiryOption"; } interface CrossRegionRestoreSettingsResponse { /** * CrossRegionRestore state */ state?: string; } /** * CrossSubscriptionRestore Settings */ interface CrossSubscriptionRestoreSettingsResponse { /** * CrossSubscriptionRestore state */ state?: string; } /** * Duration based custom options to copy */ interface CustomCopyOptionResponse { /** * Data copied after given timespan */ duration?: string; /** * Type of the specific object - used for deserializing * Expected value is 'CustomCopyOption'. */ objectType: "CustomCopyOption"; } /** * DataStoreInfo base */ interface DataStoreInfoBaseResponse { /** * type of datastore; Operational/Vault/Archive */ dataStoreType: string; /** * Type of Datasource object, used to initialize the right inherited type */ objectType: string; } /** * Datasource to be backed up */ interface DatasourceResponse { /** * DatasourceType of the resource. */ datasourceType?: string; /** * Type of Datasource object, used to initialize the right inherited type */ objectType?: string; /** * Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. */ resourceID: string; /** * Location of datasource. */ resourceLocation?: string; /** * Unique identifier of the resource in the context of parent. */ resourceName?: string; /** * Properties specific to data source */ resourceProperties?: outputs.dataprotection.DefaultResourcePropertiesResponse; /** * Resource Type of Datasource. */ resourceType?: string; /** * Uri of the resource. */ resourceUri?: string; } /** * DatasourceSet details of datasource to be backed up */ interface DatasourceSetResponse { /** * DatasourceType of the resource. */ datasourceType?: string; /** * Type of Datasource object, used to initialize the right inherited type */ objectType?: string; /** * Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault. */ resourceID: string; /** * Location of datasource. */ resourceLocation?: string; /** * Unique identifier of the resource in the context of parent. */ resourceName?: string; /** * Properties specific to data source set */ resourceProperties?: outputs.dataprotection.DefaultResourcePropertiesResponse; /** * Resource Type of Datasource. */ resourceType?: string; /** * Uri of the resource. */ resourceUri?: string; } /** * Day of the week */ interface DayResponse { /** * Date of the month */ date?: number; /** * Whether Date is last date of month */ isLast?: boolean; } /** * Default source properties */ interface DefaultResourcePropertiesResponse { /** * Type of the specific object - used for deserializing * Expected value is 'DefaultResourceProperties'. */ objectType: "DefaultResourceProperties"; } /** * Identity details */ interface DppIdentityDetailsResponse { /** * The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource. */ principalId: string; /** * A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member. */ tenantId: string; /** * The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None */ type?: string; /** * Gets or sets the user assigned identities. */ userAssignedIdentities?: { [key: string]: outputs.dataprotection.UserAssignedIdentityResponse; }; } /** * Customer Managed Key details of the resource. */ interface EncryptionSettingsResponse { /** * Enabling/Disabling the Double Encryption state */ infrastructureEncryption?: string; /** * The details of the managed identity used for CMK */ kekIdentity?: outputs.dataprotection.CmkKekIdentityResponse; /** * The properties of the Key Vault which hosts CMK */ keyVaultProperties?: outputs.dataprotection.CmkKeyVaultPropertiesResponse; /** * Encryption state of the Backup Vault. */ state?: string; } /** * Class containing feature settings of vault */ interface FeatureSettingsResponse { crossRegionRestoreSettings?: outputs.dataprotection.CrossRegionRestoreSettingsResponse; /** * CrossSubscriptionRestore Settings */ crossSubscriptionRestoreSettings?: outputs.dataprotection.CrossSubscriptionRestoreSettingsResponse; } interface IdentityDetailsResponse { /** * Specifies if the BI is protected by System Identity. */ useSystemAssignedIdentity?: boolean; /** * ARM URL for User Assigned Identity. */ userAssignedIdentityArmUrl?: string; } /** * Immediate copy Option */ interface ImmediateCopyOptionResponse { /** * Type of the specific object - used for deserializing * Expected value is 'ImmediateCopyOption'. */ objectType: "ImmediateCopyOption"; } /** * Immutability Settings at vault level */ interface ImmutabilitySettingsResponse { /** * Immutability state */ state?: string; } /** * Inner Error */ interface InnerErrorResponse { /** * Any Key value pairs that can be provided to the client for additional verbose information. */ additionalInfo?: { [key: string]: string; }; /** * Unique code for this error */ code?: string; /** * Child Inner Error, to allow Nesting. */ embeddedInnerError?: outputs.dataprotection.InnerErrorResponse; } /** * Parameters for Kubernetes Cluster Backup Datasource */ interface KubernetesClusterBackupDatasourceParametersResponse { /** * Gets or sets the backup hook references. This property sets the hook reference to be executed during backup. */ backupHookReferences?: outputs.dataprotection.NamespacedNameResourceResponse[]; /** * Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during backup. */ excludedNamespaces?: string[]; /** * Gets or sets the exclude resource types property. This property sets the resource types to be excluded during backup. */ excludedResourceTypes?: string[]; /** * Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during backup. */ includeClusterScopeResources: boolean; /** * Gets or sets the include namespaces property. This property sets the namespaces to be included during backup. */ includedNamespaces?: string[]; /** * Gets or sets the include resource types property. This property sets the resource types to be included during backup. */ includedResourceTypes?: string[]; /** * Gets or sets the include volume types property. This property sets the volume types to be included during backup. */ includedVolumeTypes?: string[]; /** * Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during backup. */ labelSelectors?: string[]; /** * Type of the specific object - used for deserializing * Expected value is 'KubernetesClusterBackupDatasourceParameters'. */ objectType: "KubernetesClusterBackupDatasourceParameters"; /** * Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during backup. */ snapshotVolumes: boolean; } /** * Monitoring Settings */ interface MonitoringSettingsResponse { /** * Settings for Azure Monitor based alerts */ azureMonitorAlertSettings?: outputs.dataprotection.AzureMonitorAlertSettingsResponse; } /** * Class to refer resources which contains namespace and name */ interface NamespacedNameResourceResponse { /** * Name of the resource */ name?: string; /** * Namespace in which the resource exists */ namespace?: string; } /** * Policy Info in backupInstance */ interface PolicyInfoResponse { policyId: string; /** * Policy parameters for the backup instance */ policyParameters?: outputs.dataprotection.PolicyParametersResponse; policyVersion: string; } /** * Parameters in Policy */ interface PolicyParametersResponse { /** * Gets or sets the Backup Data Source Parameters */ backupDatasourceParametersList?: (outputs.dataprotection.BlobBackupDatasourceParametersResponse | outputs.dataprotection.KubernetesClusterBackupDatasourceParametersResponse)[]; /** * Gets or sets the DataStore Parameters */ dataStoreParametersList?: outputs.dataprotection.AzureOperationalStoreParametersResponse[]; } /** * Protection status details */ interface ProtectionStatusDetailsResponse { /** * Specifies the protection status error of the resource */ errorDetails?: outputs.dataprotection.UserFacingErrorResponse; /** * Specifies the protection status of the resource */ status?: string; } /** * VaultCritical Operation protected by a resource guard */ interface ResourceGuardOperationDetailResponse { defaultResourceRequest?: string; vaultCriticalOperation?: string; } /** * This class contains all the details about a critical operation. */ interface ResourceGuardOperationResponse { /** * Type of resource request. */ requestResourceType: string; /** * Name of the critical operation. */ vaultCriticalOperation: string; } /** * ResourceGuardProxyBase object, used in ResourceGuardProxyBaseResource */ interface ResourceGuardProxyBaseResponse { description?: string; lastUpdatedTime?: string; resourceGuardOperationDetails?: outputs.dataprotection.ResourceGuardOperationDetailResponse[]; resourceGuardResourceId?: string; } interface ResourceGuardResponse { /** * This flag indicates whether auto approval is allowed or not. */ allowAutoApprovals: boolean; /** * Description about the pre-req steps to perform all the critical operations. */ description: string; /** * Provisioning state of the BackupVault resource */ provisioningState: string; /** * {readonly} List of operation details those are protected by the ResourceGuard resource */ resourceGuardOperations: outputs.dataprotection.ResourceGuardOperationResponse[]; /** * List of critical operations which are not protected by this resourceGuard */ vaultCriticalOperationExclusionList?: string[]; } /** * ResourceMoveDetails will be returned in response to GetResource call from ARM */ interface ResourceMoveDetailsResponse { /** * Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format. */ completionTimeUtc?: string; /** * CorrelationId of latest ResourceMove operation attempted */ operationId?: string; /** * ARM resource path of source resource */ sourceResourcePath?: string; /** * Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format. */ startTimeUtc?: string; /** * ARM resource path of target resource used in latest ResourceMove operation */ targetResourcePath?: string; } /** * Retention tag */ interface RetentionTagResponse { /** * Retention Tag version. */ eTag: string; /** * Retention Tag version. */ id: string; /** * Retention Tag Name to relate it to retention rule. */ tagName: string; } /** * Schedule based backup criteria */ interface ScheduleBasedBackupCriteriaResponse { /** * it contains absolute values like "AllBackup" / "FirstOfDay" / "FirstOfWeek" / "FirstOfMonth" * and should be part of AbsoluteMarker enum */ absoluteCriteria?: string[]; /** * This is day of the month from 1 to 28 other wise last of month */ daysOfMonth?: outputs.dataprotection.DayResponse[]; /** * It should be Sunday/Monday/T..../Saturday */ daysOfTheWeek?: string[]; /** * It should be January/February/....../December */ monthsOfYear?: string[]; /** * Type of the specific object - used for deserializing * Expected value is 'ScheduleBasedBackupCriteria'. */ objectType: "ScheduleBasedBackupCriteria"; /** * List of schedule times for backup */ scheduleTimes?: string[]; /** * It should be First/Second/Third/Fourth/Last */ weeksOfTheMonth?: string[]; } /** * Schedule based trigger context */ interface ScheduleBasedTriggerContextResponse { /** * Type of the specific object - used for deserializing * Expected value is 'ScheduleBasedTriggerContext'. */ objectType: "ScheduleBasedTriggerContext"; /** * Schedule for this backup */ schedule: outputs.dataprotection.BackupScheduleResponse; /** * List of tags that can be applicable for given schedule. */ taggingCriteria: outputs.dataprotection.TaggingCriteriaResponse[]; } /** * Secret store based authentication credentials. */ interface SecretStoreBasedAuthCredentialsResponse { /** * Type of the specific object - used for deserializing * Expected value is 'SecretStoreBasedAuthCredentials'. */ objectType: "SecretStoreBasedAuthCredentials"; /** * Secret store resource */ secretStoreResource?: outputs.dataprotection.SecretStoreResourceResponse; } /** * Class representing a secret store resource. */ interface SecretStoreResourceResponse { /** * Gets or sets the type of secret store */ secretStoreType: string; /** * Uri to get to the resource */ uri?: string; /** * Gets or sets value stored in secret store resource */ value?: string; } /** * Class containing security settings of vault */ interface SecuritySettingsResponse { /** * Customer Managed Key details of the resource. */ encryptionSettings?: outputs.dataprotection.EncryptionSettingsResponse; /** * Immutability Settings at vault level */ immutabilitySettings?: outputs.dataprotection.ImmutabilitySettingsResponse; /** * Soft delete related settings */ softDeleteSettings?: outputs.dataprotection.SoftDeleteSettingsResponse; } /** * Soft delete related settings */ interface SoftDeleteSettingsResponse { /** * Soft delete retention duration */ retentionDurationInDays?: number; /** * State of soft delete */ state?: string; } /** * Source LifeCycle */ interface SourceLifeCycleResponse { /** * Delete Option */ deleteAfter: outputs.dataprotection.AbsoluteDeleteOptionResponse; /** * DataStoreInfo base */ sourceDataStore: outputs.dataprotection.DataStoreInfoBaseResponse; targetDataStoreCopySettings?: outputs.dataprotection.TargetCopySettingResponse[]; } /** * Storage setting */ interface StorageSettingResponse { /** * Gets or sets the type of the datastore. */ datastoreType?: string; /** * Gets or sets the type. */ type?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Tagging criteria */ interface TaggingCriteriaResponse { /** * Criteria which decides whether the tag can be applied to a triggered backup. */ criteria?: outputs.dataprotection.ScheduleBasedBackupCriteriaResponse[]; /** * Specifies if tag is default. */ isDefault: boolean; /** * Retention tag information */ tagInfo: outputs.dataprotection.RetentionTagResponse; /** * Retention Tag priority. */ taggingPriority: number; } /** * Target copy settings */ interface TargetCopySettingResponse { /** * It can be CustomCopyOption or ImmediateCopyOption. */ copyAfter: outputs.dataprotection.CopyOnExpiryOptionResponse | outputs.dataprotection.CustomCopyOptionResponse | outputs.dataprotection.ImmediateCopyOptionResponse; /** * Info of target datastore */ dataStore: outputs.dataprotection.DataStoreInfoBaseResponse; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Error object used by layers that have access to localized content, and propagate that to user */ interface UserFacingErrorResponse { /** * Unique code for this error */ code?: string; /** * Additional related Errors */ details?: outputs.dataprotection.UserFacingErrorResponse[]; /** * Inner Error */ innerError?: outputs.dataprotection.InnerErrorResponse; /** * Whether the operation will be retryable or not */ isRetryable?: boolean; /** * Whether the operation is due to a user error or service error */ isUserError?: boolean; message?: string; /** * Any key value pairs that can be injected inside error object */ properties?: { [key: string]: string; }; /** * RecommendedAction � localized. */ recommendedAction?: string[]; /** * Target of the error. */ target?: string; } } export declare namespace datareplication { /** * AzStackHCI cluster properties. */ interface AzStackHCIClusterPropertiesResponse { /** * Gets or sets the AzStackHCICluster FQDN name. */ clusterName: string; /** * Gets or sets the AzStackHCICluster resource name. */ resourceName: string; /** * Gets or sets the Storage account name. */ storageAccountName: string; /** * Gets or sets the list of AzStackHCICluster Storage Container. */ storageContainers: outputs.datareplication.StorageContainerPropertiesResponse[]; } /** * AzStackHCI fabric model custom properties. */ interface AzStackHCIFabricModelCustomPropertiesResponse { /** * Gets or sets the Appliance name. */ applianceName: string[]; /** * Gets or sets the ARM Id of the AzStackHCI site. */ azStackHciSiteId: string; /** * AzStackHCI cluster properties. */ cluster: outputs.datareplication.AzStackHCIClusterPropertiesResponse; /** * Gets or sets the fabric container Id. */ fabricContainerId: string; /** * Gets or sets the fabric resource Id. */ fabricResourceId: string; /** * Gets or sets the instance type. * Expected value is 'AzStackHCI'. */ instanceType: "AzStackHCI"; /** * Gets or sets the migration hub Uri. */ migrationHubUri: string; /** * Gets or sets the Migration solution ARM Id. */ migrationSolutionId: string; } /** * Dra model properties. */ interface DraModelPropertiesResponse { /** * Identity model. */ authenticationIdentity: outputs.datareplication.IdentityModelResponse; /** * Gets or sets the Dra correlation Id. */ correlationId: string; /** * Dra model custom properties. */ customProperties: outputs.datareplication.VMwareDraModelCustomPropertiesResponse; /** * Gets or sets the list of health errors. */ healthErrors: outputs.datareplication.HealthErrorModelResponse[]; /** * Gets or sets a value indicating whether Dra is responsive. */ isResponsive: boolean; /** * Gets or sets the time when last heartbeat was sent by the Dra. */ lastHeartbeat: string; /** * Gets or sets the machine Id where Dra is running. */ machineId: string; /** * Gets or sets the machine name where Dra is running. */ machineName: string; /** * Gets or sets the provisioning state of the Dra. */ provisioningState: string; /** * Identity model. */ resourceAccessIdentity: outputs.datareplication.IdentityModelResponse; /** * Gets or sets the Dra version. */ versionNumber: string; } interface DraModelResponseSystemData { /** * Gets or sets the timestamp of resource creation (UTC). */ createdAt?: string; /** * Gets or sets identity that created the resource. */ createdBy?: string; /** * Gets or sets the type of identity that created the resource: user, application, * managedIdentity. */ createdByType?: string; /** * Gets or sets the timestamp of resource last modification (UTC). */ lastModifiedAt?: string; /** * Gets or sets the identity that last modified the resource. */ lastModifiedBy?: string; /** * Gets or sets the type of identity that last modified the resource: user, application, * managedIdentity. */ lastModifiedByType?: string; } /** * Fabric agent model properties. */ interface FabricAgentModelPropertiesResponse { /** * Identity model. */ authenticationIdentity: outputs.datareplication.IdentityModelResponse; /** * Gets or sets the fabric agent correlation Id. */ correlationId: string; /** * Fabric agent model custom properties. */ customProperties: outputs.datareplication.VMwareFabricAgentModelCustomPropertiesResponse; /** * Gets or sets the list of health errors. */ healthErrors: outputs.datareplication.HealthErrorModelResponse[]; /** * Gets or sets a value indicating whether the fabric agent is responsive. */ isResponsive: boolean; /** * Gets or sets the time when last heartbeat was sent by the fabric agent. */ lastHeartbeat: string; /** * Gets or sets the machine Id where fabric agent is running. */ machineId: string; /** * Gets or sets the machine name where fabric agent is running. */ machineName: string; /** * Gets or sets the provisioning state of the fabric agent. */ provisioningState: string; /** * Identity model. */ resourceAccessIdentity: outputs.datareplication.IdentityModelResponse; /** * Gets or sets the fabric agent version. */ versionNumber: string; } /** * Fabric model properties. */ interface FabricModelPropertiesResponse { /** * Fabric model custom properties. */ customProperties: outputs.datareplication.AzStackHCIFabricModelCustomPropertiesResponse | outputs.datareplication.HyperVMigrateFabricModelCustomPropertiesResponse | outputs.datareplication.VMwareMigrateFabricModelCustomPropertiesResponse; /** * Gets or sets the fabric health. */ health: string; /** * Gets or sets the list of health errors. */ healthErrors: outputs.datareplication.HealthErrorModelResponse[]; /** * Gets or sets the provisioning state of the fabric. */ provisioningState: string; /** * Gets or sets the service endpoint. */ serviceEndpoint: string; /** * Gets or sets the service resource Id. */ serviceResourceId: string; } interface FabricModelResponseSystemData { /** * Gets or sets the timestamp of resource creation (UTC). */ createdAt?: string; /** * Gets or sets identity that created the resource. */ createdBy?: string; /** * Gets or sets the type of identity that created the resource: user, application, * managedIdentity. */ createdByType?: string; /** * Gets or sets the timestamp of resource last modification (UTC). */ lastModifiedAt?: string; /** * Gets or sets the identity that last modified the resource. */ lastModifiedBy?: string; /** * Gets or sets the type of identity that last modified the resource: user, application, * managedIdentity. */ lastModifiedByType?: string; } /** * Health error model. */ interface HealthErrorModelResponse { /** * Gets or sets the list of affected resource correlation Ids. This can be used to * uniquely identify the count of items affected by a specific category and severity * as well as count of item affected by an specific issue. */ affectedResourceCorrelationIds?: string[]; /** * Gets or sets the type of affected resource type. */ affectedResourceType?: string; /** * Gets or sets the error category. */ category: string; /** * Gets or sets possible causes of the error. */ causes: string; /** * Gets or sets a list of child health errors associated with this error. */ childErrors?: outputs.datareplication.InnerHealthErrorModelResponse[]; /** * Gets or sets the error code. */ code: string; /** * Gets or sets the error creation time. */ creationTime: string; /** * Gets or sets the health category. */ healthCategory: string; /** * Gets or sets a value indicating whether the error is customer resolvable. */ isCustomerResolvable: boolean; /** * Gets or sets the error message. */ message: string; /** * Gets or sets recommended action to resolve the error. */ recommendation: string; /** * Gets or sets the error severity. */ severity: string; /** * Gets or sets the error source. */ source: string; /** * Gets or sets the error summary. */ summary: string; } /** * HyperV migrate fabric model custom properties. */ interface HyperVMigrateFabricModelCustomPropertiesResponse { /** * Gets or sets the fabric container Id. */ fabricContainerId: string; /** * Gets or sets the fabric resource Id. */ fabricResourceId: string; /** * Gets or sets the ARM Id of the HyperV site. */ hyperVSiteId: string; /** * Gets or sets the instance type. * Expected value is 'HyperVMigrate'. */ instanceType: "HyperVMigrate"; /** * Gets or sets the migration hub Uri. */ migrationHubUri: string; /** * Gets or sets the migration solution ARM Id. */ migrationSolutionId: string; } /** * HyperVToAzStack disk input. */ interface HyperVToAzStackHCIDiskInputResponse { /** * Gets or sets the type of the virtual hard disk, vhd or vhdx. */ diskFileFormat: string; /** * Gets or sets the disk Id. */ diskId: string; /** * Gets or sets the disk size in GB. */ diskSizeGB: number; /** * Gets or sets a value indicating whether dynamic sizing is enabled on the virtual hard * disk. */ isDynamic?: boolean; /** * Gets or sets a value indicating whether disk is os disk. */ isOsDisk: boolean; /** * Gets or sets the target storage account ARM Id. */ storageContainerId?: string; } /** * HyperVToAzStackHCI NIC properties. */ interface HyperVToAzStackHCINicInputResponse { /** * Gets or sets the network name. */ networkName: string; /** * Gets or sets the NIC Id. */ nicId: string; /** * Gets or sets the selection type of the NIC. */ selectionTypeForFailover: string; /** * Gets or sets the target network Id within AzStackHCI Cluster. */ targetNetworkId: string; /** * Gets or sets the target test network Id within AzStackHCI Cluster. */ testNetworkId: string; } /** * HyperV To AzStackHCI Policy model custom properties. */ interface HyperVToAzStackHCIPolicyModelCustomPropertiesResponse { /** * Gets or sets the app consistent snapshot frequency (in minutes). */ appConsistentFrequencyInMinutes: number; /** * Gets or sets the crash consistent snapshot frequency (in minutes). */ crashConsistentFrequencyInMinutes: number; /** * Gets or sets the instance type. * Expected value is 'HyperVToAzStackHCI'. */ instanceType: "HyperVToAzStackHCI"; /** * Gets or sets the duration in minutes until which the recovery points need to be * stored. */ recoveryPointHistoryInMinutes: number; } /** * HyperVToAzStackHCI protected disk properties. */ interface HyperVToAzStackHCIProtectedDiskPropertiesResponse { /** * Gets or sets the disk capacity in bytes. */ capacityInBytes: number; /** * Gets or sets the disk type. */ diskType: string; /** * Gets or sets a value indicating whether dynamic sizing is enabled on the virtual hard * disk. */ isDynamic: boolean; /** * Gets or sets a value indicating whether the disk is the OS disk. */ isOsDisk: boolean; /** * Gets or sets the failover clone disk. */ migrateDiskName: string; /** * Gets or sets the seed disk name. */ seedDiskName: string; /** * Gets or sets the source disk Id. */ sourceDiskId: string; /** * Gets or sets the source disk Name. */ sourceDiskName: string; /** * Gets or sets the ARM Id of the storage container. */ storageContainerId: string; /** * Gets or sets the local path of the storage container. */ storageContainerLocalPath: string; /** * Gets or sets the test failover clone disk. */ testMigrateDiskName: string; } /** * HyperV to AzStackHCI Protected item model custom properties. */ interface HyperVToAzStackHCIProtectedItemModelCustomPropertiesResponse { /** * Gets or sets the location of the protected item. */ activeLocation: string; /** * Gets or sets the location of Azure Arc HCI custom location resource. */ customLocationRegion: string; /** * Gets or sets the list of disks to replicate. */ disksToInclude: outputs.datareplication.HyperVToAzStackHCIDiskInputResponse[]; /** * Protected item dynamic memory config. */ dynamicMemoryConfig?: outputs.datareplication.ProtectedItemDynamicMemoryConfigResponse; /** * Gets or sets the ARM Id of the discovered machine. */ fabricDiscoveryMachineId: string; /** * Gets or sets the recovery point Id to which the VM was failed over. */ failoverRecoveryPointId: string; /** * Gets or sets the firmware type. */ firmwareType: string; /** * Gets or sets the hypervisor generation of the virtual machine. */ hyperVGeneration: string; /** * Gets or sets the initial replication progress percentage. This is calculated based on * total bytes processed for all disks in the source VM. */ initialReplicationProgressPercentage: number; /** * Gets or sets the instance type. * Expected value is 'HyperVToAzStackHCI'. */ instanceType: "HyperVToAzStackHCI"; /** * Gets or sets a value indicating whether memory is dynamical. */ isDynamicRam?: boolean; /** * Gets or sets the last recovery point Id. */ lastRecoveryPointId: string; /** * Gets or sets the last recovery point received time. */ lastRecoveryPointReceived: string; /** * Gets or sets the latest timestamp that replication status is updated. */ lastReplicationUpdateTime: string; /** * Gets or sets the list of VM NIC to replicate. */ nicsToInclude: outputs.datareplication.HyperVToAzStackHCINicInputResponse[]; /** * Gets or sets the name of the OS. */ osName: string; /** * Gets or sets the type of the OS. */ osType: string; /** * Gets or sets the list of protected disks. */ protectedDisks: outputs.datareplication.HyperVToAzStackHCIProtectedDiskPropertiesResponse[]; /** * Gets or sets the VM NIC details. */ protectedNics: outputs.datareplication.HyperVToAzStackHCIProtectedNicPropertiesResponse[]; /** * Gets or sets the resync progress percentage. This is calculated based on total bytes * processed for all disks in the source VM. */ resyncProgressPercentage: number; /** * Gets or sets the Run As account Id. */ runAsAccountId: string; /** * Gets or sets the source appliance name. */ sourceApplianceName: string; /** * Gets or sets the source VM CPU cores. */ sourceCpuCores: number; /** * Gets or sets the source DRA name. */ sourceDraName: string; /** * Gets or sets the source VM ram memory size in megabytes. */ sourceMemoryInMegaBytes: number; /** * Gets or sets the source VM display name. */ sourceVmName: string; /** * Gets or sets the target storage container ARM Id. */ storageContainerId: string; /** * Gets or sets the target appliance name. */ targetApplianceName: string; /** * Gets or sets the Target Arc Cluster Custom Location ARM Id. */ targetArcClusterCustomLocationId: string; /** * Gets or sets the Target AzStackHCI cluster name. */ targetAzStackHciClusterName: string; /** * Gets or sets the target CPU cores. */ targetCpuCores?: number; /** * Gets or sets the target DRA name. */ targetDraName: string; /** * Gets or sets the Target HCI Cluster ARM Id. */ targetHciClusterId: string; /** * Gets or sets the target location. */ targetLocation: string; /** * Gets or sets the target memory in mega-bytes. */ targetMemoryInMegaBytes?: number; /** * Gets or sets the target network Id within AzStackHCI Cluster. */ targetNetworkId?: string; /** * Gets or sets the target resource group ARM Id. */ targetResourceGroupId: string; /** * Gets or sets the BIOS Id of the target AzStackHCI VM. */ targetVmBiosId: string; /** * Gets or sets the target VM display name. */ targetVmName?: string; /** * Gets or sets the target test network Id within AzStackHCI Cluster. */ testNetworkId?: string; } /** * HyperVToAzStackHCI NIC properties. */ interface HyperVToAzStackHCIProtectedNicPropertiesResponse { /** * Gets or sets the NIC mac address. */ macAddress: string; /** * Gets or sets the network name. */ networkName: string; /** * Gets or sets the NIC Id. */ nicId: string; /** * Gets or sets the selection type of the NIC. */ selectionTypeForFailover: string; /** * Gets or sets the target network Id within AzStackHCI Cluster. */ targetNetworkId: string; /** * Gets or sets the target test network Id within AzStackHCI Cluster. */ testNetworkId: string; } /** * HyperV to AzStackHCI Replication extension model custom properties. */ interface HyperVToAzStackHCIReplicationExtensionModelCustomPropertiesResponse { /** * Gets or sets the Uri of ASR. */ asrServiceUri: string; /** * Gets or sets the ARM Id of the target AzStackHCI fabric. */ azStackHciFabricArmId: string; /** * Gets or sets the ARM Id of the AzStackHCI site. */ azStackHciSiteId: string; /** * Gets or sets the Uri of Gateway. */ gatewayServiceUri: string; /** * Gets or sets the ARM Id of the source HyperV fabric. */ hyperVFabricArmId: string; /** * Gets or sets the ARM Id of the HyperV site. */ hyperVSiteId: string; /** * Gets or sets the instance type. * Expected value is 'HyperVToAzStackHCI'. */ instanceType: "HyperVToAzStackHCI"; /** * Gets or sets the Uri of Rcm. */ rcmServiceUri: string; /** * Gets or sets the resource group. */ resourceGroup: string; /** * Gets or sets the resource location. */ resourceLocation: string; /** * Gets or sets the gateway service Id of source. */ sourceGatewayServiceId: string; /** * Gets or sets the source storage container name. */ sourceStorageContainerName: string; /** * Gets or sets the storage account Id. */ storageAccountId?: string; /** * Gets or sets the Sas Secret of storage account. */ storageAccountSasSecretName?: string; /** * Gets or sets the subscription. */ subscriptionId: string; /** * Gets or sets the gateway service Id of target. */ targetGatewayServiceId: string; /** * Gets or sets the target storage container name. */ targetStorageContainerName: string; } /** * Identity model. */ interface IdentityModelResponse { /** * Gets or sets the authority of the SPN with which fabric agent communicates to service. */ aadAuthority: string; /** * Gets or sets the client/application Id of the SPN with which fabric agent communicates to service. */ applicationId: string; /** * Gets or sets the audience of the SPN with which fabric agent communicates to service. */ audience: string; /** * Gets or sets the object Id of the SPN with which fabric agent communicates to service. */ objectId: string; /** * Gets or sets the tenant Id of the SPN with which fabric agent communicates to service. */ tenantId: string; } /** * Inner health error model. */ interface InnerHealthErrorModelResponse { /** * Gets or sets the error category. */ category: string; /** * Gets or sets possible causes of the error. */ causes: string; /** * Gets or sets the error code. */ code: string; /** * Gets or sets the error creation time. */ creationTime: string; /** * Gets or sets the health category. */ healthCategory: string; /** * Gets or sets a value indicating whether the error is customer resolvable. */ isCustomerResolvable: boolean; /** * Gets or sets the error message. */ message: string; /** * Gets or sets recommended action to resolve the error. */ recommendation: string; /** * Gets or sets the error severity. */ severity: string; /** * Gets or sets the error source. */ source: string; /** * Gets or sets the error summary. */ summary: string; } /** * Policy model properties. */ interface PolicyModelPropertiesResponse { /** * Policy model custom properties. */ customProperties: outputs.datareplication.HyperVToAzStackHCIPolicyModelCustomPropertiesResponse | outputs.datareplication.VMwareToAzStackHCIPolicyModelCustomPropertiesResponse; /** * Gets or sets the provisioning state of the policy. */ provisioningState: string; } interface PolicyModelResponseSystemData { /** * Gets or sets the timestamp of resource creation (UTC). */ createdAt?: string; /** * Gets or sets identity that created the resource. */ createdBy?: string; /** * Gets or sets the type of identity that created the resource: user, application, * managedIdentity. */ createdByType?: string; /** * Gets or sets the timestamp of resource last modification (UTC). */ lastModifiedAt?: string; /** * Gets or sets the identity that last modified the resource. */ lastModifiedBy?: string; /** * Gets or sets the type of identity that last modified the resource: user, application, * managedIdentity. */ lastModifiedByType?: string; } /** * Represents Private endpoint connection response properties. */ interface PrivateEndpointConnectionResponsePropertiesResponse { /** * Represent private Endpoint network resource that is linked to the Private Endpoint connection. */ privateEndpoint?: outputs.datareplication.PrivateEndpointResponse; /** * Represents Private link service connection state. */ privateLinkServiceConnectionState?: outputs.datareplication.PrivateLinkServiceConnectionStateResponse; /** * Gets or sets provisioning state of the private endpoint connection. */ provisioningState: string; } /** * Represent private Endpoint network resource that is linked to the Private Endpoint connection. */ interface PrivateEndpointResponse { /** * Gets or sets the id. */ id?: string; } /** * Represents Private link service connection state. */ interface PrivateLinkServiceConnectionStateResponse { /** * Gets or sets actions required. */ actionsRequired?: string; /** * Gets or sets description. */ description?: string; /** * Gets or sets the status. */ status?: string; } /** * Protected item dynamic memory config. */ interface ProtectedItemDynamicMemoryConfigResponse { /** * Gets or sets maximum memory in MB. */ maximumMemoryInMegaBytes: number; /** * Gets or sets minimum memory in MB. */ minimumMemoryInMegaBytes: number; /** * Gets or sets target memory buffer in %. */ targetMemoryBufferPercentage: number; } /** * Protected item model properties. */ interface ProtectedItemModelPropertiesResponse { /** * Gets or sets the allowed scenarios on the protected item. */ allowedJobs: string[]; /** * Gets or sets the protected item correlation Id. */ correlationId: string; currentJob: outputs.datareplication.ProtectedItemModelPropertiesResponseCurrentJob; /** * Protected item model custom properties. */ customProperties: outputs.datareplication.HyperVToAzStackHCIProtectedItemModelCustomPropertiesResponse | outputs.datareplication.VMwareToAzStackHCIProtectedItemModelCustomPropertiesResponse; /** * Gets or sets the DRA Id. */ draId: string; /** * Gets or sets the fabric Id. */ fabricId: string; /** * Gets or sets the fabric object Id. */ fabricObjectId: string; /** * Gets or sets the fabric object name. */ fabricObjectName: string; /** * Gets or sets the list of health errors. */ healthErrors: outputs.datareplication.HealthErrorModelResponse[]; lastFailedEnableProtectionJob: outputs.datareplication.ProtectedItemModelPropertiesResponseLastFailedEnableProtectionJob; lastFailedPlannedFailoverJob: outputs.datareplication.ProtectedItemModelPropertiesResponseLastFailedPlannedFailoverJob; /** * Gets or sets the Last successful planned failover time. */ lastSuccessfulPlannedFailoverTime: string; /** * Gets or sets the Last successful test failover time. */ lastSuccessfulTestFailoverTime: string; /** * Gets or sets the Last successful unplanned failover time. */ lastSuccessfulUnplannedFailoverTime: string; lastTestFailoverJob: outputs.datareplication.ProtectedItemModelPropertiesResponseLastTestFailoverJob; /** * Gets or sets the policy name. */ policyName: string; /** * Gets or sets the protection state. */ protectionState: string; /** * Gets or sets the protection state description. */ protectionStateDescription: string; /** * Gets or sets the provisioning state of the Dra. */ provisioningState: string; /** * Gets or sets the replication extension name. */ replicationExtensionName: string; /** * Gets or sets protected item replication health. */ replicationHealth: string; /** * Gets or sets a value indicating whether resynchronization is required or not. */ resyncRequired: boolean; /** * Gets or sets the resynchronization state. */ resynchronizationState: string; /** * Gets or sets the source fabric provider Id. */ sourceFabricProviderId: string; /** * Gets or sets the target DRA Id. */ targetDraId: string; /** * Gets or sets the target fabric Id. */ targetFabricId: string; /** * Gets or sets the target fabric provider Id. */ targetFabricProviderId: string; /** * Gets or sets the test failover state. */ testFailoverState: string; /** * Gets or sets the Test failover state description. */ testFailoverStateDescription: string; } interface ProtectedItemModelPropertiesResponseCurrentJob { /** * Gets or sets the workflow friendly display name. */ displayName: string; /** * Gets or sets end time of the workflow. */ endTime: string; /** * Gets or sets workflow Id. */ id: string; /** * Gets or sets workflow name. */ name: string; /** * Gets or sets protection scenario name. */ scenarioName: string; /** * Gets or sets start time of the workflow. */ startTime: string; /** * Gets or sets workflow state. */ state: string; } interface ProtectedItemModelPropertiesResponseLastFailedEnableProtectionJob { /** * Gets or sets the workflow friendly display name. */ displayName: string; /** * Gets or sets end time of the workflow. */ endTime: string; /** * Gets or sets workflow Id. */ id: string; /** * Gets or sets workflow name. */ name: string; /** * Gets or sets protection scenario name. */ scenarioName: string; /** * Gets or sets start time of the workflow. */ startTime: string; /** * Gets or sets workflow state. */ state: string; } interface ProtectedItemModelPropertiesResponseLastFailedPlannedFailoverJob { /** * Gets or sets the workflow friendly display name. */ displayName: string; /** * Gets or sets end time of the workflow. */ endTime: string; /** * Gets or sets workflow Id. */ id: string; /** * Gets or sets workflow name. */ name: string; /** * Gets or sets protection scenario name. */ scenarioName: string; /** * Gets or sets start time of the workflow. */ startTime: string; /** * Gets or sets workflow state. */ state: string; } interface ProtectedItemModelPropertiesResponseLastTestFailoverJob { /** * Gets or sets the workflow friendly display name. */ displayName: string; /** * Gets or sets end time of the workflow. */ endTime: string; /** * Gets or sets workflow Id. */ id: string; /** * Gets or sets workflow name. */ name: string; /** * Gets or sets protection scenario name. */ scenarioName: string; /** * Gets or sets start time of the workflow. */ startTime: string; /** * Gets or sets workflow state. */ state: string; } interface ProtectedItemModelResponseSystemData { /** * Gets or sets the timestamp of resource creation (UTC). */ createdAt?: string; /** * Gets or sets identity that created the resource. */ createdBy?: string; /** * Gets or sets the type of identity that created the resource: user, application, * managedIdentity. */ createdByType?: string; /** * Gets or sets the timestamp of resource last modification (UTC). */ lastModifiedAt?: string; /** * Gets or sets the identity that last modified the resource. */ lastModifiedBy?: string; /** * Gets or sets the type of identity that last modified the resource: user, application, * managedIdentity. */ lastModifiedByType?: string; } /** * Replication extension model properties. */ interface ReplicationExtensionModelPropertiesResponse { /** * Replication extension model custom properties. */ customProperties: outputs.datareplication.HyperVToAzStackHCIReplicationExtensionModelCustomPropertiesResponse | outputs.datareplication.VMwareToAzStackHCIReplicationExtensionModelCustomPropertiesResponse; /** * Gets or sets the provisioning state of the replication extension. */ provisioningState: string; } interface ReplicationExtensionModelResponseSystemData { /** * Gets or sets the timestamp of resource creation (UTC). */ createdAt?: string; /** * Gets or sets identity that created the resource. */ createdBy?: string; /** * Gets or sets the type of identity that created the resource: user, application, * managedIdentity. */ createdByType?: string; /** * Gets or sets the timestamp of resource last modification (UTC). */ lastModifiedAt?: string; /** * Gets or sets the identity that last modified the resource. */ lastModifiedBy?: string; /** * Gets or sets the type of identity that last modified the resource: user, application, * managedIdentity. */ lastModifiedByType?: string; } /** * Storage container properties. */ interface StorageContainerPropertiesResponse { /** * Gets or sets the ClusterSharedVolumePath. */ clusterSharedVolumePath: string; /** * Gets or sets the Name. */ name: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * VMware DRA model custom properties. */ interface VMwareDraModelCustomPropertiesResponse { /** * Gets or sets the BIOS Id of the DRA machine. */ biosId: string; /** * Gets or sets the instance type. * Expected value is 'VMware'. */ instanceType: "VMware"; /** * Identity model. */ marsAuthenticationIdentity: outputs.datareplication.IdentityModelResponse; } /** * VMware fabric agent model custom properties. */ interface VMwareFabricAgentModelCustomPropertiesResponse { /** * Gets or sets the BIOS Id of the fabric agent machine. */ biosId: string; /** * Discriminator property for FabricAgentModelCustomProperties. * Expected value is 'VMware'. */ instanceType: "VMware"; /** * Identity model. */ marsAuthenticationIdentity: outputs.datareplication.IdentityModelResponse; } /** * VMware migrate fabric model custom properties. */ interface VMwareMigrateFabricModelCustomPropertiesResponse { /** * Gets or sets the instance type. * Expected value is 'VMwareMigrate'. */ instanceType: "VMwareMigrate"; /** * Gets or sets the ARM Id of the migration solution. */ migrationSolutionId: string; /** * Gets or sets the ARM Id of the VMware site. */ vmwareSiteId: string; } /** * VMwareToAzStack disk input. */ interface VMwareToAzStackHCIDiskInputResponse { /** * Gets or sets the type of the virtual hard disk, vhd or vhdx. */ diskFileFormat: string; /** * Gets or sets the disk Id. */ diskId: string; /** * Gets or sets the disk size in GB. */ diskSizeGB: number; /** * Gets or sets a value indicating whether dynamic sizing is enabled on the virtual hard * disk. */ isDynamic?: boolean; /** * Gets or sets a value indicating whether disk is os disk. */ isOsDisk: boolean; /** * Gets or sets the target storage account ARM Id. */ storageContainerId?: string; } /** * VMwareToAzStackHCI NIC properties. */ interface VMwareToAzStackHCINicInputResponse { /** * Gets or sets the NIC label. */ label: string; /** * Gets or sets the network name. */ networkName: string; /** * Gets or sets the NIC Id. */ nicId: string; /** * Gets or sets the selection type of the NIC. */ selectionTypeForFailover: string; /** * Gets or sets the target network Id within AzStackHCI Cluster. */ targetNetworkId: string; /** * Gets or sets the target test network Id within AzStackHCI Cluster. */ testNetworkId: string; } /** * VMware To AzStackHCI Policy model custom properties. */ interface VMwareToAzStackHCIPolicyModelCustomPropertiesResponse { /** * Gets or sets the app consistent snapshot frequency (in minutes). */ appConsistentFrequencyInMinutes: number; /** * Gets or sets the crash consistent snapshot frequency (in minutes). */ crashConsistentFrequencyInMinutes: number; /** * Gets or sets the instance type. * Expected value is 'VMwareToAzStackHCI'. */ instanceType: "VMwareToAzStackHCI"; /** * Gets or sets the duration in minutes until which the recovery points need to be * stored. */ recoveryPointHistoryInMinutes: number; } /** * VMwareToAzStackHCI protected disk properties. */ interface VMwareToAzStackHCIProtectedDiskPropertiesResponse { /** * Gets or sets the disk capacity in bytes. */ capacityInBytes: number; /** * Gets or sets the disk type. */ diskType: string; /** * Gets or sets a value indicating whether dynamic sizing is enabled on the virtual hard * disk. */ isDynamic: boolean; /** * Gets or sets a value indicating whether the disk is the OS disk. */ isOsDisk: boolean; /** * Gets or sets the failover clone disk. */ migrateDiskName: string; /** * Gets or sets the seed disk name. */ seedDiskName: string; /** * Gets or sets the source disk Id. */ sourceDiskId: string; /** * Gets or sets the source disk Name. */ sourceDiskName: string; /** * Gets or sets the ARM Id of the storage container. */ storageContainerId: string; /** * Gets or sets the local path of the storage container. */ storageContainerLocalPath: string; /** * Gets or sets the test failover clone disk. */ testMigrateDiskName: string; } /** * VMware to AzStackHCI Protected item model custom properties. */ interface VMwareToAzStackHCIProtectedItemModelCustomPropertiesResponse { /** * Gets or sets the location of the protected item. */ activeLocation: string; /** * Gets or sets the location of Azure Arc HCI custom location resource. */ customLocationRegion: string; /** * Gets or sets the list of disks to replicate. */ disksToInclude: outputs.datareplication.VMwareToAzStackHCIDiskInputResponse[]; /** * Protected item dynamic memory config. */ dynamicMemoryConfig?: outputs.datareplication.ProtectedItemDynamicMemoryConfigResponse; /** * Gets or sets the ARM Id of the discovered machine. */ fabricDiscoveryMachineId: string; /** * Gets or sets the recovery point Id to which the VM was failed over. */ failoverRecoveryPointId: string; /** * Gets or sets the firmware type. */ firmwareType: string; /** * Gets or sets the hypervisor generation of the virtual machine possible values are 1,2. */ hyperVGeneration: string; /** * Gets or sets the initial replication progress percentage. This is calculated based on * total bytes processed for all disks in the source VM. */ initialReplicationProgressPercentage: number; /** * Gets or sets the instance type. * Expected value is 'VMwareToAzStackHCI'. */ instanceType: "VMwareToAzStackHCI"; /** * Gets or sets a value indicating whether memory is dynamical. */ isDynamicRam?: boolean; /** * Gets or sets the last recovery point Id. */ lastRecoveryPointId: string; /** * Gets or sets the last recovery point received time. */ lastRecoveryPointReceived: string; /** * Gets or sets the latest timestamp that replication status is updated. */ lastReplicationUpdateTime: string; /** * Gets or sets the migration progress percentage. */ migrationProgressPercentage: number; /** * Gets or sets the list of VM NIC to replicate. */ nicsToInclude: outputs.datareplication.VMwareToAzStackHCINicInputResponse[]; /** * Gets or sets the name of the OS. */ osName: string; /** * Gets or sets the type of the OS. */ osType: string; /** * Gets or sets a value indicating whether auto resync is to be done. */ performAutoResync?: boolean; /** * Gets or sets the list of protected disks. */ protectedDisks: outputs.datareplication.VMwareToAzStackHCIProtectedDiskPropertiesResponse[]; /** * Gets or sets the VM NIC details. */ protectedNics: outputs.datareplication.VMwareToAzStackHCIProtectedNicPropertiesResponse[]; /** * Gets or sets the resume progress percentage. */ resumeProgressPercentage: number; /** * Gets or sets the resume retry count. */ resumeRetryCount: number; /** * Gets or sets the resync progress percentage. This is calculated based on total bytes * processed for all disks in the source VM. */ resyncProgressPercentage: number; /** * Gets or sets a value indicating whether resync is required. */ resyncRequired: boolean; /** * Gets or sets the resync retry count. */ resyncRetryCount: number; /** * Gets or sets the resync state. */ resyncState: string; /** * Gets or sets the run as account Id. */ runAsAccountId: string; /** * Gets or sets the source appliance name. */ sourceApplianceName: string; /** * Gets or sets the source VM CPU cores. */ sourceCpuCores: number; /** * Gets or sets the source DRA name. */ sourceDraName: string; /** * Gets or sets the source VM ram memory size in megabytes. */ sourceMemoryInMegaBytes: number; /** * Gets or sets the source VM display name. */ sourceVmName: string; /** * Gets or sets the target storage container ARM Id. */ storageContainerId: string; /** * Gets or sets the target appliance name. */ targetApplianceName: string; /** * Gets or sets the Target Arc Cluster Custom Location ARM Id. */ targetArcClusterCustomLocationId: string; /** * Gets or sets the Target AzStackHCI cluster name. */ targetAzStackHciClusterName: string; /** * Gets or sets the target CPU cores. */ targetCpuCores?: number; /** * Gets or sets the target DRA name. */ targetDraName: string; /** * Gets or sets the Target HCI Cluster ARM Id. */ targetHciClusterId: string; /** * Gets or sets the target location. */ targetLocation: string; /** * Gets or sets the target memory in mega-bytes. */ targetMemoryInMegaBytes?: number; /** * Gets or sets the target network Id within AzStackHCI Cluster. */ targetNetworkId?: string; /** * Gets or sets the target resource group ARM Id. */ targetResourceGroupId: string; /** * Gets or sets the BIOS Id of the target AzStackHCI VM. */ targetVmBiosId: string; /** * Gets or sets the target VM display name. */ targetVmName?: string; /** * Gets or sets the target test network Id within AzStackHCI Cluster. */ testNetworkId?: string; } /** * VMwareToAzStackHCI NIC properties. */ interface VMwareToAzStackHCIProtectedNicPropertiesResponse { /** * Gets or sets a value indicating whether this is the primary NIC. */ isPrimaryNic?: boolean; /** * Gets or sets the NIC label. */ label: string; /** * Gets or sets the NIC mac address. */ macAddress: string; /** * Gets or sets the network name. */ networkName: string; /** * Gets or sets the NIC Id. */ nicId: string; /** * Gets or sets the selection type of the NIC. */ selectionTypeForFailover: string; /** * Gets or sets the target network Id within AzStackHCI Cluster. */ targetNetworkId: string; /** * Gets or sets the target test network Id within AzStackHCI Cluster. */ testNetworkId: string; } /** * VMware to AzStackHCI Replication extension model custom properties. */ interface VMwareToAzStackHCIReplicationExtensionModelCustomPropertiesResponse { /** * Gets or sets the Uri of ASR. */ asrServiceUri: string; /** * Gets or sets the ARM Id of the target AzStackHCI fabric. */ azStackHciFabricArmId: string; /** * Gets or sets the ARM Id of the AzStackHCI site. */ azStackHciSiteId: string; /** * Gets or sets the Uri of Gateway. */ gatewayServiceUri: string; /** * Gets or sets the instance type. * Expected value is 'VMwareToAzStackHCI'. */ instanceType: "VMwareToAzStackHCI"; /** * Gets or sets the Uri of Rcm. */ rcmServiceUri: string; /** * Gets or sets the resource group. */ resourceGroup: string; /** * Gets or sets the resource location. */ resourceLocation: string; /** * Gets or sets the gateway service Id of source. */ sourceGatewayServiceId: string; /** * Gets or sets the source storage container name. */ sourceStorageContainerName: string; /** * Gets or sets the storage account Id. */ storageAccountId?: string; /** * Gets or sets the Sas Secret of storage account. */ storageAccountSasSecretName?: string; /** * Gets or sets the subscription. */ subscriptionId: string; /** * Gets or sets the gateway service Id of target. */ targetGatewayServiceId: string; /** * Gets or sets the target storage container name. */ targetStorageContainerName: string; /** * Gets or sets the ARM Id of the source VMware fabric. */ vmwareFabricArmId: string; /** * Gets or sets the ARM Id of the VMware site. */ vmwareSiteId: string; } /** * Vault properties. */ interface VaultModelPropertiesResponse { /** * Gets or sets the provisioning state of the vault. */ provisioningState: string; /** * Gets or sets the service resource Id. */ serviceResourceId: string; /** * Gets or sets the type of vault. */ vaultType?: string; } interface VaultModelResponseSystemData { /** * Gets or sets the timestamp of resource creation (UTC). */ createdAt?: string; /** * Gets or sets identity that created the resource. */ createdBy?: string; /** * Gets or sets the type of identity that created the resource: user, application, * managedIdentity. */ createdByType?: string; /** * Gets or sets the timestamp of resource last modification (UTC). */ lastModifiedAt?: string; /** * Gets or sets the identity that last modified the resource. */ lastModifiedBy?: string; /** * Gets or sets the type of identity that last modified the resource: user, application, * managedIdentity. */ lastModifiedByType?: string; } } export declare namespace datashare { /** * Identity of resource */ interface IdentityResponse { /** * service principal Id */ principalId: string; /** * Tenant Id */ tenantId: string; /** * Identity Type */ type?: string; } /** * A type of synchronization setting based on schedule */ interface ScheduledSourceSynchronizationSettingResponse { /** * Kind of synchronization setting on share. * Expected value is 'ScheduleBased'. */ kind: "ScheduleBased"; /** * Recurrence Interval */ recurrenceInterval?: string; /** * Synchronization time */ synchronizationTime?: string; } /** * A ShareSubscriptionSynchronization data transfer object. */ interface ShareSubscriptionSynchronizationResponse { /** * Synchronization duration */ durationMs: number; /** * End time of synchronization */ endTime: string; /** * message of Synchronization */ message: string; /** * start time of synchronization */ startTime: string; /** * Raw Status */ status: string; /** * Synchronization id */ synchronizationId: string; /** * Synchronization Mode */ synchronizationMode: string; } /** * A ShareSynchronization data transfer object. */ interface ShareSynchronizationResponse { /** * Email of the user who created the synchronization */ consumerEmail?: string; /** * Name of the user who created the synchronization */ consumerName?: string; /** * Tenant name of the consumer who created the synchronization */ consumerTenantName?: string; /** * synchronization duration */ durationMs?: number; /** * End time of synchronization */ endTime?: string; /** * message of synchronization */ message?: string; /** * start time of synchronization */ startTime?: string; /** * Raw Status */ status?: string; /** * Synchronization id */ synchronizationId?: string; /** * Synchronization mode */ synchronizationMode: string; } /** * Synchronization details at data set level */ interface SynchronizationDetailsResponse { /** * Id of data set */ dataSetId: string; /** * Type of the data set */ dataSetType: string; /** * Duration of data set level copy */ durationMs: number; /** * End time of data set level copy */ endTime: string; /** * The number of files read from the source data set */ filesRead: number; /** * The number of files written into the sink data set */ filesWritten: number; /** * Error message if any */ message: string; /** * Name of the data set */ name: string; /** * The number of files copied into the sink data set */ rowsCopied: number; /** * The number of rows read from the source data set. */ rowsRead: number; /** * The size of the data read from the source data set in bytes */ sizeRead: number; /** * The size of the data written into the sink data set in bytes */ sizeWritten: number; /** * Start time of data set level copy */ startTime: string; /** * Raw Status */ status: string; /** * The vCore units consumed for the data set synchronization */ vCore: number; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The type of identity that last modified the resource. */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Table level sharing properties dto for kusto data set properties */ interface TableLevelSharingPropertiesResponse { /** * External tables to be excluded in the data set */ externalTablesToExclude?: string[]; /** * External tables to be included in the data set */ externalTablesToInclude?: string[]; /** * Materialized views to be excluded in the data set */ materializedViewsToExclude?: string[]; /** * Materialized views to be included in the data set */ materializedViewsToInclude?: string[]; /** * Tables to be excluded in the data set */ tablesToExclude?: string[]; /** * Tables to be included in the data set */ tablesToInclude?: string[]; } } export declare namespace dbformariadb { interface PrivateEndpointPropertyResponse { /** * Resource id of the private endpoint. */ id?: string; } interface PrivateLinkServiceConnectionStatePropertyResponse { /** * The actions required for private link service connection. */ actionsRequired: string; /** * The private link service connection description. */ description: string; /** * The private link service connection status. */ status: string; } /** * Properties of a private endpoint connection. */ interface ServerPrivateEndpointConnectionPropertiesResponse { /** * Private endpoint which the connection belongs to. */ privateEndpoint?: outputs.dbformariadb.PrivateEndpointPropertyResponse; /** * Connection state of the private endpoint connection. */ privateLinkServiceConnectionState?: outputs.dbformariadb.ServerPrivateLinkServiceConnectionStatePropertyResponse; /** * State of the private endpoint connection. */ provisioningState: string; } /** * A private endpoint connection under a server */ interface ServerPrivateEndpointConnectionResponse { /** * Resource Id of the private endpoint connection. */ id: string; /** * Private endpoint connection properties */ properties: outputs.dbformariadb.ServerPrivateEndpointConnectionPropertiesResponse; } interface ServerPrivateLinkServiceConnectionStatePropertyResponse { /** * The actions required for private link service connection. */ actionsRequired: string; /** * The private link service connection description. */ description: string; /** * The private link service connection status. */ status: string; } /** * Billing information related properties of a server. */ interface SkuResponse { /** * The scale up/out capacity, representing server's compute units. */ capacity?: number; /** * The family of hardware. */ family?: string; /** * The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8. */ name: string; /** * The size code, to be interpreted by resource as appropriate. */ size?: string; /** * The tier of the particular SKU, e.g. Basic. */ tier?: string; } /** * Storage Profile properties of a server */ interface StorageProfileResponse { /** * Backup retention days for the server. */ backupRetentionDays?: number; /** * Enable Geo-redundant or not for server backup. */ geoRedundantBackup?: string; /** * Enable Storage Auto Grow. */ storageAutogrow?: string; /** * Max storage allowed for a server. */ storageMB?: number; } } export declare namespace dbformysql { /** * Storage Profile properties of a server */ interface BackupResponse { /** * Backup interval hours for the server. */ backupIntervalHours?: number; /** * Backup retention days for the server. */ backupRetentionDays?: number; /** * Earliest restore point creation time (ISO8601 format) */ earliestRestoreDate: string; /** * Whether or not geo redundant backup is enabled. */ geoRedundantBackup?: string; } /** * backupResponseProvideDefaults sets the appropriate defaults for BackupResponse */ function backupResponseProvideDefaults(val: BackupResponse): BackupResponse; /** * The date encryption for cmk. */ interface DataEncryptionResponse { /** * Geo backup key uri as key vault can't cross region, need cmk in same region as geo backup */ geoBackupKeyURI?: string; /** * Geo backup user identity resource id as identity can't cross region, need identity in same region as geo backup */ geoBackupUserAssignedIdentityId?: string; /** * Primary key uri */ primaryKeyURI?: string; /** * Primary user identity resource id */ primaryUserAssignedIdentityId?: string; /** * The key type, AzureKeyVault for enable cmk, SystemManaged for disable cmk. */ type?: string; } /** * High availability properties of a server */ interface HighAvailabilityResponse { /** * High availability mode for a server. */ mode?: string; /** * Availability zone of the standby server. */ standbyAvailabilityZone?: string; /** * The state of server high availability. */ state: string; } /** * Import source related properties. */ interface ImportSourcePropertiesResponse { /** * Relative path of data directory in storage. */ dataDirPath?: string; /** * Storage type of import source. */ storageType?: string; /** * Uri of the import source storage. */ storageUrl?: string; } /** * Maintenance window of a server. */ interface MaintenanceWindowResponse { /** * indicates whether custom window is enabled or disabled */ customWindow?: string; /** * day of week for maintenance window */ dayOfWeek?: number; /** * start hour for maintenance window */ startHour?: number; /** * start minute for maintenance window */ startMinute?: number; } /** * Properties to configure Identity for Bring your Own Keys */ interface MySQLServerIdentityResponse { /** * ObjectId from the KeyVault */ principalId: string; /** * TenantId from the KeyVault */ tenantId: string; /** * Type of managed service identity. */ type?: string; /** * Metadata of user assigned identity. */ userAssignedIdentities?: { [key: string]: outputs.dbformysql.UserAssignedIdentityResponse; }; } /** * Billing information related properties of a server. */ interface MySQLServerSkuResponse { /** * The name of the sku, e.g. Standard_D32s_v3. */ name: string; /** * The tier of the particular SKU, e.g. GeneralPurpose. */ tier: string; } /** * Network related properties of a server */ interface NetworkResponse { /** * Delegated subnet resource id used to setup vnet for a server. */ delegatedSubnetResourceId?: string; /** * Private DNS zone resource id. */ privateDnsZoneResourceId?: string; /** * Whether or not public network access is allowed for this server. Value is 'Disabled' when server has VNet integration. */ publicNetworkAccess?: string; } /** * The private endpoint connection resource. */ interface PrivateEndpointConnectionResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint resource. */ privateEndpoint?: outputs.dbformysql.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.dbformysql.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.dbformysql.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } interface PrivateEndpointPropertyResponse { /** * Resource id of the private endpoint. */ id?: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Azure Active Directory identity configuration for a resource. */ interface ResourceIdentityResponse { /** * The Azure Active Directory principal id. */ principalId: string; /** * The Azure Active Directory tenant id. */ tenantId: string; /** * The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. */ type?: string; } /** * Properties of a private endpoint connection. */ interface ServerPrivateEndpointConnectionPropertiesResponse { /** * Private endpoint which the connection belongs to. */ privateEndpoint?: outputs.dbformysql.PrivateEndpointPropertyResponse; /** * Connection state of the private endpoint connection. */ privateLinkServiceConnectionState?: outputs.dbformysql.ServerPrivateLinkServiceConnectionStatePropertyResponse; /** * State of the private endpoint connection. */ provisioningState: string; } /** * A private endpoint connection under a server */ interface ServerPrivateEndpointConnectionResponse { /** * Resource Id of the private endpoint connection. */ id: string; /** * Private endpoint connection properties */ properties: outputs.dbformysql.ServerPrivateEndpointConnectionPropertiesResponse; } interface ServerPrivateLinkServiceConnectionStatePropertyResponse { /** * The actions required for private link service connection. */ actionsRequired: string; /** * The private link service connection description. */ description: string; /** * The private link service connection status. */ status: string; } /** * Billing information related properties of a server. */ interface SkuResponse { /** * The scale up/out capacity, representing server's compute units. */ capacity?: number; /** * The family of hardware. */ family?: string; /** * The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8. */ name: string; /** * The size code, to be interpreted by resource as appropriate. */ size?: string; /** * The tier of the particular SKU, e.g. Basic. */ tier?: string; } /** * Storage Profile properties of a server */ interface StorageProfileResponse { /** * Backup retention days for the server. */ backupRetentionDays?: number; /** * Enable Geo-redundant or not for server backup. */ geoRedundantBackup?: string; /** * Enable Storage Auto Grow. */ storageAutogrow?: string; /** * Max storage allowed for a server. */ storageMB?: number; } /** * Storage Profile properties of a server */ interface StorageResponse { /** * Enable Storage Auto Grow or not. */ autoGrow?: string; /** * Enable IO Auto Scaling or not. */ autoIoScaling?: string; /** * Storage IOPS for a server. */ iops?: number; /** * Enable Log On Disk or not. */ logOnDisk?: string; /** * The redundant type of the server storage. The parameter is used for server creation. */ storageRedundancy?: string; /** * Max storage size allowed for a server. */ storageSizeGB?: number; /** * The sku name of the server storage. */ storageSku: string; } /** * storageResponseProvideDefaults sets the appropriate defaults for StorageResponse */ function storageResponseProvideDefaults(val: StorageResponse): StorageResponse; /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Metadata of user assigned identity. */ interface UserAssignedIdentityResponse { /** * Client Id of user assigned identity */ clientId: string; /** * Principal Id of user assigned identity */ principalId: string; } } export declare namespace dbforpostgresql { /** * Authentication configuration properties of a server. */ interface AuthConfigResponse { /** * Indicates if the server supports Microsoft Entra authentication. */ activeDirectoryAuth?: string; /** * Indicates if the server supports password based authentication. */ passwordAuth?: string; /** * Identifier of the tenant of the delegated resource. */ tenantId?: string; } /** * authConfigResponseProvideDefaults sets the appropriate defaults for AuthConfigResponse */ function authConfigResponseProvideDefaults(val: AuthConfigResponse): AuthConfigResponse; /** * Backup properties of a server. */ interface BackupResponse { /** * Backup retention days for the server. */ backupRetentionDays?: number; /** * Earliest restore point time (ISO8601 format) for a server. */ earliestRestoreDate: string; /** * Indicates if the server is configured to create geographically redundant backups. */ geoRedundantBackup?: string; } /** * backupResponseProvideDefaults sets the appropriate defaults for BackupResponse */ function backupResponseProvideDefaults(val: BackupResponse): BackupResponse; /** * Cluster properties of a server. */ interface ClusterResponse { /** * Number of nodes assigned to the elastic cluster. */ clusterSize?: number; /** * Default database name for the elastic cluster. */ defaultDatabaseName?: string; } /** * clusterResponseProvideDefaults sets the appropriate defaults for ClusterResponse */ function clusterResponseProvideDefaults(val: ClusterResponse): ClusterResponse; /** * Data encryption properties of a server. */ interface DataEncryptionResponse { /** * Status of key used by a server configured with data encryption based on customer managed key, to encrypt the geographically redundant storage associated to the server when it is configured to support geographically redundant backups. */ geoBackupEncryptionKeyStatus: string; /** * Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. */ geoBackupKeyURI?: string; /** * Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the geographically redundant storage associated to a server that is configured to support geographically redundant backups. */ geoBackupUserAssignedIdentityId?: string; /** * Status of key used by a server configured with data encryption based on customer managed key, to encrypt the primary storage associated to the server. */ primaryEncryptionKeyStatus: string; /** * URI of the key in Azure Key Vault used for data encryption of the primary storage associated to a server. */ primaryKeyURI?: string; /** * Identifier of the user assigned managed identity used to access the key in Azure Key Vault for data encryption of the primary storage associated to a server. */ primaryUserAssignedIdentityId?: string; /** * Data encryption type used by a server. */ type?: string; } /** * Migration state of a database. */ interface DatabaseMigrationStateResponse { /** * Change Data Capture applied changes counter. */ appliedChanges?: number; /** * Change Data Capture delete counter. */ cdcDeleteCounter?: number; /** * Change Data Capture insert counter. */ cdcInsertCounter?: number; /** * Change Data Capture update counter. */ cdcUpdateCounter?: number; /** * Name of database. */ databaseName?: string; /** * End time of a migration state. */ endedOn?: string; /** * Number of tables loaded during the migration of a database. */ fullLoadCompletedTables?: number; /** * Number of tables encountering errors during the migration of a database. */ fullLoadErroredTables?: number; /** * Number of tables loading during the migration of a database. */ fullLoadLoadingTables?: number; /** * Number of tables queued for the migration of a database. */ fullLoadQueuedTables?: number; /** * Change Data Capture incoming changes counter. */ incomingChanges?: number; /** * Lag in seconds between source and target during online phase. */ latency?: number; /** * Error message, if any, for the migration state. */ message?: string; /** * Migration operation of a database. */ migrationOperation?: string; /** * Migration state of a database. */ migrationState?: string; /** * Start time of a migration state. */ startedOn?: string; } /** * Validation status summary for a database. */ interface DbLevelValidationStatusResponse { /** * Name of database. */ databaseName?: string; /** * End time of a database level validation. */ endedOn?: string; /** * Start time of a database level validation. */ startedOn?: string; /** * Summary of database level validations. */ summary?: outputs.dbforpostgresql.ValidationSummaryItemResponse[]; } /** * Database server metadata. */ interface DbServerMetadataResponse { /** * Location of database server. */ location: string; /** * Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. */ sku?: outputs.dbforpostgresql.ServerSkuResponse; /** * Storage size (in MB) for database server. */ storageMb?: number; /** * Major version of PostgreSQL database engine. */ version?: string; } /** * High availability properties of a server. */ interface HighAvailabilityResponse { /** * High availability mode for a server. */ mode?: string; /** * Availability zone associated to the standby server created when high availability is set to SameZone or ZoneRedundant. */ standbyAvailabilityZone?: string; /** * Possible states of the standby server created when high availability is set to SameZone or ZoneRedundant. */ state: string; } /** * highAvailabilityResponseProvideDefaults sets the appropriate defaults for HighAvailabilityResponse */ function highAvailabilityResponseProvideDefaults(val: HighAvailabilityResponse): HighAvailabilityResponse; /** * Describes the identity of the cluster. */ interface IdentityPropertiesResponse { type?: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.dbforpostgresql.UserAssignedIdentityServerGroupClusterResponse; }; } /** * Maintenance window properties of a server. */ interface MaintenanceWindowResponse { /** * Indicates whether custom window is enabled or disabled. */ customWindow?: string; /** * Day of the week to be used for maintenance window. */ dayOfWeek?: number; /** * Start hour to be used for maintenance window. */ startHour?: number; /** * Start minute to be used for maintenance window. */ startMinute?: number; } /** * maintenanceWindowResponseProvideDefaults sets the appropriate defaults for MaintenanceWindowResponse */ function maintenanceWindowResponseProvideDefaults(val: MaintenanceWindowResponse): MaintenanceWindowResponse; /** * State of migration. */ interface MigrationStatusResponse { /** * Current migration sub state details. */ currentSubStateDetails: outputs.dbforpostgresql.MigrationSubstateDetailsResponse; /** * Error message, if any, for the migration state. */ error: string; /** * State of migration. */ state: string; } /** * Details of migration substate. */ interface MigrationSubstateDetailsResponse { /** * Substate of migration. */ currentSubState: string; dbDetails?: { [key: string]: outputs.dbforpostgresql.DatabaseMigrationStateResponse; }; /** * Details for the validation for migration. */ validationDetails?: outputs.dbforpostgresql.ValidationDetailsResponse; } /** * Network properties of a server. */ interface NetworkResponse { /** * Resource identifier of the delegated subnet. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. */ delegatedSubnetResourceId?: string; /** * Identifier of the private DNS zone. Required during creation of a new server, in case you want the server to be integrated into your own virtual network. For an update operation, you only have to provide this property if you want to change the value assigned for the private DNS zone. */ privateDnsZoneArmResourceId?: string; /** * Indicates if public network access is enabled or not. This is only supported for servers that are not integrated into a virtual network which is owned and provided by customer when server is deployed. */ publicNetworkAccess?: string; } /** * The private endpoint connection resource. */ interface PrivateEndpointConnectionResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint resource. */ privateEndpoint?: outputs.dbforpostgresql.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.dbforpostgresql.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.dbforpostgresql.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } interface PrivateEndpointPropertyResponse { /** * Resource id of the private endpoint. */ id?: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Replica properties of a server. */ interface ReplicaResponse { /** * Maximum number of read replicas allowed for a server. */ capacity: number; /** * Indicates the replication state of a read replica. This property is returned only when the target server is a read replica. Possible values are Active, Broken, Catchup, Provisioning, Reconfiguring, and Updating */ replicationState: string; /** * Role of the server in a replication set. */ role?: string; } /** * Azure Active Directory identity configuration for a resource. */ interface ResourceIdentityResponse { /** * The Azure Active Directory principal id. */ principalId: string; /** * The Azure Active Directory tenant id. */ tenantId: string; /** * The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. */ type?: string; } /** * Authentication configuration of a cluster. */ interface ServerGroupClusterAuthConfigResponse { activeDirectoryAuth?: string; passwordAuth?: string; } /** * The data encryption properties of a cluster. */ interface ServerGroupClusterDataEncryptionResponse { /** * URI for the key in keyvault for data encryption of the primary server. */ primaryKeyUri?: string; /** * Resource Id for the User assigned identity to be used for data encryption of the primary server. */ primaryUserAssignedIdentityId?: string; type?: string; } /** * Schedule settings for regular cluster updates. */ interface ServerGroupClusterMaintenanceWindowResponse { /** * Indicates whether custom maintenance window is enabled or not. */ customWindow?: string; /** * Preferred day of the week for maintenance window. */ dayOfWeek?: number; /** * Start hour within preferred day of the week for maintenance window. */ startHour?: number; /** * Start minute within the start hour for maintenance window. */ startMinute?: number; } /** * The name object for a server. */ interface ServerNameItemResponse { /** * The fully qualified domain name of a server. */ fullyQualifiedDomainName: string; /** * The name of a server. */ name?: string; } /** * Properties of a private endpoint connection. */ interface ServerPrivateEndpointConnectionPropertiesResponse { /** * Private endpoint which the connection belongs to. */ privateEndpoint?: outputs.dbforpostgresql.PrivateEndpointPropertyResponse; /** * Connection state of the private endpoint connection. */ privateLinkServiceConnectionState?: outputs.dbforpostgresql.ServerPrivateLinkServiceConnectionStatePropertyResponse; /** * State of the private endpoint connection. */ provisioningState: string; } /** * A private endpoint connection under a server */ interface ServerPrivateEndpointConnectionResponse { /** * Resource ID of the Private Endpoint Connection. */ id: string; /** * Private endpoint connection properties */ properties: outputs.dbforpostgresql.ServerPrivateEndpointConnectionPropertiesResponse; } interface ServerPrivateLinkServiceConnectionStatePropertyResponse { /** * The actions required for private link service connection. */ actionsRequired: string; /** * The private link service connection description. */ description: string; /** * The private link service connection status. */ status: string; } /** * Compute information of a server. */ interface ServerSkuResponse { /** * Compute tier and size of the database server. This object is empty for an Azure Database for PostgreSQL single server. */ name?: string; /** * Tier of the compute assigned to a server. */ tier?: string; } /** * A private endpoint connection. */ interface SimplePrivateEndpointConnectionResponse { /** * Group ids of the private endpoint connection. */ groupIds?: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * Private endpoint which the connection belongs to. */ privateEndpoint?: outputs.dbforpostgresql.PrivateEndpointPropertyResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState?: outputs.dbforpostgresql.PrivateLinkServiceConnectionStateResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.dbforpostgresql.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Billing information related properties of a server. */ interface SingleServerSkuResponse { /** * The scale up/out capacity, representing server's compute units. */ capacity?: number; /** * The family of hardware. */ family?: string; /** * The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8. */ name: string; /** * The size code, to be interpreted by resource as appropriate. */ size?: string; /** * The tier of the particular SKU, e.g. Basic. */ tier?: string; } /** * Compute information of a server. */ interface SkuResponse { /** * Name by which is known a given compute size assigned to a server. */ name: string; /** * Tier of the compute assigned to a server. */ tier: string; } /** * Storage Profile properties of a server */ interface StorageProfileResponse { /** * Backup retention days for the server. */ backupRetentionDays?: number; /** * Enable Geo-redundant or not for server backup. */ geoRedundantBackup?: string; /** * Enable Storage Auto Grow. */ storageAutogrow?: string; /** * Max storage allowed for a server. */ storageMB?: number; } /** * Storage properties of a server. */ interface StorageResponse { /** * Flag to enable or disable the automatic growth of storage size of a server when available space is nearing zero and conditions allow for automatically growing storage size. */ autoGrow?: string; /** * Maximum IOPS supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. */ iops?: number; /** * Size of storage assigned to a server. */ storageSizeGB?: number; /** * Maximum throughput supported for storage. Required when type of storage is PremiumV2_LRS or UltraSSD_LRS. */ throughput?: number; /** * Storage tier of a server. */ tier?: string; /** * Type of storage assigned to a server. Allowed values are Premium_LRS, PremiumV2_LRS, or UltraSSD_LRS. If not specified, it defaults to Premium_LRS. */ type?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Identities associated with a server. */ interface UserAssignedIdentityResponse { /** * Identifier of the object of the service principal associated to the user assigned managed identity. */ principalId?: string; /** * Identifier of the tenant of a server. */ tenantId: string; /** * Types of identities associated with a server. */ type: string; /** * Map of user assigned managed identities. */ userAssignedIdentities?: { [key: string]: outputs.dbforpostgresql.UserIdentityResponse; }; } /** * User assigned identity properties */ interface UserAssignedIdentityServerGroupClusterResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * User assigned managed identity associated with a server. */ interface UserIdentityResponse { /** * Identifier of the client of the service principal associated to the user assigned managed identity. */ clientId?: string; /** * Identifier of the object of the service principal associated to the user assigned managed identity. */ principalId?: string; } /** * Details for the validation for migration. */ interface ValidationDetailsResponse { /** * Details of server level validations. */ dbLevelValidationDetails?: outputs.dbforpostgresql.DbLevelValidationStatusResponse[]; /** * Details of server level validations. */ serverLevelValidationDetails?: outputs.dbforpostgresql.ValidationSummaryItemResponse[]; /** * Validation status for migration. */ status?: string; /** * End time (UTC) for validation. */ validationEndTimeInUtc?: string; /** * Start time (UTC) for validation. */ validationStartTimeInUtc?: string; } /** * Validation message object. */ interface ValidationMessageResponse { /** * Validation message string. */ message?: string; /** * Severity of validation message. */ state?: string; } /** * Validation summary object. */ interface ValidationSummaryItemResponse { /** * Validation messages. */ messages?: outputs.dbforpostgresql.ValidationMessageResponse[]; /** * Validation status for migration. */ state?: string; /** * Validation type. */ type?: string; } } export declare namespace delegatednetwork { /** * controller details */ interface ControllerDetailsResponse { /** * controller arm resource id */ id?: string; } interface OrchestratorIdentityResponse { /** * The principal id of the system assigned identity which is used by orchestrator. */ principalId: string; /** * The tenant id of the system assigned identity which is used by orchestrator. */ tenantId: string; /** * The type of identity used for orchestrator cluster. Type 'SystemAssigned' will use an implicitly created identity orchestrator clusters */ type?: string; } /** * Properties of orchestrator */ interface SubnetDetailsResponse { /** * subnet arm resource id */ id?: string; } } export declare namespace dependencymap { /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.dependencymap.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.dependencymap.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * Model representing properties returned upon successful completion of the export dependencies asynchronous operation. */ interface GetDependencyViewForAllMachinesResultPropertiesResponse { /** * The SAS URI of the blob containing the layout file for the multi-server view. */ layoutFileSasUrl: string; } /** * OffAzure discovery source resource properties */ interface OffAzureDiscoverySourceResourcePropertiesResponse { /** * Provisioning state of Discovery Source resource. */ provisioningState: string; /** * Source ArmId of Discovery Source resource */ sourceId: string; /** * Source type of the discoverySource * Expected value is 'OffAzure'. */ sourceType: "OffAzure"; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace desktopvirtualization { /** * The session host configuration for updating agent, monitoring agent, and stack component. */ interface AgentUpdatePropertiesResponse { /** * Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true. */ maintenanceWindowTimeZone?: string; /** * List of maintenance windows. Maintenance windows are 2 hours long. */ maintenanceWindows?: outputs.desktopvirtualization.MaintenanceWindowPropertiesResponse[]; /** * The type of maintenance for session host components. */ type?: string; /** * Whether to use localTime of the virtual machine. */ useSessionHostLocalTime?: boolean; } /** * Schema for Import Package Information properties. */ interface AppAttachPackageInfoPropertiesResponse { /** * Date certificate expires, found in the appxmanifest.xml. */ certificateExpiry?: string; /** * Certificate name found in the appxmanifest.xml. */ certificateName?: string; /** * User friendly Name to be displayed in the portal. */ displayName?: string; /** * VHD/CIM image path on Network Share. */ imagePath?: string; /** * Make this version of the package the active one across the hostpool. */ isActive?: boolean; /** * Is package timestamped so it can ignore the certificate expiry date */ isPackageTimestamped?: string; /** * Specifies how to register Package in feed. */ isRegularRegistration?: boolean; /** * Date Package was last updated, found in the appxmanifest.xml. */ lastUpdated?: string; /** * Alias of App Attach Package. Assigned at import time */ packageAlias?: string; /** * List of package applications. */ packageApplications?: outputs.desktopvirtualization.MsixPackageApplicationsResponse[]; /** * List of package dependencies. */ packageDependencies?: outputs.desktopvirtualization.MsixPackageDependenciesResponse[]; /** * Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. */ packageFamilyName?: string; /** * Package Full Name from appxmanifest.xml. */ packageFullName?: string; /** * Package Name from appxmanifest.xml. */ packageName?: string; /** * Relative Path to the package inside the image. */ packageRelativePath?: string; /** * Package version found in the appxmanifest.xml. */ version?: string; } /** * Schema for App Attach Package properties. */ interface AppAttachPackagePropertiesResponse { /** * Parameter indicating how the health check should behave if this package fails staging */ failHealthCheckOnStagingFailure?: string; /** * List of Hostpool resource Ids. */ hostPoolReferences?: string[]; /** * Detailed properties for App Attach Package */ image?: outputs.desktopvirtualization.AppAttachPackageInfoPropertiesResponse; /** * URL path to certificate name located in keyVault */ keyVaultURL?: string; /** * The provisioning state of the App Attach Package. */ provisioningState: string; } /** * Maintenance window starting hour and day of week. */ interface MaintenanceWindowPropertiesResponse { /** * Day of the week. */ dayOfWeek?: string; /** * The update start hour of the day. (0 - 23) */ hour?: number; } /** * Schema for MSIX Package Application properties. */ interface MsixPackageApplicationsResponse { /** * Package Application Id, found in appxmanifest.xml. */ appId?: string; /** * Used to activate Package Application. Consists of Package Name and ApplicationID. Found in appxmanifest.xml. */ appUserModelID?: string; /** * Description of Package Application. */ description?: string; /** * User friendly name. */ friendlyName?: string; /** * User friendly name. */ iconImageName?: string; /** * the icon a 64 bit string as a byte array. */ rawIcon?: string; /** * the icon a 64 bit string as a byte array. */ rawPng?: string; } /** * Schema for MSIX Package Dependencies properties. */ interface MsixPackageDependenciesResponse { /** * Name of package dependency. */ dependencyName?: string; /** * Dependency version required. */ minVersion?: string; /** * Name of dependency publisher. */ publisher?: string; } /** * The private endpoint connection resource. */ interface PrivateEndpointConnectionResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint resource. */ privateEndpoint?: outputs.desktopvirtualization.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.desktopvirtualization.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.desktopvirtualization.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Represents a RegistrationInfo definition. */ interface RegistrationInfoResponse { /** * Expiration time of registration token. */ expirationTime?: string; /** * The type of resetting the token. */ registrationTokenOperation?: string; /** * The registration token base64 encoded string. */ token?: string; } /** * Represents a Minimal set of properties for RegistrationToken definition. */ interface RegistrationTokenMinimalResponse { /** * Expiration time of registration token. */ expirationTime?: string; /** * The registration token base64 encoded string. */ token?: string; } interface ResourceModelWithAllowedPropertySetResponseIdentity { /** * The principal ID of resource identity. The value must be an UUID. */ principalId: string; /** * The tenant ID of resource. The value must be an UUID. */ tenantId: string; /** * The identity type. */ type?: string; } interface ResourceModelWithAllowedPropertySetResponsePlan { /** * A user defined name of the 3rd Party Artifact that is being procured. */ name: string; /** * The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. */ product: string; /** * A publisher provided promotion code as provisioned in Data Market for the said product/artifact. */ promotionCode?: string; /** * The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic */ publisher: string; /** * The version of the desired product/artifact. */ version?: string; } interface ResourceModelWithAllowedPropertySetResponseSku { /** * If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. */ capacity?: number; /** * If the service has different generations of hardware, for the same SKU, then that can be captured here. */ family?: string; /** * The name of the SKU. E.g. P3. It is typically a letter+number code */ name: string; /** * The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. */ size?: string; /** * This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. */ tier?: string; } /** * Scaling plan reference to hostpool. */ interface ScalingHostPoolReferenceResponse { /** * Arm path of referenced hostpool. */ hostPoolArmPath?: string; /** * Is the scaling plan enabled for this hostpool. */ scalingPlanEnabled?: boolean; } /** * A ScalingPlanPooledSchedule. */ interface ScalingScheduleResponse { /** * Set of days of the week on which this schedule is active. */ daysOfWeek?: string[]; /** * Name of the ScalingPlanPooledSchedule. */ name?: string; /** * Load balancing algorithm for off-peak period. */ offPeakLoadBalancingAlgorithm?: string; /** * Starting time for off-peak period. */ offPeakStartTime?: outputs.desktopvirtualization.TimeResponse; /** * Load balancing algorithm for peak period. */ peakLoadBalancingAlgorithm?: string; /** * Starting time for peak period. */ peakStartTime?: outputs.desktopvirtualization.TimeResponse; /** * Capacity threshold for ramp down period. */ rampDownCapacityThresholdPct?: number; /** * Should users be logged off forcefully from hosts. */ rampDownForceLogoffUsers?: boolean; /** * Load balancing algorithm for ramp down period. */ rampDownLoadBalancingAlgorithm?: string; /** * Minimum host percentage for ramp down period. */ rampDownMinimumHostsPct?: number; /** * Notification message for users during ramp down period. */ rampDownNotificationMessage?: string; /** * Starting time for ramp down period. */ rampDownStartTime?: outputs.desktopvirtualization.TimeResponse; /** * Specifies when to stop hosts during ramp down period. */ rampDownStopHostsWhen?: string; /** * Number of minutes to wait to stop hosts during ramp down period. */ rampDownWaitTimeMinutes?: number; /** * Capacity threshold for ramp up period. */ rampUpCapacityThresholdPct?: number; /** * Load balancing algorithm for ramp up period. */ rampUpLoadBalancingAlgorithm?: string; /** * Minimum host percentage for ramp up period. */ rampUpMinimumHostsPct?: number; /** * Starting time for ramp up period. */ rampUpStartTime?: outputs.desktopvirtualization.TimeResponse; } /** * Contains details on the failure. */ interface SessionHostHealthCheckFailureDetailsResponse { /** * Error code corresponding for the failure. */ errorCode: number; /** * The timestamp of the last update. */ lastHealthCheckDateTime: string; /** * Failure message: hints on what is wrong and how to recover. */ message: string; } /** * The report for session host information. */ interface SessionHostHealthCheckReportResponse { /** * Additional detailed information on the failure. */ additionalFailureDetails: outputs.desktopvirtualization.SessionHostHealthCheckFailureDetailsResponse; /** * Represents the name of the health check operation performed. */ healthCheckName: string; /** * Represents the Health state of the health check we performed. */ healthCheckResult: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The time for a scaling action to occur. */ interface TimeResponse { /** * The hour. */ hour: number; /** * The minute. */ minute: number; } } export declare namespace devcenter { /** * A name/value pair to describe a capability. */ interface CapabilityResponse { /** * Name of the capability. */ name: string; /** * Value of the capability. */ value: string; } /** * An individual conflict error. */ interface CatalogConflictErrorResponse { /** * Name of the conflicting catalog item. */ name: string; /** * The path of the file that has a conflicting name. */ path: string; } /** * Catalog error details */ interface CatalogErrorDetailsResponse { /** * An identifier for the error. */ code?: string; /** * A message describing the error. */ message?: string; } /** * An individual synchronization error. */ interface CatalogSyncErrorResponse { /** * Errors associated with the file. */ errorDetails: outputs.devcenter.CatalogErrorDetailsResponse[]; /** * The path of the file the error is associated with. */ path: string; } /** * All Customer-managed key encryption properties for the resource. */ interface CustomerManagedKeyEncryptionResponse { /** * All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. */ keyEncryptionKeyIdentity?: outputs.devcenter.CustomerManagedKeyEncryptionResponseKeyEncryptionKeyIdentity; /** * key encryption key Url, versioned or non-versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. */ keyEncryptionKeyUrl?: string; } /** * All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. */ interface CustomerManagedKeyEncryptionResponseKeyEncryptionKeyIdentity { /** * delegated identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity and userAssignedIdentity - internal use only. */ delegatedIdentityClientId?: string; /** * Values can be systemAssignedIdentity or userAssignedIdentity */ identityType?: string; /** * user assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity and delegatedResourceIdentity. */ userAssignedIdentityResourceId?: string; } /** * Project catalog settings for project catalogs under a project associated to this dev center. */ interface DevCenterProjectCatalogSettingsResponse { /** * Whether project catalogs associated with projects in this dev center can be configured to sync catalog items. */ catalogItemSyncEnableStatus?: string; } /** * The resource model definition representing SKU for DevCenter resources */ interface DevCenterSkuResponse { /** * Collection of name/value pairs to describe the SKU capabilities. */ capabilities: outputs.devcenter.CapabilityResponse[]; /** * If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. */ capacity?: number; /** * If the service has different generations of hardware, for the same SKU, then that can be captured here. */ family?: string; /** * SKU supported locations. */ locations: string[]; /** * The name of the SKU. E.g. P3. It is typically a letter+number code */ name: string; /** * The name of the resource type */ resourceType: string; /** * The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. */ size?: string; /** * This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. */ tier?: string; } interface EncryptionResponse { /** * All Customer-managed key encryption properties for the resource. */ customerManagedKeyEncryption?: outputs.devcenter.CustomerManagedKeyEncryptionResponse; } /** * A role that can be assigned to a user. */ interface EnvironmentRoleResponse { /** * This is a description of the Role Assignment. */ description: string; /** * The common name of the Role Assignment. This is a descriptive name such as 'AcrPush'. */ roleName: string; } /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.devcenter.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.devcenter.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * Properties for a Git repository catalog. */ interface GitCatalogResponse { /** * Git branch. */ branch?: string; /** * The folder where the catalog items can be found inside the repository. */ path?: string; /** * A reference to the Key Vault secret containing a security token to authenticate to a Git repository. */ secretIdentifier?: string; /** * Git URI. */ uri?: string; } /** * Pool health status detail. */ interface HealthStatusDetailResponse { /** * An identifier for the issue. */ code: string; /** * A message describing the issue, intended to be suitable for display in a user interface */ message: string; } /** * Image creation error details */ interface ImageCreationErrorDetailsResponse { /** * An identifier for the error. */ code?: string; /** * A message describing the error. */ message?: string; } /** * A task group executed during the image definition build. */ interface ImageDefinitionBuildTaskGroupResponse { /** * End time of the task group. */ endTime: string; /** * The name of the task group. */ name: string; /** * Start time of the task group. */ startTime: string; /** * The status of the task group. */ status: string; /** * The list of tasks executed during the task group. */ tasks: outputs.devcenter.ImageDefinitionBuildTaskResponse[]; } /** * A task executed during the image definition build. */ interface ImageDefinitionBuildTaskResponse { /** * Display name to help differentiate multiple instances of the same task. */ displayName?: string; /** * End time of the task. */ endTime: string; /** * ID of the task instance. */ id: string; /** * The URI for retrieving logs for the task execution. */ logUri: string; /** * The name of the task. */ name?: string; /** * Parameters for the task. */ parameters?: outputs.devcenter.ImageDefinitionBuildTaskResponseParameters[]; /** * Start time of the task. */ startTime: string; /** * The status of the task. */ status: string; } interface ImageDefinitionBuildTaskResponseParameters { key: string; value: string; } /** * Image reference information */ interface ImageReferenceResponse { /** * The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use. */ exactVersion: string; /** * Image ID, or Image version ID. When Image ID is provided, its latest version will be used. */ id?: string; } /** * Image validation error details */ interface ImageValidationErrorDetailsResponse { /** * An identifier for the error. */ code?: string; /** * A message describing the error. */ message?: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.devcenter.UserAssignedIdentityResponse; }; } /** * The sync status of the plan member. */ interface PlanMemberSyncStatusResponse { /** * Error response describing why the sync failed. */ lastSyncError?: outputs.devcenter.ErrorDetailResponse; /** * When the plan member was last synced. */ lastSyncTime: string; /** * The synchronization state of the plan member. */ syncState: string; } /** * Settings to be used when associating a project with a catalog. */ interface ProjectCatalogSettingsResponse { /** * Indicates catalog item types that can be synced. */ catalogItemSyncTypes?: string[]; } /** * The role definition assigned to the environment creator on backing resources. */ interface ProjectEnvironmentTypeUpdatePropertiesResponseCreatorRoleAssignment { /** * A map of roles to assign to the environment creator. */ roles?: { [key: string]: outputs.devcenter.EnvironmentRoleResponse; }; } /** * Network settings for the project. */ interface ProjectNetworkSettingsResponse { /** * Indicates whether pools in this Dev Center can use Microsoft Hosted Networks. Defaults to Enabled if not set. */ microsoftHostedNetworkEnableStatus: string; } /** * A resource policy. */ interface ResourcePolicyResponse { /** * Optional. When specified, this expression is used to filter the resources. */ filter?: string; /** * Resources that are included and shared as a part of a project policy. */ resources?: string; } /** * The resource model definition representing SKU */ interface SkuResponse { /** * If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. */ capacity?: number; /** * If the service has different generations of hardware, for the same SKU, then that can be captured here. */ family?: string; /** * The name of the SKU. E.g. P3. It is typically a letter+number code */ name: string; /** * The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. */ size?: string; /** * This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. */ tier?: string; } /** * Stop on disconnect configuration settings for Dev Boxes created in this pool. */ interface StopOnDisconnectConfigurationResponse { /** * The specified time in minutes to wait before stopping a Dev Box once disconnect is detected. */ gracePeriodMinutes?: number; /** * Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled. */ status?: string; } /** * Stats of the synchronization. */ interface SyncStatsResponse { /** * Count of catalog items added during synchronization. */ added: number; /** * Count of catalog items removed during synchronization. */ removed: number; /** * Indicates catalog item types that were synced. */ syncedCatalogItemTypes?: string[]; /** * Count of synchronization errors that occured during synchronization. */ synchronizationErrors: number; /** * Count of catalog items that were unchanged during synchronization. */ unchanged: number; /** * Count of catalog items updated during synchronization. */ updated: number; /** * Count of catalog items that had validation errors during synchronization. */ validationErrors: number; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Mapping of user object ID to role assignments. */ interface UserRoleAssignmentResponse { /** * A map of roles to assign to the parent user. */ roles?: { [key: string]: outputs.devcenter.EnvironmentRoleResponse; }; } } export declare namespace devhub { /** * Information on the azure container registry */ interface ACRResponse { /** * ACR registry */ acrRegistryName?: string; /** * ACR repository */ acrRepositoryName?: string; /** * ACR resource group */ acrResourceGroup?: string; /** * ACR subscription id */ acrSubscriptionId?: string; } interface DeploymentPropertiesResponse { /** * Helm chart directory path in repository. */ helmChartPath?: string; /** * Helm Values.yaml file location in repository. */ helmValues?: string; kubeManifestLocations?: string[]; /** * Determines the type of manifests within the repository. */ manifestType?: string; /** * Manifest override values. */ overrides?: { [key: string]: string; }; } /** * GitHub Workflow Profile */ interface GitHubWorkflowProfileResponse { /** * Information on the azure container registry */ acr?: outputs.devhub.ACRResponse; /** * The Azure Kubernetes Cluster Resource the application will be deployed to. */ aksResourceId?: string; /** * Determines the authorization status of requests. */ authStatus: string; /** * Repository Branch Name */ branchName?: string; deploymentProperties?: outputs.devhub.DeploymentPropertiesResponse; /** * Path to Dockerfile Build Context within the repository. */ dockerBuildContext?: string; /** * Path to the Dockerfile within the repository. */ dockerfile?: string; lastWorkflowRun?: outputs.devhub.WorkflowRunResponse; /** * Kubernetes namespace the application is deployed to. */ namespace?: string; /** * The fields needed for OIDC with GitHub. */ oidcCredentials?: outputs.devhub.GitHubWorkflowProfileResponseOidcCredentials; /** * The status of the Pull Request submitted against the users repository. */ prStatus: string; /** * The URL to the Pull Request submitted against the users repository. */ prURL: string; /** * The number associated with the submitted pull request. */ pullNumber: number; /** * Repository Name */ repositoryName?: string; /** * Repository Owner */ repositoryOwner?: string; } /** * The fields needed for OIDC with GitHub. */ interface GitHubWorkflowProfileResponseOidcCredentials { /** * Azure Application Client ID */ azureClientId?: string; /** * Azure Directory (tenant) ID */ azureTenantId?: string; } interface IacTemplateDetailsResponse { /** * Count of the product */ count?: number; /** * Naming convention of this product */ namingConvention?: string; /** * The name of the products. */ productName?: string; } /** * Properties of a IacTemplate. */ interface IacTemplatePropertiesResponse { /** * the sample instance name of the template */ instanceName?: string; /** * the source stage of the template */ instanceStage?: string; /** * Determines the authorization status of requests. */ quickStartTemplateType?: string; /** * the source store of the template */ sourceResourceId?: string; templateDetails?: outputs.devhub.IacTemplateDetailsResponse[]; /** * Template Name */ templateName?: string; } /** * Properties of a Stage. */ interface StagePropertiesResponse { dependencies?: string[]; gitEnvironment?: string; /** * Stage Name */ stageName?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } interface WorkflowRunResponse { /** * The timestamp of the last workflow run. */ lastRunAt: string; /** * Describes if the workflow run succeeded. */ succeeded: boolean; /** * Describes the status of the workflow run */ workflowRunStatus?: string; /** * URL to the run of the workflow. */ workflowRunURL: string; } } export declare namespace deviceprovisioningservices { /** * The description of an X509 CA Certificate. */ interface CertificatePropertiesResponse { /** * base-64 representation of X509 certificate .cer file or just .pem file content. */ certificate?: string; /** * The certificate's creation date and time. */ created: string; /** * The certificate's expiration date and time. */ expiry: string; /** * Determines whether certificate has been verified. */ isVerified?: boolean; /** * The certificate's subject name. */ subject: string; /** * The certificate's thumbprint. */ thumbprint: string; /** * The certificate's last update date and time. */ updated: string; } /** * the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope */ interface IotDpsPropertiesDescriptionResponse { /** * Allocation policy to be used by this provisioning service. */ allocationPolicy?: string; /** * List of authorization keys for a provisioning service. */ authorizationPolicies?: outputs.deviceprovisioningservices.SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionResponse[]; /** * Device endpoint for this provisioning service. */ deviceProvisioningHostName: string; /** * Optional. * Indicates if the DPS instance has Data Residency enabled, removing the cross geo-pair disaster recovery. */ enableDataResidency?: boolean; /** * Unique identifier of this provisioning service. */ idScope: string; /** * List of IoT hubs associated with this provisioning service. */ iotHubs?: outputs.deviceprovisioningservices.IotHubDefinitionDescriptionResponse[]; /** * The IP filter rules. */ ipFilterRules?: outputs.deviceprovisioningservices.IpFilterRuleResponse[]; /** * Portal endpoint to enable CORS for this provisioning service. */ portalOperationsHostName?: string; /** * Private endpoint connections created on this IotHub */ privateEndpointConnections?: outputs.deviceprovisioningservices.PrivateEndpointConnectionResponse[]; /** * The ARM provisioning state of the provisioning service. */ provisioningState?: string; /** * Whether requests from Public Network are allowed */ publicNetworkAccess?: string; /** * Service endpoint for provisioning service. */ serviceOperationsHostName: string; /** * Current state of the provisioning service. */ state?: string; } /** * List of possible provisioning service SKUs. */ interface IotDpsSkuInfoResponse { /** * The number of units to provision */ capacity?: number; /** * Sku name. */ name?: string; /** * Pricing tier name of the provisioning service. */ tier: string; } /** * Description of the IoT hub. */ interface IotHubDefinitionDescriptionResponse { /** * weight to apply for a given iot h. */ allocationWeight?: number; /** * flag for applying allocationPolicy or not for a given iot hub. */ applyAllocationPolicy?: boolean; /** * Connection string of the IoT hub. */ connectionString: string; /** * ARM region of the IoT hub. */ location: string; /** * Host name of the IoT hub. */ name: string; } /** * The IP filter rules for a provisioning Service. */ interface IpFilterRuleResponse { /** * The desired action for requests captured by this rule. */ action: string; /** * The name of the IP filter rule. */ filterName: string; /** * A string that contains the IP address range in CIDR notation for the rule. */ ipMask: string; /** * Target for requests captured by this rule. */ target?: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.deviceprovisioningservices.UserAssignedIdentityResponse; }; } /** * The properties of a private endpoint connection */ interface PrivateEndpointConnectionPropertiesResponse { /** * The private endpoint property of a private endpoint connection */ privateEndpoint?: outputs.deviceprovisioningservices.PrivateEndpointResponse; /** * The current state of a private endpoint connection */ privateLinkServiceConnectionState: outputs.deviceprovisioningservices.PrivateLinkServiceConnectionStateResponse; } /** * The private endpoint connection of a provisioning service */ interface PrivateEndpointConnectionResponse { /** * The resource identifier. */ id: string; /** * The resource name. */ name: string; /** * The properties of a private endpoint connection */ properties: outputs.deviceprovisioningservices.PrivateEndpointConnectionPropertiesResponse; /** * Metadata pertaining to creation and last modification of the resource. */ systemData: outputs.deviceprovisioningservices.SystemDataResponse; /** * The resource type. */ type: string; } /** * The private endpoint property of a private endpoint connection */ interface PrivateEndpointResponse { /** * The resource identifier. */ id: string; } /** * The current state of a private endpoint connection */ interface PrivateLinkServiceConnectionStateResponse { /** * Actions required for a private endpoint connection */ actionsRequired?: string; /** * The description for the current state of a private endpoint connection */ description: string; /** * The status of a private endpoint connection */ status: string; } /** * Description of the shared access key. */ interface SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionResponse { /** * Name of the key. */ keyName: string; /** * Primary SAS key value. */ primaryKey?: string; /** * Rights that this key has. */ rights: string; /** * Secondary SAS key value. */ secondaryKey?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace deviceregistry { /** * Defines the asset endpoint profile status error properties. */ interface AssetEndpointProfileStatusErrorResponse { /** * Error code for classification of errors (ex: 400, 404, 500, etc.). */ code: number; /** * Human readable helpful error message to provide additional context for error (ex: “targetAddress 'foo' is not a valid url”). */ message: string; } /** * Defines the asset endpoint profile status properties. */ interface AssetEndpointProfileStatusResponse { /** * Array object to transfer and persist errors that originate from the Edge. */ errors: outputs.deviceregistry.AssetEndpointProfileStatusErrorResponse[]; } /** * Defines the asset status dataset properties. */ interface AssetStatusDatasetResponse { /** * The message schema reference object. */ messageSchemaReference: outputs.deviceregistry.MessageSchemaReferenceResponse; /** * The name of the dataset. Must be unique within the status.datasets array. This name is used to correlate between the spec and status dataset information. */ name: string; } /** * Defines the asset status error properties. */ interface AssetStatusErrorResponse { /** * Error code for classification of errors (ex: 400, 404, 500, etc.). */ code: number; /** * Human readable helpful error message to provide additional context for error (ex: “capability Id 'foo' does not exist”). */ message: string; } /** * Defines the asset status event properties. */ interface AssetStatusEventResponse { /** * The message schema reference object. */ messageSchemaReference: outputs.deviceregistry.MessageSchemaReferenceResponse; /** * The name of the event. Must be unique within the status.events array. This name is used to correlate between the spec and status event information. */ name: string; } /** * Defines the asset status properties. */ interface AssetStatusResponse { /** * Array of dataset statuses that describe the status of each dataset. */ datasets: outputs.deviceregistry.AssetStatusDatasetResponse[]; /** * Array object to transfer and persist errors that originate from the Edge. */ errors: outputs.deviceregistry.AssetStatusErrorResponse[]; /** * Array of event statuses that describe the status of each event. */ events: outputs.deviceregistry.AssetStatusEventResponse[]; /** * A read only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (Edge) state of the Asset. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. */ version: number; } /** * Definition of the client authentication mechanism to the server. */ interface AuthenticationResponse { /** * Defines the method to authenticate the user of the client at the server. */ method: string; /** * Defines the username and password references when UsernamePassword user authentication mode is selected. */ usernamePasswordCredentials?: outputs.deviceregistry.UsernamePasswordCredentialsResponse; /** * Defines the certificate reference when Certificate user authentication mode is selected. */ x509Credentials?: outputs.deviceregistry.X509CredentialsResponse; } /** * authenticationResponseProvideDefaults sets the appropriate defaults for AuthenticationResponse */ function authenticationResponseProvideDefaults(val: AuthenticationResponse): AuthenticationResponse; /** * The configuration for a MQTT broker state store destination. */ interface BrokerStateStoreDestinationConfigurationResponse { /** * The MQTT broker state store destination key. */ key: string; } /** * The configuration to set up an ICA. */ interface CertificateAuthorityConfigurationResponse { /** * Crypto type: ECC. */ keyType: string; /** * Certificate subject. */ subject: string; /** * Certificate is valid not after this date. Format ISO8601. Generated based on validity period. */ validityNotAfter: string; /** * Certificate is valid not before this date. Format ISO8601. Generated based on on validity period. */ validityNotBefore: string; } /** * The certificate configuration. */ interface CertificateConfigurationResponse { /** * The configuration to set up an ICA. */ certificateAuthorityConfiguration: outputs.deviceregistry.CertificateAuthorityConfigurationResponse; /** * The leaf certificate configuration. */ leafCertificateConfiguration: outputs.deviceregistry.LeafCertificateConfigurationResponse; } /** * Defines the data point properties. */ interface DataPointResponse { /** * Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. */ dataPointConfiguration?: string; /** * The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. */ dataSource: string; /** * The name of the data point. */ name: string; /** * An indication of how the data point should be mapped to OpenTelemetry. */ observabilityMode?: string; } /** * dataPointResponseProvideDefaults sets the appropriate defaults for DataPointResponse */ function dataPointResponseProvideDefaults(val: DataPointResponse): DataPointResponse; /** * The type for a MQTT broker state store destination. */ interface DatasetBrokerStateStoreDestinationResponse { /** * The MQTT broker state store destination configuration. */ configuration: outputs.deviceregistry.BrokerStateStoreDestinationConfigurationResponse; /** * The set of supported dataset destinations for an asset. * Expected value is 'BrokerStateStore'. */ target: "BrokerStateStore"; } /** * The type for a MQTT destination. */ interface DatasetMqttDestinationResponse { /** * The MQTT destination configuration. */ configuration: outputs.deviceregistry.MqttDestinationConfigurationResponse; /** * The set of supported dataset destinations for an asset. * Expected value is 'Mqtt'. */ target: "Mqtt"; } /** * datasetMqttDestinationResponseProvideDefaults sets the appropriate defaults for DatasetMqttDestinationResponse */ function datasetMqttDestinationResponseProvideDefaults(val: DatasetMqttDestinationResponse): DatasetMqttDestinationResponse; /** * Defines the dataset properties. */ interface DatasetResponse { /** * Array of data points that are part of the dataset. Each data point can have per-data point configuration. */ dataPoints?: outputs.deviceregistry.DataPointResponse[]; /** * Stringified JSON that contains connector-specific JSON string that describes configuration for the specific dataset. */ datasetConfiguration?: string; /** * Name of the dataset. */ name: string; /** * Object that describes the topic information for the specific dataset. */ topic?: outputs.deviceregistry.TopicResponse; } /** * datasetResponseProvideDefaults sets the appropriate defaults for DatasetResponse */ function datasetResponseProvideDefaults(val: DatasetResponse): DatasetResponse; /** * The type for a storage destination. */ interface DatasetStorageDestinationResponse { /** * The storage destination configuration. */ configuration: outputs.deviceregistry.StorageDestinationConfigurationResponse; /** * The set of supported dataset destinations for an asset. * Expected value is 'Storage'. */ target: "Storage"; } /** * Device messaging endpoint model. */ interface DeviceMessagingEndpointResponse { /** * The endpoint address to connect to. */ address: string; /** * Type of connection used for the messaging endpoint. */ endpointType?: string; } /** * Defines which device and endpoint to use for this asset */ interface DeviceRefResponse { /** * Name of the device resource */ deviceName: string; /** * The name of endpoint to use */ endpointName: string; } /** * Defines the device status properties. */ interface DeviceStatusEndpointResponse { /** * Defines the error related to this endpoint. */ error: outputs.deviceregistry.StatusErrorResponse; } /** * Defines the device status for inbound/outbound endpoints. */ interface DeviceStatusEndpointsResponse { /** * KeyValue pair representing status of inbound endpoints. */ inbound: { [key: string]: outputs.deviceregistry.DeviceStatusEndpointResponse; }; } /** * Defines the device status properties. */ interface DeviceStatusResponse { /** * Defines the device status config properties. */ config: outputs.deviceregistry.StatusConfigResponse; /** * Defines the device status for inbound/outbound endpoints. */ endpoints: outputs.deviceregistry.DeviceStatusEndpointsResponse; } /** * Defines the data point properties. */ interface DiscoveredDataPointResponse { /** * Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. */ dataPointConfiguration?: string; /** * The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. */ dataSource: string; /** * UTC timestamp indicating when the data point was added or modified. */ lastUpdatedOn?: string; /** * The name of the data point. */ name: string; } /** * Defines the dataset properties. */ interface DiscoveredDatasetResponse { /** * Array of data points that are part of the dataset. Each data point can have per-data point configuration. */ dataPoints?: outputs.deviceregistry.DiscoveredDataPointResponse[]; /** * Stringified JSON that contains connector-specific properties that describes configuration for the specific dataset. */ datasetConfiguration?: string; /** * Name of the dataset. */ name: string; /** * Object that describes the topic information for the specific dataset. */ topic?: outputs.deviceregistry.TopicResponse; } /** * discoveredDatasetResponseProvideDefaults sets the appropriate defaults for DiscoveredDatasetResponse */ function discoveredDatasetResponseProvideDefaults(val: DiscoveredDatasetResponse): DiscoveredDatasetResponse; /** * Defines the event properties. */ interface DiscoveredEventResponse { /** * Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. */ eventConfiguration?: string; /** * The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. */ eventNotifier: string; /** * UTC timestamp indicating when the event was added or modified. */ lastUpdatedOn?: string; /** * The name of the event. */ name: string; /** * Object that describes the topic information for the specific event. */ topic?: outputs.deviceregistry.TopicResponse; } /** * discoveredEventResponseProvideDefaults sets the appropriate defaults for DiscoveredEventResponse */ function discoveredEventResponseProvideDefaults(val: DiscoveredEventResponse): DiscoveredEventResponse; /** * An endpoint to connect to the device. */ interface DiscoveredInboundEndpointsResponse { /** * Stringified JSON that contains configuration to be used by the connector (e.g., OPC UA, ONVIF). */ additionalConfiguration?: string; /** * The endpoint address & port. This can be either an IP address (e.g., 192.168.1.1) or a fully qualified domain name (FQDN, e.g., server.example.com). */ address: string; /** * Type of connection endpoint. */ endpointType: string; /** * The timestamp (in UTC) when the endpoint was discovered. */ lastUpdatedOn?: string; /** * List of supported authentication methods supported by device for Inbound connections. */ supportedAuthenticationMethods?: string[]; /** * Protocol version associated with the endpoint e.g. 1 or 2 for endpointType Microsoft.HTTP, and 3.5 or 5.0 for endpointType Microsoft.Mqtt etc. */ version?: string; } /** * Connection endpoint URL a device can use to connect to a service. */ interface DiscoveredMessagingEndpointsResponse { /** * Set of endpoints to connect to the device. */ inbound?: { [key: string]: outputs.deviceregistry.DiscoveredInboundEndpointsResponse; }; /** * Set of endpoints a device can connect to. */ outbound?: outputs.deviceregistry.DiscoveredOutboundEndpointsResponse; } /** * Property bag contains the device's outbound endpoints */ interface DiscoveredOutboundEndpointsResponse { /** * Endpoints the device can connect to. */ assigned: { [key: string]: outputs.deviceregistry.DeviceMessagingEndpointResponse; }; } /** * Defines the error details properties. */ interface ErrorDetailsResponse { /** * Multi-part error code for classification and root causing of errors (ex: 400.200.100.432). */ code: string; /** * Unique identifier for the transaction to aid in debugging. */ correlationId: string; /** * Human-readable helpful detailed text context for debugging (ex: “The following mechanisms are supported...”). */ info: string; /** * Human-readable helpful error message to provide additional context for error (ex: “Authentication method not supported”). */ message: string; } /** * The type for a MQTT destination. */ interface EventMqttDestinationResponse { /** * The MQTT destination configuration. */ configuration: outputs.deviceregistry.MqttDestinationConfigurationResponse; /** * The set of supported event destinations for an asset. * Expected value is 'Mqtt'. */ target: "Mqtt"; } /** * eventMqttDestinationResponseProvideDefaults sets the appropriate defaults for EventMqttDestinationResponse */ function eventMqttDestinationResponseProvideDefaults(val: EventMqttDestinationResponse): EventMqttDestinationResponse; /** * Defines the event properties. */ interface EventResponse { /** * Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. */ eventConfiguration?: string; /** * The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. */ eventNotifier: string; /** * The name of the event. */ name: string; /** * An indication of how the event should be mapped to OpenTelemetry. */ observabilityMode?: string; /** * Object that describes the topic information for the specific event. */ topic?: outputs.deviceregistry.TopicResponse; } /** * eventResponseProvideDefaults sets the appropriate defaults for EventResponse */ function eventResponseProvideDefaults(val: EventResponse): EventResponse; /** * The type for a storage destination. */ interface EventStorageDestinationResponse { /** * The storage destination configuration. */ configuration: outputs.deviceregistry.StorageDestinationConfigurationResponse; /** * The set of supported event destinations for an asset. * Expected value is 'Storage'. */ target: "Storage"; } /** * The extended location. */ interface ExtendedLocationResponse { /** * The extended location name. */ name: string; /** * The extended location type. */ type: string; } /** * Definition of the client authentication mechanism to the host. */ interface HostAuthenticationResponse { /** * Defines the method to authenticate the user of the client at the server. */ method: string; /** * Defines the username and password references when UsernamePassword user authentication mode is selected. */ usernamePasswordCredentials?: outputs.deviceregistry.UsernamePasswordCredentialsResponse; /** * Defines the certificate reference when Certificate user authentication mode is selected. */ x509Credentials?: outputs.deviceregistry.X509CredentialsResponse; } /** * hostAuthenticationResponseProvideDefaults sets the appropriate defaults for HostAuthenticationResponse */ function hostAuthenticationResponseProvideDefaults(val: HostAuthenticationResponse): HostAuthenticationResponse; /** * An endpoint to connect to the device. */ interface InboundEndpointsResponse { /** * Stringified JSON that contains configuration to be used by the connector (e.g., OPC UA, ONVIF). */ additionalConfiguration?: string; /** * The endpoint address & port. This can be either an IP address (e.g., 192.168.1.1) or a fully qualified domain name (FQDN, e.g., server.example.com). */ address: string; /** * Defines the client authentication mechanism to the server. */ authentication?: outputs.deviceregistry.HostAuthenticationResponse; /** * Type of connection endpoint. */ endpointType: string; /** * Defines server trust settings for the endpoint. */ trustSettings?: outputs.deviceregistry.TrustSettingsResponse; /** * Protocol version associated with the endpoint e.g. 1 or 2 for endpointType Microsoft.HTTP, and 3.5 or 5.0 for endpointType Microsoft.Mqtt etc. */ version?: string; } /** * inboundEndpointsResponseProvideDefaults sets the appropriate defaults for InboundEndpointsResponse */ function inboundEndpointsResponseProvideDefaults(val: InboundEndpointsResponse): InboundEndpointsResponse; /** * The leaf certificate configuration. */ interface LeafCertificateConfigurationResponse { /** * The validity period in days. */ validityPeriodInDays: number; } /** * Defines the action properties. */ interface ManagementActionResponse { /** * Stringified JSON that contains connector-specific configuration for the action. */ actionConfiguration?: string; /** * The type of the action. */ actionType?: string; /** * Name of the action. */ name: string; /** * The target URI on which a client can invoke the specific action. */ targetUri: string; /** * Response timeout for the action. */ timeoutInSeconds?: number; /** * The MQTT topic path on which a client will receive the request for the action. */ topic?: string; /** * URI or type definition ID. */ typeRef?: string; } /** * managementActionResponseProvideDefaults sets the appropriate defaults for ManagementActionResponse */ function managementActionResponseProvideDefaults(val: ManagementActionResponse): ManagementActionResponse; /** * Defines the management group properties. */ interface ManagementGroupResponse { /** * Array of actions that are part of the management group. Each action can have an individual configuration. */ actions?: outputs.deviceregistry.ManagementActionResponse[]; /** * Default response timeout for all actions that are part of the management group. */ defaultTimeoutInSeconds?: number; /** * Default MQTT topic path on which a client will receive the request for all actions that are part of the management group. */ defaultTopic?: string; /** * Stringified JSON that contains connector-specific configuration for the management group. */ managementGroupConfiguration?: string; /** * Name of the management group. */ name: string; /** * URI or type definition ID. */ typeRef?: string; } /** * managementGroupResponseProvideDefaults sets the appropriate defaults for ManagementGroupResponse */ function managementGroupResponseProvideDefaults(val: ManagementGroupResponse): ManagementGroupResponse; /** * Defines the message schema reference properties. */ interface MessageSchemaReferenceResponse { /** * The message schema name. */ schemaName: string; /** * The message schema registry namespace. */ schemaRegistryNamespace: string; /** * The message schema version. */ schemaVersion: string; } /** * Namespace messaging endpoint model used by a device to connect to a service. */ interface MessagingEndpointResponse { /** * The endpoint address to connect to. */ address: string; /** * Type of connection used for messaging endpoint. */ endpointType?: string; /** * The messaging endpoint Azure resource Id. */ resourceId?: string; } /** * Connection endpoint URL a device can use to connect to a service. */ interface MessagingEndpointsResponse { /** * Set of endpoints to connect to the device. */ inbound?: { [key: string]: outputs.deviceregistry.InboundEndpointsResponse; }; /** * Set of endpoints a device can connect to. */ outbound?: outputs.deviceregistry.OutboundEndpointsResponse; } /** * The namespace messaging endpoints model. */ interface MessagingResponse { /** * Dictionary of messaging endpoints. */ endpoints?: { [key: string]: outputs.deviceregistry.MessagingEndpointResponse; }; } /** * The configuration for a MQTT destination. */ interface MqttDestinationConfigurationResponse { /** * The MQTT QoS setting. Defaults to QoS 1. */ qos?: string; /** * When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. */ retain?: string; /** * The MQTT topic. */ topic: string; /** * The MQTT TTL setting. */ ttl?: number; } /** * mqttDestinationConfigurationResponseProvideDefaults sets the appropriate defaults for MqttDestinationConfigurationResponse */ function mqttDestinationConfigurationResponseProvideDefaults(val: MqttDestinationConfigurationResponse): MqttDestinationConfigurationResponse; /** * Defines the asset status dataset properties. */ interface NamespaceAssetStatusDatasetResponse { /** * Object to transfer and persist errors that originate from the edge. */ error: outputs.deviceregistry.StatusErrorResponse; /** * The message schema reference object. */ messageSchemaReference: outputs.deviceregistry.NamespaceMessageSchemaReferenceResponse; /** * The name of the dataset. Must be unique within the status.datasets array. This name is used to correlate between the spec and status dataset information. */ name: string; } /** * Defines the asset status event properties. */ interface NamespaceAssetStatusEventResponse { /** * Object to transfer and persist errors that originate from the edge. */ error: outputs.deviceregistry.StatusErrorResponse; /** * The message schema reference object. */ messageSchemaReference: outputs.deviceregistry.NamespaceMessageSchemaReferenceResponse; /** * The name of the event. Must be unique within the status.events array. This name is used to correlate between the spec and status event information. */ name: string; } /** * Defines the asset status action properties. */ interface NamespaceAssetStatusManagementActionResponse { /** * Object to transfer and persist errors that originate from the edge. */ error: outputs.deviceregistry.StatusErrorResponse; /** * The name of the action. Must be unique within the status.actions array. This name is used to correlate between the spec and status event information. */ name: string; /** * The request message schema reference object for the action. */ requestMessageSchemaReference: outputs.deviceregistry.NamespaceMessageSchemaReferenceResponse; /** * The response message schema reference object for the action. */ responseMessageSchemaReference: outputs.deviceregistry.NamespaceMessageSchemaReferenceResponse; } /** * Defines the asset status management group properties. */ interface NamespaceAssetStatusManagementGroupResponse { /** * Array of action statuses that describe the status of each action. */ actions: outputs.deviceregistry.NamespaceAssetStatusManagementActionResponse[]; /** * The name of the management group. Must be unique within the status.managementGroups array. This name is used to correlate between the spec and status event information. */ name: string; } /** * Defines the asset status properties. */ interface NamespaceAssetStatusResponse { /** * Defines the asset status config properties. */ config: outputs.deviceregistry.StatusConfigResponse; /** * Array of dataset statuses that describe the status of each dataset. */ datasets: outputs.deviceregistry.NamespaceAssetStatusDatasetResponse[]; /** * Array of event statuses that describe the status of each event. */ events: outputs.deviceregistry.NamespaceAssetStatusEventResponse[]; /** * Array of management group statuses that describe the status of each management group. */ managementGroups: outputs.deviceregistry.NamespaceAssetStatusManagementGroupResponse[]; /** * Array of stream statuses that describe the status of each stream. */ streams: outputs.deviceregistry.NamespaceAssetStatusStreamResponse[]; } /** * Defines the asset status stream properties. */ interface NamespaceAssetStatusStreamResponse { /** * Object to transfer and persist errors that originate from the edge. */ error: outputs.deviceregistry.StatusErrorResponse; /** * The message schema reference object. */ messageSchemaReference: outputs.deviceregistry.NamespaceMessageSchemaReferenceResponse; /** * The name of the stream. Must be unique within the status.streams array. This name is used to correlate between the spec and status event information. */ name: string; } /** * Defines the dataset data point properties. */ interface NamespaceDatasetDataPointResponse { /** * Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. */ dataPointConfiguration?: string; /** * The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. */ dataSource: string; /** * The name of the data point. */ name: string; /** * URI or type definition ID. */ typeRef?: string; } /** * Defines the dataset properties. */ interface NamespaceDatasetResponse { /** * Array of data points that are part of the dataset. Each data point can have per-data point configuration. */ dataPoints?: outputs.deviceregistry.NamespaceDatasetDataPointResponse[]; /** * Reference to a data source for a given dataset. */ dataSource?: string; /** * Stringified JSON that contains connector-specific JSON string that describes configuration for the specific dataset. */ datasetConfiguration?: string; /** * Destinations for a dataset. */ destinations?: (outputs.deviceregistry.DatasetBrokerStateStoreDestinationResponse | outputs.deviceregistry.DatasetMqttDestinationResponse | outputs.deviceregistry.DatasetStorageDestinationResponse)[]; /** * Name of the dataset. */ name: string; /** * URI or type definition ID. */ typeRef?: string; } /** * Defines the discovered dataset data point properties. */ interface NamespaceDiscoveredDatasetDataPointResponse { /** * Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. */ dataPointConfiguration?: string; /** * The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. */ dataSource: string; /** * UTC timestamp indicating when the data point was added or modified. */ lastUpdatedOn?: string; /** * The name of the data point. */ name: string; /** * URI or type definition ID. */ typeRef?: string; } /** * Defines the dataset properties. */ interface NamespaceDiscoveredDatasetResponse { /** * Array of data points that are part of the dataset. Each data point can have per-data point configuration. */ dataPoints?: outputs.deviceregistry.NamespaceDiscoveredDatasetDataPointResponse[]; /** * Reference to a data source for a given dataset. */ dataSource?: string; /** * Stringified JSON that contains connector-specific properties that describes configuration for the specific dataset. */ datasetConfiguration?: string; /** * Destinations for a dataset. */ destinations?: (outputs.deviceregistry.DatasetBrokerStateStoreDestinationResponse | outputs.deviceregistry.DatasetMqttDestinationResponse | outputs.deviceregistry.DatasetStorageDestinationResponse)[]; /** * Timestamp (in UTC) indicating when the dataset was added or modified. */ lastUpdatedOn?: string; /** * Name of the dataset. */ name: string; /** * URI or type definition ID. */ typeRef?: string; } /** * Defines the discovered event data point properties. */ interface NamespaceDiscoveredEventDataPointResponse { /** * Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. */ dataPointConfiguration?: string; /** * The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. */ dataSource: string; /** * UTC timestamp indicating when the data point was added or modified. */ lastUpdatedOn?: string; /** * The name of the data point. */ name: string; } /** * Defines the event properties. */ interface NamespaceDiscoveredEventResponse { /** * Array of data points that are part of the event. Each data point can have a per-data point configuration. */ dataPoints?: outputs.deviceregistry.NamespaceDiscoveredEventDataPointResponse[]; /** * Destinations for an event. */ destinations?: (outputs.deviceregistry.EventMqttDestinationResponse | outputs.deviceregistry.EventStorageDestinationResponse)[]; /** * Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. */ eventConfiguration?: string; /** * The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. */ eventNotifier: string; /** * UTC timestamp indicating when the event was added or modified. */ lastUpdatedOn?: string; /** * The name of the event. */ name: string; /** * URI or type definition ID. */ typeRef?: string; } /** * Defines the action properties. */ interface NamespaceDiscoveredManagementActionResponse { /** * Stringified JSON that contains connector-specific configuration for the action. */ actionConfiguration?: string; /** * The type of the action. */ actionType?: string; /** * Timestamp (in UTC) indicating when the management action was added or modified. */ lastUpdatedOn?: string; /** * Name of the action. */ name: string; /** * The target URI on which a client can invoke the specific action. */ targetUri: string; /** * Response timeout for the action. */ timeoutInSeconds?: number; /** * The MQTT topic path on which a client will receive the request for the action. */ topic?: string; /** * URI or type definition ID. */ typeRef?: string; } /** * namespaceDiscoveredManagementActionResponseProvideDefaults sets the appropriate defaults for NamespaceDiscoveredManagementActionResponse */ function namespaceDiscoveredManagementActionResponseProvideDefaults(val: NamespaceDiscoveredManagementActionResponse): NamespaceDiscoveredManagementActionResponse; /** * Defines the management group properties. */ interface NamespaceDiscoveredManagementGroupResponse { /** * Array of actions that are part of the management group. Each action can have an individual configuration. */ actions?: outputs.deviceregistry.NamespaceDiscoveredManagementActionResponse[]; /** * Default response timeout for all actions that are part of the management group. */ defaultTimeoutInSeconds?: number; /** * Default MQTT topic path on which a client will receive the request for all actions that are part of the management group. */ defaultTopic?: string; /** * Timestamp (in UTC) indicating when the management group was added or modified. */ lastUpdatedOn?: string; /** * Stringified JSON that contains connector-specific configuration for the management group. */ managementGroupConfiguration?: string; /** * Name of the management group. */ name: string; /** * URI or type definition ID. */ typeRef?: string; } /** * namespaceDiscoveredManagementGroupResponseProvideDefaults sets the appropriate defaults for NamespaceDiscoveredManagementGroupResponse */ function namespaceDiscoveredManagementGroupResponseProvideDefaults(val: NamespaceDiscoveredManagementGroupResponse): NamespaceDiscoveredManagementGroupResponse; /** * Defines the stream properties. */ interface NamespaceDiscoveredStreamResponse { /** * Destinations for a stream. */ destinations?: (outputs.deviceregistry.StreamMqttDestinationResponse | outputs.deviceregistry.StreamStorageDestinationResponse)[]; /** * Timestamp (in UTC) indicating when the stream was added or modified. */ lastUpdatedOn?: string; /** * Name of the stream definition. */ name: string; /** * Stringified JSON that contains connector-specific configuration for the specific stream. */ streamConfiguration?: string; /** * URI or type definition ID. */ typeRef?: string; } /** * Defines the event data point properties. */ interface NamespaceEventDataPointResponse { /** * Stringified JSON that contains connector-specific configuration for the data point. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. */ dataPointConfiguration?: string; /** * The address of the source of the data in the asset (e.g. URL) so that a client can access the data source on the asset. */ dataSource: string; /** * The name of the data point. */ name: string; } /** * Defines the event properties. */ interface NamespaceEventResponse { /** * Array of data points that are part of the event. Each data point can have a per-data point configuration. */ dataPoints?: outputs.deviceregistry.NamespaceEventDataPointResponse[]; /** * Destinations for an event. */ destinations?: (outputs.deviceregistry.EventMqttDestinationResponse | outputs.deviceregistry.EventStorageDestinationResponse)[]; /** * Stringified JSON that contains connector-specific configuration for the event. For OPC UA, this could include configuration like, publishingInterval, samplingInterval, and queueSize. */ eventConfiguration?: string; /** * The address of the notifier of the event in the asset (e.g. URL) so that a client can access the event on the asset. */ eventNotifier: string; /** * The name of the event. */ name: string; /** * URI or type definition ID. */ typeRef?: string; } /** * Defines the message schema reference properties. */ interface NamespaceMessageSchemaReferenceResponse { /** * The message schema name. */ schemaName: string; /** * The message schema registry namespace. */ schemaRegistryNamespace: string; /** * The message schema version. */ schemaVersion: string; } /** * Defines the stream properties. */ interface NamespaceStreamResponse { /** * Destinations for a stream. */ destinations?: (outputs.deviceregistry.StreamMqttDestinationResponse | outputs.deviceregistry.StreamStorageDestinationResponse)[]; /** * Name of the stream definition. */ name: string; /** * Stringified JSON that contains connector-specific configuration for the specific stream. */ streamConfiguration?: string; /** * URI or type definition ID. */ typeRef?: string; } /** * Property bag contains the device's outbound endpoints */ interface OutboundEndpointsResponse { /** * Endpoints the device can connect to. */ assigned: { [key: string]: outputs.deviceregistry.DeviceMessagingEndpointResponse; }; /** * Set of most recently removed endpoints. */ unassigned?: { [key: string]: outputs.deviceregistry.DeviceMessagingEndpointResponse; }; } /** * Details of the Credential Policy. */ interface PolicyPropertiesResponse { /** * The certificate configuration. */ certificate?: outputs.deviceregistry.CertificateConfigurationResponse; /** * The status of the last operation. */ provisioningState: string; } /** * Defines the status config properties. */ interface StatusConfigResponse { /** * Object to transfer and persist errors that originate from the edge. */ error: outputs.deviceregistry.StatusErrorResponse; /** * A read-only timestamp indicating the last time the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. */ lastTransitionTime: string; /** * A read-only incremental counter indicating the number of times the configuration has been modified from the perspective of the current actual (edge) state of the CRD. Edge would be the only writer of this value and would sync back up to the cloud. In steady state, this should equal version. */ version: number; } /** * Defines the status config error properties. */ interface StatusErrorResponse { /** * Error code for classification of errors (ex: '400', '404', '500', etc.). */ code: string; /** * Array of error details that describe the status of each error. */ details: outputs.deviceregistry.ErrorDetailsResponse[]; /** * Human-readable helpful error message to provide additional context for error (e.g.,: “Capability ID 'foo' does not exist”). */ message: string; } /** * The configuration for a storage destination. */ interface StorageDestinationConfigurationResponse { /** * The storage destination path. */ path: string; } /** * The type for a MQTT destination. */ interface StreamMqttDestinationResponse { /** * The MQTT destination configuration. */ configuration: outputs.deviceregistry.MqttDestinationConfigurationResponse; /** * The set of supported stream destinations for an asset. * Expected value is 'Mqtt'. */ target: "Mqtt"; } /** * streamMqttDestinationResponseProvideDefaults sets the appropriate defaults for StreamMqttDestinationResponse */ function streamMqttDestinationResponseProvideDefaults(val: StreamMqttDestinationResponse): StreamMqttDestinationResponse; /** * The type for a storage destination. */ interface StreamStorageDestinationResponse { /** * The storage destination configuration. */ configuration: outputs.deviceregistry.StorageDestinationConfigurationResponse; /** * The set of supported stream destinations for an asset. * Expected value is 'Storage'. */ target: "Storage"; } /** * Managed service identity (either system assigned, or none) */ interface SystemAssignedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (either system assigned, or none). */ type: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Object that describes the topic information. */ interface TopicResponse { /** * The topic path for messages published to an MQTT broker. */ path: string; /** * When set to 'Keep', messages published to an MQTT broker will have the retain flag set. Default: 'Never'. */ retain?: string; } /** * topicResponseProvideDefaults sets the appropriate defaults for TopicResponse */ function topicResponseProvideDefaults(val: TopicResponse): TopicResponse; /** * Defines server trust settings for an endpoint. */ interface TrustSettingsResponse { /** * Defines a secret reference for certificates to trust. */ trustList?: string; } /** * The credentials for authentication mode UsernamePassword. */ interface UsernamePasswordCredentialsResponse { /** * The name of the secret containing the password. */ passwordSecretName: string; /** * The name of the secret containing the username. */ usernameSecretName: string; } /** * The x509 certificate for authentication mode Certificate. */ interface X509CredentialsResponse { /** * The name of the secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx). */ certificateSecretName: string; } } export declare namespace deviceupdate { /** * Private endpoint connection proxy object properties. */ interface ConnectionDetailsResponse { /** * Group ID. */ groupId: string; /** * Connection details ID. */ id: string; /** * Link ID. */ linkIdentifier: string; /** * Member name. */ memberName: string; /** * Private IP address. */ privateIpAddress: string; } /** * Customer-initiated diagnostic log collection storage properties */ interface DiagnosticStoragePropertiesResponse { /** * Authentication Type */ authenticationType: string; /** * ConnectionString of the diagnostic storage account */ connectionString?: string; /** * ResourceId of the diagnostic storage account */ resourceId: string; } /** * The CMK encryption settings on the Device Update account. */ interface EncryptionResponse { /** * The URI of the key vault */ keyVaultKeyUri?: string; /** * The full resourceId of the user assigned identity to be used for key vault access. Identity has to be also assigned to the Account */ userAssignedIdentity?: string; } /** * Group connectivity details. */ interface GroupConnectivityInformationResponse { /** * List of customer visible FQDNs. */ customerVisibleFqdns?: string[]; /** * Group ID. */ groupId: string; /** * Internal FQDN. */ internalFqdn: string; /** * Member name. */ memberName: string; /** * PrivateLinkService ARM region. */ privateLinkServiceArmRegion?: string; /** * Redirect map ID. */ redirectMapId?: string; } /** * Device Update account integration with IoT Hub settings. */ interface IotHubSettingsResponse { /** * IoTHub resource ID */ resourceId: string; } interface LocationResponse { name?: string; /** * Whether the location is primary or failover */ role?: string; } /** * locationResponseProvideDefaults sets the appropriate defaults for LocationResponse */ function locationResponseProvideDefaults(val: LocationResponse): LocationResponse; /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.deviceupdate.UserAssignedIdentityResponse; }; } /** * The Private Endpoint Connection resource. */ interface PrivateEndpointConnectionResponse { /** * Array of group IDs. */ groupIds?: string[]; /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * The resource of private end point. */ privateEndpoint?: outputs.deviceupdate.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.deviceupdate.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.deviceupdate.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The Private Endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint */ id: string; } /** * Private link service connection details. */ interface PrivateLinkServiceConnectionResponse { /** * List of group IDs. */ groupIds?: string[]; /** * Private link service connection name. */ name?: string; /** * Request message. */ requestMessage?: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Private link service proxy details. */ interface PrivateLinkServiceProxyResponse { /** * Group connectivity information. */ groupConnectivityInformation?: outputs.deviceupdate.GroupConnectivityInformationResponse[]; /** * NRP resource ID. */ id?: string; /** * Remote private endpoint connection details. */ remotePrivateEndpointConnection?: outputs.deviceupdate.PrivateLinkServiceProxyResponseRemotePrivateEndpointConnection; /** * Remote private link service connection state */ remotePrivateLinkServiceConnectionState?: outputs.deviceupdate.PrivateLinkServiceConnectionStateResponse; } /** * Remote private endpoint connection details. */ interface PrivateLinkServiceProxyResponseRemotePrivateEndpointConnection { /** * Remote private endpoint connection ID. */ id: string; } /** * Remote private endpoint details. */ interface RemotePrivateEndpointResponse { /** * List of connection details. */ connectionDetails?: outputs.deviceupdate.ConnectionDetailsResponse[]; /** * Remote endpoint resource ID. */ id?: string; /** * Original resource ID needed by Microsoft.Network. */ immutableResourceId?: string; /** * Original subscription ID needed by Microsoft.Network. */ immutableSubscriptionId?: string; /** * ARM location of the remote private endpoint. */ location?: string; /** * List of private link service connections that need manual approval. */ manualPrivateLinkServiceConnections?: outputs.deviceupdate.PrivateLinkServiceConnectionResponse[]; /** * List of automatically approved private link service connections. */ privateLinkServiceConnections?: outputs.deviceupdate.PrivateLinkServiceConnectionResponse[]; /** * List of private link service proxies. */ privateLinkServiceProxies?: outputs.deviceupdate.PrivateLinkServiceProxyResponse[]; /** * Virtual network traffic tag. */ vnetTrafficTag?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace devopsinfrastructure { /** * The stand-by agent scheme is determined based on historical demand. */ interface AutomaticResourcePredictionsProfileResponse { /** * Determines how the stand-by scheme should be provided. * Expected value is 'Automatic'. */ kind: "Automatic"; /** * Determines the balance between cost and performance. */ predictionPreference?: string; } /** * Azure DevOps organization profile */ interface AzureDevOpsOrganizationProfileResponse { /** * Discriminator property for OrganizationProfile. * Expected value is 'AzureDevOps'. */ kind: "AzureDevOps"; /** * The list of Azure DevOps organizations the pool should be present in. */ organizations: outputs.devopsinfrastructure.OrganizationResponse[]; /** * The type of permission which determines which accounts are admins on the Azure DevOps pool. */ permissionProfile?: outputs.devopsinfrastructure.AzureDevOpsPermissionProfileResponse; } /** * Defines the type of Azure DevOps pool permission. */ interface AzureDevOpsPermissionProfileResponse { /** * Group email addresses */ groups?: string[]; /** * Determines who has admin permissions to the Azure DevOps pool. */ kind: string; /** * User email addresses */ users?: string[]; } /** * The data disk of the VMSS. */ interface DataDiskResponse { /** * The type of caching to be enabled for the data disks. The default value for caching is readwrite. For information about the caching options see: https://blogs.msdn.microsoft.com/windowsazurestorage/2012/06/27/exploring-windows-azure-drives-disks-and-images/. */ caching?: string; /** * The initial disk size in gigabytes. */ diskSizeGiB?: number; /** * The drive letter for the empty data disk. If not specified, it will be the first available letter. */ driveLetter?: string; /** * The storage Account type to be used for the data disk. If omitted, the default is "standard_lrs". */ storageAccountType?: string; } /** * The Azure SKU of the machines in the pool. */ interface DevOpsAzureSkuResponse { /** * The Azure SKU name of the machines in the pool. */ name: string; } /** * GitHub organization profile */ interface GitHubOrganizationProfileResponse { /** * Discriminator property for OrganizationProfile. * Expected value is 'GitHub'. */ kind: "GitHub"; /** * The list of GitHub organizations/repositories the pool should be present in. */ organizations: outputs.devopsinfrastructure.GitHubOrganizationResponse[]; } /** * Defines a GitHub organization */ interface GitHubOrganizationResponse { /** * Optional list of repositories in which the pool should be created. */ repositories?: string[]; /** * The GitHub organization URL in which the pool should be created. */ url: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.devopsinfrastructure.UserAssignedIdentityResponse; }; } /** * Customer provides the stand-by agent scheme. */ interface ManualResourcePredictionsProfileResponse { /** * Determines how the stand-by scheme should be provided. * Expected value is 'Manual'. */ kind: "Manual"; } /** * The network profile of the machines in the pool. */ interface NetworkProfileResponse { /** * The subnet id on which to put all machines created in the pool. */ subnetId: string; } /** * Defines an Azure DevOps organization. */ interface OrganizationResponse { /** * Determines if the pool should have open access to all projects in this organization. */ openAccess?: boolean; /** * How many machines can be created at maximum in this organization out of the maximumConcurrency of the pool. */ parallelism?: number; /** * Optional list of projects in which the pool should be created. */ projects?: string[]; /** * The Azure DevOps organization URL in which the pool should be created. */ url: string; } /** * The OS profile of the machines in the pool. */ interface OsProfileResponse { /** * Determines how the service should be run. By default, this will be set to Service. */ logonType?: string; /** * The secret management settings of the machines in the pool. */ secretsManagementSettings?: outputs.devopsinfrastructure.SecretsManagementSettingsResponse; } /** * The VM image of the machines in the pool. */ interface PoolImageResponse { /** * List of aliases to reference the image by. */ aliases?: string[]; /** * The percentage of the buffer to be allocated to this image. */ buffer?: string; /** * The ephemeral type of the image. */ ephemeralType?: string; /** * The resource id of the image. */ resourceId?: string; /** * The image to use from a well-known set of images made available to customers. */ wellKnownImageName?: string; } /** * poolImageResponseProvideDefaults sets the appropriate defaults for PoolImageResponse */ function poolImageResponseProvideDefaults(val: PoolImageResponse): PoolImageResponse; /** * The secret management settings of the machines in the pool. */ interface SecretsManagementSettingsResponse { /** * Where to store certificates on the machine. */ certificateStoreLocation?: string; /** * Name of the certificate store to use on the machine, currently 'My' and 'Root' are supported. */ certificateStoreName?: string; /** * Defines if the key of the certificates should be exportable. */ keyExportable: boolean; /** * The list of certificates to install on all machines in the pool. */ observedCertificates: string[]; } /** * Stateful profile meaning that the machines will be returned to the pool after running a job. */ interface StatefulResponse { /** * How long should the machine be kept around after it ran a workload when there are no stand-by agents. The maximum is one week. */ gracePeriodTimeSpan?: string; /** * Discriminator property for AgentProfile. * Expected value is 'Stateful'. */ kind: "Stateful"; /** * How long should stateful machines be kept around. The maximum is one week. */ maxAgentLifetime?: string; /** * Defines pool buffer/stand-by agents. */ resourcePredictions?: any; /** * Defines how the pool buffer/stand-by agents is provided. */ resourcePredictionsProfile?: outputs.devopsinfrastructure.AutomaticResourcePredictionsProfileResponse | outputs.devopsinfrastructure.ManualResourcePredictionsProfileResponse; } /** * Stateless profile meaning that the machines will be cleaned up after running a job. */ interface StatelessAgentProfileResponse { /** * Discriminator property for AgentProfile. * Expected value is 'Stateless'. */ kind: "Stateless"; /** * Defines pool buffer/stand-by agents. */ resourcePredictions?: any; /** * Defines how the pool buffer/stand-by agents is provided. */ resourcePredictionsProfile?: outputs.devopsinfrastructure.AutomaticResourcePredictionsProfileResponse | outputs.devopsinfrastructure.ManualResourcePredictionsProfileResponse; } /** * The storage profile of the VMSS. */ interface StorageProfileResponse { /** * A list of empty data disks to attach. */ dataDisks?: outputs.devopsinfrastructure.DataDiskResponse[]; /** * The Azure SKU name of the machines in the pool. */ osDiskStorageAccountType?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * The agents will run on Virtual Machine Scale Sets. */ interface VmssFabricProfileResponse { /** * The VM images of the machines in the pool. */ images: outputs.devopsinfrastructure.PoolImageResponse[]; /** * Discriminator property for FabricProfile. * Expected value is 'Vmss'. */ kind: "Vmss"; /** * The network profile of the machines in the pool. */ networkProfile?: outputs.devopsinfrastructure.NetworkProfileResponse; /** * The OS profile of the machines in the pool. */ osProfile?: outputs.devopsinfrastructure.OsProfileResponse; /** * The Azure SKU of the machines in the pool. */ sku: outputs.devopsinfrastructure.DevOpsAzureSkuResponse; /** * The storage profile of the machines in the pool. */ storageProfile?: outputs.devopsinfrastructure.StorageProfileResponse; } } export declare namespace devspaces { interface ControllerConnectionDetailsResponse { /** * Base class for types that supply values used to connect to container orchestrators */ orchestratorSpecificConnectionDetails?: outputs.devspaces.KubernetesConnectionDetailsResponse; } /** * Contains information used to connect to a Kubernetes cluster */ interface KubernetesConnectionDetailsResponse { /** * Gets the Instance type. * Expected value is 'Kubernetes'. */ instanceType: "Kubernetes"; /** * Gets the kubeconfig for the cluster. */ kubeConfig?: string; } /** * Model representing SKU for Azure Dev Spaces Controller. */ interface SkuResponse { /** * The name of the SKU for Azure Dev Spaces Controller. */ name: string; /** * The tier of the SKU for Azure Dev Spaces Controller. */ tier?: string; } } export declare namespace devtestlab { /** * Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level. */ interface ApplicableScheduleResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The auto-shutdown schedule, if one has been set at the lab or lab resource level. */ labVmsShutdown?: outputs.devtestlab.ScheduleResponse; /** * The auto-startup schedule, if one has been set at the lab or lab resource level. */ labVmsStartup?: outputs.devtestlab.ScheduleResponse; /** * The location of the resource. */ location?: string; /** * The name of the resource */ name: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.devtestlab.SystemDataResponse; /** * The tags of the resource. */ tags?: { [key: string]: string; }; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * applicableScheduleResponseProvideDefaults sets the appropriate defaults for ApplicableScheduleResponse */ function applicableScheduleResponseProvideDefaults(val: ApplicableScheduleResponse): ApplicableScheduleResponse; /** * Properties of an Azure Resource Manager template parameter. */ interface ArmTemplateParameterPropertiesResponse { /** * The name of the template parameter. */ name?: string; /** * The value of the template parameter. */ value?: string; } /** * Properties of an artifact deployment. */ interface ArtifactDeploymentStatusPropertiesResponse { /** * The total count of the artifacts that were successfully applied. */ artifactsApplied?: number; /** * The deployment status of the artifact. */ deploymentStatus?: string; /** * The total count of the artifacts that were tentatively applied. */ totalArtifacts?: number; } /** * Properties of an artifact. */ interface ArtifactInstallPropertiesResponse { /** * The artifact's identifier. */ artifactId?: string; /** * The artifact's title. */ artifactTitle?: string; /** * The status message from the deployment. */ deploymentStatusMessage?: string; /** * The time that the artifact starts to install on the virtual machine. */ installTime?: string; /** * The parameters of the artifact. */ parameters?: outputs.devtestlab.ArtifactParameterPropertiesResponse[]; /** * The status of the artifact. */ status?: string; /** * The status message from the virtual machine extension. */ vmExtensionStatusMessage?: string; } /** * Properties of an artifact parameter. */ interface ArtifactParameterPropertiesResponse { /** * The name of the artifact parameter. */ name?: string; /** * The value of the artifact parameter. */ value?: string; } /** * Properties to attach new disk to the Virtual Machine. */ interface AttachNewDataDiskOptionsResponse { /** * The name of the disk to be attached. */ diskName?: string; /** * Size of the disk to be attached in Gibibytes. */ diskSizeGiB?: number; /** * The storage type for the disk (i.e. Standard, Premium). */ diskType?: string; } /** * Parameters for creating multiple virtual machines as a single action. */ interface BulkCreationParametersResponse { /** * The number of virtual machine instances to create. */ instanceCount?: number; } /** * A data disks attached to a virtual machine. */ interface ComputeDataDiskResponse { /** * Gets data disk size in GiB. */ diskSizeGiB?: number; /** * When backed by a blob, the URI of underlying blob. */ diskUri?: string; /** * When backed by managed disk, this is the ID of the compute disk resource. */ managedDiskId?: string; /** * Gets data disk name. */ name?: string; } /** * Status information about a virtual machine. */ interface ComputeVmInstanceViewStatusResponse { /** * Gets the status Code. */ code?: string; /** * Gets the short localizable label for the status. */ displayStatus?: string; /** * Gets the message associated with the status. */ message?: string; } /** * Properties of a virtual machine returned by the Microsoft.Compute API. */ interface ComputeVmPropertiesResponse { /** * Gets data disks blob uri for the virtual machine. */ dataDiskIds?: string[]; /** * Gets all data disks attached to the virtual machine. */ dataDisks?: outputs.devtestlab.ComputeDataDiskResponse[]; /** * Gets the network interface ID of the virtual machine. */ networkInterfaceId?: string; /** * Gets OS disk blob uri for the virtual machine. */ osDiskId?: string; /** * Gets the OS type of the virtual machine. */ osType?: string; /** * Gets the statuses of the virtual machine. */ statuses?: outputs.devtestlab.ComputeVmInstanceViewStatusResponse[]; /** * Gets the size of the virtual machine. */ vmSize?: string; } /** * Properties for creating a custom image from a VHD. */ interface CustomImagePropertiesCustomResponse { /** * The image name. */ imageName?: string; /** * The OS type of the custom image (i.e. Windows, Linux) */ osType: string; /** * Indicates whether sysprep has been run on the VHD. */ sysPrep?: boolean; } /** * Properties for plan on a custom image. */ interface CustomImagePropertiesFromPlanResponse { /** * The id of the plan, equivalent to name of the plan */ id?: string; /** * The offer for the plan from the marketplace image the custom image is derived from */ offer?: string; /** * The publisher for the plan from the marketplace image the custom image is derived from */ publisher?: string; } /** * Properties for creating a custom image from a virtual machine. */ interface CustomImagePropertiesFromVmResponse { /** * The Linux OS information of the VM. */ linuxOsInfo?: outputs.devtestlab.LinuxOsInfoResponse; /** * The source vm identifier. */ sourceVmId?: string; /** * The Windows OS information of the VM. */ windowsOsInfo?: outputs.devtestlab.WindowsOsInfoResponse; } /** * Request body for adding a new or existing data disk to a virtual machine. */ interface DataDiskPropertiesResponse { /** * Specifies options to attach a new disk to the virtual machine. */ attachNewDataDiskOptions?: outputs.devtestlab.AttachNewDataDiskOptionsResponse; /** * Specifies the existing lab disk id to attach to virtual machine. */ existingLabDiskId?: string; /** * Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). */ hostCaching?: string; } /** * Storage information about the data disks present in the custom image */ interface DataDiskStorageTypeInfoResponse { /** * Disk Lun */ lun?: string; /** * Disk Storage Type */ storageType?: string; } /** * Properties of a daily schedule. */ interface DayDetailsResponse { /** * The time of day the schedule will occur. */ time?: string; } /** * Properties of an environment deployment. */ interface EnvironmentDeploymentPropertiesResponse { /** * The Azure Resource Manager template's identifier. */ armTemplateId?: string; /** * The parameters of the Azure Resource Manager template. */ parameters?: outputs.devtestlab.ArmTemplateParameterPropertiesResponse[]; } /** * An event to be notified for. */ interface EventResponse { /** * The event type for which this notification is enabled (i.e. AutoShutdown, Cost) */ eventName?: string; } /** * Subnet information as returned by the Microsoft.Network API. */ interface ExternalSubnetResponse { /** * Gets or sets the identifier. */ id?: string; /** * Gets or sets the name. */ name?: string; } /** * Information about a VM from which a formula is to be created. */ interface FormulaPropertiesFromVmResponse { /** * The identifier of the VM from which a formula is to be created. */ labVmId?: string; } /** * The reference information for an Azure Marketplace image. */ interface GalleryImageReferenceResponse { /** * The offer of the gallery image. */ offer?: string; /** * The OS type of the gallery image. */ osType?: string; /** * The publisher of the gallery image. */ publisher?: string; /** * The SKU of the gallery image. */ sku?: string; /** * The version of the gallery image. */ version?: string; } /** * Properties of an hourly schedule. */ interface HourDetailsResponse { /** * Minutes of the hour the schedule will run. */ minute?: number; } /** * Properties of a managed identity */ interface IdentityPropertiesResponse { /** * The client secret URL of the identity. */ clientSecretUrl?: string; /** * The principal id of resource identity. */ principalId?: string; /** * The tenant identifier of resource. */ tenantId?: string; /** * Managed identity. */ type?: string; } /** * A rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer. */ interface InboundNatRuleResponse { /** * The port to which the external traffic will be redirected. */ backendPort?: number; /** * The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. */ frontendPort?: number; /** * The transport protocol for the endpoint. */ transportProtocol?: string; } /** * Properties of a lab's announcement banner */ interface LabAnnouncementPropertiesResponse { /** * Is the lab announcement active/enabled at this time? */ enabled?: string; /** * The time at which the announcement expires (null for never) */ expirationDate?: string; /** * Has this announcement expired? */ expired?: boolean; /** * The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. */ markdown?: string; /** * The provisioning status of the resource. */ provisioningState: string; /** * The plain text title for the lab announcement */ title?: string; /** * The unique immutable identifier of a resource (Guid). */ uniqueIdentifier: string; } /** * Properties of a lab's support banner */ interface LabSupportPropertiesResponse { /** * Is the lab support banner active/enabled at this time? */ enabled?: string; /** * The markdown text (if any) that this lab displays in the UI. If left empty/null, nothing will be shown. */ markdown?: string; } /** * Properties of a VHD in the lab. */ interface LabVhdResponse { /** * The URI to the VHD. */ id?: string; } /** * Properties for creating a virtual machine. */ interface LabVirtualMachineCreationParameterResponse { /** * Indicates whether another user can take ownership of the virtual machine */ allowClaim?: boolean; /** * The artifacts to be installed on the virtual machine. */ artifacts?: outputs.devtestlab.ArtifactInstallPropertiesResponse[]; /** * The number of virtual machine instances to create. */ bulkCreationParameters?: outputs.devtestlab.BulkCreationParametersResponse; /** * The creation date of the virtual machine. */ createdDate?: string; /** * The custom image identifier of the virtual machine. */ customImageId?: string; /** * New or existing data disks to attach to the virtual machine after creation */ dataDiskParameters?: outputs.devtestlab.DataDiskPropertiesResponse[]; /** * Indicates whether the virtual machine is to be created without a public IP address. */ disallowPublicIpAddress?: boolean; /** * The resource ID of the environment that contains this virtual machine, if any. */ environmentId?: string; /** * The expiration date for VM. */ expirationDate?: string; /** * The Microsoft Azure Marketplace image reference of the virtual machine. */ galleryImageReference?: outputs.devtestlab.GalleryImageReferenceResponse; /** * Indicates whether this virtual machine uses an SSH key for authentication. */ isAuthenticationWithSshKey?: boolean; /** * The lab subnet name of the virtual machine. */ labSubnetName?: string; /** * The lab virtual network identifier of the virtual machine. */ labVirtualNetworkId?: string; /** * The location of the new virtual machine or environment */ location?: string; /** * The name of the virtual machine or environment */ name?: string; /** * The network interface properties. */ networkInterface?: outputs.devtestlab.NetworkInterfacePropertiesResponse; /** * The notes of the virtual machine. */ notes?: string; /** * The object identifier of the owner of the virtual machine. */ ownerObjectId?: string; /** * The user principal name of the virtual machine owner. */ ownerUserPrincipalName?: string; /** * The password of the virtual machine administrator. */ password?: string; /** * The id of the plan associated with the virtual machine image */ planId?: string; /** * Virtual Machine schedules to be created */ scheduleParameters?: outputs.devtestlab.ScheduleCreationParameterResponse[]; /** * The size of the virtual machine. */ size?: string; /** * The SSH key of the virtual machine administrator. */ sshKey?: string; /** * Storage type to use for virtual machine (i.e. Standard, Premium). */ storageType?: string; /** * The tags of the resource. */ tags?: { [key: string]: string; }; /** * The user name of the virtual machine. */ userName?: string; } /** * labVirtualMachineCreationParameterResponseProvideDefaults sets the appropriate defaults for LabVirtualMachineCreationParameterResponse */ function labVirtualMachineCreationParameterResponseProvideDefaults(val: LabVirtualMachineCreationParameterResponse): LabVirtualMachineCreationParameterResponse; /** * Information about a Linux OS. */ interface LinuxOsInfoResponse { /** * The state of the Linux OS (i.e. NonDeprovisioned, DeprovisionRequested, DeprovisionApplied). */ linuxOsState?: string; } /** * Properties of a network interface. */ interface NetworkInterfacePropertiesResponse { /** * The DNS name. */ dnsName?: string; /** * The private IP address. */ privateIpAddress?: string; /** * The public IP address. */ publicIpAddress?: string; /** * The resource ID of the public IP address. */ publicIpAddressId?: string; /** * The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). */ rdpAuthority?: string; /** * The configuration for sharing a public IP address across multiple virtual machines. */ sharedPublicIpAddressConfiguration?: outputs.devtestlab.SharedPublicIpAddressConfigurationResponse; /** * The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. */ sshAuthority?: string; /** * The resource ID of the sub net. */ subnetId?: string; /** * The resource ID of the virtual network. */ virtualNetworkId?: string; } /** * Notification settings for a schedule. */ interface NotificationSettingsResponse { /** * The email recipient to send notifications to (can be a list of semi-colon separated email addresses). */ emailRecipient?: string; /** * The locale to use when sending a notification (fallback for unsupported languages is EN). */ notificationLocale?: string; /** * If notifications are enabled for this schedule (i.e. Enabled, Disabled). */ status?: string; /** * Time in minutes before event at which notification will be sent. */ timeInMinutes?: number; /** * The webhook URL to which the notification will be sent. */ webhookUrl?: string; } /** * notificationSettingsResponseProvideDefaults sets the appropriate defaults for NotificationSettingsResponse */ function notificationSettingsResponseProvideDefaults(val: NotificationSettingsResponse): NotificationSettingsResponse; /** * Properties of a network port. */ interface PortResponse { /** * Backend port of the target virtual machine. */ backendPort?: number; /** * Protocol type of the port. */ transportProtocol?: string; } /** * Properties for creating a schedule. */ interface ScheduleCreationParameterResponse { /** * If the schedule will occur once each day of the week, specify the daily recurrence. */ dailyRecurrence?: outputs.devtestlab.DayDetailsResponse; /** * If the schedule will occur multiple times a day, specify the hourly recurrence. */ hourlyRecurrence?: outputs.devtestlab.HourDetailsResponse; /** * The location of the new virtual machine or environment */ location: string; /** * The name of the virtual machine or environment */ name?: string; /** * Notification settings. */ notificationSettings?: outputs.devtestlab.NotificationSettingsResponse; /** * The status of the schedule (i.e. Enabled, Disabled) */ status?: string; /** * The tags of the resource. */ tags?: { [key: string]: string; }; /** * The resource ID to which the schedule belongs */ targetResourceId?: string; /** * The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). */ taskType?: string; /** * The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) */ timeZoneId?: string; /** * If the schedule will occur only some days of the week, specify the weekly recurrence. */ weeklyRecurrence?: outputs.devtestlab.WeekDetailsResponse; } /** * scheduleCreationParameterResponseProvideDefaults sets the appropriate defaults for ScheduleCreationParameterResponse */ function scheduleCreationParameterResponseProvideDefaults(val: ScheduleCreationParameterResponse): ScheduleCreationParameterResponse; /** * A schedule. */ interface ScheduleResponse { /** * The creation date of the schedule. */ createdDate: string; /** * If the schedule will occur once each day of the week, specify the daily recurrence. */ dailyRecurrence?: outputs.devtestlab.DayDetailsResponse; /** * If the schedule will occur multiple times a day, specify the hourly recurrence. */ hourlyRecurrence?: outputs.devtestlab.HourDetailsResponse; /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The geo-location where the resource lives */ location?: string; /** * The name of the resource */ name: string; /** * Notification settings. */ notificationSettings?: outputs.devtestlab.NotificationSettingsResponse; /** * The provisioning status of the resource. */ provisioningState: string; /** * The status of the schedule (i.e. Enabled, Disabled) */ status?: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.devtestlab.SystemDataResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * The resource ID to which the schedule belongs */ targetResourceId?: string; /** * The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). */ taskType?: string; /** * The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) */ timeZoneId?: string; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; /** * The unique immutable identifier of a resource (Guid). */ uniqueIdentifier: string; /** * If the schedule will occur only some days of the week, specify the weekly recurrence. */ weeklyRecurrence?: outputs.devtestlab.WeekDetailsResponse; } /** * scheduleResponseProvideDefaults sets the appropriate defaults for ScheduleResponse */ function scheduleResponseProvideDefaults(val: ScheduleResponse): ScheduleResponse; /** * Properties of a virtual machine that determine how it is connected to a load balancer. */ interface SharedPublicIpAddressConfigurationResponse { /** * The incoming NAT rules */ inboundNatRules?: outputs.devtestlab.InboundNatRuleResponse[]; } /** * Property overrides on a subnet of a virtual network. */ interface SubnetOverrideResponse { /** * The name given to the subnet within the lab. */ labSubnetName?: string; /** * The resource ID of the subnet. */ resourceId?: string; /** * Properties that virtual machines on this subnet will share. */ sharedPublicIpAddressConfiguration?: outputs.devtestlab.SubnetSharedPublicIpAddressConfigurationResponse; /** * Indicates whether this subnet can be used during virtual machine creation (i.e. Allow, Deny). */ useInVmCreationPermission?: string; /** * Indicates whether public IP addresses can be assigned to virtual machines on this subnet (i.e. Allow, Deny). */ usePublicIpAddressPermission?: string; /** * The virtual network pool associated with this subnet. */ virtualNetworkPoolName?: string; } /** * Subnet information. */ interface SubnetResponse { /** * The permission policy of the subnet for allowing public IP addresses (i.e. Allow, Deny)). */ allowPublicIp?: string; /** * The name of the subnet as seen in the lab. */ labSubnetName?: string; /** * The resource ID of the subnet. */ resourceId?: string; } /** * Configuration for public IP address sharing. */ interface SubnetSharedPublicIpAddressConfigurationResponse { /** * Backend ports that virtual machines on this subnet are allowed to expose */ allowedPorts?: outputs.devtestlab.PortResponse[]; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Identity attributes of a lab user. */ interface UserIdentityResponse { /** * Set to the app Id of the client JWT making the request. */ appId?: string; /** * Set to the object Id of the client JWT making the request. Not all users have object Id. For CSP (reseller) scenarios for example, object Id is not available. */ objectId?: string; /** * Set to the principal Id of the client JWT making the request. Service principal will not have the principal Id. */ principalId?: string; /** * Set to the principal name / UPN of the client JWT making the request. */ principalName?: string; /** * Set to the tenant ID of the client JWT making the request. */ tenantId?: string; } /** * Properties of a user's secret store. */ interface UserSecretStoreResponse { /** * The ID of the user's Key vault. */ keyVaultId?: string; /** * The URI of the user's Key vault. */ keyVaultUri?: string; } /** * Properties of a weekly schedule. */ interface WeekDetailsResponse { /** * The time of the day the schedule will occur. */ time?: string; /** * The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). */ weekdays?: string[]; } /** * Information about a Windows OS. */ interface WindowsOsInfoResponse { /** * The state of the Windows OS (i.e. NonSysprepped, SysprepRequested, SysprepApplied). */ windowsOsState?: string; } } export declare namespace digitaltwins { /** * Properties of a time series database connection to Azure Data Explorer with data being sent via an EventHub. */ interface AzureDataExplorerConnectionPropertiesResponse { /** * The name of the Azure Data Explorer database. */ adxDatabaseName: string; /** * The URI of the Azure Data Explorer endpoint. */ adxEndpointUri: string; /** * The name of the Azure Data Explorer table used for recording relationship lifecycle events. The table will not be created if this property is left unspecified. */ adxRelationshipLifecycleEventsTableName?: string; /** * The resource ID of the Azure Data Explorer cluster. */ adxResourceId: string; /** * The name of the Azure Data Explorer table used for storing updates to properties of twins and relationships. Defaults to AdtPropertyEvents. */ adxTableName?: string; /** * The name of the Azure Data Explorer table used for recording twin lifecycle events. The table will not be created if this property is left unspecified. */ adxTwinLifecycleEventsTableName?: string; /** * The type of time series connection resource. * Expected value is 'AzureDataExplorer'. */ connectionType: "AzureDataExplorer"; /** * The EventHub consumer group to use when ADX reads from EventHub. Defaults to $Default. */ eventHubConsumerGroup?: string; /** * The URL of the EventHub namespace for identity-based authentication. It must include the protocol sb:// */ eventHubEndpointUri: string; /** * The EventHub name in the EventHub namespace for identity-based authentication. */ eventHubEntityPath: string; /** * The resource ID of the EventHub namespace. */ eventHubNamespaceResourceId: string; /** * Managed identity properties for the time series database connection resource. */ identity?: outputs.digitaltwins.ManagedIdentityReferenceResponse; /** * The provisioning state. */ provisioningState: string; /** * Specifies whether or not to record twin / relationship property and item removals, including removals of indexed or keyed values (such as map entries, array elements, etc.). This feature is de-activated unless explicitly set to 'true'. Setting this property to 'true' will generate an additional column in the property events table in ADX. */ recordPropertyAndItemRemovals?: string; } /** * azureDataExplorerConnectionPropertiesResponseProvideDefaults sets the appropriate defaults for AzureDataExplorerConnectionPropertiesResponse */ function azureDataExplorerConnectionPropertiesResponseProvideDefaults(val: AzureDataExplorerConnectionPropertiesResponse): AzureDataExplorerConnectionPropertiesResponse; /** * The properties of a private endpoint connection. */ interface ConnectionPropertiesResponse { /** * The list of group ids for the private endpoint connection. */ groupIds?: string[]; /** * The private endpoint. */ privateEndpoint?: outputs.digitaltwins.PrivateEndpointResponse; /** * The connection state. */ privateLinkServiceConnectionState?: outputs.digitaltwins.ConnectionPropertiesResponsePrivateLinkServiceConnectionState; /** * The provisioning state. */ provisioningState: string; } /** * The connection state. */ interface ConnectionPropertiesResponsePrivateLinkServiceConnectionState { /** * Actions required for a private endpoint connection. */ actionsRequired?: string; /** * The description for the current state of a private endpoint connection. */ description: string; /** * The status of a private endpoint connection. */ status: string; } /** * The managed identity for the DigitalTwinsInstance. */ interface DigitalTwinsIdentityResponse { /** * The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity */ principalId: string; /** * The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity */ tenantId: string; /** * The type of Managed Identity used by the DigitalTwinsInstance. */ type?: string; /** * The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. * . */ userAssignedIdentities?: { [key: string]: outputs.digitaltwins.UserAssignedIdentityResponse; }; } /** * Properties related to EventGrid. */ interface EventGridResponse { /** * EventGrid secondary accesskey. Will be obfuscated during read. */ accessKey1: string; /** * EventGrid secondary accesskey. Will be obfuscated during read. */ accessKey2?: string; /** * Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. */ authenticationType?: string; /** * Time when the Endpoint was added to DigitalTwinsInstance. */ createdTime: string; /** * Dead letter storage secret for key-based authentication. Will be obfuscated during read. */ deadLetterSecret?: string; /** * Dead letter storage URL for identity-based authentication. */ deadLetterUri?: string; /** * The type of Digital Twins endpoint * Expected value is 'EventGrid'. */ endpointType: "EventGrid"; /** * Managed identity properties for the endpoint. */ identity?: outputs.digitaltwins.ManagedIdentityReferenceResponse; /** * The provisioning state. */ provisioningState: string; /** * EventGrid Topic Endpoint. */ topicEndpoint: string; } /** * Properties related to EventHub. */ interface EventHubResponse { /** * Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. */ authenticationType?: string; /** * PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. */ connectionStringPrimaryKey?: string; /** * SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. */ connectionStringSecondaryKey?: string; /** * Time when the Endpoint was added to DigitalTwinsInstance. */ createdTime: string; /** * Dead letter storage secret for key-based authentication. Will be obfuscated during read. */ deadLetterSecret?: string; /** * Dead letter storage URL for identity-based authentication. */ deadLetterUri?: string; /** * The type of Digital Twins endpoint * Expected value is 'EventHub'. */ endpointType: "EventHub"; /** * The URL of the EventHub namespace for identity-based authentication. It must include the protocol 'sb://'. */ endpointUri?: string; /** * The EventHub name in the EventHub namespace for identity-based authentication. */ entityPath?: string; /** * Managed identity properties for the endpoint. */ identity?: outputs.digitaltwins.ManagedIdentityReferenceResponse; /** * The provisioning state. */ provisioningState: string; } /** * The properties of the Managed Identity. */ interface ManagedIdentityReferenceResponse { /** * The type of managed identity used. */ type?: string; /** * The user identity ARM resource id if the managed identity type is 'UserAssigned'. */ userAssignedIdentity?: string; } /** * The private endpoint connection of a Digital Twin. */ interface PrivateEndpointConnectionResponse { /** * The resource identifier. */ id: string; /** * The resource name. */ name: string; /** * The connection properties. */ properties: outputs.digitaltwins.ConnectionPropertiesResponse; /** * Metadata pertaining to creation and last modification of the private endpoint connection. */ systemData: outputs.digitaltwins.SystemDataResponse; /** * The resource type. */ type: string; } /** * The private endpoint property of a private endpoint connection. */ interface PrivateEndpointResponse { /** * The resource identifier. */ id: string; } /** * Properties related to ServiceBus. */ interface ServiceBusResponse { /** * Specifies the authentication type being used for connecting to the endpoint. Defaults to 'KeyBased'. If 'KeyBased' is selected, a connection string must be specified (at least the primary connection string). If 'IdentityBased' is select, the endpointUri and entityPath properties must be specified. */ authenticationType?: string; /** * Time when the Endpoint was added to DigitalTwinsInstance. */ createdTime: string; /** * Dead letter storage secret for key-based authentication. Will be obfuscated during read. */ deadLetterSecret?: string; /** * Dead letter storage URL for identity-based authentication. */ deadLetterUri?: string; /** * The type of Digital Twins endpoint * Expected value is 'ServiceBus'. */ endpointType: "ServiceBus"; /** * The URL of the ServiceBus namespace for identity-based authentication. It must include the protocol 'sb://'. */ endpointUri?: string; /** * The ServiceBus Topic name for identity-based authentication. */ entityPath?: string; /** * Managed identity properties for the endpoint. */ identity?: outputs.digitaltwins.ManagedIdentityReferenceResponse; /** * PrimaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. */ primaryConnectionString?: string; /** * The provisioning state. */ provisioningState: string; /** * SecondaryConnectionString of the endpoint for key-based authentication. Will be obfuscated during read. */ secondaryConnectionString?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The information about the user assigned identity. */ interface UserAssignedIdentityResponse { /** * The client id of the User Assigned Identity Resource. */ clientId: string; /** * The object id of the User Assigned Identity Resource. */ principalId: string; } } export declare namespace discovery { /** * The Azure NetApp Files properties. */ interface AzureNetAppFilesStoreResponse { /** * The kind of the backing storage store. * Expected value is 'AzureNetAppFiles'. */ kind: "AzureNetAppFiles"; /** * The associated Azure NetApp Files volume ID. */ netAppVolumeId: string; } /** * The Azure storage blob properties. */ interface AzureStorageBlobStoreResponse { /** * The kind of the backing storage store. * Expected value is 'AzureStorageBlob'. */ kind: "AzureStorageBlob"; /** * The associated Azure Storage Account ID. */ storageAccountId: string; } /** * Key Vault Properties with clientId selection */ interface BookshelfKeyVaultPropertiesResponse { /** * The client ID of the identity to use for accessing the Key Vault. Must be a workload identity assigned to the Bookshelf resource. */ identityClientId: string; /** * The Key Name in Key Vault */ keyName: string; /** * The Key Vault URI */ keyVaultUri: string; /** * The Key Version in Key Vault */ keyVersion?: string; } /** * Bookshelf properties */ interface BookshelfPropertiesResponse { /** * The bookshelf data plane API URI */ bookshelfUri: string; /** * Whether or not to use a customer managed key when encrypting data at rest */ customerManagedKeys?: string; /** * The key to use for encrypting data at rest when customer managed keys are enabled. Required if Customer Managed Keys is enabled. */ keyVaultProperties?: outputs.discovery.BookshelfKeyVaultPropertiesResponse; /** * The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled. */ logAnalyticsClusterId?: string; /** * Managed-On-Behalf-Of configuration properties. This configuration exists for the resources where a resource provider manages those resources on behalf of the resource owner. */ managedOnBehalfOfConfiguration: outputs.discovery.WithMoboBrokerResourcesResponse; /** * The resource group for resources managed on behalf of customer. */ managedResourceGroup: string; /** * List of private endpoint connections. */ privateEndpointConnections: outputs.discovery.PrivateEndpointConnectionResponse[]; /** * Private Endpoint Subnet ID for private endpoint connections. */ privateEndpointSubnetId?: string; /** * The status of the last operation. */ provisioningState: string; /** * Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible. */ publicNetworkAccess?: string; /** * Search Subnet ID for search resources. */ searchSubnetId?: string; /** * User assigned identity IDs to be used by knowledgebase workloads. The key value must be the resource ID of the identity resource. */ workloadIdentities?: { [key: string]: outputs.discovery.UserAssignedIdentityResponse; }; } /** * Defines a deployment binding a specific model family to a user-defined deployment name for chat inference. */ interface ChatModelDeploymentPropertiesResponse { /** * Model format as published by the provider. Verify supported formats per region using the Model Catalog API. */ modelFormat: string; /** * Canonical provider model name available in the selected region. Verify supported values per region using the Model Catalog API. */ modelName: string; /** * The status of the last operation. */ provisioningState: string; } /** * For user assigned identity resource property. */ interface IdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The resource ID of the user assigned identity. */ id: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * For Key Vault Key references */ interface KeyVaultPropertiesResponse { /** * The Key Name in Key Vault */ keyName: string; /** * The Key Vault URI */ keyVaultUri: string; /** * The Key Version in Key Vault */ keyVersion?: string; } /** * Managed-On-Behalf-Of broker resource. This resource is created by the Resource Provider to manage some resources on behalf of the user. */ interface MoboBrokerResourceResponse { /** * Resource identifier of a Managed-On-Behalf-Of broker resource */ id?: string; } /** * NodePool properties */ interface NodePoolPropertiesResponse { /** * The maximum number of nodes. */ maxNodeCount: number; /** * The minimum number of nodes. */ minNodeCount?: number; /** * The status of the last operation. */ provisioningState: string; /** * The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'. */ scaleSetPriority?: string; /** * The node pool subnet. */ subnetId: string; /** * The size of the underlying Azure VM. */ vmSize: string; } /** * nodePoolPropertiesResponseProvideDefaults sets the appropriate defaults for NodePoolPropertiesResponse */ function nodePoolPropertiesResponseProvideDefaults(val: NodePoolPropertiesResponse): NodePoolPropertiesResponse; /** * Properties of the private endpoint connection. */ interface PrivateEndpointConnectionPropertiesResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * The private endpoint resource. */ privateEndpoint?: outputs.discovery.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.discovery.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; } /** * The private endpoint connection resource. */ interface PrivateEndpointConnectionResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint resource. */ privateEndpoint?: outputs.discovery.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.discovery.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.discovery.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Project properties */ interface ProjectPropertiesResponse { /** * Foundry project endpoint URI. */ foundryProjectEndpoint: string; /** * The status of the last operation. */ provisioningState: string; /** * Settings for the project. */ settings?: outputs.discovery.ProjectSettingsResponse; /** * Allowed StorageContainers (Control plane resource references). */ storageContainerIds?: string[]; } /** * Settings schema for the project */ interface ProjectSettingsResponse { /** * Default preferences to guide AI behaviors in this project. */ behaviorPreferences?: string; } /** * Storage Asset properties */ interface StorageAssetPropertiesResponse { /** * The description */ description: string; /** * The path to the data within its parent container. This should be relative to the root of the parent container. */ path?: string; /** * The status of the last operation. */ provisioningState: string; } /** * Storage Container properties */ interface StorageContainerPropertiesResponse { /** * The status of the last operation. */ provisioningState: string; /** * Storage store properties */ storageStore: outputs.discovery.AzureNetAppFilesStoreResponse | outputs.discovery.AzureStorageBlobStoreResponse; } /** * Dictionary of identity properties for the Supercomputer. */ interface SupercomputerIdentitiesResponse { /** * Cluster identity ID. */ clusterIdentity: outputs.discovery.IdentityResponse; /** * Kubelet identity ID used by the supercomputer. * This identity is used by the supercomputer at node level to access Azure resources. * This identity must have ManagedIdentityOperator role on the clusterIdentity. */ kubeletIdentity: outputs.discovery.IdentityResponse; /** * User assigned identity IDs to be used by workloads as federated credentials running on supercomputer. The key value must be the resource ID of the identity resource. */ workloadIdentities?: { [key: string]: outputs.discovery.UserAssignedIdentityResponse; }; } /** * Supercomputer properties */ interface SupercomputerPropertiesResponse { /** * Whether or not to use a customer managed key when encrypting data at rest */ customerManagedKeys?: string; /** * Disk Encryption Set ID to use for Customer Managed Keys encryption. Required if Customer Managed Keys is enabled. */ diskEncryptionSetId?: string; /** * Dictionary of identity properties. */ identities: outputs.discovery.SupercomputerIdentitiesResponse; /** * The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled. */ logAnalyticsClusterId?: string; /** * Managed-On-Behalf-Of configuration properties. This configuration exists for the resources where a resource provider manages those resources on behalf of the resource owner. */ managedOnBehalfOfConfiguration: outputs.discovery.WithMoboBrokerResourcesResponse; /** * The resource group for resources managed on behalf of customer. */ managedResourceGroup: string; /** * System Subnet ID associated with AKS apiserver. Must be delegated to Microsoft.ContainerService/managedClusters. * It should have connectivity to the system subnet and nodepool subnets. */ managementSubnetId?: string; /** * Network egress type provisioned for the supercomputer workloads. * Defaults to LoadBalancer if not specified. * If None is specified, the customer is responsible for providing outbound connectivity for Supercomputer functionality. */ outboundType?: string; /** * The status of the last operation. */ provisioningState: string; /** * System Subnet ID associated with managed NodePool for system resources. * It should have connectivity to the child NodePool subnets. */ subnetId: string; /** * The SKU to use for the system node pool. */ systemSku?: string; } /** * supercomputerPropertiesResponseProvideDefaults sets the appropriate defaults for SupercomputerPropertiesResponse */ function supercomputerPropertiesResponseProvideDefaults(val: SupercomputerPropertiesResponse): SupercomputerPropertiesResponse; /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Discovery Tool list item properties */ interface ToolPropertiesResponse { /** * The JSON content for defining a resource */ definitionContent: any; /** * Environment variables to make available */ environmentVariables?: { [key: string]: string; }; /** * The status of the last operation. */ provisioningState: string; /** * The version of a resource definition */ version: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * For tracking mobo resources */ interface WithMoboBrokerResourcesResponse { /** * Managed-On-Behalf-Of broker resources */ moboBrokerResources: outputs.discovery.MoboBrokerResourceResponse[]; } /** * Workspace properties */ interface WorkspacePropertiesResponse { /** * Agent Subnet ID for agent resources. */ agentSubnetId?: string; /** * Whether or not to use a customer managed key when encrypting data at rest */ customerManagedKeys?: string; /** * The key to use for encrypting data at rest when customer managed keys are enabled. */ keyVaultProperties?: outputs.discovery.KeyVaultPropertiesResponse; /** * The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled. */ logAnalyticsClusterId?: string; /** * Managed-On-Behalf-Of configuration properties. This configuration exists for the resources where a resource provider manages those resources on behalf of the resource owner. */ managedOnBehalfOfConfiguration: outputs.discovery.WithMoboBrokerResourcesResponse; /** * The resource group for resources managed on behalf of customer. */ managedResourceGroup: string; /** * List of private endpoint connections. */ privateEndpointConnections: outputs.discovery.PrivateEndpointConnectionResponse[]; /** * Private Endpoint Subnet ID for private endpoint connections. */ privateEndpointSubnetId?: string; /** * The status of the last operation. */ provisioningState: string; /** * Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible. */ publicNetworkAccess?: string; /** * List of linked SuperComputers. */ supercomputerIds?: string[]; /** * workspace API endpoint Uri. */ workspaceApiUri: string; /** * Identity IDs used for leveraging Workspace resources. */ workspaceIdentity: outputs.discovery.IdentityResponse; /** * Function Subnet ID for workspace resources. */ workspaceSubnetId?: string; /** * workspace User Interface Uri. */ workspaceUiUri: string; } } export declare namespace dns { /** * An A record. */ interface ARecordResponse { /** * The IPv4 address of this A record. */ ipv4Address?: string; } /** * An AAAA record. */ interface AaaaRecordResponse { /** * The IPv6 address of this AAAA record. */ ipv6Address?: string; } /** * A CAA record. */ interface CaaRecordResponse { /** * The flags for this CAA record as an integer between 0 and 255. */ flags?: number; /** * The tag for this CAA record. */ tag?: string; /** * The value for this CAA record. */ value?: string; } /** * A CNAME record. */ interface CnameRecordResponse { /** * The canonical name for this CNAME record. */ cname?: string; } /** * The delegation signer information. */ interface DelegationSignerInfoResponse { /** * The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml */ digestAlgorithmType: number; /** * The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. */ digestValue: string; /** * The record represents a delegation signer (DS) record. */ record: string; } /** * A digest. */ interface DigestResponse { /** * The digest algorithm type represents the standard digest algorithm number used to construct the digest. See: https://www.iana.org/assignments/ds-rr-types/ds-rr-types.xhtml */ algorithmType?: number; /** * The digest value is a cryptographic hash value of the referenced DNSKEY Resource Record. */ value?: string; } /** * Represents a single Azure resource and its referencing DNS records. */ interface DnsResourceReferenceResponse { /** * A list of dns Records */ dnsResources?: outputs.dns.SubResourceResponse[]; /** * A reference to an azure resource from where the dns resource value is taken. */ targetResource?: outputs.dns.SubResourceResponse; } /** * A DS record. For more information about the DS record format, see RFC 4034: https://www.rfc-editor.org/rfc/rfc4034 */ interface DsRecordResponse { /** * The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml */ algorithm?: number; /** * The digest entity. */ digest?: outputs.dns.DigestResponse; /** * The key tag value is used to determine which DNSKEY Resource Record is used for signature verification. */ keyTag?: number; } /** * An MX record. */ interface MxRecordResponse { /** * The domain name of the mail host for this MX record. */ exchange?: string; /** * The preference value for this MX record. */ preference?: number; } /** * A NAPTR record. For more information about the NAPTR record format, see RFC 3403: https://www.rfc-editor.org/rfc/rfc3403 */ interface NaptrRecordResponse { /** * The flags specific to DDDS applications. Values currently defined in RFC 3404 are uppercase and lowercase letters "A", "P", "S", and "U", and the empty string, "". Enclose Flags in quotation marks. */ flags?: string; /** * The order in which the NAPTR records MUST be processed in order to accurately represent the ordered list of rules. The ordering is from lowest to highest. Valid values: 0-65535. */ order?: number; /** * The preference specifies the order in which NAPTR records with equal 'order' values should be processed, low numbers being processed before high numbers. Valid values: 0-65535. */ preference?: number; /** * The regular expression that the DDDS application uses to convert an input value into an output value. For example: an IP phone system might use a regular expression to convert a phone number that is entered by a user into a SIP URI. Enclose the regular expression in quotation marks. Specify either a value for 'regexp' or a value for 'replacement'. */ regexp?: string; /** * The replacement is a fully qualified domain name (FQDN) of the next domain name that you want the DDDS application to submit a DNS query for. The DDDS application replaces the input value with the value specified for replacement. Specify either a value for 'regexp' or a value for 'replacement'. If you specify a value for 'regexp', specify a dot (.) for 'replacement'. */ replacement?: string; /** * The services specific to DDDS applications. Enclose Services in quotation marks. */ services?: string; } /** * An NS record. */ interface NsRecordResponse { /** * The name server name for this NS record. */ nsdname?: string; } /** * A PTR record. */ interface PtrRecordResponse { /** * The PTR target domain name for this PTR record. */ ptrdname?: string; } /** * Represents the signing key. */ interface SigningKeyResponse { /** * The delegation signer information. */ delegationSignerInfo: outputs.dns.DelegationSignerInfoResponse[]; /** * The flags specifies how the key is used. */ flags: number; /** * The key tag value of the DNSKEY Resource Record. */ keyTag: number; /** * The protocol value. The value is always 3. */ protocol: number; /** * The public key, represented as a Base64 encoding. */ publicKey: string; /** * The security algorithm type represents the standard security algorithm number of the DNSKEY Resource Record. See: https://www.iana.org/assignments/dns-sec-alg-numbers/dns-sec-alg-numbers.xhtml */ securityAlgorithmType: number; } /** * An SOA record. */ interface SoaRecordResponse { /** * The email contact for this SOA record. */ email?: string; /** * The expire time for this SOA record. */ expireTime?: number; /** * The domain name of the authoritative name server for this SOA record. */ host?: string; /** * The minimum value for this SOA record. By convention this is used to determine the negative caching duration. */ minimumTtl?: number; /** * The refresh value for this SOA record. */ refreshTime?: number; /** * The retry time for this SOA record. */ retryTime?: number; /** * The serial number for this SOA record. */ serialNumber?: number; } /** * An SRV record. */ interface SrvRecordResponse { /** * The port value for this SRV record. */ port?: number; /** * The priority value for this SRV record. */ priority?: number; /** * The target domain name for this SRV record. */ target?: string; /** * The weight value for this SRV record. */ weight?: number; } /** * A reference to a another resource */ interface SubResourceResponse { /** * Resource Id. */ id?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * A TLSA record. For more information about the TLSA record format, see RFC 6698: https://www.rfc-editor.org/rfc/rfc6698 */ interface TlsaRecordResponse { /** * This specifies the certificate association data to be matched. */ certAssociationData?: string; /** * The matching type specifies how the certificate association is presented. */ matchingType?: number; /** * The selector specifies which part of the TLS certificate presented by the server will be matched against the association data. */ selector?: number; /** * The usage specifies the provided association that will be used to match the certificate presented in the TLS handshake. */ usage?: number; } /** * A TXT record. */ interface TxtRecordResponse { /** * The text value of this TXT record. */ value?: string[]; } } export declare namespace dnsresolver { /** * The action to take on DNS requests that match the DNS security rule. */ interface DnsSecurityRuleActionResponse { /** * The type of action to take. */ actionType?: string; /** * The response code for block actions. */ blockResponseCode?: string; } /** * IP configuration. */ interface IpConfigurationResponse { /** * Private IP address of the IP configuration. */ privateIpAddress?: string; /** * Private IP address allocation method. */ privateIpAllocationMethod?: string; /** * The reference to the subnet bound to the IP configuration. */ subnet: outputs.dnsresolver.SubResourceResponse; } /** * ipConfigurationResponseProvideDefaults sets the appropriate defaults for IpConfigurationResponse */ function ipConfigurationResponseProvideDefaults(val: IpConfigurationResponse): IpConfigurationResponse; /** * Reference to another ARM resource. */ interface SubResourceResponse { /** * Resource ID. */ id: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Describes a server to forward the DNS queries to. */ interface TargetDnsServerResponse { /** * DNS server IP address. */ ipAddress: string; /** * DNS server port. */ port?: number; } /** * targetDnsServerResponseProvideDefaults sets the appropriate defaults for TargetDnsServerResponse */ function targetDnsServerResponseProvideDefaults(val: TargetDnsServerResponse): TargetDnsServerResponse; /** * Reference to DNS forwarding ruleset and associated virtual network link. */ interface VirtualNetworkDnsForwardingRulesetResponse { /** * DNS Forwarding Ruleset Resource ID. */ id?: string; /** * The reference to the virtual network link. */ virtualNetworkLink?: outputs.dnsresolver.SubResourceResponse; } } export declare namespace domainregistration { /** * Details of a hostname derived from a domain. */ interface HostNameResponse { /** * Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name. */ azureResourceName?: string; /** * Type of the Azure resource the hostname is assigned to. */ azureResourceType?: string; /** * Type of the DNS record. */ customHostNameDnsRecordType?: string; /** * Type of the hostname. */ hostNameType?: string; /** * Name of the hostname. */ name?: string; /** * List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager. */ siteNames?: string[]; } /** * Identifies an object. */ interface NameIdentifierResponse { /** * Name of the object. */ name?: string; } /** * Legal agreement for a top level domain. */ interface TldLegalAgreementResponse { /** * Unique identifier for the agreement. */ agreementKey: string; /** * Agreement details. */ content: string; /** * Agreement title. */ title: string; /** * URL where a copy of the agreement details is hosted. */ url?: string; } } export declare namespace durabletask { /** * The private endpoint connection resource. */ interface PrivateEndpointConnectionResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint resource. */ privateEndpoint?: outputs.durabletask.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.durabletask.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.durabletask.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * The properties of a retention policy */ interface RetentionPolicyDetailsResponse { /** * The orchestration state to which this policy applies. If omitted, the policy applies to all purgeable orchestration states. */ orchestrationState?: string; /** * The retention period in days after which the orchestration will be purged automatically */ retentionPeriodInDays: number; } /** * The retention policy settings for the resource */ interface RetentionPolicyPropertiesResponse { /** * The status of the last operation */ provisioningState: string; /** * The orchestration retention policies */ retentionPolicies?: outputs.durabletask.RetentionPolicyDetailsResponse[]; } /** * Details of the Scheduler */ interface SchedulerPropertiesResponse { /** * URL of the durable task scheduler */ endpoint: string; /** * IP allow list for durable task scheduler. Values can be IPv4, IPv6 or CIDR */ ipAllowlist: string[]; /** * The private endpoints exposed by this resource */ privateEndpointConnections: outputs.durabletask.PrivateEndpointConnectionResponse[]; /** * The status of the last operation */ provisioningState: string; /** * Allow or disallow public network access to durable task scheduler */ publicNetworkAccess?: string; /** * SKU of the durable task scheduler */ sku: outputs.durabletask.SchedulerSkuResponse; } /** * The SKU (Stock Keeping Unit) assigned to this durable task scheduler */ interface SchedulerSkuResponse { /** * The SKU capacity. This allows scale out/in for the resource and impacts zone redundancy */ capacity?: number; /** * The name of the SKU */ name: string; /** * Indicates whether the current SKU configuration is zone redundant */ redundancyState: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The properties of Task Hub */ interface TaskHubPropertiesResponse { /** * URL of the durable task scheduler dashboard */ dashboardUrl: string; /** * The status of the last operation */ provisioningState: string; } } export declare namespace dynamics365fraudprotection { /** * An array of administrator user identities */ interface DFPInstanceAdministratorsResponse { /** * An array of administrator user identities. */ members?: string[]; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace easm { /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace edge { /** * Available Solution template Version along with latest revision */ interface AvailableSolutionTemplateVersionResponse { /** * Has this solution template version been configured */ isConfigured: boolean; /** * Latest Configuration Revision */ latestConfigRevision: string; /** * Solution template Version */ solutionTemplateVersion: string; } /** * Capability, to match in Solution Templates & Targets */ interface CapabilityResponse { /** * Description of Capability */ description: string; /** * Name of Capability */ name: string; /** * State of resource */ state?: string; } /** * Component Status */ interface ComponentStatusResponse { /** * Component name */ name?: string; /** * Component status */ status?: string; } /** * Config Template Properties */ interface ConfigTemplatePropertiesResponse { /** * Description of config template */ description: string; /** * Latest config template version */ latestVersion: string; /** * Provisioning state of resource */ provisioningState: string; /** * A unique identifier for the config template, generated by the system */ uniqueIdentifier: string; } /** * Configuration Properties */ interface ConfigurationPropertiesResponse { /** * Provisioning state of resource */ provisioningState: string; } /** * Properties for ConfigurationReference Resource */ interface ConfigurationReferencePropertiesResponse { /** * ArmId of Configuration resource */ configurationResourceId?: string; /** * The status of the last operation. */ provisioningState: string; } /** * Context Properties */ interface ContextPropertiesResponse { /** * List of Capabilities */ capabilities: outputs.edge.CapabilityResponse[]; /** * List of Hierarchies */ hierarchies: outputs.edge.HierarchyResponse[]; /** * Provisioning state of resource */ provisioningState: string; } /** * Deployment Status */ interface DeploymentStatusResponse { /** * Indicates if Instance is deployed */ deployed?: number; /** * The expected running job id */ expectedRunningJobId?: number; /** * Deployment Generation */ generation?: number; /** * The lastModified of the Status */ lastModified?: string; /** * The running job id */ runningJobId?: number; /** * Deployment status */ status?: string; /** * Status details */ statusDetails?: string; /** * Target resource statuses */ targetStatuses?: outputs.edge.TargetStatusResponse[]; } /** * The properties of a Diagnostic resource. */ interface DiagnosticPropertiesResponse { /** * The status of the last operation. */ provisioningState: string; } /** * Dynamic Configuration Properties */ interface DynamicConfigurationPropertiesResponse { /** * Current Version of dynamic configuration */ currentVersion: string; /** * Type of dynamic configuration model */ dynamicConfigurationModel: string; /** * Type of dynamic configuration */ dynamicConfigurationType: string; /** * Provisioning state of resource */ provisioningState: string; } /** * Dynamic Configuration Properties */ interface DynamicConfigurationVersionPropertiesResponse { /** * Provisioning state of resource */ provisioningState: string; /** * Schema Id for configuration */ schemaId: string; /** * Values of configuration version */ values: string; } /** * DynamicSchema Properties */ interface DynamicSchemaPropertiesResponse { /** * Type of configuration model */ configurationModel: string; /** * Type of configuration */ configurationType: string; /** * Provisioning state of resource */ provisioningState: string; } /** * Error Action Properties */ interface ErrorActionResponse { /** * Max tolerated failures */ maxToleratedFailures?: number; /** * Error action mode */ mode?: string; } /** * errorActionResponseProvideDefaults sets the appropriate defaults for ErrorActionResponse */ function errorActionResponseProvideDefaults(val: ErrorActionResponse): ErrorActionResponse; /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.edge.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.edge.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * Execution Properties */ interface ExecutionPropertiesResponse { /** * Provisioning state of resource */ provisioningState: string; /** * Execution specification */ specification?: any; /** * Status of Execution */ status: outputs.edge.ExecutionStatusResponse; /** * Workflow version of execution */ workflowVersionId: string; } /** * Execution Status */ interface ExecutionStatusResponse { /** * target resource statuses */ stageHistory?: outputs.edge.StageStatusResponse[]; /** * Deployment status */ status?: number; /** * status details */ statusMessage?: string; /** * The lastModified timestamp of the Status */ updateTime?: string; } /** * ExecutionV2 Properties */ interface ExecutionV2PropertiesResponse { /** * Provisioning state of resource */ provisioningState: string; /** * ExecutionV2 specification */ specification?: any; /** * Status of ExecutionV2 */ status: outputs.edge.ExecutionV2StatusResponse; /** * Workflow version of ExecutionV2 */ workflowVersionId?: string; } /** * ExecutionV2 Status */ interface ExecutionV2StatusResponse { /** * target resource statuses */ stageHistory?: outputs.edge.StageStatusResponse[]; /** * Deployment status */ status?: number; /** * status details */ statusMessage?: string; /** * The lastModified timestamp of the Status */ updateTime?: string; } /** * The complex type of the extended location. */ interface ExtendedLocationResponse { /** * The name of the extended location. */ name: string; /** * The type of the extended location. */ type: string; } /** * Hierarchy, to tag Sites / Hierarchy Provider nodes with what they represent */ interface HierarchyResponse { /** * Description of Hierarchy */ description: string; /** * Name of Hierarchy */ name: string; } /** * Instance Properties */ interface InstancePropertiesResponse { /** * State of instance */ activeState?: string; /** * Deployment timestamp of instance */ deploymentTimestampEpoch: number; /** * Provisioning state of resource */ provisioningState: string; /** * Reconciliation policy of instance */ reconciliationPolicy?: outputs.edge.ReconciliationPolicyPropertiesResponse; /** * Scope of instance */ solutionScope?: string; /** * Solution version of instance */ solutionVersionId: string; /** * Status of instance */ status: outputs.edge.DeploymentStatusResponse; /** * Target of instance */ targetId: string; } /** * Defines a ReconciliationPolicy */ interface ReconciliationPolicyPropertiesResponse { /** * Policy interval */ interval: string; /** * The state of the ReconciliationPolicy */ state: string; } /** * Schema Properties */ interface SchemaPropertiesResponse { /** * Current Version of schema */ currentVersion: string; /** * Provisioning state of resource */ provisioningState: string; } /** * Schema Reference Properties */ interface SchemaReferencePropertiesResponse { /** * Provisioning state of resource */ provisioningState: string; /** * Schema Id of schema reference */ schemaId: string; } /** * Schema Version Properties */ interface SchemaVersionPropertiesResponse { /** * Provisioning state of resource */ provisioningState: string; /** * Value of schema version */ value: string; } /** * Site address properties */ interface SiteAddressPropertiesResponse { /** * City of the address */ city?: string; /** * Country of the address */ country?: string; /** * Postal or ZIP code of the address */ postalCode?: string; /** * State or province of the address */ stateOrProvince?: string; /** * First line of the street address */ streetAddress1?: string; /** * Second line of the street address */ streetAddress2?: string; } /** * Site properties */ interface SitePropertiesResponse { /** * AddressResource ArmId of Site resource */ addressResourceId?: string; /** * Description of Site resource */ description?: string; /** * displayName of Site resource */ displayName?: string; /** * Provisioning state of last operation */ provisioningState: string; } /** * Site properties */ interface SitePropertiesSitesByServiceGroupResponse { /** * Description of Site resource */ description?: string; /** * displayName of Site resource */ displayName?: string; /** * Key-value pairs for labeling the site resource. */ labels?: { [key: string]: string; }; /** * Provisioning state of last operation */ provisioningState: string; /** * Physical address of the site */ siteAddress?: outputs.edge.SiteAddressPropertiesResponse; } /** * Site Reference Properties */ interface SiteReferencePropertiesResponse { /** * Provisioning State */ provisioningState: string; /** * Azure Resource ID for Site */ siteId: string; } /** * Solution Dependency Context */ interface SolutionDependencyResponse { /** * Solution dependencies */ dependencies?: outputs.edge.SolutionDependencyResponse[]; /** * Solution Instance Name */ solutionInstanceName?: string; /** * Solution Template Version Id */ solutionTemplateVersionId: string; /** * Solution Version Id */ solutionVersionId: string; /** * Target Id */ targetId: string; } /** * Solution Properties */ interface SolutionPropertiesResponse { /** * List of latest revisions for available solution template versions */ availableSolutionTemplateVersions: outputs.edge.AvailableSolutionTemplateVersionResponse[]; /** * Provisioning state of resource */ provisioningState: string; /** * Solution template Id */ solutionTemplateId: string; } /** * Solution Template Properties */ interface SolutionTemplatePropertiesResponse { /** * List of capabilities */ capabilities: string[]; /** * Description of Solution template */ description: string; /** * Flag to enable external validation */ enableExternalValidation?: boolean; /** * Latest solution template version */ latestVersion: string; /** * Provisioning state of resource */ provisioningState: string; /** * State of resource */ state?: string; /** * A unique identifier for the solution template, generated by the system */ uniqueIdentifier: string; } /** * Solution Version Properties */ interface SolutionVersionPropertiesResponse { /** * The type of the latest action performed on this solution version. */ actionType: string; /** * Resolved configuration values */ configuration: string; /** * Error Details if any failure is there */ errorDetails: outputs.edge.ErrorDetailResponse; /** * External validation id */ externalValidationId: string; /** * The URI for tracking the latest action performed on this solution version. */ latestActionTrackingUri: string; /** * Provisioning state of resource */ provisioningState: string; /** * Review id of resolved config for this solution version */ reviewId: string; /** * Revision number of resolved config for this solution version */ revision: number; /** * Solution Dependency Context */ solutionDependencies: outputs.edge.SolutionDependencyResponse[]; /** * Solution instance name */ solutionInstanceName: string; /** * Solution Template Version Id */ solutionTemplateVersionId: string; /** * App components spec */ specification: any; /** * State of solution instance */ state: string; /** * Name of applicable target's display name */ targetDisplayName: string; /** * Configuration on the line level across all solution template versions */ targetLevelConfiguration: string; } /** * Stage Properties */ interface StageSpecResponse { /** * Name of Stage */ name: string; /** * Stage specification */ specification?: any; /** * Task option for the stage */ taskOption?: outputs.edge.TaskOptionResponse; /** * List of tasks in the stage */ tasks?: outputs.edge.TaskSpecResponse[]; } /** * stageSpecResponseProvideDefaults sets the appropriate defaults for StageSpecResponse */ function stageSpecResponseProvideDefaults(val: StageSpecResponse): StageSpecResponse; /** * Result of Stage execution */ interface StageStatusResponse { /** * Error message */ errorMessage?: string; /** * The inputs of the StageHistory, Inputs holds a key-value map of user-defined parameters for the initial stage */ inputs?: any; /** * whether this stage is active or inactive */ isActive?: string; /** * Next stage */ nextstage?: string; /** * The outputs of the StageHistory, it is different as the different input stages. */ outputs?: any; /** * Current stage */ stage?: string; /** * Deployment status */ status?: number; /** * Status message */ statusMessage?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Target Properties */ interface TargetPropertiesResponse { /** * List of capabilities */ capabilities: string[]; /** * ArmId of Context */ contextId: string; /** * Description of target */ description: string; /** * Display name of target */ displayName: string; /** * Hierarchy Level */ hierarchyLevel: string; /** * Provisioning state of resource */ provisioningState: string; /** * Scope of the target resource */ solutionScope?: string; /** * State of resource */ state?: string; /** * Status of target */ status: outputs.edge.DeploymentStatusResponse; /** * target spec */ targetSpecification: any; } /** * Target Status */ interface TargetStatusResponse { /** * Component statuses */ componentStatuses?: outputs.edge.ComponentStatusResponse[]; /** * Target name */ name?: string; /** * Target status */ status?: string; } /** * Task Option Properties */ interface TaskOptionResponse { /** * Parallel worker numbers of the tasks */ concurrency?: number; /** * Error action for the tasks */ errorAction?: outputs.edge.ErrorActionResponse; } /** * taskOptionResponseProvideDefaults sets the appropriate defaults for TaskOptionResponse */ function taskOptionResponseProvideDefaults(val: TaskOptionResponse): TaskOptionResponse; /** * Task Spec */ interface TaskSpecResponse { /** * Name of Task */ name: string; /** * Task specification */ specification: any; /** * Target ARM id */ targetId?: string; } /** * Workflow Properties */ interface WorkflowPropertiesResponse { /** * Provisioning state of resource */ provisioningState: string; /** * Workflow template Id */ workflowTemplateId: string; } /** * Workflow Properties */ interface WorkflowV2PropertiesResponse { /** * Provisioning state of resource */ provisioningState: string; /** * Workflow template Id */ workflowTemplateId: string; } /** * Workflow Version Properties */ interface WorkflowVersionPropertiesResponse { /** * Resolved configuration values */ configuration: string; /** * Provisioning state of resource */ provisioningState: string; /** * Review id of resolved config for this workflow version */ reviewId: string; /** * Revision number of resolved config for this workflow version */ revision: number; /** * Execution specification */ specification?: any; /** * A list of stage specs */ stageSpec: outputs.edge.StageSpecResponse[]; /** * State of workflow version */ state: string; } /** * Workflow Version Properties */ interface WorkflowVersionV2PropertiesResponse { /** * Resolved configuration values */ configuration: string; /** * Provisioning state of resource */ provisioningState: string; /** * Review id of resolved config for this workflow version */ reviewId: string; /** * Revision number of resolved config for this workflow version */ revision: number; /** * Execution specification */ specification?: any; /** * A list of stage specs */ stageSpec: outputs.edge.StageSpecResponse[]; /** * State of workflow version */ state: string; } } export declare namespace edgeorder { /** * Additional Configuration details. */ interface AdditionalConfigurationResponse { /** * Hierarchy of the product which uniquely identifies the configuration. */ hierarchyInformation: outputs.edgeorder.HierarchyInformationResponse; /** * List Provisioning Details for Devices in Additional Config. */ provisioningDetails?: outputs.edgeorder.ProvisioningDetailsResponse[]; /** * Quantity of the product. */ quantity: number; } /** * Address details for an order item. */ interface AddressDetailsResponse { /** * Customer address and contact details. */ forwardAddress: outputs.edgeorder.AddressPropertiesResponse; /** * Return shipping address. */ returnAddress: outputs.edgeorder.AddressPropertiesResponse; } /** * Address Properties. */ interface AddressPropertiesResponse { /** * Type of address based on its usage context. */ addressClassification?: string; /** * Status of address validation. */ addressValidationStatus: string; /** * Contact details for the address. */ contactDetails?: outputs.edgeorder.ContactDetailsResponse; /** * Provisioning state */ provisioningState: string; /** * Shipping details for the address. */ shippingAddress?: outputs.edgeorder.ShippingAddressResponse; } /** * Availability information of a product system. */ interface AvailabilityInformationResponse { /** * Current availability stage of the product. */ availabilityStage: string; /** * Reason why the product is disabled. */ disabledReason: string; /** * Message for why the product is disabled. */ disabledReasonMessage: string; } /** * Holds billing meter details for each type of billing. */ interface BillingMeterDetailsResponse { /** * Frequency of recurrence. */ frequency: string; /** * Represents MeterDetails. */ meterDetails: outputs.edgeorder.Pav2MeterDetailsResponse | outputs.edgeorder.PurchaseMeterDetailsResponse; /** * Represents Metering type (eg one-time or recurrent). */ meteringType: string; /** * Represents Billing type name. */ name: string; /** * Represent Term Type details. */ termTypeDetails: outputs.edgeorder.TermTypeDetailsResponse; } /** * Category related properties of a child configuration. */ interface CategoryInformationResponse { /** * Category display name of the child configuration. */ categoryDisplayName?: string; /** * Category name of the child configuration. */ categoryName?: string; /** * Description text for the category. */ description?: string; /** * Links for the category. */ links?: outputs.edgeorder.LinkResponse[]; } /** * Child configuration object. */ interface ChildConfigurationResponse { /** * Availability information of the product system. */ availabilityInformation: outputs.edgeorder.AvailabilityInformationResponse; /** * Child configuration type. */ childConfigurationType: string; /** * Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter. */ childConfigurationTypes: string[]; /** * Cost information for the product system. */ costInformation: outputs.edgeorder.CostInformationResponse; /** * Description related to the product system. */ description: outputs.edgeorder.DescriptionResponse; /** * Dimensions of the configuration. */ dimensions: outputs.edgeorder.DimensionsResponse; /** * Display Name for the product system. */ displayName: string; /** * List of filters supported for a product. */ filterableProperties: outputs.edgeorder.FilterablePropertyResponse[]; /** * The entity responsible for fulfillment of the item at the given hierarchy level. */ fulfilledBy: string; /** * Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration. */ groupedChildConfigurations: outputs.edgeorder.GroupedChildConfigurationsResponse[]; /** * Hierarchy information of a product. */ hierarchyInformation: outputs.edgeorder.HierarchyInformationResponse; /** * Image information for the product system. */ imageInformation: outputs.edgeorder.ImageInformationResponse[]; /** * Flag to indicate if the child configuration is part of the base configuration, which means the customer need not pass this configuration in OptInAdditionalConfigurations while placing an order, it will be shipped by default. */ isPartOfBaseConfiguration: boolean; /** * Maximum quantity a customer can order while choosing this configuration. */ maximumQuantity: number; /** * Minimum quantity a customer can order while choosing this configuration. */ minimumQuantity: number; /** * Determining nature of provisioning that the configuration supports. */ provisioningSupport: string; /** * Specifications of the configuration. */ specifications: outputs.edgeorder.SpecificationResponse[]; /** * The Term Commitment Durations that are supported for a configuration. */ supportedTermCommitmentDurations: string[]; } /** * Device details for configuration. */ interface ConfigurationDeviceDetailsResponse { /** * List of device details. */ deviceDetails: outputs.edgeorder.DeviceDetailsResponse[]; /** * Display details of the product. */ displayInfo?: outputs.edgeorder.DisplayInfoResponse; /** * Hierarchy of the product which uniquely identifies the configuration. */ hierarchyInformation: outputs.edgeorder.HierarchyInformationResponse; /** * Identification type of the configuration. */ identificationType: string; /** * Quantity of the product. */ quantity: number; /** * Term Commitment Information of the Device. */ termCommitmentInformation: outputs.edgeorder.TermCommitmentInformationResponse; } /** * configurationDeviceDetailsResponseProvideDefaults sets the appropriate defaults for ConfigurationDeviceDetailsResponse */ function configurationDeviceDetailsResponseProvideDefaults(val: ConfigurationDeviceDetailsResponse): ConfigurationDeviceDetailsResponse; /** * Configuration object. */ interface ConfigurationResponse { /** * Availability information of the product system. */ availabilityInformation: outputs.edgeorder.AvailabilityInformationResponse; /** * Different types of child configurations which exist for this configuration, these can be used to populate the child configuration filter. */ childConfigurationTypes: string[]; /** * Cost information for the product system. */ costInformation: outputs.edgeorder.CostInformationResponse; /** * Description related to the product system. */ description: outputs.edgeorder.DescriptionResponse; /** * Dimensions of the configuration. */ dimensions: outputs.edgeorder.DimensionsResponse; /** * Display Name for the product system. */ displayName: string; /** * List of filters supported for a product. */ filterableProperties: outputs.edgeorder.FilterablePropertyResponse[]; /** * The entity responsible for fulfillment of the item at the given hierarchy level. */ fulfilledBy: string; /** * Child configurations present for the configuration after applying child configuration filter, grouped by the category name of the child configuration. */ groupedChildConfigurations: outputs.edgeorder.GroupedChildConfigurationsResponse[]; /** * Hierarchy information of a product. */ hierarchyInformation: outputs.edgeorder.HierarchyInformationResponse; /** * Image information for the product system. */ imageInformation: outputs.edgeorder.ImageInformationResponse[]; /** * Determining nature of provisioning that the configuration supports. */ provisioningSupport: string; /** * Specifications of the configuration. */ specifications: outputs.edgeorder.SpecificationResponse[]; /** * The Term Commitment Durations that are supported for a configuration. */ supportedTermCommitmentDurations: string[]; } /** * Contact Details. */ interface ContactDetailsResponse { /** * Contact name of the person. */ contactName?: string; /** * List of Email-ids to be notified about job progress. */ emailList?: string[]; /** * Mobile number of the contact person. */ mobile?: string; /** * Phone number of the contact person. */ phone?: string; /** * Phone extension number of the contact person. */ phoneExtension?: string; } /** * Cost information for the product system. */ interface CostInformationResponse { /** * Default url to display billing information. */ billingInfoUrl: string; /** * Details on the various billing aspects for the product system. */ billingMeterDetails: outputs.edgeorder.BillingMeterDetailsResponse[]; } /** * Description related properties of a product system. */ interface DescriptionResponse { /** * Attributes for the product system. */ attributes: string[]; /** * Type of description. */ descriptionType: string; /** * Keywords for the product system. */ keywords: string[]; /** * Links for the product system. */ links: outputs.edgeorder.LinkResponse[]; /** * Long description of the product system. */ longDescription: string; /** * Short description of the product system. */ shortDescription: string; } /** * Device details. */ interface DeviceDetailsResponse { /** * Device serial number to be displayed. */ displaySerialNumber: string; /** * Management Resource Id. */ managementResourceId: string; /** * Management Resource Tenant ID. */ managementResourceTenantId: string; /** * Provisioning Details for the device. */ provisioningDetails: outputs.edgeorder.ProvisioningDetailsResponse; /** * Determining nature of provisioning that the configuration supports. */ provisioningSupport: string; /** * Device serial number. */ serialNumber: string; } /** * deviceDetailsResponseProvideDefaults sets the appropriate defaults for DeviceDetailsResponse */ function deviceDetailsResponseProvideDefaults(val: DeviceDetailsResponse): DeviceDetailsResponse; /** * Proof of possession details. */ interface DevicePresenceVerificationDetailsResponse { /** * Insights on current status. */ message: string; /** * Proof of possession status. */ status: string; } /** * Dimensions of a configuration. */ interface DimensionsResponse { /** * Depth of the device. */ depth: number; /** * Height of the device. */ height: number; /** * Length of the device. */ length: number; /** * Unit for the dimensions of length, height and width. */ lengthHeightUnit: string; /** * Weight of the device. */ weight: number; /** * Unit for the dimensions of weight. */ weightUnit: string; /** * Width of the device. */ width: number; } /** * Describes product display information. */ interface DisplayInfoResponse { /** * Configuration display name. */ configurationDisplayName: string; /** * Product family display name. */ productFamilyDisplayName: string; } /** * Preferences related to the double encryption. */ interface EncryptionPreferencesResponse { /** * Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured. */ doubleEncryptionStatus?: string; } /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.edgeorder.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.edgeorder.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * Different types of filters supported and its values. */ interface FilterablePropertyResponse { /** * Values to be filtered. */ supportedValues: string[]; /** * Type of product filter. */ type: string; } /** * Forward shipment details. */ interface ForwardShippingDetailsResponse { /** * Carrier Name for display purpose. Not to be used for any processing. */ carrierDisplayName: string; /** * Name of the carrier. */ carrierName: string; /** * TrackingId of the package. */ trackingId: string; /** * TrackingUrl of the package. */ trackingUrl: string; } /** * Grouped child configuration object. */ interface GroupedChildConfigurationsResponse { /** * Category information. */ categoryInformation: outputs.edgeorder.CategoryInformationResponse; /** * List of child configurations. */ childConfigurations: outputs.edgeorder.ChildConfigurationResponse[]; } /** * Holds details about product hierarchy information. */ interface HierarchyInformationResponse { /** * Represents Model Display Name. */ configurationIdDisplayName?: string; /** * Represents configuration name that uniquely identifies configuration. */ configurationName?: string; /** * Represents product family name that uniquely identifies product family. */ productFamilyName?: string; /** * Represents product line name that uniquely identifies product line. */ productLineName?: string; /** * Represents product name that uniquely identifies product. */ productName?: string; } /** * Image for the product. */ interface ImageInformationResponse { /** * Type of the image. */ imageType: string; /** * Url of the image. */ imageUrl: string; } /** * Returns link related to the product. */ interface LinkResponse { /** * Type of link. */ linkType: string; /** * Url of the link. */ linkUrl: string; } /** * Management resource preference to link device. */ interface ManagementResourcePreferencesResponse { /** * Customer preferred Management resource ARM ID. */ preferredManagementResourceId?: string; } /** * Notification preference for a job stage. */ interface NotificationPreferenceResponse { /** * Notification is required or not. */ sendNotification: boolean; /** * Name of the stage. */ stageName: string; } /** * Order item details. */ interface OrderItemDetailsResponse { /** * Cancellation reason. */ cancellationReason: string; /** * Describes whether the order item is cancellable or not. */ cancellationStatus: string; /** * Current Order item Status. */ currentStage: outputs.edgeorder.StageDetailsResponse; /** * Describes whether the order item is deletable or not. */ deletionStatus: string; /** * Top level error for the job. */ error: outputs.edgeorder.ErrorDetailResponse; /** * Forward Package Shipping details. */ forwardShippingDetails: outputs.edgeorder.ForwardShippingDetailsResponse; /** * List of parent RP details supported for configuration. */ managementRpDetailsList: outputs.edgeorder.ResourceProviderDetailsResponse[]; /** * Additional notification email list. */ notificationEmailList?: string[]; /** * Defines the mode of the Order item. */ orderItemMode?: string; /** * Order item status history. */ orderItemStageHistory: outputs.edgeorder.StageDetailsResponse[]; /** * Order item type. */ orderItemType: string; /** * Customer notification Preferences. */ preferences?: outputs.edgeorder.PreferencesResponse; /** * Represents product details. */ productDetails: outputs.edgeorder.ProductDetailsResponse; /** * Return reason. */ returnReason: string; /** * Describes whether the order item is returnable or not. */ returnStatus: string; /** * Reverse Package Shipping details. */ reverseShippingDetails: outputs.edgeorder.ReverseShippingDetailsResponse; /** * Site Related Details. */ siteDetails?: outputs.edgeorder.SiteDetailsResponse; } /** * orderItemDetailsResponseProvideDefaults sets the appropriate defaults for OrderItemDetailsResponse */ function orderItemDetailsResponseProvideDefaults(val: OrderItemDetailsResponse): OrderItemDetailsResponse; /** * Billing type PAV2 meter details. */ interface Pav2MeterDetailsResponse { /** * Represents billing type. * Expected value is 'Pav2'. */ billingType: "Pav2"; /** * Charging type. */ chargingType: string; /** * Validation status of requested data center and transport. */ meterGuid: string; /** * Billing unit applicable for Pav2 billing. */ multiplier: number; } /** * Preferences related to the order. */ interface PreferencesResponse { /** * Preferences related to the Encryption. */ encryptionPreferences?: outputs.edgeorder.EncryptionPreferencesResponse; /** * Preferences related to the Management resource. */ managementResourcePreferences?: outputs.edgeorder.ManagementResourcePreferencesResponse; /** * Notification preferences. */ notificationPreferences?: outputs.edgeorder.NotificationPreferenceResponse[]; /** * Preferences related to the Term commitment. */ termCommitmentPreferences?: outputs.edgeorder.TermCommitmentPreferencesResponse; /** * Preferences related to the shipment logistics of the order. */ transportPreferences?: outputs.edgeorder.TransportPreferencesResponse; } /** * Represents product details. */ interface ProductDetailsResponse { /** * Details of all child configurations that are part of the order item. */ childConfigurationDeviceDetails: outputs.edgeorder.ConfigurationDeviceDetailsResponse[]; /** * Display details of the product. */ displayInfo?: outputs.edgeorder.DisplayInfoResponse; /** * Hierarchy of the product which uniquely identifies the product. */ hierarchyInformation: outputs.edgeorder.HierarchyInformationResponse; /** * Identification type of the configuration. */ identificationType: string; /** * List of additional configurations customer wants in the order item apart from the ones included in the base configuration. */ optInAdditionalConfigurations?: outputs.edgeorder.AdditionalConfigurationResponse[]; /** * Device details of the parent configuration. */ parentDeviceDetails: outputs.edgeorder.DeviceDetailsResponse; /** * Device Provisioning Details for Parent. */ parentProvisioningDetails?: outputs.edgeorder.ProvisioningDetailsResponse; /** * Double encryption status of the configuration. Read-only field. */ productDoubleEncryptionStatus: string; /** * Term Commitment Information of the Device. */ termCommitmentInformation: outputs.edgeorder.TermCommitmentInformationResponse; } /** * productDetailsResponseProvideDefaults sets the appropriate defaults for ProductDetailsResponse */ function productDetailsResponseProvideDefaults(val: ProductDetailsResponse): ProductDetailsResponse; /** * Product Family. */ interface ProductFamilyResponse { /** * Availability information of the product system. */ availabilityInformation: outputs.edgeorder.AvailabilityInformationResponse; /** * Cost information for the product system. */ costInformation: outputs.edgeorder.CostInformationResponse; /** * Description related to the product system. */ description: outputs.edgeorder.DescriptionResponse; /** * Display Name for the product system. */ displayName: string; /** * List of filters supported for a product. */ filterableProperties: outputs.edgeorder.FilterablePropertyResponse[]; /** * The entity responsible for fulfillment of the item at the given hierarchy level. */ fulfilledBy: string; /** * Hierarchy information of a product. */ hierarchyInformation: outputs.edgeorder.HierarchyInformationResponse; /** * Image information for the product system. */ imageInformation: outputs.edgeorder.ImageInformationResponse[]; /** * List of product lines supported in the product family. */ productLines: outputs.edgeorder.ProductLineResponse[]; /** * Contains details related to resource provider. */ resourceProviderDetails?: outputs.edgeorder.ResourceProviderDetailsResponse[]; } /** * Product line. */ interface ProductLineResponse { /** * Availability information of the product system. */ availabilityInformation: outputs.edgeorder.AvailabilityInformationResponse; /** * Cost information for the product system. */ costInformation: outputs.edgeorder.CostInformationResponse; /** * Description related to the product system. */ description: outputs.edgeorder.DescriptionResponse; /** * Display Name for the product system. */ displayName: string; /** * List of filters supported for a product. */ filterableProperties: outputs.edgeorder.FilterablePropertyResponse[]; /** * The entity responsible for fulfillment of the item at the given hierarchy level. */ fulfilledBy: string; /** * Hierarchy information of a product. */ hierarchyInformation: outputs.edgeorder.HierarchyInformationResponse; /** * Image information for the product system. */ imageInformation: outputs.edgeorder.ImageInformationResponse[]; /** * List of products in the product line. */ products: outputs.edgeorder.ProductResponse[]; } /** * Represents a product. */ interface ProductResponse { /** * Availability information of the product system. */ availabilityInformation: outputs.edgeorder.AvailabilityInformationResponse; /** * List of configurations for the product. */ configurations: outputs.edgeorder.ConfigurationResponse[]; /** * Cost information for the product system. */ costInformation: outputs.edgeorder.CostInformationResponse; /** * Description related to the product system. */ description: outputs.edgeorder.DescriptionResponse; /** * Display Name for the product system. */ displayName: string; /** * List of filters supported for a product. */ filterableProperties: outputs.edgeorder.FilterablePropertyResponse[]; /** * The entity responsible for fulfillment of the item at the given hierarchy level. */ fulfilledBy: string; /** * Hierarchy information of a product. */ hierarchyInformation: outputs.edgeorder.HierarchyInformationResponse; /** * Image information for the product system. */ imageInformation: outputs.edgeorder.ImageInformationResponse[]; } /** * Details Related To Provision Resource. */ interface ProvisioningDetailsResponse { /** * Auto Provisioning Details. */ autoProvisioningStatus?: string; /** * Proof of possession details. */ devicePresenceVerification?: outputs.edgeorder.DevicePresenceVerificationDetailsResponse; /** * Management Resource ArmId. */ managementResourceArmId?: string; /** * Provisioning Resource Arm ID. */ provisioningArmId?: string; /** * Provisioning End Point. */ provisioningEndPoint?: string; /** * Quantity of the devices. */ quantity?: number; /** * Arc Enabled Resource Arm id. */ readyToConnectArmId?: string; /** * Serial Number for the Device. */ serialNumber?: string; /** * Unique Identity for a Device. */ uniqueDeviceIdentifier: string; /** * Vendor Name for the Device , (for 1P devices - Microsoft). */ vendorName?: string; } /** * provisioningDetailsResponseProvideDefaults sets the appropriate defaults for ProvisioningDetailsResponse */ function provisioningDetailsResponseProvideDefaults(val: ProvisioningDetailsResponse): ProvisioningDetailsResponse; /** * Billing type Purchase meter details. */ interface PurchaseMeterDetailsResponse { /** * Represents billing type. * Expected value is 'Purchase'. */ billingType: "Purchase"; /** * Charging type. */ chargingType: string; /** * Billing unit applicable for Pav2 billing. */ multiplier: number; /** * Product Id. */ productId: string; /** * Sku Id. */ skuId: string; /** * Term Id. */ termId: string; } /** * Msi identity details of the resource */ interface ResourceIdentityResponse { /** * Service Principal Id backing the Msi */ principalId: string; /** * Home Tenant Id */ tenantId: string; /** * Identity type */ type?: string; /** * User Assigned Identities */ userAssignedIdentities?: { [key: string]: outputs.edgeorder.UserAssignedIdentityResponse; }; } /** * resourceIdentityResponseProvideDefaults sets the appropriate defaults for ResourceIdentityResponse */ function resourceIdentityResponseProvideDefaults(val: ResourceIdentityResponse): ResourceIdentityResponse; /** * Management RP details. */ interface ResourceProviderDetailsResponse { /** * Resource provider namespace. */ resourceProviderNamespace: string; } /** * Reverse shipment details. */ interface ReverseShippingDetailsResponse { /** * Carrier Name for display purpose. Not to be used for any processing. */ carrierDisplayName: string; /** * Name of the carrier. */ carrierName: string; /** * SAS key to download the reverse shipment label of the package. */ sasKeyForLabel: string; /** * TrackingId of the package. */ trackingId: string; /** * TrackingUrl of the package. */ trackingUrl: string; } /** * Shipping address where customer wishes to receive the device. */ interface ShippingAddressResponse { /** * Type of address. */ addressType?: string; /** * Name of the City. */ city?: string; /** * Name of the company. */ companyName?: string; /** * Name of the Country. */ country: string; /** * Postal code. */ postalCode?: string; /** * Name of the State or Province. */ stateOrProvince?: string; /** * Street Address line 1. */ streetAddress1?: string; /** * Street Address line 2. */ streetAddress2?: string; /** * Street Address line 3. */ streetAddress3?: string; /** * Extended Zip Code. */ zipExtendedCode?: string; } /** * Represents Site Related Details. */ interface SiteDetailsResponse { /** * Unique Id, Identifying A Site. */ siteId: string; } /** * Specification of the configurations. */ interface SpecificationResponse { /** * Name of the specification. */ name: string; /** * Value of the specification. */ value: string; } /** * Resource stage details. */ interface StageDetailsResponse { /** * Display name of the resource stage. */ displayName: string; /** * Stage name. */ stageName: string; /** * Stage status. */ stageStatus: string; /** * Stage start time. */ startTime: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Term Commitment Information. */ interface TermCommitmentInformationResponse { /** * Number of Days Pending for Term Commitment */ pendingDaysForTerm: number; /** * Term Commitment Type */ termCommitmentType: string; /** * Term Commitment Duration. Currently Supporting P365D, P1095D */ termCommitmentTypeDuration: string; } /** * termCommitmentInformationResponseProvideDefaults sets the appropriate defaults for TermCommitmentInformationResponse */ function termCommitmentInformationResponseProvideDefaults(val: TermCommitmentInformationResponse): TermCommitmentInformationResponse; /** * Term Commitment preference received from customer. */ interface TermCommitmentPreferencesResponse { /** * Customer preferred Term Duration. */ preferredTermCommitmentDuration?: string; /** * Term Commitment Type */ preferredTermCommitmentType: string; } /** * Holds details about term type and duration. */ interface TermTypeDetailsResponse { /** * Term Commitment Type */ termType: string; /** * Duration for the term type. */ termTypeDuration: string; } /** * Preferences related to the shipment logistics of the sku. */ interface TransportPreferencesResponse { /** * Indicates Shipment Logistics type that the customer preferred. */ preferredShipmentType: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace education { /** * The amount. */ interface AmountResponse { /** * The type of currency being used for the value. */ currency?: string; /** * Amount value. */ value?: number; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace elastic { /** * Connected Partner Resource Properties */ interface ConnectedPartnerResourcePropertiesResponse { /** * The azure resource Id of the deployment. */ azureResourceId?: string; /** * The location of the deployment. */ location?: string; /** * Elastic deployment name */ partnerDeploymentName?: string; /** * Deployment URL of the elasticsearch in Elastic cloud deployment. */ partnerDeploymentUri?: string; } /** * Connected Partner Resources List Format */ interface ConnectedPartnerResourcesListFormatResponse { /** * Connected Partner Resource Properties */ properties?: outputs.elastic.ConnectedPartnerResourcePropertiesResponse; } /** * Details of the user's elastic deployment associated with the monitor resource. */ interface ElasticCloudDeploymentResponse { /** * Associated Azure subscription Id for the elastic deployment. */ azureSubscriptionId: string; /** * Elastic deployment Id */ deploymentId: string; /** * Region where Deployment at Elastic side took place. */ elasticsearchRegion: string; /** * Elasticsearch ingestion endpoint of the Elastic deployment. */ elasticsearchServiceUrl: string; /** * Kibana endpoint of the Elastic deployment. */ kibanaServiceUrl: string; /** * Kibana dashboard sso URL of the Elastic deployment. */ kibanaSsoUrl: string; /** * Elastic deployment name */ name: string; } /** * Details of the user's elastic account. */ interface ElasticCloudUserResponse { /** * Elastic cloud default dashboard sso URL of the Elastic user account. */ elasticCloudSsoDefaultUrl: string; /** * Email of the Elastic User Account. */ emailAddress: string; /** * User Id of the elastic account of the User. */ id: string; } /** * The properties of Azure Subscription ID to which the Organization of the logged in user belongs and gets billed into. */ interface ElasticOrganizationToAzureSubscriptionMappingResponsePropertiesResponse { /** * The Azure Subscription ID to which the Organization belongs and gets billed into. This is empty for a new user OR a user without an Elastic Organization. */ billedAzureSubscriptionId?: string; /** * The Elastic Organization Id. */ elasticOrganizationId?: string; /** * The Elastic Organization Name. */ elasticOrganizationName?: string; /** * Marketplace SaaS Info of the resource. */ marketplaceSaasInfo: outputs.elastic.MarketplaceSaaSInfoResponse; } /** * Elastic Resource Properties. */ interface ElasticPropertiesResponse { /** * Details of the elastic cloud deployment. */ elasticCloudDeployment?: outputs.elastic.ElasticCloudDeploymentResponse; /** * Details of the user's elastic account. */ elasticCloudUser?: outputs.elastic.ElasticCloudUserResponse; } /** * Elastic traffic filter object */ interface ElasticTrafficFilterResponse { /** * Description of the elastic filter */ description?: string; /** * Id of the elastic filter */ id?: string; /** * IncludeByDefault for the elastic filter */ includeByDefault?: boolean; /** * Name of the elastic filter */ name?: string; /** * Region of the elastic filter */ region?: string; /** * Rules in the elastic filter */ rules?: outputs.elastic.ElasticTrafficFilterRuleResponse[]; /** * Type of the elastic filter */ type?: string; } /** * Elastic traffic filter rule object */ interface ElasticTrafficFilterRuleResponse { /** * Guid of Private Endpoint in the elastic filter rule */ azureEndpointGuid?: string; /** * Name of the Private Endpoint in the elastic filter rule */ azureEndpointName?: string; /** * Description of the elastic filter rule */ description?: string; /** * Id of the elastic filter rule */ id?: string; /** * IP of the elastic filter rule */ source?: string; } /** * The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored. */ interface FilteringTagResponse { /** * Valid actions for a filtering tag. */ action?: string; /** * The name (also known as the key) of the tag. */ name?: string; /** * The value of the tag. */ value?: string; } /** * Identity properties. */ interface IdentityPropertiesResponse { /** * The identity ID. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * Managed identity type. */ type?: string; } /** * Set of rules for sending logs for the Monitor resource. */ interface LogRulesResponse { /** * List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured. If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags. */ filteringTags?: outputs.elastic.FilteringTagResponse[]; /** * Flag specifying if AAD logs should be sent for the Monitor resource. */ sendAadLogs?: boolean; /** * Flag specifying if activity logs from Azure resources should be sent for the Monitor resource. */ sendActivityLogs?: boolean; /** * Flag specifying if subscription logs should be sent for the Monitor resource. */ sendSubscriptionLogs?: boolean; } /** * Marketplace SAAS Info of the resource. */ interface MarketplaceSaaSInfoResponse { /** * The Azure Subscription ID to which the Marketplace Subscription belongs and gets billed into. */ billedAzureSubscriptionId?: string; /** * Marketplace Subscription Details: SAAS Name */ marketplaceName?: string; /** * Marketplace Subscription Details: Resource URI */ marketplaceResourceId?: string; /** * Marketplace Subscription Details: SaaS Subscription Status */ marketplaceStatus?: string; /** * Marketplace Subscription */ marketplaceSubscription?: outputs.elastic.MarketplaceSaaSInfoResponseMarketplaceSubscription; /** * Flag specifying if the Marketplace status is subscribed or not. */ subscribed?: boolean; } /** * Marketplace Subscription */ interface MarketplaceSaaSInfoResponseMarketplaceSubscription { /** * Marketplace Subscription Id. This is a GUID-formatted string. */ id?: string; } /** * Properties specific to the monitor resource. */ interface MonitorPropertiesResponse { /** * Elastic cloud properties. */ elasticProperties?: outputs.elastic.ElasticPropertiesResponse; /** * Flag to determine if User API Key has to be generated and shared. */ generateApiKey?: boolean; liftrResourceCategory: string; /** * The priority of the resource. */ liftrResourcePreference: number; /** * Flag specifying if the resource monitoring is enabled or disabled. */ monitoringStatus?: string; /** * Plan details of the monitor resource. */ planDetails?: outputs.elastic.PlanDetailsResponse; /** * Provisioning state of the monitor resource. */ provisioningState?: string; /** * Status of Azure Subscription where Marketplace SaaS is located. */ saaSAzureSubscriptionStatus?: string; /** * A unique identifier associated with the campaign. */ sourceCampaignId?: string; /** * Name of the marketing campaign. */ sourceCampaignName?: string; /** * State of the Azure Subscription containing the monitor resource */ subscriptionState?: string; /** * Version of elastic of the monitor resource */ version?: string; } /** * The properties of a resource currently being monitored by the Elastic monitor resource. */ interface MonitoredResourceResponse { /** * The ARM id of the resource. */ id?: string; /** * Reason for why the resource is sending logs (or why it is not sending). */ reasonForLogsStatus?: string; /** * Flag indicating the status of the resource for sending logs operation to Elastic. */ sendingLogs?: string; } /** * The list of subscriptions and it's monitoring status by current Elastic monitor. */ interface MonitoredSubscriptionResponse { /** * The reason of not monitoring the subscription. */ error?: string; /** * The state of monitoring. */ status?: string; /** * The subscriptionId to be monitored. */ subscriptionId?: string; /** * Definition of the properties for a TagRules resource. */ tagRules?: outputs.elastic.MonitoringTagRulesPropertiesResponse; } /** * Definition of the properties for a TagRules resource. */ interface MonitoringTagRulesPropertiesResponse { /** * Rules for sending logs. */ logRules?: outputs.elastic.LogRulesResponse; /** * Provisioning state of the monitoring tag rules. */ provisioningState: string; } /** * Definition of the properties for a TagRules resource. */ interface MonitoringTagRulesPropertiesTagRuleResponse { /** * Rules for sending logs. */ logRules?: outputs.elastic.LogRulesResponse; /** * Provisioning state of the monitoring tag rules. */ provisioningState?: string; } /** * Open AI Integration details. */ interface OpenAIIntegrationPropertiesResponse { /** * Value of API key for Open AI resource */ key?: string; /** * Last Update Timestamp for key updation */ lastRefreshAt: string; /** * The API endpoint for Open AI resource */ openAIResourceEndpoint?: string; /** * The resource name of Open AI resource */ openAIResourceId?: string; } /** * Status of the OpenAI Integration */ interface OpenAIIntegrationStatusResponsePropertiesResponse { /** * Status of the OpenAI Integration */ status?: string; } /** * Partner Billing details associated with the resource. */ interface PartnerBillingEntityResponse { /** * The Elastic Organization Id. */ id?: string; /** * The Elastic Organization Name. */ name?: string; /** * Link to the elastic organization page */ partnerEntityUri?: string; } /** * Plan details of the monitor resource. */ interface PlanDetailsResponse { /** * Offer ID of the plan */ offerID?: string; /** * Plan ID */ planID?: string; /** * Plan Name */ planName?: string; /** * Publisher ID of the plan */ publisherID?: string; /** * Term ID of the plan */ termID?: string; } /** * Microsoft.Elastic SKU. */ interface ResourceSkuResponse { /** * Name of the SKU. */ name: string; } /** * The request to update subscriptions needed to be monitored by the Elastic monitor resource. */ interface SubscriptionListResponse { /** * List of subscriptions and the state of the monitoring. */ monitoredSubscriptionList?: outputs.elastic.MonitoredSubscriptionResponse[]; /** * Provisioning State of the resource */ provisioningState: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } interface UserApiKeyResponsePropertiesResponse { /** * The User Api Key Generated based on GenerateApiKey flag. This is applicable for non-Portal clients only. */ apiKey?: string; } /** * The vm resource properties that is currently being monitored by the Elastic monitor resource. */ interface VMResourcesResponse { /** * The ARM id of the VM resource. */ vmResourceId?: string; } } export declare namespace elasticsan { /** * Encryption identity for the volume group. */ interface EncryptionIdentityResponse { /** * Resource identifier of the UserAssigned identity to be associated with server-side encryption on the volume group. */ encryptionUserAssignedIdentity?: string; } /** * The encryption settings on the volume group. */ interface EncryptionPropertiesResponse { /** * The identity to be used with service-side encryption at rest. */ encryptionIdentity?: outputs.elasticsan.EncryptionIdentityResponse; /** * Properties provided by key vault. */ keyVaultProperties?: outputs.elasticsan.KeyVaultPropertiesResponse; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The identity type. */ type: string; /** * Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this volume group. The key is the ARM resource identifier of the identity. */ userAssignedIdentities?: { [key: string]: outputs.elasticsan.UserAssignedIdentityResponse; }; } /** * Iscsi target information */ interface IscsiTargetInfoResponse { /** * State of the operation on the resource. */ provisioningState: string; /** * Operational status of the iSCSI Target. */ status?: string; /** * iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server". */ targetIqn: string; /** * iSCSI Target Portal Host Name */ targetPortalHostname: string; /** * iSCSI Target Portal Port */ targetPortalPort: number; } /** * Properties of key vault. */ interface KeyVaultPropertiesResponse { /** * This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. */ currentVersionedKeyExpirationTimestamp: string; /** * The object identifier of the current versioned Key Vault Key in use. */ currentVersionedKeyIdentifier: string; /** * The name of KeyVault key. */ keyName?: string; /** * The Uri of KeyVault. */ keyVaultUri?: string; /** * The version of KeyVault key. */ keyVersion?: string; /** * Timestamp of last rotation of the Key Vault Key. */ lastKeyRotationTimestamp: string; } /** * Parent resource information. */ interface ManagedByInfoResponse { /** * Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use. */ resourceId?: string; } /** * A set of rules governing the network accessibility. */ interface NetworkRuleSetResponse { /** * The list of virtual network rules. */ virtualNetworkRules?: outputs.elasticsan.VirtualNetworkRuleResponse[]; } /** * Response for PrivateEndpoint Connection object */ interface PrivateEndpointConnectionResponse { /** * List of resources private endpoint is mapped */ groupIds?: string[]; /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * Private Endpoint resource */ privateEndpoint?: outputs.elasticsan.PrivateEndpointResponse; /** * Private Link Service Connection State. */ privateLinkServiceConnectionState: outputs.elasticsan.PrivateLinkServiceConnectionStateResponse; /** * Provisioning State of Private Endpoint connection resource */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.elasticsan.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Response for PrivateEndpoint */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint */ id: string; } /** * Response for Private Link Service Connection state */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * The SKU name. Required for account creation; optional for update. */ interface SkuResponse { /** * The sku name. */ name: string; /** * The sku tier. */ tier?: string; } /** * Data used when creating a volume snapshot. */ interface SnapshotCreationDataResponse { /** * Fully qualified resource ID of the volume. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}" */ sourceId: string; } /** * Data source used when creating the volume. */ interface SourceCreationDataResponse { /** * This enumerates the possible sources of a volume creation. */ createSource?: string; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ sourceId?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * UserAssignedIdentity for the resource. */ interface UserAssignedIdentityResponse { /** * The client ID of the identity. */ clientId: string; /** * The principal ID of the identity. */ principalId: string; } /** * Virtual Network rule. */ interface VirtualNetworkRuleResponse { /** * The action of virtual network rule. */ action?: string; /** * Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. */ virtualNetworkResourceId: string; } /** * virtualNetworkRuleResponseProvideDefaults sets the appropriate defaults for VirtualNetworkRuleResponse */ function virtualNetworkRuleResponseProvideDefaults(val: VirtualNetworkRuleResponse): VirtualNetworkRuleResponse; } export declare namespace engagementfabric { /** * EngagementFabric channel description */ interface ChannelTypeDescriptionResponse { /** * Text description for the channel */ channelDescription?: string; /** * All the available functions for the channel */ channelFunctions?: string[]; /** * Channel type */ channelType?: string; } /** * The description of the EngagementFabric account key */ interface KeyDescriptionResponse { /** * The name of the key */ name: string; /** * The rank of the key */ rank: string; /** * The value of the key */ value: string; } /** * The EngagementFabric SKU */ interface SKUResponse { /** * The name of the SKU */ name: string; /** * The price tier of the SKU */ tier?: string; } } export declare namespace enterpriseknowledgegraph { /** * The parameters to provide for the EnterpriseKnowledgeGraph. */ interface EnterpriseKnowledgeGraphPropertiesResponse { /** * The description of the EnterpriseKnowledgeGraph */ description?: string; /** * Specifies the metadata of the resource. */ metadata?: any; /** * The state of EnterpriseKnowledgeGraph provisioning */ provisioningState?: string; } /** * The SKU of the EnterpriseKnowledgeGraph service account. */ interface SkuResponse { /** * The sku name */ name: string; } } export declare namespace eventgrid { /** * Information about the azure function destination for an event subscription. */ interface AzureFunctionEventSubscriptionDestinationResponse { /** * Delivery attribute details. */ deliveryAttributeMappings?: (outputs.eventgrid.DynamicDeliveryAttributeMappingResponse | outputs.eventgrid.StaticDeliveryAttributeMappingResponse)[]; /** * Type of the endpoint for the event subscription destination. * Expected value is 'AzureFunction'. */ endpointType: "AzureFunction"; /** * Maximum number of events per batch. */ maxEventsPerBatch?: number; /** * Preferred batch size in Kilobytes. */ preferredBatchSizeInKilobytes?: number; /** * The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription. */ resourceId?: string; } /** * azureFunctionEventSubscriptionDestinationResponseProvideDefaults sets the appropriate defaults for AzureFunctionEventSubscriptionDestinationResponse */ function azureFunctionEventSubscriptionDestinationResponseProvideDefaults(val: AzureFunctionEventSubscriptionDestinationResponse): AzureFunctionEventSubscriptionDestinationResponse; /** * BoolEquals Advanced Filter. */ interface BoolEqualsAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'BoolEquals'. */ operatorType: "BoolEquals"; /** * The boolean filter value. */ value?: boolean; } /** * BoolEquals Filter. */ interface BoolEqualsFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'BoolEquals'. */ operatorType: "BoolEquals"; /** * The boolean filter value. */ value?: boolean; } /** * The certificate authentication properties for the client. */ interface ClientCertificateAuthenticationResponse { /** * The list of thumbprints that are allowed during client authentication. This property is required only if the validationScheme is 'ThumbprintMatch'. */ allowedThumbprints?: string[]; /** * The validation scheme used to authenticate the client. Default value is SubjectMatchesAuthenticationName. */ validationScheme?: string; } /** * ConnectionState information. */ interface ConnectionStateResponse { /** * Actions required (if any). */ actionsRequired?: string; /** * Description of the connection state. */ description?: string; /** * Status of the connection. */ status?: string; } /** * A custom domain configuration that allows users to publish to their own domain name. */ interface CustomDomainConfigurationResponse { /** * The URL for the certificate that is used for publishing to the custom domain. We currently support certificates stored in Azure Key Vault only. While certificate URL can be either * versioned URL of the following format https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, or unversioned URL of the following format (e.g., * https://contosovault.vault.azure.net/certificates/contosocert, we support unversioned certificate URL only (e.g., https://contosovault.vault.azure.net/certificates/contosocert) */ certificateUrl?: string; /** * Expected DNS TXT record name. Event Grid will check for a TXT record with this name in the DNS record set of the custom domain name to prove ownership over the domain. * The values under this TXT record must contain the expected TXT record value. */ expectedTxtRecordName?: string; /** * Expected DNS TXT record value. Event Grid will check for a TXT record with this value in the DNS record set of the custom domain name to prove ownership over the domain. */ expectedTxtRecordValue?: string; /** * Fully Qualified Domain Name (FQDN) for the custom domain. */ fullyQualifiedDomainName: string; /** * Identity info for accessing the certificate for the custom domain. This identity info must match an identity that has been set on the namespace. */ identity?: outputs.eventgrid.CustomDomainIdentityResponse; /** * Validation state for the custom domain. This is a read only property and is initially set to 'Pending' and will be updated to 'Approved' by Event Grid only after ownership of the domain name has been successfully validated. */ validationState?: string; } /** * The identity information for retrieving the certificate for the custom domain. */ interface CustomDomainIdentityResponse { /** * The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. */ type?: string; /** * The user identity associated with the resource. */ userAssignedIdentity?: string; } /** * Information about the deadletter destination with resource identity. */ interface DeadLetterWithResourceIdentityResponse { /** * Information about the destination where events have to be delivered for the event subscription. * Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during dead-lettering. */ deadLetterDestination?: outputs.eventgrid.StorageBlobDeadLetterDestinationResponse; /** * The identity to use when dead-lettering events. */ identity?: outputs.eventgrid.EventSubscriptionIdentityResponse; } /** * Properties of the delivery configuration information of the event subscription. */ interface DeliveryConfigurationResponse { /** * Delivery mode of the event subscription. */ deliveryMode?: string; /** * This property should be populated when deliveryMode is push and represents information about the push subscription. */ push?: outputs.eventgrid.PushInfoResponse; /** * This property should be populated when deliveryMode is queue and represents information about the queue subscription. */ queue?: outputs.eventgrid.QueueInfoResponse; } /** * Information about the delivery for an event subscription with resource identity. */ interface DeliveryWithResourceIdentityResponse { /** * Information about the destination where events have to be delivered for the event subscription. * Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. */ destination?: outputs.eventgrid.AzureFunctionEventSubscriptionDestinationResponse | outputs.eventgrid.EventHubEventSubscriptionDestinationResponse | outputs.eventgrid.HybridConnectionEventSubscriptionDestinationResponse | outputs.eventgrid.MonitorAlertEventSubscriptionDestinationResponse | outputs.eventgrid.NamespaceTopicEventSubscriptionDestinationResponse | outputs.eventgrid.ServiceBusQueueEventSubscriptionDestinationResponse | outputs.eventgrid.ServiceBusTopicEventSubscriptionDestinationResponse | outputs.eventgrid.StorageQueueEventSubscriptionDestinationResponse | outputs.eventgrid.WebHookEventSubscriptionDestinationResponse; /** * The identity to use when delivering events. */ identity?: outputs.eventgrid.EventSubscriptionIdentityResponse; } /** * Dynamic delivery attribute mapping details. */ interface DynamicDeliveryAttributeMappingResponse { /** * Name of the delivery attribute or header. */ name?: string; /** * JSON path in the event which contains attribute value. */ sourceField?: string; /** * Type of the delivery attribute or header name. * Expected value is 'Dynamic'. */ type: "Dynamic"; } interface DynamicRoutingEnrichmentResponse { /** * Dynamic routing enrichment key. */ key?: string; /** * Dynamic routing enrichment value. */ value?: string; } /** * Information about the event hub destination for an event subscription. */ interface EventHubEventSubscriptionDestinationResponse { /** * Delivery attribute details. */ deliveryAttributeMappings?: (outputs.eventgrid.DynamicDeliveryAttributeMappingResponse | outputs.eventgrid.StaticDeliveryAttributeMappingResponse)[]; /** * Type of the endpoint for the event subscription destination. * Expected value is 'EventHub'. */ endpointType: "EventHub"; /** * The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription. */ resourceId?: string; } /** * Filter for the Event Subscription. */ interface EventSubscriptionFilterResponse { /** * An array of advanced filters that are used for filtering event subscriptions. */ advancedFilters?: (outputs.eventgrid.BoolEqualsAdvancedFilterResponse | outputs.eventgrid.IsNotNullAdvancedFilterResponse | outputs.eventgrid.IsNullOrUndefinedAdvancedFilterResponse | outputs.eventgrid.NumberGreaterThanAdvancedFilterResponse | outputs.eventgrid.NumberGreaterThanOrEqualsAdvancedFilterResponse | outputs.eventgrid.NumberInAdvancedFilterResponse | outputs.eventgrid.NumberInRangeAdvancedFilterResponse | outputs.eventgrid.NumberLessThanAdvancedFilterResponse | outputs.eventgrid.NumberLessThanOrEqualsAdvancedFilterResponse | outputs.eventgrid.NumberNotInAdvancedFilterResponse | outputs.eventgrid.NumberNotInRangeAdvancedFilterResponse | outputs.eventgrid.StringBeginsWithAdvancedFilterResponse | outputs.eventgrid.StringContainsAdvancedFilterResponse | outputs.eventgrid.StringEndsWithAdvancedFilterResponse | outputs.eventgrid.StringInAdvancedFilterResponse | outputs.eventgrid.StringNotBeginsWithAdvancedFilterResponse | outputs.eventgrid.StringNotContainsAdvancedFilterResponse | outputs.eventgrid.StringNotEndsWithAdvancedFilterResponse | outputs.eventgrid.StringNotInAdvancedFilterResponse)[]; /** * Allows advanced filters to be evaluated against an array of values instead of expecting a singular value. */ enableAdvancedFilteringOnArrays?: boolean; /** * A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null. */ includedEventTypes?: string[]; /** * Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter * should be compared in a case sensitive manner. */ isSubjectCaseSensitive?: boolean; /** * An optional string to filter events for an event subscription based on a resource path prefix. * The format of this depends on the publisher of the events. * Wildcard characters are not supported in this path. */ subjectBeginsWith?: string; /** * An optional string to filter events for an event subscription based on a resource path suffix. * Wildcard characters are not supported in this path. */ subjectEndsWith?: string; } /** * eventSubscriptionFilterResponseProvideDefaults sets the appropriate defaults for EventSubscriptionFilterResponse */ function eventSubscriptionFilterResponseProvideDefaults(val: EventSubscriptionFilterResponse): EventSubscriptionFilterResponse; /** * The identity information with the event subscription. */ interface EventSubscriptionIdentityResponse { /** * The type of managed identity used. Can be either 'SystemAssigned' or 'UserAssigned'. */ type?: string; /** * The user identity associated with the resource. */ userAssignedIdentity?: string; } /** * The event type information for Channels. */ interface EventTypeInfoResponse { /** * A collection of inline event types for the resource. The inline event type keys are of type string which represents the name of the event. * An example of a valid inline event name is "Contoso.OrderCreated". * The inline event type values are of type InlineEventProperties and will contain additional information for every inline event type. */ inlineEventTypes?: { [key: string]: outputs.eventgrid.InlineEventPropertiesResponse; }; /** * The kind of event type used. */ kind?: string; } /** * Filters configuration for the Event Subscription. */ interface FiltersConfigurationResponse { /** * An array of filters that are used for filtering event subscriptions. */ filters?: (outputs.eventgrid.BoolEqualsFilterResponse | outputs.eventgrid.IsNotNullFilterResponse | outputs.eventgrid.IsNullOrUndefinedFilterResponse | outputs.eventgrid.NumberGreaterThanFilterResponse | outputs.eventgrid.NumberGreaterThanOrEqualsFilterResponse | outputs.eventgrid.NumberInFilterResponse | outputs.eventgrid.NumberInRangeFilterResponse | outputs.eventgrid.NumberLessThanFilterResponse | outputs.eventgrid.NumberLessThanOrEqualsFilterResponse | outputs.eventgrid.NumberNotInFilterResponse | outputs.eventgrid.NumberNotInRangeFilterResponse | outputs.eventgrid.StringBeginsWithFilterResponse | outputs.eventgrid.StringContainsFilterResponse | outputs.eventgrid.StringEndsWithFilterResponse | outputs.eventgrid.StringInFilterResponse | outputs.eventgrid.StringNotBeginsWithFilterResponse | outputs.eventgrid.StringNotContainsFilterResponse | outputs.eventgrid.StringNotEndsWithFilterResponse | outputs.eventgrid.StringNotInFilterResponse)[]; /** * A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null. */ includedEventTypes?: string[]; } /** * Information about the HybridConnection destination for an event subscription. */ interface HybridConnectionEventSubscriptionDestinationResponse { /** * Delivery attribute details. */ deliveryAttributeMappings?: (outputs.eventgrid.DynamicDeliveryAttributeMappingResponse | outputs.eventgrid.StaticDeliveryAttributeMappingResponse)[]; /** * Type of the endpoint for the event subscription destination. * Expected value is 'HybridConnection'. */ endpointType: "HybridConnection"; /** * The Azure Resource ID of an hybrid connection that is the destination of an event subscription. */ resourceId?: string; } /** * The identity information for the resource. */ interface IdentityInfoResponse { /** * The principal ID of resource identity. */ principalId?: string; /** * The tenant ID of resource. */ tenantId?: string; /** * The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identity. */ type?: string; /** * The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. * This property is currently not used and reserved for future usage. */ userAssignedIdentities?: { [key: string]: outputs.eventgrid.UserIdentityPropertiesResponse; }; } interface InboundIpRuleResponse { /** * Action to perform based on the match or no match of the IpMask. */ action?: string; /** * IP Address in CIDR notation e.g., 10.0.0.0/8. */ ipMask?: string; } /** * Additional information about every inline event. */ interface InlineEventPropertiesResponse { /** * The dataSchemaUrl for the inline event. */ dataSchemaUrl?: string; /** * The description for the inline event. */ description?: string; /** * The displayName for the inline event. */ displayName?: string; /** * The documentationUrl for the inline event. */ documentationUrl?: string; } /** * IsNotNull Advanced Filter. */ interface IsNotNullAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'IsNotNull'. */ operatorType: "IsNotNull"; } /** * IsNotNull Filter. */ interface IsNotNullFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'IsNotNull'. */ operatorType: "IsNotNull"; } /** * IsNullOrUndefined Advanced Filter. */ interface IsNullOrUndefinedAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'IsNullOrUndefined'. */ operatorType: "IsNullOrUndefined"; } /** * IsNullOrUndefined Filter. */ interface IsNullOrUndefinedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'IsNullOrUndefined'. */ operatorType: "IsNullOrUndefined"; } /** * This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id', 'topic' and 'eventtime' properties. This represents a field in the input event schema. */ interface JsonFieldResponse { /** * Name of a field in the input event schema that's to be used as the source of a mapping. */ sourceField?: string; } /** * This is used to express the source of an input schema mapping for a single target field * in the Event Grid Event schema. This is currently used in the mappings for the 'subject', * 'eventtype' and 'dataversion' properties. This represents a field in the input event schema * along with a default value to be used, and at least one of these two properties should be provided. */ interface JsonFieldWithDefaultResponse { /** * The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload. */ defaultValue?: string; /** * Name of a field in the input event schema that's to be used as the source of a mapping. */ sourceField?: string; } /** * This enables publishing to Event Grid using a custom input schema. This can be used to map properties from a custom input JSON schema to the Event Grid event schema. */ interface JsonInputSchemaMappingResponse { /** * The mapping information for the DataVersion property of the Event Grid Event. */ dataVersion?: outputs.eventgrid.JsonFieldWithDefaultResponse; /** * The mapping information for the EventTime property of the Event Grid Event. */ eventTime?: outputs.eventgrid.JsonFieldResponse; /** * The mapping information for the EventType property of the Event Grid Event. */ eventType?: outputs.eventgrid.JsonFieldWithDefaultResponse; /** * The mapping information for the Id property of the Event Grid Event. */ id?: outputs.eventgrid.JsonFieldResponse; /** * Type of the custom mapping * Expected value is 'Json'. */ inputSchemaMappingType: "Json"; /** * The mapping information for the Subject property of the Event Grid Event. */ subject?: outputs.eventgrid.JsonFieldWithDefaultResponse; /** * The mapping information for the Topic property of the Event Grid Event. */ topic?: outputs.eventgrid.JsonFieldResponse; } /** * Information about the Monitor Alert destination for an event subscription. */ interface MonitorAlertEventSubscriptionDestinationResponse { /** * The list of ARM Ids of Action Groups that will be triggered on every Alert fired through this event subscription. * Each resource ARM Id should follow this pattern: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}. */ actionGroups?: string[]; /** * The description that will be attached to every Alert fired through this event subscription. */ description?: string; /** * Type of the endpoint for the event subscription destination. * Expected value is 'MonitorAlert'. */ endpointType: "MonitorAlert"; /** * The severity that will be attached to every Alert fired through this event subscription. * This field must be provided. */ severity?: string; } /** * Represents available Sku pricing tiers. */ interface NamespaceSkuResponse { /** * Specifies the number of Throughput Units that defines the capacity for the namespace. The property default value is * 1 which signifies 1 Throughput Unit = 1MB/s ingress and 2MB/s egress per namespace. Min capacity is 1 and * max allowed capacity is 20. */ capacity?: number; /** * The name of the SKU. */ name?: string; } /** * Information about the Namespace Topic destination for an event subscription. */ interface NamespaceTopicEventSubscriptionDestinationResponse { /** * Type of the endpoint for the event subscription destination. * Expected value is 'NamespaceTopic'. */ endpointType: "NamespaceTopic"; /** * The Azure resource Id that represents the endpoint of the Event Grid Namespace Topic destination of an event subscription. * This field is required and the Namespace Topic resource listed must already exist. * The resource ARM Id should follow this pattern: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}. */ resourceId?: string; } /** * NumberGreaterThan Advanced Filter. */ interface NumberGreaterThanAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'NumberGreaterThan'. */ operatorType: "NumberGreaterThan"; /** * The filter value. */ value?: number; } /** * NumberGreaterThan Filter. */ interface NumberGreaterThanFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'NumberGreaterThan'. */ operatorType: "NumberGreaterThan"; /** * The filter value. */ value?: number; } /** * NumberGreaterThanOrEquals Advanced Filter. */ interface NumberGreaterThanOrEqualsAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'NumberGreaterThanOrEquals'. */ operatorType: "NumberGreaterThanOrEquals"; /** * The filter value. */ value?: number; } /** * NumberGreaterThanOrEquals Filter. */ interface NumberGreaterThanOrEqualsFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'NumberGreaterThanOrEquals'. */ operatorType: "NumberGreaterThanOrEquals"; /** * The filter value. */ value?: number; } /** * NumberIn Advanced Filter. */ interface NumberInAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'NumberIn'. */ operatorType: "NumberIn"; /** * The set of filter values. */ values?: number[]; } /** * NumberIn Filter. */ interface NumberInFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'NumberIn'. */ operatorType: "NumberIn"; /** * The set of filter values. */ values?: number[]; } /** * NumberInRange Advanced Filter. */ interface NumberInRangeAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'NumberInRange'. */ operatorType: "NumberInRange"; /** * The set of filter values. */ values?: number[][]; } /** * NumberInRange Filter. */ interface NumberInRangeFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'NumberInRange'. */ operatorType: "NumberInRange"; /** * The set of filter values. */ values?: number[][]; } /** * NumberLessThan Advanced Filter. */ interface NumberLessThanAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'NumberLessThan'. */ operatorType: "NumberLessThan"; /** * The filter value. */ value?: number; } /** * NumberLessThan Filter. */ interface NumberLessThanFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'NumberLessThan'. */ operatorType: "NumberLessThan"; /** * The filter value. */ value?: number; } /** * NumberLessThanOrEquals Advanced Filter. */ interface NumberLessThanOrEqualsAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'NumberLessThanOrEquals'. */ operatorType: "NumberLessThanOrEquals"; /** * The filter value. */ value?: number; } /** * NumberLessThanOrEquals Filter. */ interface NumberLessThanOrEqualsFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'NumberLessThanOrEquals'. */ operatorType: "NumberLessThanOrEquals"; /** * The filter value. */ value?: number; } /** * NumberNotIn Advanced Filter. */ interface NumberNotInAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'NumberNotIn'. */ operatorType: "NumberNotIn"; /** * The set of filter values. */ values?: number[]; } /** * NumberNotIn Filter. */ interface NumberNotInFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'NumberNotIn'. */ operatorType: "NumberNotIn"; /** * The set of filter values. */ values?: number[]; } /** * NumberNotInRange Advanced Filter. */ interface NumberNotInRangeAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'NumberNotInRange'. */ operatorType: "NumberNotInRange"; /** * The set of filter values. */ values?: number[][]; } /** * NumberNotInRange Filter. */ interface NumberNotInRangeFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'NumberNotInRange'. */ operatorType: "NumberNotInRange"; /** * The set of filter values. */ values?: number[][]; } /** * The partner authorization details. */ interface PartnerAuthorizationResponse { /** * The list of authorized partners. */ authorizedPartnersList?: outputs.eventgrid.PartnerResponse[]; /** * Time used to validate the authorization expiration time for each authorized partner. If DefaultMaximumExpirationTimeInDays is * not specified, the default is 7 days. Otherwise, allowed values are between 1 and 365 days. */ defaultMaximumExpirationTimeInDays?: number; } /** * Information about the partner. */ interface PartnerResponse { /** * Expiration time of the partner authorization. If this timer expires, any request from this partner to create, update or delete resources in subscriber's * context will fail. If specified, the allowed values are between 1 to the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration. * If not specified, the default value will be the value of defaultMaximumExpirationTimeInDays specified in PartnerConfiguration or 7 if this value is not specified. */ authorizationExpirationTimeInUtc?: string; /** * The partner name. */ partnerName?: string; /** * The immutableId of the corresponding partner registration. */ partnerRegistrationImmutableId?: string; } /** * Properties of the corresponding partner topic of a Channel. */ interface PartnerTopicInfoResponse { /** * Azure subscription ID of the subscriber. The partner topic associated with the channel will be * created under this Azure subscription. */ azureSubscriptionId?: string; /** * Event Type Information for the partner topic. This information is provided by the publisher and can be used by the * subscriber to view different types of events that are published. */ eventTypeInfo?: outputs.eventgrid.EventTypeInfoResponse; /** * Name of the partner topic associated with the channel. */ name?: string; /** * Azure Resource Group of the subscriber. The partner topic associated with the channel will be * created under this resource group. */ resourceGroupName?: string; /** * The source information is provided by the publisher to determine the scope or context from which the events * are originating. This information can be used by the subscriber during the approval process of the * created partner topic. */ source?: string; } interface PrivateEndpointConnectionResponse { /** * GroupIds from the private link service resource. */ groupIds?: string[]; /** * Fully qualified identifier of the resource. */ id: string; /** * Name of the resource. */ name: string; /** * The Private Endpoint resource for this Connection. */ privateEndpoint?: outputs.eventgrid.PrivateEndpointResponse; /** * Details about the state of the connection. */ privateLinkServiceConnectionState?: outputs.eventgrid.ConnectionStateResponse; /** * Provisioning state of the Private Endpoint Connection. */ provisioningState?: string; /** * Type of the resource. */ type: string; } /** * PrivateEndpoint information. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint. */ id?: string; } /** * Properties of the destination info for event subscription supporting push. */ interface PushInfoResponse { /** * The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. * Uses the managed identity setup on the parent resource (namely, namespace) to acquire the authentication tokens being used during dead-lettering. */ deadLetterDestinationWithResourceIdentity?: outputs.eventgrid.DeadLetterWithResourceIdentityResponse; /** * Information about the destination where events have to be delivered for the event subscription. * Uses the managed identity setup on the parent resource (namely, topic or domain) to acquire the authentication tokens being used during delivery. */ deliveryWithResourceIdentity?: outputs.eventgrid.DeliveryWithResourceIdentityResponse; /** * Information about the destination where events have to be delivered for the event subscription. * Uses Azure Event Grid's identity to acquire the authentication tokens being used during delivery. */ destination?: outputs.eventgrid.AzureFunctionEventSubscriptionDestinationResponse | outputs.eventgrid.EventHubEventSubscriptionDestinationResponse | outputs.eventgrid.HybridConnectionEventSubscriptionDestinationResponse | outputs.eventgrid.MonitorAlertEventSubscriptionDestinationResponse | outputs.eventgrid.NamespaceTopicEventSubscriptionDestinationResponse | outputs.eventgrid.ServiceBusQueueEventSubscriptionDestinationResponse | outputs.eventgrid.ServiceBusTopicEventSubscriptionDestinationResponse | outputs.eventgrid.StorageQueueEventSubscriptionDestinationResponse | outputs.eventgrid.WebHookEventSubscriptionDestinationResponse; /** * Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. * This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: * - (n) is replaced by the value of each time element that follows the (n). * - P is the duration (or Period) designator and is always placed at the beginning of the duration. * - Y is the year designator, and it follows the value for the number of years. * - M is the month designator, and it follows the value for the number of months. * - W is the week designator, and it follows the value for the number of weeks. * - D is the day designator, and it follows the value for the number of days. * - T is the time designator, and it precedes the time components. * - H is the hour designator, and it follows the value for the number of hours. * - M is the minute designator, and it follows the value for the number of minutes. * - S is the second designator, and it follows the value for the number of seconds. * This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined * by topic’s EventRetentionInDays value. The followings are examples of valid values: * - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. * - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. */ eventTimeToLive?: string; /** * The maximum delivery count of the events. */ maxDeliveryCount?: number; } /** * Properties of the Queue info for event subscription. */ interface QueueInfoResponse { /** * The dead letter destination of the event subscription. Any event that cannot be delivered to its' destination is sent to the dead letter destination. * Uses the managed identity setup on the parent resource (namely, topic) to acquire the authentication tokens being used during delivery / dead-lettering. */ deadLetterDestinationWithResourceIdentity?: outputs.eventgrid.DeadLetterWithResourceIdentityResponse; /** * Time span duration in ISO 8601 format that determines how long messages are available to the subscription from the time the message was published. * This duration value is expressed using the following format: \'P(n)Y(n)M(n)DT(n)H(n)M(n)S\', where: * - (n) is replaced by the value of each time element that follows the (n). * - P is the duration (or Period) designator and is always placed at the beginning of the duration. * - Y is the year designator, and it follows the value for the number of years. * - M is the month designator, and it follows the value for the number of months. * - W is the week designator, and it follows the value for the number of weeks. * - D is the day designator, and it follows the value for the number of days. * - T is the time designator, and it precedes the time components. * - H is the hour designator, and it follows the value for the number of hours. * - M is the minute designator, and it follows the value for the number of minutes. * - S is the second designator, and it follows the value for the number of seconds. * This duration value cannot be set greater than the topic’s EventRetentionInDays. It is is an optional field where its minimum value is 1 minute, and its maximum is determined * by topic’s EventRetentionInDays value. The followings are examples of valid values: * - \'P0DT23H12M\' or \'PT23H12M\': for duration of 23 hours and 12 minutes. * - \'P1D\' or \'P1DT0H0M0S\': for duration of 1 day. */ eventTimeToLive?: string; /** * The maximum delivery count of the events. */ maxDeliveryCount?: number; /** * Maximum period in seconds in which once the message is in received (by the client) state and waiting to be accepted, released or rejected. * If this time elapsed after a message has been received by the client and not transitioned into accepted (not processed), released or rejected, * the message is available for redelivery. This is an optional field, where default is 60 seconds, minimum is 60 seconds and maximum is 300 seconds. */ receiveLockDurationInSeconds?: number; } /** * Information about the retry policy for an event subscription. */ interface RetryPolicyResponse { /** * Time To Live (in minutes) for events. */ eventTimeToLiveInMinutes?: number; /** * Maximum number of delivery retry attempts for events. */ maxDeliveryAttempts?: number; } /** * retryPolicyResponseProvideDefaults sets the appropriate defaults for RetryPolicyResponse */ function retryPolicyResponseProvideDefaults(val: RetryPolicyResponse): RetryPolicyResponse; interface RoutingEnrichmentsResponse { dynamic?: outputs.eventgrid.DynamicRoutingEnrichmentResponse[]; static?: outputs.eventgrid.StaticStringRoutingEnrichmentResponse[]; } /** * Routing identity info for topic spaces configuration. */ interface RoutingIdentityInfoResponse { /** * Routing identity type for topic spaces configuration. */ type?: string; userAssignedIdentity?: string; } /** * Information about the service bus destination for an event subscription. */ interface ServiceBusQueueEventSubscriptionDestinationResponse { /** * Delivery attribute details. */ deliveryAttributeMappings?: (outputs.eventgrid.DynamicDeliveryAttributeMappingResponse | outputs.eventgrid.StaticDeliveryAttributeMappingResponse)[]; /** * Type of the endpoint for the event subscription destination. * Expected value is 'ServiceBusQueue'. */ endpointType: "ServiceBusQueue"; /** * The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription. */ resourceId?: string; } /** * Information about the service bus topic destination for an event subscription. */ interface ServiceBusTopicEventSubscriptionDestinationResponse { /** * Delivery attribute details. */ deliveryAttributeMappings?: (outputs.eventgrid.DynamicDeliveryAttributeMappingResponse | outputs.eventgrid.StaticDeliveryAttributeMappingResponse)[]; /** * Type of the endpoint for the event subscription destination. * Expected value is 'ServiceBusTopic'. */ endpointType: "ServiceBusTopic"; /** * The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription. */ resourceId?: string; } /** * Static delivery attribute mapping details. */ interface StaticDeliveryAttributeMappingResponse { /** * Boolean flag to tell if the attribute contains sensitive information . */ isSecret?: boolean; /** * Name of the delivery attribute or header. */ name?: string; /** * Type of the delivery attribute or header name. * Expected value is 'Static'. */ type: "Static"; /** * Value of the delivery attribute. */ value?: string; } /** * staticDeliveryAttributeMappingResponseProvideDefaults sets the appropriate defaults for StaticDeliveryAttributeMappingResponse */ function staticDeliveryAttributeMappingResponseProvideDefaults(val: StaticDeliveryAttributeMappingResponse): StaticDeliveryAttributeMappingResponse; interface StaticStringRoutingEnrichmentResponse { /** * Static routing enrichment key. */ key?: string; /** * String type routing enrichment value. */ value?: string; /** * Static routing enrichment value type. For e.g. this property value can be 'String'. * Expected value is 'String'. */ valueType: "String"; } /** * Information about the storage blob based dead letter destination. */ interface StorageBlobDeadLetterDestinationResponse { /** * The name of the Storage blob container that is the destination of the deadletter events */ blobContainerName?: string; /** * Type of the endpoint for the dead letter destination * Expected value is 'StorageBlob'. */ endpointType: "StorageBlob"; /** * The Azure Resource ID of the storage account that is the destination of the deadletter events */ resourceId?: string; } /** * Information about the storage queue destination for an event subscription. */ interface StorageQueueEventSubscriptionDestinationResponse { /** * Type of the endpoint for the event subscription destination. * Expected value is 'StorageQueue'. */ endpointType: "StorageQueue"; /** * Storage queue message time to live in seconds. This value cannot be zero or negative with the exception of using -1 to indicate that the Time To Live of the message is Infinite. */ queueMessageTimeToLiveInSeconds?: number; /** * The name of the Storage queue under a storage account that is the destination of an event subscription. */ queueName?: string; /** * The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription. */ resourceId?: string; } /** * StringBeginsWith Advanced Filter. */ interface StringBeginsWithAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'StringBeginsWith'. */ operatorType: "StringBeginsWith"; /** * The set of filter values. */ values?: string[]; } /** * StringBeginsWith Filter. */ interface StringBeginsWithFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'StringBeginsWith'. */ operatorType: "StringBeginsWith"; /** * The set of filter values. */ values?: string[]; } /** * StringContains Advanced Filter. */ interface StringContainsAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'StringContains'. */ operatorType: "StringContains"; /** * The set of filter values. */ values?: string[]; } /** * StringContains Filter. */ interface StringContainsFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'StringContains'. */ operatorType: "StringContains"; /** * The set of filter values. */ values?: string[]; } /** * StringEndsWith Advanced Filter. */ interface StringEndsWithAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'StringEndsWith'. */ operatorType: "StringEndsWith"; /** * The set of filter values. */ values?: string[]; } /** * StringEndsWith Filter. */ interface StringEndsWithFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'StringEndsWith'. */ operatorType: "StringEndsWith"; /** * The set of filter values. */ values?: string[]; } /** * StringIn Advanced Filter. */ interface StringInAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'StringIn'. */ operatorType: "StringIn"; /** * The set of filter values. */ values?: string[]; } /** * StringIn Filter. */ interface StringInFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'StringIn'. */ operatorType: "StringIn"; /** * The set of filter values. */ values?: string[]; } /** * StringNotBeginsWith Advanced Filter. */ interface StringNotBeginsWithAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'StringNotBeginsWith'. */ operatorType: "StringNotBeginsWith"; /** * The set of filter values. */ values?: string[]; } /** * StringNotBeginsWith Filter. */ interface StringNotBeginsWithFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'StringNotBeginsWith'. */ operatorType: "StringNotBeginsWith"; /** * The set of filter values. */ values?: string[]; } /** * StringNotContains Advanced Filter. */ interface StringNotContainsAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'StringNotContains'. */ operatorType: "StringNotContains"; /** * The set of filter values. */ values?: string[]; } /** * StringNotContains Filter. */ interface StringNotContainsFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'StringNotContains'. */ operatorType: "StringNotContains"; /** * The set of filter values. */ values?: string[]; } /** * StringNotEndsWith Advanced Filter. */ interface StringNotEndsWithAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'StringNotEndsWith'. */ operatorType: "StringNotEndsWith"; /** * The set of filter values. */ values?: string[]; } /** * StringNotEndsWith Filter. */ interface StringNotEndsWithFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'StringNotEndsWith'. */ operatorType: "StringNotEndsWith"; /** * The set of filter values. */ values?: string[]; } /** * StringNotIn Advanced Filter. */ interface StringNotInAdvancedFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'StringNotIn'. */ operatorType: "StringNotIn"; /** * The set of filter values. */ values?: string[]; } /** * StringNotIn Filter. */ interface StringNotInFilterResponse { /** * The field/property in the event based on which you want to filter. */ key?: string; /** * The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others. * Expected value is 'StringNotIn'. */ operatorType: "StringNotIn"; /** * The set of filter values. */ values?: string[]; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Properties of the Topic Spaces Configuration. */ interface TopicSpacesConfigurationResponse { /** * List of custom domain configurations for the namespace. */ customDomains?: outputs.eventgrid.CustomDomainConfigurationResponse[]; /** * The endpoint for the topic spaces configuration. This is a read-only property. */ hostname: string; /** * The maximum number of sessions per authentication name. The property default value is 1. * Min allowed value is 1 and max allowed value is 100. */ maximumClientSessionsPerAuthenticationName?: number; /** * The maximum session expiry in hours. The property default value is 1 hour. * Min allowed value is 1 hour and max allowed value is 8 hours. */ maximumSessionExpiryInHours?: number; /** * Fully qualified Azure Resource Id for the Event Grid Topic to which events will be routed to from TopicSpaces under a namespace. * This property should be in the following format '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft.EventGrid/topics/{topicName}'. * This topic should reside in the same region where namespace is located. */ routeTopicResourceId?: string; /** * Routing enrichments for topic spaces configuration */ routingEnrichments?: outputs.eventgrid.RoutingEnrichmentsResponse; /** * Routing identity info for topic spaces configuration. */ routingIdentityInfo?: outputs.eventgrid.RoutingIdentityInfoResponse; /** * Indicate if Topic Spaces Configuration is enabled for the namespace. Default is Disabled. */ state?: string; } /** * topicSpacesConfigurationResponseProvideDefaults sets the appropriate defaults for TopicSpacesConfigurationResponse */ function topicSpacesConfigurationResponseProvideDefaults(val: TopicSpacesConfigurationResponse): TopicSpacesConfigurationResponse; /** * Properties of the Topics Configuration. */ interface TopicsConfigurationResponse { /** * List of custom domain configurations for the namespace. */ customDomains?: outputs.eventgrid.CustomDomainConfigurationResponse[]; /** * The hostname for the topics configuration. This is a read-only property. */ hostname: string; } /** * The information about the user identity. */ interface UserIdentityPropertiesResponse { /** * The client id of user assigned identity. */ clientId?: string; /** * The principal id of user assigned identity. */ principalId?: string; } /** * Information about the webhook destination for an event subscription. */ interface WebHookEventSubscriptionDestinationResponse { /** * The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests. */ azureActiveDirectoryApplicationIdOrUri?: string; /** * The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests. */ azureActiveDirectoryTenantId?: string; /** * Delivery attribute details. */ deliveryAttributeMappings?: (outputs.eventgrid.DynamicDeliveryAttributeMappingResponse | outputs.eventgrid.StaticDeliveryAttributeMappingResponse)[]; /** * The base URL that represents the endpoint of the destination of an event subscription. */ endpointBaseUrl: string; /** * Type of the endpoint for the event subscription destination. * Expected value is 'WebHook'. */ endpointType: "WebHook"; /** * The URL that represents the endpoint of the destination of an event subscription. */ endpointUrl?: string; /** * Maximum number of events per batch. */ maxEventsPerBatch?: number; /** * Minimum TLS version that should be supported by webhook endpoint */ minimumTlsVersionAllowed?: string; /** * Preferred batch size in Kilobytes. */ preferredBatchSizeInKilobytes?: number; } /** * webHookEventSubscriptionDestinationResponseProvideDefaults sets the appropriate defaults for WebHookEventSubscriptionDestinationResponse */ function webHookEventSubscriptionDestinationResponseProvideDefaults(val: WebHookEventSubscriptionDestinationResponse): WebHookEventSubscriptionDestinationResponse; } export declare namespace eventhub { /** * Properties to configure capture description for eventhub */ interface CaptureDescriptionResponse { /** * Properties of Destination where capture will be stored. (Storage Account, Blob Names) */ destination?: outputs.eventhub.DestinationResponse; /** * A value that indicates whether capture description is enabled. */ enabled?: boolean; /** * Enumerates the possible values for the encoding format of capture description. Note: 'AvroDeflate' will be deprecated in New API Version */ encoding?: string; /** * The time window allows you to set the frequency with which the capture to Azure Blobs will happen, value should between 60 to 900 seconds */ intervalInSeconds?: number; /** * The size window defines the amount of data built up in your Event Hub before an capture operation, value should be between 10485760 to 524288000 bytes */ sizeLimitInBytes?: number; /** * A value that indicates whether to Skip Empty Archives */ skipEmptyArchives?: boolean; } /** * A value that indicates whether capture description is enabled. */ interface CaptureIdentityResponse { /** * Type of Azure Active Directory Managed Identity. */ type?: string; /** * ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used. */ userAssignedIdentity?: string; } /** * SKU parameters particular to a cluster instance. */ interface ClusterSkuResponse { /** * The quantity of Event Hubs Cluster Capacity Units contained in this cluster. */ capacity?: number; /** * Name of this SKU. */ name: string; } /** * ConnectionState information. */ interface ConnectionStateResponse { /** * Description of the connection state. */ description?: string; /** * Status of the connection. */ status?: string; } /** * Capture storage details for capture description */ interface DestinationResponse { /** * Blob naming convention for archive, e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order */ archiveNameFormat?: string; /** * Blob container Name */ blobContainer?: string; /** * The Azure Data Lake Store name for the captured events */ dataLakeAccountName?: string; /** * The destination folder path for the captured events */ dataLakeFolderPath?: string; /** * Subscription Id of Azure Data Lake Store */ dataLakeSubscriptionId?: string; /** * A value that indicates whether capture description is enabled. */ identity?: outputs.eventhub.CaptureIdentityResponse; /** * Name for capture destination */ name?: string; /** * Resource id of the storage account to be used to create the blobs */ storageAccountResourceId?: string; } /** * Properties to configure Encryption */ interface EncryptionResponse { /** * Enumerates the possible value of keySource for Encryption */ keySource?: string; /** * Properties of KeyVault */ keyVaultProperties?: outputs.eventhub.KeyVaultPropertiesResponse[]; /** * Enable Infrastructure Encryption (Double Encryption) */ requireInfrastructureEncryption?: boolean; } /** * encryptionResponseProvideDefaults sets the appropriate defaults for EncryptionResponse */ function encryptionResponseProvideDefaults(val: EncryptionResponse): EncryptionResponse; /** * Properties to configure Identity for Bring your Own Keys */ interface IdentityResponse { /** * ObjectId from the KeyVault */ principalId: string; /** * TenantId from the KeyVault */ tenantId: string; /** * Type of managed service identity. */ type?: string; /** * Properties for User Assigned Identities */ userAssignedIdentities?: { [key: string]: outputs.eventhub.UserAssignedIdentityResponse; }; } /** * Properties to configure keyVault Properties */ interface KeyVaultPropertiesResponse { identity?: outputs.eventhub.UserAssignedIdentityPropertiesResponse; /** * Name of the Key from KeyVault */ keyName?: string; /** * Uri of KeyVault */ keyVaultUri?: string; /** * Key Version */ keyVersion?: string; } /** * The response from the List namespace operation. */ interface NWRuleSetIpRulesResponse { /** * The IP Filter Action */ action?: string; /** * IP Mask */ ipMask?: string; } /** * The response from the List namespace operation. */ interface NWRuleSetVirtualNetworkRulesResponse { /** * Value that indicates whether to ignore missing Vnet Service Endpoint */ ignoreMissingVnetServiceEndpoint?: boolean; /** * Subnet properties */ subnet?: outputs.eventhub.SubnetResponse; } /** * Properties of the PrivateEndpointConnection. */ interface PrivateEndpointConnectionResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The geo-location where the resource lives */ location: string; /** * The name of the resource */ name: string; /** * The Private Endpoint resource for this Connection. */ privateEndpoint?: outputs.eventhub.PrivateEndpointResponse; /** * Details about the state of the connection. */ privateLinkServiceConnectionState?: outputs.eventhub.ConnectionStateResponse; /** * Provisioning state of the Private Endpoint Connection. */ provisioningState?: string; /** * The system meta data relating to this resource. */ systemData: outputs.eventhub.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs" */ type: string; } /** * PrivateEndpoint information. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint. */ id?: string; } /** * Properties to configure retention settings for the eventhub */ interface RetentionDescriptionResponse { /** * Enumerates the possible values for cleanup policy */ cleanupPolicy?: string; /** * Number of hours to retain the events for this Event Hub. This value is only used when cleanupPolicy is Delete. If cleanupPolicy is Compact the returned value of this property is Long.MaxValue */ retentionTimeInHours?: number; /** * Number of hours to retain the tombstone markers of a compacted Event Hub. This value is only used when cleanupPolicy is Compact. Consumer must complete reading the tombstone marker within this specified amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key described by the tombstone marker within the compacted Event Hub */ tombstoneRetentionTimeInHours?: number; } /** * SKU parameters supplied to the create namespace operation */ interface SkuResponse { /** * The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. */ capacity?: number; /** * Name of this SKU. */ name: string; /** * The billing tier of this particular SKU. */ tier?: string; } /** * Properties supplied for Subnet */ interface SubnetResponse { /** * Resource ID of Virtual Network Subnet */ id?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The type of identity that last modified the resource. */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Properties of the throttling policy */ interface ThrottlingPolicyResponse { /** * Metric Id on which the throttle limit should be set, MetricId can be discovered by hovering over Metric in the Metrics section of Event Hub Namespace inside Azure Portal */ metricId: string; /** * The Name of this policy */ name: string; /** * The Threshold limit above which the application group will be throttled.Rate limit is always per second. */ rateLimitThreshold: number; /** * Application Group Policy types * Expected value is 'ThrottlingPolicy'. */ type: "ThrottlingPolicy"; } interface UserAssignedIdentityPropertiesResponse { /** * ARM ID of user Identity selected for encryption */ userAssignedIdentity?: string; } /** * Recognized Dictionary value. */ interface UserAssignedIdentityResponse { /** * Client Id of user assigned identity */ clientId: string; /** * Principal Id of user assigned identity */ principalId: string; } } export declare namespace extendedlocation { /** * This is optional input that contains the authentication that should be used to generate the namespace. */ interface CustomLocationPropertiesAuthenticationResponse { /** * The type of the Custom Locations authentication */ type?: string; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The identity type. */ type?: string; } /** * A label selector is composed of two parts, matchLabels and matchExpressions. The first part, matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is 'key', the operator is 'In', and the values array contains only 'value'. The second part, matchExpressions is a list of resource selector requirements. Valid operators include In, NotIn, Exists, and DoesNotExist. The values set must be non-empty in the case of In and NotIn. The values set must be empty in the case of Exists and DoesNotExist. All of the requirements, from both matchLabels and matchExpressions must all be satisfied in order to match. */ interface ResourceSyncRulePropertiesSelectorResponse { /** * MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is 'key', the operator is 'In', and the values array contains only 'value'. */ matchLabels?: { [key: string]: string; }; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace fabric { /** * The administration properties of the Fabric capacity resource */ interface CapacityAdministrationResponse { /** * An array of administrator user identities. */ members: string[]; } /** * Represents the SKU name and Azure pricing tier for Microsoft Fabric capacity resource. */ interface RpSkuResponse { /** * The name of the SKU level. */ name: string; /** * The name of the Azure pricing tier to which the SKU applies. */ tier: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace features { /** * Authorization Profile */ interface AuthorizationProfileResponse { /** * The approved time */ approvedTime: string; /** * The approver */ approver: string; /** * The requested time */ requestedTime: string; /** * The requester */ requester: string; /** * The requester object id */ requesterObjectId: string; } interface SubscriptionFeatureRegistrationResponseProperties { /** * The feature approval type. */ approvalType: string; /** * Authorization Profile */ authorizationProfile?: outputs.features.AuthorizationProfileResponse; /** * The feature description. */ description?: string; /** * The featureDisplayName. */ displayName: string; /** * The feature documentation link. */ documentationLink: string; /** * The featureName. */ featureName: string; /** * Key-value pairs for meta data. */ metadata?: { [key: string]: string; }; /** * The providerNamespace. */ providerNamespace: string; /** * The feature registration date. */ registrationDate: string; /** * The feature release date. */ releaseDate: string; /** * Indicates whether feature should be displayed in Portal. */ shouldFeatureDisplayInPortal?: boolean; /** * The state. */ state?: string; /** * The subscriptionId. */ subscriptionId: string; /** * The tenantId. */ tenantId: string; } /** * subscriptionFeatureRegistrationResponsePropertiesProvideDefaults sets the appropriate defaults for SubscriptionFeatureRegistrationResponseProperties */ function subscriptionFeatureRegistrationResponsePropertiesProvideDefaults(val: SubscriptionFeatureRegistrationResponseProperties): SubscriptionFeatureRegistrationResponseProperties; } export declare namespace fileshares { /** * File share limits API result. */ interface FileShareLimitsOutputResponse { /** * The limits for the file share. */ limits: outputs.fileshares.FileShareLimitsResponse; /** * The provisioning constants for the file share. */ provisioningConstants: outputs.fileshares.FileShareProvisioningConstantsResponse; } /** * File share-related limits in the specified subscription/location. */ interface FileShareLimitsResponse { /** * The maximum number of private endpoint connections allowed for a file share. */ maxFileSharePrivateEndpointConnections: number; /** * The maximum number of snapshots allowed per file share. */ maxFileShareSnapshots: number; /** * The maximum number of subnets that can be associated with a file share. */ maxFileShareSubnets: number; /** * The maximum number of file shares that can be created. */ maxFileShares: number; /** * The maximum provisioned IOPS (Input/Output Operations Per Second) for a file share. */ maxProvisionedIOPerSec: number; /** * The maximum provisioned storage in GiB for a file share. */ maxProvisionedStorageGiB: number; /** * The maximum provisioned throughput in MiB/s for a file share. */ maxProvisionedThroughputMiBPerSec: number; /** * The minimum provisioned IOPS (Input/Output Operations Per Second) for a file share. */ minProvisionedIOPerSec: number; /** * The minimum provisioned storage in GiB for a file share. */ minProvisionedStorageGiB: number; /** * The minimum provisioned throughput in MiB/s for a file share. */ minProvisionedThroughputMiBPerSec: number; } /** * File share properties */ interface FileSharePropertiesResponse { /** * The host name of the file share. */ hostName: string; /** * Burst IOPS are extra buffer IOPS enabling you to consume more than your provisioned IOPS for a short period of time, depending on the burst credits available for your share. */ includedBurstIOPerSec: number; /** * Max burst IOPS credits shows the maximum number of burst credits the share can have at the current IOPS provisioning level. */ maxBurstIOPerSecCredits: number; /** * The storage media tier of the file share. */ mediaTier?: string; /** * The name of the file share as seen by the end user when mounting the share, such as in a URI or UNC format in their operating system. */ mountName?: string; /** * Protocol settings specific NFS. */ nfsProtocolProperties?: outputs.fileshares.NfsProtocolPropertiesResponse; /** * The list of associated private endpoint connections. */ privateEndpointConnections: outputs.fileshares.PrivateEndpointConnectionResponse[]; /** * The file sharing protocol for this file share. */ protocol?: string; /** * The provisioned IO / sec of the share. */ provisionedIOPerSec?: number; /** * A date/time value that specifies when the provisioned IOPS for the file share is permitted to be reduced. */ provisionedIOPerSecNextAllowedDowngrade: string; /** * The provisioned storage size of the share in GiB (1 GiB is 1024^3 bytes or 1073741824 bytes). A component of the file share's bill is the provisioned storage, regardless of the amount of used storage. */ provisionedStorageGiB?: number; /** * A date/time value that specifies when the provisioned storage for the file share is permitted to be reduced. */ provisionedStorageNextAllowedDowngrade: string; /** * The provisioned throughput / sec of the share. */ provisionedThroughputMiBPerSec?: number; /** * A date/time value that specifies when the provisioned throughput for the file share is permitted to be reduced. */ provisionedThroughputNextAllowedDowngrade: string; /** * The status of the last operation. */ provisioningState: string; /** * The set of properties for control public access. */ publicAccessProperties?: outputs.fileshares.PublicAccessPropertiesResponse; /** * Gets or sets allow or disallow public network access to azure managed file share */ publicNetworkAccess?: string; /** * The chosen redundancy level of the file share. */ redundancy?: string; } /** * Constants used for calculating recommended values of file share provisioning properties. */ interface FileShareProvisioningConstantsResponse { /** * Base IO per second. */ baseIOPerSec: number; /** * Base throughput in MiB per second. */ baseThroughputMiBPerSec: number; /** * Scalar IO per second. */ scalarIOPerSec: number; /** * Scalar throughput in MiB per second. */ scalarThroughputMiBPerSec: number; } /** * File share provisioning parameters recommendation API result. */ interface FileShareProvisioningRecommendationOutputResponse { /** * Redundancy options for the share. */ availableRedundancyOptions: string[]; /** * The recommended value of provisioned IO / sec of the share. */ provisionedIOPerSec: number; /** * The recommended value of provisioned throughput / sec of the share. */ provisionedThroughputMiBPerSec: number; } /** * FileShareSnapshot properties */ interface FileShareSnapshotPropertiesResponse { /** * The initiator of the FileShareSnapshot. This is a user-defined value. */ initiatorId?: string; /** * The metadata */ metadata?: { [key: string]: string; }; /** * The FileShareSnapshot time in UTC in string representation */ snapshotTime: string; } /** * File shares usage result. */ interface FileShareUsageDataOutputResponse { /** * File share usage data for active file shares. */ liveShares: outputs.fileshares.LiveSharesUsageDataResponse; } /** * Usage data for live shares. */ interface LiveSharesUsageDataResponse { /** * The number of active file shares. */ fileShareCount: number; } /** * Properties specific to the NFS protocol. */ interface NfsProtocolPropertiesResponse { /** * Root squash defines how root users on clients are mapped to the NFS share. */ rootSquash?: string; } /** * The private endpoint connection resource. */ interface PrivateEndpointConnectionResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint resource. */ privateEndpoint?: outputs.fileshares.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.fileshares.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.fileshares.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * The set of properties for control public access. */ interface PublicAccessPropertiesResponse { /** * The allowed set of subnets when access is restricted. */ allowedSubnets?: string[]; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace fluidrelay { /** * All Customer-managed key encryption properties for the resource. */ interface CustomerManagedKeyEncryptionPropertiesResponse { /** * All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. */ keyEncryptionKeyIdentity?: outputs.fluidrelay.CustomerManagedKeyEncryptionPropertiesResponseKeyEncryptionKeyIdentity; /** * key encryption key Url, with or without a version. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. Key auto rotation is enabled by providing a key uri without version. Otherwise, customer is responsible for rotating the key. The keyEncryptionKeyIdentity(either SystemAssigned or UserAssigned) should have permission to access this key url. */ keyEncryptionKeyUrl?: string; } /** * All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. */ interface CustomerManagedKeyEncryptionPropertiesResponseKeyEncryptionKeyIdentity { /** * Values can be SystemAssigned or UserAssigned */ identityType?: string; /** * user assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity. */ userAssignedIdentityResourceId?: string; } /** * All encryption configuration for a resource. */ interface EncryptionPropertiesResponse { /** * All Customer-managed key encryption properties for the resource. */ customerManagedKeyEncryption?: outputs.fluidrelay.CustomerManagedKeyEncryptionPropertiesResponse; } /** * The Fluid Relay endpoints for this server */ interface FluidRelayEndpointsResponse { /** * The Fluid Relay Orderer endpoints. */ ordererEndpoints: string[]; /** * The Fluid Relay service endpoints. */ serviceEndpoints: string[]; /** * The Fluid Relay storage endpoints. */ storageEndpoints: string[]; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The identity type. */ type?: string; /** * The list of user identities associated with the resource. */ userAssignedIdentities?: { [key: string]: outputs.fluidrelay.IdentityResponseUserAssignedIdentities; }; } interface IdentityResponseUserAssignedIdentities { /** * The client id of user assigned identity. */ clientId: string; /** * The principal id of user assigned identity. */ principalId: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace frontdoor { /** * A backend pool is a collection of backends that can be routed to. */ interface BackendPoolResponse { /** * The set of backends for this pool */ backends?: outputs.frontdoor.BackendResponse[]; /** * L7 health probe settings for a backend pool */ healthProbeSettings?: outputs.frontdoor.SubResourceResponse; /** * Resource ID. */ id?: string; /** * Load balancing settings for a backend pool */ loadBalancingSettings?: outputs.frontdoor.SubResourceResponse; /** * Resource name. */ name?: string; /** * Resource status. */ resourceState: string; /** * Resource type. */ type: string; } /** * Settings that apply to all backend pools. */ interface BackendPoolsSettingsResponse { /** * Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests. */ enforceCertificateNameCheck?: string; /** * Send and receive timeout on forwarding request to the backend. When timeout is reached, the request fails and returns. */ sendRecvTimeoutSeconds?: number; } /** * backendPoolsSettingsResponseProvideDefaults sets the appropriate defaults for BackendPoolsSettingsResponse */ function backendPoolsSettingsResponseProvideDefaults(val: BackendPoolsSettingsResponse): BackendPoolsSettingsResponse; /** * Backend address of a frontDoor load balancer. */ interface BackendResponse { /** * Location of the backend (IP address or FQDN) */ address?: string; /** * The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host. */ backendHostHeader?: string; /** * Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled' */ enabledState?: string; /** * The HTTP TCP port number. Must be between 1 and 65535. */ httpPort?: number; /** * The HTTPS TCP port number. Must be between 1 and 65535. */ httpsPort?: number; /** * Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy. */ priority?: number; /** * The Approval status for the connection to the Private Link */ privateEndpointStatus: string; /** * The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private' */ privateLinkAlias?: string; /** * A custom message to be included in the approval request to connect to the Private Link */ privateLinkApprovalMessage?: string; /** * The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated */ privateLinkLocation?: string; /** * The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private' */ privateLinkResourceId?: string; /** * Weight of this endpoint for load balancing purposes. */ weight?: number; } /** * Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object. */ interface CacheConfigurationResponse { /** * The duration for which the content needs to be cached. Allowed format is in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). HTTP requires the value to be no more than a year */ cacheDuration?: string; /** * Whether to use dynamic compression for cached content */ dynamicCompression?: string; /** * Treatment of URL query terms when forming the cache key. */ queryParameterStripDirective?: string; /** * query parameters to include or exclude (comma separated). */ queryParameters?: string; } /** * Https settings for a domain */ interface CustomHttpsConfigurationResponse { /** * Defines the source of the SSL certificate */ certificateSource: string; /** * Defines the type of the certificate used for secure connections to a frontendEndpoint */ certificateType?: string; /** * The minimum TLS version required from the clients to establish an SSL handshake with Front Door. */ minimumTlsVersion: string; /** * Defines the TLS extension protocol that is used for secure delivery */ protocolType: string; /** * The name of the Key Vault secret representing the full certificate PFX */ secretName?: string; /** * The version of the Key Vault secret representing the full certificate PFX */ secretVersion?: string; /** * The Key Vault containing the SSL certificate */ vault?: outputs.frontdoor.KeyVaultCertificateSourceParametersVaultResponse; } /** * Defines contents of custom rules */ interface CustomRuleListResponse { /** * List of rules */ rules?: outputs.frontdoor.CustomRuleResponse[]; } /** * Defines contents of a web application rule */ interface CustomRuleResponse { /** * Describes what action to be applied when rule matches. */ action: string; /** * Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. */ enabledState?: string; /** * Describes the list of variables to group the rate limit requests */ groupBy?: outputs.frontdoor.GroupByVariableResponse[]; /** * List of match conditions. */ matchConditions: outputs.frontdoor.MatchConditionResponse[]; /** * Describes the name of the rule. */ name?: string; /** * Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. */ priority: number; /** * Time window for resetting the rate limit count. Default is 1 minute. */ rateLimitDurationInMinutes?: number; /** * Number of allowed requests per client within the time window. */ rateLimitThreshold?: number; /** * Describes type of rule. */ ruleType: string; } /** * Defines the endpoint properties */ interface EndpointResponse { /** * The endpoint URL */ endpoint?: string; /** * The name of the endpoint */ name?: string; } /** * Describes Forwarding Route. */ interface ForwardingConfigurationResponse { /** * A reference to the BackendPool which this rule routes to. */ backendPool?: outputs.frontdoor.SubResourceResponse; /** * The caching configuration associated with this rule. */ cacheConfiguration?: outputs.frontdoor.CacheConfigurationResponse; /** * A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path. */ customForwardingPath?: string; /** * Protocol this rule will use when forwarding traffic to backends. */ forwardingProtocol?: string; /** * Expected value is '#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration'. */ odataType: "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration"; } /** * Defines the Resource ID for a Frontend Endpoint. */ interface FrontendEndpointLinkResponse { /** * Resource ID. */ id?: string; } /** * A frontend endpoint used for routing. */ interface FrontendEndpointResponse { /** * The configuration specifying how to enable HTTPS */ customHttpsConfiguration: outputs.frontdoor.CustomHttpsConfigurationResponse; /** * Provisioning status of Custom Https of the frontendEndpoint. */ customHttpsProvisioningState: string; /** * Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. */ customHttpsProvisioningSubstate: string; /** * The host name of the frontendEndpoint. Must be a domain name. */ hostName?: string; /** * Resource ID. */ id?: string; /** * Resource name. */ name?: string; /** * Resource status. */ resourceState: string; /** * Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled' */ sessionAffinityEnabledState?: string; /** * UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable. */ sessionAffinityTtlSeconds?: number; /** * Resource type. */ type: string; /** * Defines the Web Application Firewall policy for each host (if applicable) */ webApplicationFirewallPolicyLink?: outputs.frontdoor.FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLinkResponse; } /** * Defines the Web Application Firewall policy for each host (if applicable) */ interface FrontendEndpointUpdateParametersWebApplicationFirewallPolicyLinkResponse { /** * Resource ID. */ id?: string; } /** * Describes the variables available to group the rate limit requests */ interface GroupByVariableResponse { /** * Describes the supported variable for group by */ variableName: string; } /** * An action that can manipulate an http header. */ interface HeaderActionResponse { /** * Which type of manipulation to apply to the header. */ headerActionType: string; /** * The name of the header this action will apply to. */ headerName: string; /** * The value to update the given header name with. This value is not used if the actionType is Delete. */ value?: string; } /** * Load balancing settings for a backend pool */ interface HealthProbeSettingsModelResponse { /** * Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool. */ enabledState?: string; /** * Configures which HTTP method to use to probe the backends defined under backendPools. */ healthProbeMethod?: string; /** * Resource ID. */ id?: string; /** * The number of seconds between health probes. */ intervalInSeconds?: number; /** * Resource name. */ name?: string; /** * The path to use for the health probe. Default is / */ path?: string; /** * Protocol scheme to use for this probe */ protocol?: string; /** * Resource status. */ resourceState: string; /** * Resource type. */ type: string; } /** * healthProbeSettingsModelResponseProvideDefaults sets the appropriate defaults for HealthProbeSettingsModelResponse */ function healthProbeSettingsModelResponseProvideDefaults(val: HealthProbeSettingsModelResponse): HealthProbeSettingsModelResponse; /** * The Key Vault containing the SSL certificate */ interface KeyVaultCertificateSourceParametersVaultResponse { /** * Resource ID. */ id?: string; } /** * Load balancing settings for a backend pool */ interface LoadBalancingSettingsModelResponse { /** * The additional latency in milliseconds for probes to fall into the lowest latency bucket */ additionalLatencyMilliseconds?: number; /** * Resource ID. */ id?: string; /** * Resource name. */ name?: string; /** * Resource status. */ resourceState: string; /** * The number of samples to consider for load balancing decisions */ sampleSize?: number; /** * The number of samples within the sample period that must succeed */ successfulSamplesRequired?: number; /** * Resource type. */ type: string; } /** * Exclude variables from managed rule evaluation. */ interface ManagedRuleExclusionResponse { /** * The variable type to be excluded. */ matchVariable: string; /** * Selector value for which elements in the collection this exclusion applies to. */ selector: string; /** * Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. */ selectorMatchOperator: string; } /** * Defines a managed rule group override setting. */ interface ManagedRuleGroupOverrideResponse { /** * Describes the exclusions that are applied to all rules in the group. */ exclusions?: outputs.frontdoor.ManagedRuleExclusionResponse[]; /** * Describes the managed rule group to override. */ ruleGroupName: string; /** * List of rules that will be disabled. If none specified, all rules in the group will be disabled. */ rules?: outputs.frontdoor.ManagedRuleOverrideResponse[]; } /** * Defines a managed rule group override setting. */ interface ManagedRuleOverrideResponse { /** * Describes the override action to be applied when rule matches. */ action?: string; /** * Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified. */ enabledState?: string; /** * Describes the exclusions that are applied to this specific rule. */ exclusions?: outputs.frontdoor.ManagedRuleExclusionResponse[]; /** * Identifier for the managed rule. */ ruleId: string; /** * Describes the override sensitivity to be applied when rule matches. */ sensitivity?: string; } /** * Defines the list of exceptions for the managed rule sets. */ interface ManagedRuleSetExceptionListResponse { /** * List of exceptions. */ exceptions?: outputs.frontdoor.ManagedRuleSetExceptionResponse[]; } /** * Excludes whole requests from managed rule evaluation according to match conditions. */ interface ManagedRuleSetExceptionResponse { /** * List of values to be matched with. */ matchValues: string[]; /** * The variable to be evaluated for excluding the request. */ matchVariable: string; /** * Scope(s) of the exception. */ scopes: outputs.frontdoor.ManagedRuleSetScopeResponse[]; /** * When matchVariable is a collection, operator used to specify which elements * in the collection this exception applies to. * Currently supported only for RequestHeaderNames. */ selector?: string; /** * Comparison operator to apply to the selector when specifying which elements * in the collection this exception applies to. */ selectorMatchOperator?: string; /** * Comparison operator to apply to the value to be matched. */ valueMatchOperator: string; } /** * Defines the list of managed rule sets for the policy. */ interface ManagedRuleSetListResponse { /** * List of exceptions applied on the managed rule sets. */ exceptionsList?: outputs.frontdoor.ManagedRuleSetExceptionListResponse; /** * List of rule sets. */ managedRuleSets?: outputs.frontdoor.ManagedRuleSetResponse[]; } /** * Defines a managed rule set. */ interface ManagedRuleSetResponse { /** * Describes the exclusions that are applied to all rules in the set. */ exclusions?: outputs.frontdoor.ManagedRuleExclusionResponse[]; /** * Defines the rule group overrides to apply to the rule set. */ ruleGroupOverrides?: outputs.frontdoor.ManagedRuleGroupOverrideResponse[]; /** * Defines the rule set action. */ ruleSetAction?: string; /** * Defines the rule set type to use. */ ruleSetType: string; /** * Defines the version of the rule set to use. */ ruleSetVersion: string; } /** * Defines the scope of the managed rules. */ interface ManagedRuleSetScopeResponse { /** * List of rule group scopes. */ ruleGroupScopes?: outputs.frontdoor.RuleGroupScopeResponse[]; /** * Defines the rule set type. * Examples: DefaultRuleSet, Microsoft_DefaultRuleSet, * Microsoft_BotManagerRuleSet, Microsoft_HTTPDDoSRuleSet, BotProtection */ ruleSetType: string; /** * Defines the version of the rule set. */ ruleSetVersion: string; } /** * Define a match condition. */ interface MatchConditionResponse { /** * List of possible match values. */ matchValue: string[]; /** * Request variable to compare with. */ matchVariable: string; /** * Describes if the result of this condition should be negated. */ negateCondition?: boolean; /** * Comparison type to use for matching with the variable value. */ operator: string; /** * Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null. */ selector?: string; /** * List of transforms. */ transforms?: string[]; } /** * Defines top-level WebApplicationFirewallPolicy configuration settings. */ interface PolicySettingsResponse { /** * Defines the Captcha cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. */ captchaExpirationInMinutes?: number; /** * If the action type is block, customer can override the response body. The body must be specified in base64 encoding. */ customBlockResponseBody?: string; /** * If the action type is block, customer can override the response status code. */ customBlockResponseStatusCode?: number; /** * Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified. */ enabledState?: string; /** * Defines the JavaScript challenge cookie validity lifetime in minutes. This setting is only applicable to Premium_AzureFrontDoor. Value must be an integer between 5 and 1440 with the default value being 30. */ javascriptChallengeExpirationInMinutes?: number; /** * Describes if it is in detection mode or prevention mode at policy level. */ mode?: string; /** * If action type is redirect, this field represents redirect URL for the client. */ redirectUrl?: string; /** * Describes if policy managed rules will inspect the request body content. */ requestBodyCheck?: string; /** * List of log scrubbing rules applied to the Web Application Firewall logs. */ scrubbingRules?: outputs.frontdoor.WebApplicationFirewallScrubbingRulesResponse[]; /** * State of the log scrubbing config. Default value is Enabled. */ state?: string; } /** * Describes Redirect Route. */ interface RedirectConfigurationResponse { /** * Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #. */ customFragment?: string; /** * Host to redirect. Leave empty to use the incoming host as the destination host. */ customHost?: string; /** * The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path. */ customPath?: string; /** * The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &. */ customQueryString?: string; /** * Expected value is '#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration'. */ odataType: "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration"; /** * The protocol of the destination to where the traffic is redirected */ redirectProtocol?: string; /** * The redirect type the rule will use when redirecting traffic. */ redirectType?: string; } /** * Defines the Resource ID for a Routing Rule. */ interface RoutingRuleLinkResponse { /** * Resource ID. */ id?: string; } /** * A routing rule represents a specification for traffic to treat and where to send it, along with health probe information. */ interface RoutingRuleResponse { /** * Protocol schemes to match for this rule */ acceptedProtocols?: string[]; /** * Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled' */ enabledState?: string; /** * Frontend endpoints associated with this rule */ frontendEndpoints?: outputs.frontdoor.SubResourceResponse[]; /** * Resource ID. */ id?: string; /** * Resource name. */ name?: string; /** * The route patterns of the rule. */ patternsToMatch?: string[]; /** * Resource status. */ resourceState: string; /** * A reference to the routing configuration. */ routeConfiguration?: outputs.frontdoor.ForwardingConfigurationResponse | outputs.frontdoor.RedirectConfigurationResponse; /** * A reference to a specific Rules Engine Configuration to apply to this route. */ rulesEngine?: outputs.frontdoor.SubResourceResponse; /** * Resource type. */ type: string; /** * Defines the Web Application Firewall policy for each routing rule (if applicable) */ webApplicationFirewallPolicyLink?: outputs.frontdoor.RoutingRuleUpdateParametersWebApplicationFirewallPolicyLinkResponse; } /** * Defines the Web Application Firewall policy for each routing rule (if applicable) */ interface RoutingRuleUpdateParametersWebApplicationFirewallPolicyLinkResponse { /** * Resource ID. */ id?: string; } /** * Defines the scope of the rule group. */ interface RuleGroupScopeResponse { /** * Defines the rule group name. */ ruleGroupName: string; /** * List of rule scopes. */ ruleScopes?: outputs.frontdoor.RuleScopeResponse[]; } /** * Defines the scope of the rule. */ interface RuleScopeResponse { /** * Defines the rule id. */ ruleId: string; } /** * One or more actions that will execute, modifying the request and/or response. */ interface RulesEngineActionResponse { /** * A list of header actions to apply from the request from AFD to the origin. */ requestHeaderActions?: outputs.frontdoor.HeaderActionResponse[]; /** * A list of header actions to apply from the response from AFD to the client. */ responseHeaderActions?: outputs.frontdoor.HeaderActionResponse[]; /** * Override the route configuration. */ routeConfigurationOverride?: outputs.frontdoor.ForwardingConfigurationResponse | outputs.frontdoor.RedirectConfigurationResponse; } /** * Define a match condition */ interface RulesEngineMatchConditionResponse { /** * Describes if this is negate condition or not */ negateCondition?: boolean; /** * Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match. */ rulesEngineMatchValue: string[]; /** * Match Variable */ rulesEngineMatchVariable: string; /** * Describes operator to apply to the match condition. */ rulesEngineOperator: string; /** * Name of selector in RequestHeader or RequestBody to be matched */ selector?: string; /** * List of transforms */ transforms?: string[]; } /** * A rules engine configuration containing a list of rules that will run to modify the runtime behavior of the request and response. */ interface RulesEngineResponse { /** * Resource ID. */ id: string; /** * Resource name. */ name: string; /** * Resource status. */ resourceState: string; /** * A list of rules that define a particular Rules Engine Configuration. */ rules?: outputs.frontdoor.RulesEngineRuleResponse[]; /** * Resource type. */ type: string; } /** * Contains a list of match conditions, and an action on how to modify the request/response. If multiple rules match, the actions from one rule that conflict with a previous rule overwrite for a singular action, or append in the case of headers manipulation. */ interface RulesEngineRuleResponse { /** * Actions to perform on the request and response if all of the match conditions are met. */ action: outputs.frontdoor.RulesEngineActionResponse; /** * A list of match conditions that must meet in order for the actions of this rule to run. Having no match conditions means the actions will always run. */ matchConditions?: outputs.frontdoor.RulesEngineMatchConditionResponse[]; /** * If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue. */ matchProcessingBehavior?: string; /** * A name to refer to this specific rule. */ name: string; /** * A priority assigned to this rule. */ priority: number; } /** * Defines the Resource ID for a Security Policy. */ interface SecurityPolicyLinkResponse { /** * Resource ID. */ id?: string; } /** * The pricing tier of the web application firewall policy. */ interface SkuResponse { /** * Name of the pricing tier. */ name?: string; } /** * Reference to another subresource. */ interface SubResourceResponse { /** * Resource ID. */ id?: string; } /** * Defines the contents of the log scrubbing rules. */ interface WebApplicationFirewallScrubbingRulesResponse { /** * The variable to be scrubbed from the logs. */ matchVariable: string; /** * When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. */ selector?: string; /** * When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. */ selectorMatchOperator: string; /** * Defines the state of a log scrubbing rule. Default value is enabled. */ state?: string; } } export declare namespace graphservices { /** * Property bag from billing account */ interface AccountResourceResponseProperties { /** * Customer owned application ID */ appId: string; /** * Billing Plan Id */ billingPlanId: string; /** * Provisioning state. */ provisioningState: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface AccountResourceResponseSystemData { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace guestconfiguration { /** * Information about the guest configuration assignment. */ interface AssignmentInfoResponse { /** * Information about the configuration. */ configuration?: outputs.guestconfiguration.ConfigurationInfoResponse; /** * Name of the guest configuration assignment. */ name: string; } /** * Reason and code for the compliance of the guest configuration assignment resource. */ interface AssignmentReportResourceComplianceReasonResponse { /** * Code for the compliance of the guest configuration assignment resource. */ code: string; /** * Reason for the compliance of the guest configuration assignment resource. */ phrase: string; } /** * The guest configuration assignment resource. */ interface AssignmentReportResourceResponse { /** * A value indicating compliance status of the machine for the assigned guest configuration. */ complianceStatus: string; /** * Properties of a guest configuration assignment resource. */ properties: any; /** * Compliance reason and reason code for a resource. */ reasons?: outputs.guestconfiguration.AssignmentReportResourceComplianceReasonResponse[]; /** * Name of the guest configuration assignment resource setting. */ resourceId: string; } interface AssignmentReportResponse { /** * Configuration details of the guest configuration assignment. */ assignment?: outputs.guestconfiguration.AssignmentInfoResponse; /** * A value indicating compliance status of the machine for the assigned guest configuration. */ complianceStatus: string; /** * End date and time of the guest configuration assignment compliance status check. */ endTime: string; /** * ARM resource id of the report for the guest configuration assignment. */ id: string; /** * Type of report, Consistency or Initial */ operationType: string; /** * GUID that identifies the guest configuration assignment report under a subscription, resource group. */ reportId: string; /** * The list of resources for which guest configuration assignment compliance is checked. */ resources?: outputs.guestconfiguration.AssignmentReportResourceResponse[]; /** * Start date and time of the guest configuration assignment compliance status check. */ startTime: string; /** * Information about the VM. */ vm?: outputs.guestconfiguration.VMInfoResponse; } /** * Information about the configuration. */ interface ConfigurationInfoResponse { /** * Name of the configuration. */ name: string; /** * Version of the configuration. */ version: string; } /** * Represents a configuration parameter. */ interface ConfigurationParameterResponse { /** * Name of the configuration parameter. */ name?: string; /** * Value of the configuration parameter. */ value?: string; } /** * Configuration setting of LCM (Local Configuration Manager). */ interface ConfigurationSettingResponse { /** * Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration */ actionAfterReboot: string; /** * If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false */ allowModuleOverwrite: boolean; /** * Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect. */ configurationMode: string; /** * How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15. */ configurationModeFrequencyMins: number; /** * Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module. */ rebootIfNeeded: boolean; /** * The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30. */ refreshFrequencyMins: number; } /** * configurationSettingResponseProvideDefaults sets the appropriate defaults for ConfigurationSettingResponse */ function configurationSettingResponseProvideDefaults(val: ConfigurationSettingResponse): ConfigurationSettingResponse; /** * Guest configuration assignment properties. */ interface GuestConfigurationAssignmentPropertiesResponse { /** * Combined hash of the configuration package and parameters. */ assignmentHash: string; /** * A value indicating compliance status of the machine for the assigned guest configuration. */ complianceStatus: string; /** * The source which initiated the guest configuration assignment. Ex: Azure Policy */ context?: string; /** * The guest configuration to assign. */ guestConfiguration?: outputs.guestconfiguration.GuestConfigurationNavigationResponse; /** * Date and time when last compliance status was checked. */ lastComplianceStatusChecked: string; /** * Last reported guest configuration assignment report. */ latestAssignmentReport?: outputs.guestconfiguration.AssignmentReportResponse; /** * Id of the latest report for the guest configuration assignment. */ latestReportId: string; /** * parameter hash for the guest configuration assignment. */ parameterHash: string; /** * The provisioning state, which only appears in the response. */ provisioningState: string; /** * Type of the resource - VMSS / VM */ resourceType: string; /** * VM resource Id. */ targetResourceId: string; /** * The list of VM Compliance data for VMSS */ vmssVMList?: outputs.guestconfiguration.VMSSVMInfoResponse[]; } /** * guestConfigurationAssignmentPropertiesResponseProvideDefaults sets the appropriate defaults for GuestConfigurationAssignmentPropertiesResponse */ function guestConfigurationAssignmentPropertiesResponseProvideDefaults(val: GuestConfigurationAssignmentPropertiesResponse): GuestConfigurationAssignmentPropertiesResponse; /** * Guest configuration is an artifact that encapsulates DSC configuration and its dependencies. The artifact is a zip file containing DSC configuration (as MOF) and dependent resources and other dependencies like modules. */ interface GuestConfigurationNavigationResponse { /** * Specifies the origin of the configuration. */ assignmentSource: string; /** * Specifies the assignment type and execution of the configuration. Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor. */ assignmentType?: string; /** * The configuration parameters for the guest configuration. */ configurationParameter?: outputs.guestconfiguration.ConfigurationParameterResponse[]; /** * The protected configuration parameters for the guest configuration. */ configurationProtectedParameter?: outputs.guestconfiguration.ConfigurationParameterResponse[]; /** * The configuration setting for the guest configuration. */ configurationSetting: outputs.guestconfiguration.ConfigurationSettingResponse; /** * Combined hash of the guest configuration package and configuration parameters. */ contentHash?: string; /** * Managed identity with storage access of the guest configuration package and configuration parameters. */ contentManagedIdentity?: string; /** * Specifies the content type of the configuration. Possible values could be Builtin or Custom. */ contentType: string; /** * Uri of the storage where guest configuration package is uploaded. */ contentUri?: string; /** * Kind of the guest configuration. For example:DSC */ kind?: string; /** * Name of the guest configuration. */ name?: string; /** * Version of the guest configuration. */ version?: string; } /** * guestConfigurationNavigationResponseProvideDefaults sets the appropriate defaults for GuestConfigurationNavigationResponse */ function guestConfigurationNavigationResponseProvideDefaults(val: GuestConfigurationNavigationResponse): GuestConfigurationNavigationResponse; /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Information about the VM. */ interface VMInfoResponse { /** * Azure resource Id of the VM. */ id: string; /** * UUID(Universally Unique Identifier) of the VM. */ uuid: string; } /** * Information about VMSS VM */ interface VMSSVMInfoResponse { /** * A value indicating compliance status of the machine for the assigned guest configuration. */ complianceStatus: string; /** * Date and time when last compliance status was checked. */ lastComplianceChecked: string; /** * Id of the latest report for the guest configuration assignment. */ latestReportId: string; /** * UUID of the VM. */ vmId: string; /** * Azure resource Id of the VM. */ vmResourceId: string; } } export declare namespace hardwaresecuritymodules { /** * The API entity reference. */ interface ApiEntityReferenceResponse { /** * The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... */ resourceId?: string; } /** * Cloud Hsm Cluster SKU information */ interface CloudHsmClusterSkuResponse { /** * Sku capacity */ capacity?: number; /** * Sku family of the Cloud HSM Cluster */ family: string; /** * Sku name of the Cloud HSM Cluster */ name: string; } /** * The Cloud HSM Properties */ interface CloudHsmPropertiesResponse { /** * FQDN of the Cloud HSM */ fqdn?: string; /** * The Cloud HSM State. Values are: Deploying, ConfiguringSlb, Starting, Starting, Failed, Failed, Deleting, DeletingSlbEntry, InitialProvisioning, Updating */ state?: string; /** * The Cloud HSM State message */ stateMessage?: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.hardwaresecuritymodules.UserAssignedIdentityResponse; }; } /** * The network interface definition. */ interface NetworkInterfaceResponse { /** * Private Ip address of the interface */ privateIpAddress?: string; /** * The Azure resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/... */ resourceId: string; } /** * The network profile definition. */ interface NetworkProfileResponse { /** * Specifies the list of resource Ids for the network interfaces associated with the dedicated HSM. */ networkInterfaces?: outputs.hardwaresecuritymodules.NetworkInterfaceResponse[]; /** * Specifies the identifier of the subnet. */ subnet?: outputs.hardwaresecuritymodules.ApiEntityReferenceResponse; } /** * The private endpoint connection resource. */ interface PrivateEndpointConnectionResponse { /** * Modified whenever there is a change in the state of private endpoint connection. */ etag?: string; /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint resource. */ privateEndpoint?: outputs.hardwaresecuritymodules.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.hardwaresecuritymodules.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.hardwaresecuritymodules.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * SKU of the dedicated HSM */ interface SkuResponse { /** * SKU of the dedicated HSM */ name?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace hdinsight { /** * Gets the application SSH endpoint */ interface ApplicationGetEndpointResponse { /** * The destination port to connect to. */ destinationPort?: number; /** * The location of the endpoint. */ location?: string; /** * The private ip address of the endpoint. */ privateIPAddress?: string; /** * The public port to connect to. */ publicPort?: number; } /** * Gets the application HTTP endpoints. */ interface ApplicationGetHttpsEndpointResponse { /** * The list of access modes for the application. */ accessModes?: string[]; /** * The destination port to connect to. */ destinationPort?: number; /** * The value indicates whether to disable GatewayAuth. */ disableGatewayAuth?: boolean; /** * The location of the endpoint. */ location: string; /** * The private ip address of the endpoint. */ privateIPAddress?: string; /** * The public port to connect to. */ publicPort: number; } /** * The HDInsight cluster application GET response. */ interface ApplicationPropertiesResponse { /** * The application state. */ applicationState: string; /** * The application type. */ applicationType?: string; /** * The list of roles in the cluster. */ computeProfile?: outputs.hdinsight.ComputeProfileResponse; /** * The application create date time. */ createdDate: string; /** * The list of errors. */ errors?: outputs.hdinsight.ErrorsResponse[]; /** * The list of application HTTPS endpoints. */ httpsEndpoints?: outputs.hdinsight.ApplicationGetHttpsEndpointResponse[]; /** * The list of install script actions. */ installScriptActions?: outputs.hdinsight.RuntimeScriptActionResponse[]; /** * The marketplace identifier. */ marketplaceIdentifier: string; /** * The private link configurations. */ privateLinkConfigurations?: outputs.hdinsight.PrivateLinkConfigurationResponse[]; /** * The provisioning state of the application. */ provisioningState: string; /** * The list of application SSH endpoints. */ sshEndpoints?: outputs.hdinsight.ApplicationGetEndpointResponse[]; /** * The list of uninstall script actions. */ uninstallScriptActions?: outputs.hdinsight.RuntimeScriptActionResponse[]; } /** * The load-based autoscale request parameters */ interface AutoscaleCapacityResponse { /** * The maximum instance count of the cluster */ maxInstanceCount?: number; /** * The minimum instance count of the cluster */ minInstanceCount?: number; } /** * Schedule-based autoscale request parameters */ interface AutoscaleRecurrenceResponse { /** * Array of schedule-based autoscale rules */ schedule?: outputs.hdinsight.AutoscaleScheduleResponse[]; /** * The time zone for the autoscale schedule times */ timeZone?: string; } /** * The autoscale request parameters */ interface AutoscaleResponse { /** * Parameters for load-based autoscale */ capacity?: outputs.hdinsight.AutoscaleCapacityResponse; /** * Parameters for schedule-based autoscale */ recurrence?: outputs.hdinsight.AutoscaleRecurrenceResponse; } /** * Parameters for a schedule-based autoscale rule, consisting of an array of days + a time and capacity */ interface AutoscaleScheduleResponse { /** * Days of the week for a schedule-based autoscale rule */ days?: string[]; /** * Time and capacity for a schedule-based autoscale rule */ timeAndCapacity?: outputs.hdinsight.AutoscaleTimeAndCapacityResponse; } /** * Time and capacity request parameters */ interface AutoscaleTimeAndCapacityResponse { /** * The maximum instance count of the cluster */ maxInstanceCount?: number; /** * The minimum instance count of the cluster */ minInstanceCount?: number; /** * 24-hour time in the form xx:xx */ time?: string; } /** * The selected configurations for azure monitor. */ interface AzureMonitorSelectedConfigurationsResponse { /** * The configuration version. */ configurationVersion?: string; /** * The global configurations of selected configurations. */ globalConfigurations?: { [key: string]: string; }; /** * The table list. */ tableList?: outputs.hdinsight.AzureMonitorTableConfigurationResponse[]; } /** * The table configuration for the Log Analytics integration. */ interface AzureMonitorTableConfigurationResponse { /** * The name. */ name?: string; } /** * The information of AAD security group. */ interface ClientGroupInfoResponse { /** * The AAD security group id. */ groupId?: string; /** * The AAD security group name. */ groupName?: string; } /** * The cluster definition. */ interface ClusterDefinitionResponse { /** * The link to the blueprint. */ blueprint?: string; /** * The versions of different services in the cluster. */ componentVersion?: { [key: string]: string; }; /** * The cluster configurations. */ configurations?: any; /** * The type of cluster. */ kind?: string; } /** * The properties of cluster. */ interface ClusterGetPropertiesResponse { /** * The cluster definition. */ clusterDefinition: outputs.hdinsight.ClusterDefinitionResponse; /** * The hdp version of the cluster. */ clusterHdpVersion?: string; /** * The cluster id. */ clusterId?: string; /** * The state of the cluster. */ clusterState?: string; /** * The version of the cluster. */ clusterVersion?: string; /** * The compute isolation properties. */ computeIsolationProperties?: outputs.hdinsight.ComputeIsolationPropertiesResponse; /** * The compute profile. */ computeProfile?: outputs.hdinsight.ComputeProfileResponse; /** * The list of connectivity endpoints. */ connectivityEndpoints?: outputs.hdinsight.ConnectivityEndpointResponse[]; /** * The date on which the cluster was created. */ createdDate?: string; /** * The disk encryption properties. */ diskEncryptionProperties?: outputs.hdinsight.DiskEncryptionPropertiesResponse; /** * The encryption-in-transit properties. */ encryptionInTransitProperties?: outputs.hdinsight.EncryptionInTransitPropertiesResponse; /** * The list of errors. */ errors?: outputs.hdinsight.ErrorsResponse[]; /** * The excluded services config. */ excludedServicesConfig?: outputs.hdinsight.ExcludedServicesConfigResponse; /** * The cluster kafka rest proxy configuration. */ kafkaRestProperties?: outputs.hdinsight.KafkaRestPropertiesResponse; /** * The minimal supported tls version. */ minSupportedTlsVersion?: string; /** * The network properties. */ networkProperties?: outputs.hdinsight.NetworkPropertiesResponse; /** * The type of operating system. */ osType?: string; /** * The list of private endpoint connections. */ privateEndpointConnections: outputs.hdinsight.PrivateEndpointConnectionResponse[]; /** * The private link configurations. */ privateLinkConfigurations?: outputs.hdinsight.PrivateLinkConfigurationResponse[]; /** * The provisioning state, which only appears in the response. */ provisioningState?: string; /** * The quota information. */ quotaInfo?: outputs.hdinsight.QuotaInfoResponse; /** * The security profile. */ securityProfile?: outputs.hdinsight.SecurityProfileResponse; /** * The storage profile. */ storageProfile?: outputs.hdinsight.StorageProfileResponse; /** * The cluster tier. */ tier?: string; } /** * clusterGetPropertiesResponseProvideDefaults sets the appropriate defaults for ClusterGetPropertiesResponse */ function clusterGetPropertiesResponseProvideDefaults(val: ClusterGetPropertiesResponse): ClusterGetPropertiesResponse; /** * Identity for the cluster. */ interface ClusterIdentityResponse { /** * The principal id of cluster identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant id associated with the cluster. This property will only be provided for a system assigned identity. */ tenantId: string; /** * The type of identity used for the cluster. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. */ type?: string; /** * The list of user identities associated with the cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.hdinsight.UserAssignedIdentityResponse; }; } /** * The compute isolation properties. */ interface ComputeIsolationPropertiesResponse { /** * The flag indicates whether enable compute isolation or not. */ enableComputeIsolation?: boolean; /** * The host sku. */ hostSku?: string; } /** * computeIsolationPropertiesResponseProvideDefaults sets the appropriate defaults for ComputeIsolationPropertiesResponse */ function computeIsolationPropertiesResponseProvideDefaults(val: ComputeIsolationPropertiesResponse): ComputeIsolationPropertiesResponse; /** * Describes the compute profile. */ interface ComputeProfileResponse { /** * The list of roles in the cluster. */ roles?: outputs.hdinsight.RoleResponse[]; } /** * The connectivity properties */ interface ConnectivityEndpointResponse { /** * The location of the endpoint. */ location?: string; /** * The name of the endpoint. */ name?: string; /** * The port to connect to. */ port?: number; /** * The private ip address of the endpoint. */ privateIPAddress?: string; /** * The protocol of the endpoint. */ protocol?: string; } /** * The data disks groups for the role. */ interface DataDisksGroupsResponse { /** * ReadOnly. The DiskSize in GB. Do not set this value. */ diskSizeGB: number; /** * The number of disks per node. */ disksPerNode?: number; /** * ReadOnly. The storage account type. Do not set this value. */ storageAccountType: string; } /** * The disk encryption properties */ interface DiskEncryptionPropertiesResponse { /** * Algorithm identifier for encryption, default RSA-OAEP. */ encryptionAlgorithm?: string; /** * Indicates whether or not resource disk encryption is enabled. */ encryptionAtHost?: boolean; /** * Key name that is used for enabling disk encryption. */ keyName?: string; /** * Specific key version that is used for enabling disk encryption. */ keyVersion?: string; /** * Resource ID of Managed Identity that is used to access the key vault. */ msiResourceId?: string; /** * Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net */ vaultUri?: string; } /** * diskEncryptionPropertiesResponseProvideDefaults sets the appropriate defaults for DiskEncryptionPropertiesResponse */ function diskEncryptionPropertiesResponseProvideDefaults(val: DiskEncryptionPropertiesResponse): DiskEncryptionPropertiesResponse; /** * The encryption-in-transit properties. */ interface EncryptionInTransitPropertiesResponse { /** * Indicates whether or not inter cluster node communication is encrypted in transit. */ isEncryptionInTransitEnabled?: boolean; } /** * encryptionInTransitPropertiesResponseProvideDefaults sets the appropriate defaults for EncryptionInTransitPropertiesResponse */ function encryptionInTransitPropertiesResponseProvideDefaults(val: EncryptionInTransitPropertiesResponse): EncryptionInTransitPropertiesResponse; /** * The error message associated with the cluster creation. */ interface ErrorsResponse { /** * The error code. */ code?: string; /** * The error message. */ message?: string; } /** * The configuration that services will be excluded when creating cluster. */ interface ExcludedServicesConfigResponse { /** * The config id of excluded services. */ excludedServicesConfigId?: string; /** * The list of excluded services. */ excludedServicesList?: string; } /** * The hardware profile. */ interface HardwareProfileResponse { /** * The size of the VM */ vmSize?: string; } /** * The ip configurations for the private link service. */ interface IPConfigurationResponse { /** * The private link IP configuration id. */ id: string; /** * The name of private link IP configuration. */ name: string; /** * Indicates whether this IP configuration is primary for the corresponding NIC. */ primary?: boolean; /** * The IP address. */ privateIPAddress?: string; /** * The method that private IP address is allocated. */ privateIPAllocationMethod?: string; /** * The private link configuration provisioning state, which only appears in the response. */ provisioningState: string; /** * The subnet resource id. */ subnet?: outputs.hdinsight.ResourceIdResponse; /** * The type of the private link IP configuration. */ type: string; } /** * Contains the IpTag associated with the public IP address */ interface IpTagResponse { /** * Gets or sets the ipTag type: Example FirstPartyUsage. */ ipTagType: string; /** * Gets or sets value of the IpTag associated with the public IP. Example HDInsight, SQL, Storage etc */ tag: string; } /** * The kafka rest proxy configuration which contains AAD security group information. */ interface KafkaRestPropertiesResponse { /** * The information of AAD security group. */ clientGroupInfo?: outputs.hdinsight.ClientGroupInfoResponse; /** * The configurations that need to be overriden. */ configurationOverride?: { [key: string]: string; }; } /** * The ssh username, password, and ssh public key. */ interface LinuxOperatingSystemProfileResponse { /** * The password. */ password?: string; /** * The SSH profile. */ sshProfile?: outputs.hdinsight.SshProfileResponse; /** * The username. */ username?: string; } /** * The network properties. */ interface NetworkPropertiesResponse { /** * A value to describe how the outbound dependencies of a HDInsight cluster are managed. 'Managed' means that the outbound dependencies are managed by the HDInsight service. 'External' means that the outbound dependencies are managed by a customer specific solution. */ outboundDependenciesManagedType?: string; /** * Indicates whether or not private link is enabled. */ privateLink?: string; /** * Gets or sets the IP tag for the public IPs created along with the HDInsight Clusters. */ publicIpTag?: outputs.hdinsight.IpTagResponse; /** * The direction for the resource provider connection. */ resourceProviderConnection?: string; } /** * The Linux operation systems profile. */ interface OsProfileResponse { /** * The Linux OS profile. */ linuxOperatingSystemProfile?: outputs.hdinsight.LinuxOperatingSystemProfileResponse; } /** * The private endpoint connection. */ interface PrivateEndpointConnectionResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The link identifier. */ linkIdentifier: string; /** * The name of the resource */ name: string; /** * The private endpoint of the private endpoint connection */ privateEndpoint: outputs.hdinsight.PrivateEndpointResponse; /** * The private link service connection state. */ privateLinkServiceConnectionState: outputs.hdinsight.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state, which only appears in the response. */ provisioningState: string; /** * Metadata pertaining to creation and last modification of the resource. */ systemData: outputs.hdinsight.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint. */ interface PrivateEndpointResponse { /** * The private endpoint id. */ id?: string; } /** * The private link configuration. */ interface PrivateLinkConfigurationResponse { /** * The HDInsight private linkable sub-resource name to apply the private link configuration to. For example, 'headnode', 'gateway', 'edgenode'. */ groupId: string; /** * The private link configuration id. */ id: string; /** * The IP configurations for the private link service. */ ipConfigurations: outputs.hdinsight.IPConfigurationResponse[]; /** * The name of private link configuration. */ name: string; /** * The private link configuration provisioning state, which only appears in the response. */ provisioningState: string; /** * The type of the private link configuration. */ type: string; } /** * The private link service connection state. */ interface PrivateLinkServiceConnectionStateResponse { /** * Whether there is further actions. */ actionsRequired?: string; /** * The optional description of the status. */ description?: string; /** * The concrete private link service connection. */ status: string; } /** * The quota properties for the cluster. */ interface QuotaInfoResponse { /** * The cores used by the cluster. */ coresUsed?: number; } /** * The azure resource id. */ interface ResourceIdResponse { /** * The azure resource id. */ id?: string; } /** * Describes a role on the cluster. */ interface RoleResponse { /** * The autoscale configurations. */ autoscaleConfiguration?: outputs.hdinsight.AutoscaleResponse; /** * The data disks groups for the role. */ dataDisksGroups?: outputs.hdinsight.DataDisksGroupsResponse[]; /** * Indicates whether encrypt the data disks. */ encryptDataDisks?: boolean; /** * The hardware profile. */ hardwareProfile?: outputs.hdinsight.HardwareProfileResponse; /** * The minimum instance count of the cluster. */ minInstanceCount?: number; /** * The name of the role. */ name?: string; /** * The operating system profile. */ osProfile?: outputs.hdinsight.OsProfileResponse; /** * The list of script actions on the role. */ scriptActions?: outputs.hdinsight.ScriptActionResponse[]; /** * The instance count of the cluster. */ targetInstanceCount?: number; /** * The name of the virtual machine group. */ vMGroupName?: string; /** * The virtual network profile. */ virtualNetworkProfile?: outputs.hdinsight.VirtualNetworkProfileResponse; } /** * roleResponseProvideDefaults sets the appropriate defaults for RoleResponse */ function roleResponseProvideDefaults(val: RoleResponse): RoleResponse; /** * Describes a script action on a running cluster. */ interface RuntimeScriptActionResponse { /** * The application name of the script action, if any. */ applicationName: string; /** * The name of the script action. */ name: string; /** * The parameters for the script */ parameters?: string; /** * The list of roles where script will be executed. */ roles: string[]; /** * The URI to the script. */ uri: string; } /** * Describes a script action on role on the cluster. */ interface ScriptActionResponse { /** * The name of the script action. */ name: string; /** * The parameters for the script provided. */ parameters: string; /** * The URI to the script. */ uri: string; } /** * The security profile which contains Ssh public key for the HDInsight cluster. */ interface SecurityProfileResponse { /** * The resource ID of the user's Azure Active Directory Domain Service. */ aaddsResourceId?: string; /** * Optional. The Distinguished Names for cluster user groups */ clusterUsersGroupDNs?: string[]; /** * The directory type. */ directoryType?: string; /** * The organization's active directory domain. */ domain?: string; /** * The domain admin password. */ domainUserPassword?: string; /** * The domain user account that will have admin privileges on the cluster. */ domainUsername?: string; /** * The LDAPS protocol URLs to communicate with the Active Directory. */ ldapsUrls?: string[]; /** * User assigned identity that has permissions to read and create cluster-related artifacts in the user's AADDS. */ msiResourceId?: string; /** * The organizational unit within the Active Directory to place the cluster and service accounts. */ organizationalUnitDN?: string; } /** * The list of SSH public keys. */ interface SshProfileResponse { /** * The list of SSH public keys. */ publicKeys?: outputs.hdinsight.SshPublicKeyResponse[]; } /** * The SSH public key for the cluster nodes. */ interface SshPublicKeyResponse { /** * The certificate for SSH. */ certificateData?: string; } /** * The storage Account. */ interface StorageAccountResponse { /** * The container in the storage account, only to be specified for WASB storage accounts. */ container?: string; /** * Enable secure channel or not, it's an optional field. Default value is false when cluster version < 5.1 and true when cluster version >= 5.1 , */ enableSecureChannel?: boolean; /** * The filesystem, only to be specified for Azure Data Lake Storage Gen 2. */ fileSystem?: string; /** * The file share name. */ fileshare?: string; /** * Whether or not the storage account is the default storage account. */ isDefault?: boolean; /** * The storage account access key. */ key?: string; /** * The managed identity (MSI) that is allowed to access the storage account, only to be specified for Azure Data Lake Storage Gen 2. */ msiResourceId?: string; /** * The name of the storage account. */ name?: string; /** * The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2. */ resourceId?: string; /** * The shared access signature key. */ saskey?: string; } /** * The storage profile. */ interface StorageProfileResponse { /** * The list of storage accounts in the cluster. */ storageaccounts?: outputs.hdinsight.StorageAccountResponse[]; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The User Assigned Identity */ interface UserAssignedIdentityResponse { /** * The client id of user assigned identity. */ clientId: string; /** * The principal id of user assigned identity. */ principalId: string; /** * The tenant id of user assigned identity. */ tenantId?: string; } /** * The virtual network properties. */ interface VirtualNetworkProfileResponse { /** * The ID of the virtual network. */ id?: string; /** * The name of the subnet. */ subnet?: string; } } export declare namespace healthbot { /** * An entry of HealthBotKeysResponse */ interface HealthBotKeyResponse { /** * The name of the key. */ keyName?: string; /** * The value of the key. */ value?: string; } /** * The properties of a Azure Health Bot. The Health Bot Service is a cloud platform that empowers developers in Healthcare organizations to build and deploy their compliant, AI-powered virtual health assistants and health bots, that help them improve processes and reduce costs. */ interface HealthBotPropertiesResponse { /** * The link. */ botManagementPortalLink: string; /** * KeyVault properties for the resource encryption. */ keyVaultProperties?: outputs.healthbot.KeyVaultPropertiesResponse; /** * The provisioning state of the Azure Health Bot resource. */ provisioningState: string; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of resource. This property will only be provided for a system assigned identity. */ tenantId: string; /** * The identity type. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the Azure Health Bot */ type?: string; /** * The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.healthbot.UserAssignedIdentityResponse; }; } /** * Properties of the key vault. */ interface KeyVaultPropertiesResponse { /** * The name of the key vault key. */ keyName: string; /** * The Uri of the key vault. */ keyVaultUri: string; /** * The version of the key vault key. */ keyVersion?: string; /** * The user assigned identity (ARM resource id) that has access to the key. */ userIdentity?: string; } /** * The resource model definition representing SKU */ interface SkuResponse { /** * The name of the Azure Health Bot SKU */ name: string; } /** * Read only system data */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC) */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource */ lastModifiedByType?: string; } /** * The details of the user assigned managed identity used by the Video Analyzer resource. */ interface UserAssignedIdentityResponse { /** * The client ID of user assigned identity. */ clientId: string; /** * The principal ID of user assigned identity. */ principalId: string; } } export declare namespace healthcareapis { /** * The Data Lake data destination for Analytics Connector. */ interface AnalyticsConnectorDataLakeDataDestinationResponse { /** * The name for the Data Lake. */ dataLakeName: string; /** * Name of data destination. */ name?: string; /** * Type of data destination. * Expected value is 'datalake'. */ type: "datalake"; } /** * The FHIR service data source for Analytics Connector. */ interface AnalyticsConnectorFhirServiceDataSourceResponse { /** * The kind of FHIR Service. */ kind: string; /** * Type of data source. * Expected value is 'fhirservice'. */ type: "fhirservice"; /** * The URL of FHIR service. */ url: string; } /** * FHIR Service data mapping configuration for Analytics Connector. */ interface AnalyticsConnectorFhirToParquetMappingResponse { /** * Artifact reference for extension schema. */ extensionSchemaReference?: string; /** * Artifact reference for filter configurations. */ filterConfigurationReference?: string; /** * Type of data mapping. * Expected value is 'fhirToParquet'. */ type: "fhirToParquet"; } /** * The settings for the CORS configuration of the service instance. */ interface CorsConfigurationResponse { /** * If credentials are allowed via CORS. */ allowCredentials?: boolean; /** * The headers to be allowed via CORS. */ headers?: string[]; /** * The max age to be allowed via CORS. */ maxAge?: number; /** * The methods to be allowed via CORS. */ methods?: string[]; /** * The origins to be allowed via CORS. */ origins?: string[]; } /** * Authentication configuration information */ interface DicomServiceAuthenticationConfigurationResponse { /** * The audiences for the service */ audiences: string[]; /** * The authority url for the service */ authority: string; } /** * Settings to encrypt a service */ interface EncryptionResponse { /** * The encryption settings for the customer-managed key */ customerManagedKeyEncryption?: outputs.healthcareapis.EncryptionResponseCustomerManagedKeyEncryption; } /** * The encryption settings for the customer-managed key */ interface EncryptionResponseCustomerManagedKeyEncryption { /** * The URL of the key to use for encryption */ keyEncryptionKeyUrl?: string; } /** * Azure container registry configuration information */ interface FhirServiceAcrConfigurationResponse { /** * The list of the Azure container registry login servers. */ loginServers?: string[]; /** * The list of Open Container Initiative (OCI) artifacts. */ ociArtifacts?: outputs.healthcareapis.ServiceOciArtifactEntryResponse[]; } /** * Authentication configuration information */ interface FhirServiceAuthenticationConfigurationResponse { /** * The audience url for the service */ audience?: string; /** * The authority url for the service */ authority?: string; /** * The array of identity provider configurations for SMART on FHIR authentication. */ smartIdentityProviders?: outputs.healthcareapis.SmartIdentityProviderConfigurationResponse[]; /** * If the SMART on FHIR proxy is enabled */ smartProxyEnabled?: boolean; } /** * The settings for the CORS configuration of the service instance. */ interface FhirServiceCorsConfigurationResponse { /** * If credentials are allowed via CORS. */ allowCredentials?: boolean; /** * The headers to be allowed via CORS. */ headers?: string[]; /** * The max age to be allowed via CORS. */ maxAge?: number; /** * The methods to be allowed via CORS. */ methods?: string[]; /** * The origins to be allowed via CORS. */ origins?: string[]; } /** * Export operation configuration information */ interface FhirServiceExportConfigurationResponse { /** * The name of the default export storage account. */ storageAccountName?: string; } /** * Import operation configuration information */ interface FhirServiceImportConfigurationResponse { /** * If the import operation is enabled. */ enabled?: boolean; /** * If the FHIR service is in InitialImportMode. */ initialImportMode?: boolean; /** * The name of the default integration storage account. */ integrationDataStore?: string; } /** * The settings for Implementation Guides - defining capabilities for national standards, vendor consortiums, clinical societies, etc. */ interface ImplementationGuidesConfigurationResponse { /** * If US Core Missing Data requirement is enabled. */ usCoreMissingData?: boolean; } /** * Event Hub ingestion endpoint configuration */ interface IotEventHubIngestionEndpointConfigurationResponse { /** * Consumer group of the event hub to connected to. */ consumerGroup?: string; /** * Event Hub name to connect to. */ eventHubName?: string; /** * Fully qualified namespace of the Event Hub to connect to. */ fullyQualifiedEventHubNamespace?: string; } /** * The mapping content. */ interface IotMappingPropertiesResponse { /** * The mapping. */ content?: any; } /** * The Private Endpoint Connection resource. */ interface PrivateEndpointConnectionResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * The resource of private end point. */ privateEndpoint?: outputs.healthcareapis.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.healthcareapis.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The Private Endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * The settings for history tracking for FHIR resources. */ interface ResourceVersionPolicyConfigurationResponse { /** * The default value for tracking history across all resources. */ default?: string; /** * A list of FHIR Resources and their version policy overrides. */ resourceTypeOverrides?: { [key: string]: string; }; } /** * An access policy entry. */ interface ServiceAccessPolicyEntryResponse { /** * An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. */ objectId: string; } /** * Azure container registry configuration information */ interface ServiceAcrConfigurationInfoResponse { /** * The list of the ACR login servers. */ loginServers?: string[]; /** * The list of Open Container Initiative (OCI) artifacts. */ ociArtifacts?: outputs.healthcareapis.ServiceOciArtifactEntryResponse[]; } /** * Authentication configuration information */ interface ServiceAuthenticationConfigurationInfoResponse { /** * The audience url for the service */ audience?: string; /** * The authority url for the service */ authority?: string; /** * If the SMART on FHIR proxy is enabled */ smartProxyEnabled?: boolean; } /** * The settings for the CORS configuration of the service instance. */ interface ServiceCorsConfigurationInfoResponse { /** * If credentials are allowed via CORS. */ allowCredentials?: boolean; /** * The headers to be allowed via CORS. */ headers?: string[]; /** * The max age to be allowed via CORS. */ maxAge?: number; /** * The methods to be allowed via CORS. */ methods?: string[]; /** * The origins to be allowed via CORS. */ origins?: string[]; } /** * The settings for the Cosmos DB database backing the service. */ interface ServiceCosmosDbConfigurationInfoResponse { /** * The multi-tenant application id used to enable CMK access for services in a data sovereign region. */ crossTenantCmkApplicationId?: string; /** * The URI of the customer-managed key for the backing database. */ keyVaultKeyUri?: string; /** * The provisioned throughput for the backing database. */ offerThroughput?: number; } /** * Export operation configuration information */ interface ServiceExportConfigurationInfoResponse { /** * The name of the default export storage account. */ storageAccountName?: string; } /** * Import operation configuration information */ interface ServiceImportConfigurationInfoResponse { /** * If the import operation is enabled. */ enabled?: boolean; /** * If the FHIR service is in InitialImportMode. */ initialImportMode?: boolean; /** * The name of the default integration storage account. */ integrationDataStore?: string; } /** * Setting indicating whether the service has a managed identity associated with it. */ interface ServiceManagedIdentityResponseIdentity { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of identity being specified, currently SystemAssigned and None are allowed. */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.healthcareapis.UserAssignedIdentityResponse; }; } /** * An Open Container Initiative (OCI) artifact. */ interface ServiceOciArtifactEntryResponse { /** * The artifact digest. */ digest?: string; /** * The artifact name. */ imageName?: string; /** * The Azure Container Registry login server. */ loginServer?: string; } /** * The properties of a service instance. */ interface ServicesPropertiesResponse { /** * The access policies of the service instance. */ accessPolicies?: outputs.healthcareapis.ServiceAccessPolicyEntryResponse[]; /** * The azure container registry settings used for convert data operation of the service instance. */ acrConfiguration?: outputs.healthcareapis.ServiceAcrConfigurationInfoResponse; /** * The authentication configuration for the service instance. */ authenticationConfiguration?: outputs.healthcareapis.ServiceAuthenticationConfigurationInfoResponse; /** * The settings for the CORS configuration of the service instance. */ corsConfiguration?: outputs.healthcareapis.ServiceCorsConfigurationInfoResponse; /** * The settings for the Cosmos DB database backing the service. */ cosmosDbConfiguration?: outputs.healthcareapis.ServiceCosmosDbConfigurationInfoResponse; /** * The settings for the export operation of the service instance. */ exportConfiguration?: outputs.healthcareapis.ServiceExportConfigurationInfoResponse; /** * The settings for the import operation of the service instance. */ importConfiguration?: outputs.healthcareapis.ServiceImportConfigurationInfoResponse; /** * The list of private endpoint connections that are set up for this resource. */ privateEndpointConnections?: outputs.healthcareapis.PrivateEndpointConnectionResponse[]; /** * The provisioning state. */ provisioningState: string; /** * Control permission for data plane traffic coming from public networks while private endpoint is enabled. */ publicNetworkAccess?: string; } /** * Setting indicating whether the service has a managed identity associated with it. */ interface ServicesResourceResponseIdentity { /** * The principal ID of the resource identity. */ principalId: string; /** * The tenant ID of the resource. */ tenantId: string; /** * Type of identity being specified, currently SystemAssigned and None are allowed. */ type?: string; } /** * An Application configured in the Identity Provider used to access FHIR resources. */ interface SmartIdentityProviderApplicationResponse { /** * The actions that are permitted to be performed on FHIR resources for the application. */ allowedDataActions?: string[]; /** * The audience that will be used to validate bearer tokens against the given authority. */ audience?: string; /** * The application client id defined in the identity provider. This value will be used to validate bearer tokens against the given authority. */ clientId?: string; } /** * An object to configure an identity provider for use with SMART on FHIR authentication. */ interface SmartIdentityProviderConfigurationResponse { /** * The array of identity provider applications for SMART on FHIR authentication. */ applications?: outputs.healthcareapis.SmartIdentityProviderApplicationResponse[]; /** * The identity provider token authority also known as the token issuing authority. */ authority?: string; } /** * The configuration of connected storage */ interface StorageConfigurationResponse { /** * The filesystem name of connected storage account. */ fileSystemName?: string; /** * The resource id of connected storage account. */ storageResourceId?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Workspaces resource specific properties. */ interface WorkspaceResponseProperties { /** * The list of private endpoint connections that are set up for this resource. */ privateEndpointConnections: outputs.healthcareapis.PrivateEndpointConnectionResponse[]; /** * The provisioning state. */ provisioningState: string; /** * Control permission for data plane traffic coming from public networks while private endpoint is enabled. */ publicNetworkAccess: string; } } export declare namespace healthdataaiservices { /** * Details of the HealthDataAIServices DeidService. */ interface DeidServicePropertiesResponse { /** * List of private endpoint connections. */ privateEndpointConnections: outputs.healthdataaiservices.PrivateEndpointConnectionResponse[]; /** * The status of the last operation. */ provisioningState: string; /** * Gets or sets allow or disallow public network access to resource */ publicNetworkAccess?: string; /** * Deid service url. */ serviceUrl: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.healthdataaiservices.UserAssignedIdentityResponse; }; } /** * Properties of the private endpoint connection. */ interface PrivateEndpointConnectionPropertiesResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * The private endpoint resource. */ privateEndpoint?: outputs.healthdataaiservices.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.healthdataaiservices.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; } /** * The private endpoint connection resource. */ interface PrivateEndpointConnectionResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint resource. */ privateEndpoint?: outputs.healthdataaiservices.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.healthdataaiservices.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.healthdataaiservices.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace horizondb { /** * Connection information for HorizonDB parameter group. */ interface HorizonDbClusterParameterGroupConnectionPropertiesResponse { /** * Indicates whether the parameters should be applied immediately. */ applyImmediately?: boolean; /** * The resource ID of the connected parameter group. */ id?: string; /** * Indication of if parameter group is applied on HorizonDB resource. */ syncStatus: string; } /** * Properties of a HorizonDB cluster. */ interface HorizonDbClusterPropertiesResponse { /** * The administrator login name. */ administratorLogin: string; /** * The mode to create a new HorizonDB cluster. */ createMode?: string; /** * The fully qualified domain name of the cluster. */ fullyQualifiedDomainName: string; /** * The network related info. */ network?: outputs.horizondb.NetworkResponse; /** * Defines connection to a parameter group. */ parameterGroup?: outputs.horizondb.HorizonDbClusterParameterGroupConnectionPropertiesResponse; /** * Restore point creation time specifying the time to restore from. */ pointInTimeUTC?: string; /** * The pool name for restore or replica operations. */ poolName?: string; /** * The processor type for the HorizonDB cluster. */ processorType?: string; /** * The provisioning state of the cluster. */ provisioningState: string; /** * The fully qualified domain name used for readonly endpoint for the cluster. */ readonlyEndpoint: string; /** * Number of replicas. */ replicaCount?: number; /** * The source cluster resource ID for restore or replica creation. */ sourceClusterResourceId?: string; /** * Current state of the cluster. */ state: string; /** * Number of vCores. */ vCores?: number; /** * The version of the HorizonDB cluster. */ version?: string; /** * Defines how replicas are placed across availability zones. */ zonePlacementPolicy?: string; } /** * Properties of a HorizonDB firewall rule. */ interface HorizonDbFirewallRulePropertiesResponse { /** * The description of the HorizonDB firewall rule. */ description?: string; /** * The end IP address of the firewall rule (IPv4). */ endIpAddress: string; /** * The provisioning state of the firewall rule. */ provisioningState: string; /** * The start IP address of the firewall rule (IPv4). */ startIpAddress: string; } /** * Properties of a HorizonDB parameter group. */ interface HorizonDbParameterGroupPropertiesResponse { /** * Indicates whether the parameters should be applied immediately. */ applyImmediately?: boolean; /** * Description of the parameter group. */ description?: string; /** * Parameters in the parameter group. */ parameters?: outputs.horizondb.ParameterPropertiesResponse[]; /** * PostgreSQL version for the parameter group. */ pgVersion?: number; /** * The provisioning state of the parameter group. */ provisioningState: string; /** * Current version of the parameter group. */ version: number; } /** * Properties of a HorizonDB replica. */ interface HorizonDbReplicaPropertiesResponse { /** * The availability zone of the replica. */ availabilityZone?: string; /** * The fully qualified domain name of the replica. */ fullyQualifiedDomainName: string; /** * The provisioning state of the replica. */ provisioningState: string; /** * Role of the replica. */ role?: string; /** * Current status of the replica. */ status: string; } /** * Network properties. */ interface NetworkResponse { /** * The flag indicating whether public ip is requested. */ publicNetworkAccess: string; } /** * Properties of a HorizonDB parameters. */ interface ParameterPropertiesResponse { /** * The allowed values for the parameter. */ allowedValues: string; /** * The data type of the parameter. */ dataType: string; /** * The description of the parameter. */ description: string; /** * Link to parameter documentation. */ documentationLink: string; /** * Whether the parameter can be changed dynamically. */ isDynamic: boolean; /** * Whether the parameter is a read-only parameter. */ isReadOnly: boolean; /** * The name of the parameter. */ name?: string; /** * The unit of measurement for the parameter. */ unit: string; /** * The value of the configuration. */ value?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace hybridcloud { /** * Resource reference properties. */ interface ResourceReferenceResponse { /** * Resource ID. */ id?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace hybridcompute { /** * Configurable properties that the user can set locally via the azcmagent config command, or remotely via ARM. */ interface AgentConfigurationResponse { /** * Name of configuration mode to use. Modes are pre-defined configurations of security controls, extension allowlists and guest configuration, maintained by Microsoft. */ configMode: string; /** * Array of extensions that are allowed to be installed or updated. */ extensionsAllowList: outputs.hybridcompute.ConfigurationExtensionResponse[]; /** * Array of extensions that are blocked (cannot be installed or updated) */ extensionsBlockList: outputs.hybridcompute.ConfigurationExtensionResponse[]; /** * Specifies whether the extension service is enabled or disabled. */ extensionsEnabled: string; /** * Specified whether the guest configuration service is enabled or disabled. */ guestConfigurationEnabled: string; /** * Specifies the list of ports that the agent will be able to listen on. */ incomingConnectionsPorts: string[]; /** * List of service names which should not use the specified proxy server. */ proxyBypass: string[]; /** * Specifies the URL of the proxy to be used. */ proxyUrl: string; } /** * The info w.r.t Agent Upgrade. */ interface AgentUpgradeResponse { /** * The correlation ID passed in from RSM per upgrade. */ correlationId?: string; /** * Specifies the version info w.r.t AgentUpgrade for the machine. */ desiredVersion?: string; /** * Specifies if RSM should try to upgrade this machine */ enableAutomaticUpgrade?: boolean; /** * Specifies the version of the last attempt */ lastAttemptDesiredVersion: string; /** * Failure message of last upgrade attempt if any. */ lastAttemptMessage: string; /** * Specifies the status of Agent Upgrade. */ lastAttemptStatus: string; /** * Timestamp of last upgrade attempt */ lastAttemptTimestamp: string; } /** * The metadata of the cloud environment (Azure/GCP/AWS/OCI...). */ interface CloudMetadataResponse { /** * Specifies the cloud provider (Azure/AWS/GCP...). */ provider: string; } /** * Describes properties that can identify extensions. */ interface ConfigurationExtensionResponse { /** * Publisher of the extension. */ publisher: string; /** * Type of the extension. */ type: string; } /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.hybridcompute.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.hybridcompute.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * ESU key */ interface EsuKeyResponse { /** * The current status of the license profile key. Represented by the same integer value that is presented on the machine itself when querying the license key status. */ licenseStatus?: number; /** * SKU number. */ sku?: string; } /** * Instance view status. */ interface ExtensionsResourceStatusResponse { /** * The status code. */ code?: string; /** * The short localizable label for the status. */ displayStatus?: string; /** * The level code. */ level?: string; /** * The detailed status message, including for alerts and error messages. */ message?: string; /** * The time of the status. */ time?: string; } /** * Properties that define a Azure Arc PrivateLinkScope resource. */ interface HybridComputePrivateLinkScopePropertiesResponse { /** * The collection of associated Private Endpoint Connections. */ privateEndpointConnections: outputs.hybridcompute.PrivateEndpointConnectionDataModelResponse[]; /** * The Guid id of the private link scope. */ privateLinkScopeId: string; /** * Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. */ provisioningState: string; /** * Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. */ publicNetworkAccess?: string; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The identity type. */ type?: string; } /** * Describes properties of the IP address. */ interface IpAddressResponse { /** * Represents the IP Address. */ address?: string; /** * Represents the Ip Address Version. */ ipAddressVersion?: string; /** * The subnet to which this IP address belongs. */ subnet: outputs.hybridcompute.SubnetResponse; } /** * Describes the properties of a License. */ interface LicenseDetailsResponse { /** * Describes the number of assigned licenses. */ assignedLicenses: number; /** * Describes the edition of the license. The values are either Standard or Datacenter. */ edition?: string; /** * Describes the immutable id. */ immutableId: string; /** * Describes the number of processors. */ processors?: number; /** * Describes the state of the license. */ state?: string; /** * Describes the license target server. */ target?: string; /** * Describes the license core type (pCore or vCore). */ type?: string; /** * A list of volume license details. */ volumeLicenseDetails?: outputs.hybridcompute.VolumeLicenseDetailsResponse[]; } /** * Properties for the Machine ESU profile. */ interface LicenseProfileMachineInstanceViewEsuPropertiesResponse { /** * The assigned license resource. */ assignedLicense?: outputs.hybridcompute.LicenseResponse; /** * The guid id of the license. */ assignedLicenseImmutableId: string; /** * Indicates the eligibility state of Esu. */ esuEligibility: string; /** * Indicates whether there is an ESU Key currently active for the machine. */ esuKeyState: string; /** * The list of ESU keys. */ esuKeys: outputs.hybridcompute.EsuKeyResponse[]; /** * Describes the license assignment state (Assigned or NotAssigned). */ licenseAssignmentState?: string; /** * The type of the Esu servers. */ serverType: string; } /** * License Profile Instance View in Machine Properties. */ interface LicenseProfileMachineInstanceViewResponse { /** * The timestamp in UTC when the billing ends. */ billingEndDate: string; /** * The timestamp in UTC when the billing starts. */ billingStartDate: string; /** * The timestamp in UTC when the user disenrolled the feature. */ disenrollmentDate: string; /** * The timestamp in UTC when the user enrolls the feature. */ enrollmentDate: string; /** * The errors that were encountered during the feature enrollment or disenrollment. */ error: outputs.hybridcompute.ErrorDetailResponse; /** * Properties for the Machine ESU profile. */ esuProfile?: outputs.hybridcompute.LicenseProfileMachineInstanceViewEsuPropertiesResponse; /** * Indicates the license channel. */ licenseChannel: string; /** * Indicates the license status of the OS. */ licenseStatus: string; /** * The list of product features. */ productFeatures?: outputs.hybridcompute.ProductFeatureResponse[]; /** * Indicates the product type of the license. */ productType?: string; /** * Specifies if this machine is licensed as part of a Software Assurance agreement. */ softwareAssuranceCustomer?: boolean; /** * Indicates the subscription status of the product. */ subscriptionStatus?: string; } /** * Describes a license in a hybrid machine. */ interface LicenseResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * Describes the properties of a License. */ licenseDetails?: outputs.hybridcompute.LicenseDetailsResponse; /** * The type of the license resource. */ licenseType?: string; /** * The geo-location where the resource lives */ location: string; /** * The name of the resource */ name: string; /** * The provisioning state, which only appears in the response. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.hybridcompute.SystemDataResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Describes the tenant id. */ tenantId?: string; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Metadata pertaining to the geographic location of the resource. */ interface LocationDataResponse { /** * The city or locality where the resource is located. */ city?: string; /** * The country or region where the resource is located */ countryOrRegion?: string; /** * The district, state, or province where the resource is located. */ district?: string; /** * A canonical name for the geographic or physical location. */ name: string; } /** * Describes the Machine Extension Instance View. */ interface MachineExtensionInstanceViewResponse { /** * The machine extension name. */ name?: string; /** * Instance view status. */ status?: outputs.hybridcompute.MachineExtensionInstanceViewResponseStatus; /** * Specifies the type of the extension; an example is "CustomScriptExtension". */ type?: string; /** * Specifies the version of the script handler. */ typeHandlerVersion?: string; } /** * Instance view status. */ interface MachineExtensionInstanceViewResponseStatus { /** * The status code. */ code?: string; /** * The short localizable label for the status. */ displayStatus?: string; /** * The level code. */ level?: string; /** * The detailed status message, including for alerts and error messages. */ message?: string; /** * The time of the status. */ time?: string; } /** * Describes the properties of a Machine Extension. */ interface MachineExtensionPropertiesResponse { /** * Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */ autoUpgradeMinorVersion?: boolean; /** * Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. */ enableAutomaticUpgrade?: boolean; /** * How the extension handler should be forced to update even if the extension configuration has not changed. */ forceUpdateTag?: string; /** * The machine extension instance view. */ instanceView?: outputs.hybridcompute.MachineExtensionInstanceViewResponse; /** * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */ protectedSettings?: any; /** * The provisioning state, which only appears in the response. */ provisioningState: string; /** * The name of the extension handler publisher. */ publisher?: string; /** * Json formatted public settings for the extension. */ settings?: any; /** * Specifies the type of the extension; an example is "CustomScriptExtension". */ type?: string; /** * Specifies the version of the script handler. */ typeHandlerVersion?: string; } /** * Describes a Machine Extension. */ interface MachineExtensionResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The geo-location where the resource lives */ location: string; /** * The name of the resource */ name: string; /** * Describes Machine Extension Properties. */ properties?: outputs.hybridcompute.MachineExtensionPropertiesResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.hybridcompute.SystemDataResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The instance view of a machine run command. */ interface MachineRunCommandInstanceViewResponse { /** * Script end time. */ endTime?: string; /** * Script error stream. */ error?: string; /** * Communicate script configuration errors or execution messages. */ executionMessage?: string; /** * Script execution status. */ executionState?: string; /** * Exit code returned from script execution. */ exitCode?: number; /** * Script output stream. */ output?: string; /** * Script start time. */ startTime?: string; /** * The status information. */ statuses?: outputs.hybridcompute.ExtensionsResourceStatusResponse[]; } /** * Describes the script sources for run command. Use only one of script, scriptUri, commandId. */ interface MachineRunCommandScriptSourceResponse { /** * Specifies the commandId of predefined built-in script. */ commandId?: string; /** * Specifies the script content to be executed on the machine. */ script?: string; /** * Specifies the script download location. It can be either SAS URI of an Azure storage blob with read access or public URI. */ scriptUri?: string; /** * User-assigned managed identity that has access to scriptUri in case of Azure storage blob. Use an empty object in case of system-assigned identity. Make sure the Azure storage blob exists, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment. In case of user-assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged. */ scriptUriManagedIdentity?: outputs.hybridcompute.RunCommandManagedIdentityResponse; } /** * Describes a network interface. */ interface NetworkInterfaceResponse { /** * The list of IP addresses in this interface. */ ipAddresses?: outputs.hybridcompute.IpAddressResponse[]; } /** * Describes the network information on this machine. */ interface NetworkProfileResponse { /** * The list of network interfaces. */ networkInterfaces?: outputs.hybridcompute.NetworkInterfaceResponse[]; } /** * Specifies the operating system settings for the hybrid machine. */ interface OSProfileResponse { /** * Specifies the host OS name of the hybrid machine. */ computerName: string; /** * Specifies the linux configuration for update management. */ linuxConfiguration?: outputs.hybridcompute.OSProfileResponseLinuxConfiguration; /** * Specifies the windows configuration for update management. */ windowsConfiguration?: outputs.hybridcompute.OSProfileResponseWindowsConfiguration; } /** * Specifies the linux configuration for update management. */ interface OSProfileResponseLinuxConfiguration { /** * Specifies the assessment mode. */ assessmentMode?: string; /** * Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. */ enableHotpatching?: boolean; /** * Specifies the patch mode. */ patchMode?: string; /** * Status of the hotpatch capability enrollment or disenrollment. */ status: outputs.hybridcompute.PatchSettingsResponseStatus; } /** * Specifies the windows configuration for update management. */ interface OSProfileResponseWindowsConfiguration { /** * Specifies the assessment mode. */ assessmentMode?: string; /** * Captures the hotpatch capability enrollment intent of the customers, which enables customers to patch their Windows machines without requiring a reboot. */ enableHotpatching?: boolean; /** * Specifies the patch mode. */ patchMode?: string; /** * Status of the hotpatch capability enrollment or disenrollment. */ status: outputs.hybridcompute.PatchSettingsResponseStatus; } /** * Status of the hotpatch capability enrollment or disenrollment. */ interface PatchSettingsResponseStatus { /** * The errors that were encountered during the hotpatch capability enrollment or disenrollment. */ error: outputs.hybridcompute.ErrorDetailResponse; /** * Indicates the current status of the hotpatch being enabled or disabled. */ hotpatchEnablementStatus?: string; } /** * The Data Model for a Private Endpoint Connection associated with a Private Link Scope */ interface PrivateEndpointConnectionDataModelResponse { /** * The ARM Resource Id of the Private Endpoint. */ id: string; /** * The Name of the Private Endpoint. */ name: string; /** * The Private Endpoint Connection properties. */ properties?: outputs.hybridcompute.PrivateEndpointConnectionPropertiesResponse; /** * Azure resource type */ type: string; } /** * Properties of a private endpoint connection. */ interface PrivateEndpointConnectionPropertiesResponse { /** * List of group IDs. */ groupIds: string[]; /** * Private endpoint which the connection belongs to. */ privateEndpoint?: outputs.hybridcompute.PrivateEndpointPropertyResponse; /** * Connection state of the private endpoint connection. */ privateLinkServiceConnectionState?: outputs.hybridcompute.PrivateLinkServiceConnectionStatePropertyResponse; /** * State of the private endpoint connection. */ provisioningState: string; } /** * Private endpoint which the connection belongs to. */ interface PrivateEndpointPropertyResponse { /** * Resource id of the private endpoint. */ id?: string; } /** * State of the private endpoint connection. */ interface PrivateLinkServiceConnectionStatePropertyResponse { /** * The actions required for private link service connection. */ actionsRequired: string; /** * The private link service connection description. */ description: string; /** * The private link service connection status. */ status: string; } /** * Product Feature */ interface ProductFeatureResponse { /** * The timestamp in UTC when the billing ends. */ billingEndDate: string; /** * The timestamp in UTC when the billing starts. */ billingStartDate: string; /** * The timestamp in UTC when the user disenrolled the feature. */ disenrollmentDate: string; /** * The timestamp in UTC when the user enrolls the feature. */ enrollmentDate: string; /** * The errors that were encountered during the feature enrollment or disenrollment. */ error: outputs.hybridcompute.ErrorDetailResponse; /** * Product feature name. */ name?: string; /** * Indicates the current status of the product features. */ subscriptionStatus?: string; } /** * Describes the properties of a run command parameter. */ interface RunCommandInputParameterResponse { /** * The run command parameter name. */ name: string; /** * The run command parameter value. */ value: string; } /** * Contains clientId or objectId (use only one, not both) of a user-assigned managed identity that has access to storage blob used in Run Command. Use an empty RunCommandManagedIdentity object in case of system-assigned identity. Make sure the Azure storage blob exists in case of scriptUri, and managed identity has been given access to blob's container with 'Storage Blob Data Reader' role assignment with scriptUri blob and 'Storage Blob Data Contributor' for Append blobs(outputBlobUri, errorBlobUri). In case of user assigned identity, make sure you add it under VM's identity. For more info on managed identity and Run Command, refer https://aka.ms/ManagedIdentity and https://aka.ms/RunCommandManaged. */ interface RunCommandManagedIdentityResponse { /** * Client Id (GUID value) of the user-assigned managed identity. ObjectId should not be used if this is provided. */ clientId?: string; /** * Object Id (GUID value) of the user-assigned managed identity. ClientId should not be used if this is provided. */ objectId?: string; } /** * Describes the status and behavior of a service. */ interface ServiceStatusResponse { /** * The behavior of the service when the Arc-enabled machine starts up. */ startupType?: string; /** * The current status of the service. */ status?: string; } /** * Reports the state and behavior of dependent services. */ interface ServiceStatusesResponse { /** * The state of the extension service on the Arc-enabled machine. */ extensionService?: outputs.hybridcompute.ServiceStatusResponse; /** * The state of the guest configuration service on the Arc-enabled machine. */ guestConfigurationService?: outputs.hybridcompute.ServiceStatusResponse; } /** * Describes the subnet. */ interface SubnetResponse { /** * Represents address prefix. */ addressPrefix?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } interface VolumeLicenseDetailsResponse { /** * The invoice id for the volume license. */ invoiceId?: string; /** * Describes the program year the volume license is for. */ programYear?: string; } } export declare namespace hybridconnectivity { /** * cloud profile for AWS. */ interface AwsCloudProfileResponse { /** * Account id for the AWS account. */ accountId: string; /** * List of AWS accounts which need to be excluded. */ excludedAccounts?: string[]; /** * Boolean value that indicates whether the account is organizational or not. True represents organization account, whereas false represents a single account. */ isOrganizationalAccount?: boolean; } /** * awsCloudProfileResponseProvideDefaults sets the appropriate defaults for AwsCloudProfileResponse */ function awsCloudProfileResponseProvideDefaults(val: AwsCloudProfileResponse): AwsCloudProfileResponse; /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace hybridcontainerservice { /** * The credential result response. */ interface CredentialResultResponse { /** * The name of the credential. */ name: string; /** * Base64-encoded Kubernetes configuration file. */ value: string; } interface ListCredentialResponseResponseError { code?: string; message?: string; } interface ListCredentialResponseResponseProperties { /** * Base64-encoded Kubernetes configuration file. */ kubeconfigs: outputs.hybridcontainerservice.CredentialResultResponse[]; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Properties of the virtual network resource */ interface VirtualNetworkPropertiesResponse { /** * List of DNS server IP Addresses associated with the network */ dnsServers?: string[]; /** * IP Address of the Gateway associated with the network */ gateway?: string; infraVnetProfile?: outputs.hybridcontainerservice.VirtualNetworkPropertiesResponseInfraVnetProfile; /** * IP Address Prefix of the network */ ipAddressPrefix?: string; provisioningState: string; /** * Status of the virtual network resource */ status: outputs.hybridcontainerservice.VirtualNetworkPropertiesResponseStatus; /** * Range of IP Addresses for Kubernetes API Server and services if using HA Proxy load balancer */ vipPool?: outputs.hybridcontainerservice.VirtualNetworkPropertiesResponseVipPool[]; /** * VLAN Id used by the network */ vlanID?: number; /** * Range of IP Addresses for Kubernetes node VMs */ vmipPool?: outputs.hybridcontainerservice.VirtualNetworkPropertiesResponseVmipPool[]; } /** * The error if any from the operation. */ interface VirtualNetworkPropertiesResponseError { /** * The error code from the operation. */ code?: string; /** * The error message from the operation. */ message?: string; } /** * Infrastructure network profile for HCI platform */ interface VirtualNetworkPropertiesResponseHci { /** * Group in MOC(Microsoft On-premises Cloud) */ mocGroup?: string; /** * Location in MOC(Microsoft On-premises Cloud) */ mocLocation?: string; /** * Virtual Network name in MOC(Microsoft On-premises Cloud) */ mocVnetName?: string; } interface VirtualNetworkPropertiesResponseInfraVnetProfile { /** * Infrastructure network profile for HCI platform */ hci?: outputs.hybridcontainerservice.VirtualNetworkPropertiesResponseHci; } /** * The detailed status of the long running operation. */ interface VirtualNetworkPropertiesResponseOperationStatus { /** * The error if any from the operation. */ error?: outputs.hybridcontainerservice.VirtualNetworkPropertiesResponseError; /** * The identifier of the operation. */ operationId?: string; /** * The status of the operation. */ status?: string; } /** * Status of the virtual network resource */ interface VirtualNetworkPropertiesResponseStatus { /** * The detailed status of the long running operation. */ operationStatus?: outputs.hybridcontainerservice.VirtualNetworkPropertiesResponseOperationStatus; } interface VirtualNetworkPropertiesResponseVipPool { /** * Ending IP address for the IP Pool */ endIP?: string; /** * Starting IP address for the IP Pool */ startIP?: string; } interface VirtualNetworkPropertiesResponseVmipPool { /** * Ending IP address for the IP Pool */ endIP?: string; /** * Starting IP address for the IP Pool */ startIP?: string; } /** * Extended location pointing to the underlying infrastructure */ interface VirtualNetworkResponseExtendedLocation { /** * ARM Id of the extended location. */ name?: string; /** * The extended location type. Allowed value: 'CustomLocation' */ type?: string; } } export declare namespace hybridnetwork { /** * The arm resource definition resource element template details. */ interface ArmResourceDefinitionResourceElementTemplateDetailsResponse { /** * The resource element template type. */ configuration?: outputs.hybridnetwork.ArmResourceDefinitionResourceElementTemplateResponse; /** * The depends on profile. */ dependsOnProfile?: outputs.hybridnetwork.DependsOnProfileResponse; /** * Name of the resource element template. */ name?: string; /** * The resource element template type. * Expected value is 'ArmResourceDefinition'. */ resourceElementType: "ArmResourceDefinition"; } /** * The arm template RE. */ interface ArmResourceDefinitionResourceElementTemplateResponse { /** * Artifact profile properties. */ artifactProfile?: outputs.hybridnetwork.NSDArtifactProfileResponse; /** * Name and value pairs that define the parameter values. It can be a well formed escaped JSON string. */ parameterValues?: string; /** * The template type. */ templateType?: string; } /** * Template artifact profile. */ interface ArmTemplateArtifactProfileResponse { /** * Template name. */ templateName?: string; /** * Template version. */ templateVersion?: string; } /** * Template mapping rule profile */ interface ArmTemplateMappingRuleProfileResponse { /** * List of template parameters. */ templateParameters?: string; } /** * Artifact manifest properties. */ interface ArtifactManifestPropertiesFormatResponse { /** * The artifact manifest state. */ artifactManifestState: string; /** * The artifacts list. */ artifacts?: outputs.hybridnetwork.ManifestArtifactFormatResponse[]; /** * The provisioning state of the ArtifactManifest resource. */ provisioningState: string; } /** * List of network fabric controller ids. */ interface ArtifactStoreNetworkFabricControllerEndPointsResponse { /** * list of network fabric controllers. */ networkFabricControllerIds?: outputs.hybridnetwork.ReferencedResourceResponse[]; } /** * List of manual private endpoints. */ interface ArtifactStorePrivateEndPointsFormatResponse { /** * list of private endpoints. */ manualPrivateEndPointConnections?: outputs.hybridnetwork.ReferencedResourceResponse[]; } /** * Artifact store properties. */ interface ArtifactStorePropertiesFormatResponse { /** * The artifact store backing resource network access type */ backingResourcePublicNetworkAccess?: string; managedResourceGroupConfiguration?: outputs.hybridnetwork.ArtifactStorePropertiesFormatResponseManagedResourceGroupConfiguration; /** * The provisioning state of the application groups resource. */ provisioningState: string; /** * The replication strategy. */ replicationStrategy?: string; /** * The created storage resource id */ storageResourceId: string; /** * The artifact store type. */ storeType?: string; } interface ArtifactStorePropertiesFormatResponseManagedResourceGroupConfiguration { /** * The managed resource group location. */ location?: string; /** * The managed resource group name. */ name?: string; } /** * The AzureArcK8sCluster NFVI detail. */ interface AzureArcK8sClusterNFVIDetailsResponse { /** * The reference to the custom location. */ customLocationReference?: outputs.hybridnetwork.ReferencedResourceResponse; /** * Name of the nfvi. */ name?: string; /** * The NFVI type. * Expected value is 'AzureArcKubernetes'. */ nfviType: "AzureArcKubernetes"; } /** * Azure arc kubernetes artifact profile properties. */ interface AzureArcKubernetesArtifactProfileResponse { /** * The reference to artifact store. */ artifactStore?: outputs.hybridnetwork.ReferencedResourceResponse; /** * Helm artifact profile. */ helmArtifactProfile?: outputs.hybridnetwork.HelmArtifactProfileResponse; } /** * Azure arc kubernetes deploy mapping rule profile. */ interface AzureArcKubernetesDeployMappingRuleProfileResponse { /** * The application enablement. */ applicationEnablement?: string; /** * The helm mapping rule profile. */ helmMappingRuleProfile?: outputs.hybridnetwork.HelmMappingRuleProfileResponse; } /** * Azure arc kubernetes helm application configurations. */ interface AzureArcKubernetesHelmApplicationResponse { /** * Azure arc kubernetes artifact profile. */ artifactProfile?: outputs.hybridnetwork.AzureArcKubernetesArtifactProfileResponse; /** * The artifact type. * Expected value is 'HelmPackage'. */ artifactType: "HelmPackage"; /** * Depends on profile definition. */ dependsOnProfile?: outputs.hybridnetwork.DependsOnProfileResponse; /** * Deploy mapping rule profile. */ deployParametersMappingRuleProfile?: outputs.hybridnetwork.AzureArcKubernetesDeployMappingRuleProfileResponse; /** * The name of the network function application. */ name?: string; } /** * Azure Arc kubernetes network function template. */ interface AzureArcKubernetesNetworkFunctionTemplateResponse { /** * Network function applications. */ networkFunctionApplications?: outputs.hybridnetwork.AzureArcKubernetesHelmApplicationResponse[]; /** * The network function type. * Expected value is 'AzureArcKubernetes'. */ nfviType: "AzureArcKubernetes"; } /** * Azure template artifact profile properties. */ interface AzureCoreArmTemplateArtifactProfileResponse { /** * The reference to artifact store. */ artifactStore?: outputs.hybridnetwork.ReferencedResourceResponse; /** * Template artifact profile. */ templateArtifactProfile?: outputs.hybridnetwork.ArmTemplateArtifactProfileResponse; } /** * Azure template deploy mapping rule profile. */ interface AzureCoreArmTemplateDeployMappingRuleProfileResponse { /** * The application enablement. */ applicationEnablement?: string; /** * The template mapping rule profile. */ templateMappingRuleProfile?: outputs.hybridnetwork.ArmTemplateMappingRuleProfileResponse; } /** * The Azure Core NFVI detail. */ interface AzureCoreNFVIDetailsResponse { /** * Location of the Azure core. */ location?: string; /** * Name of the nfvi. */ name?: string; /** * The NFVI type. * Expected value is 'AzureCore'. */ nfviType: "AzureCore"; } /** * Azure core network function Template application definition. */ interface AzureCoreNetworkFunctionArmTemplateApplicationResponse { /** * Azure template artifact profile. */ artifactProfile?: outputs.hybridnetwork.AzureCoreArmTemplateArtifactProfileResponse; /** * The artifact type. * Expected value is 'ArmTemplate'. */ artifactType: "ArmTemplate"; /** * Depends on profile definition. */ dependsOnProfile?: outputs.hybridnetwork.DependsOnProfileResponse; /** * Deploy mapping rule profile. */ deployParametersMappingRuleProfile?: outputs.hybridnetwork.AzureCoreArmTemplateDeployMappingRuleProfileResponse; /** * The name of the network function application. */ name?: string; } /** * Azure virtual network function template. */ interface AzureCoreNetworkFunctionTemplateResponse { /** * Network function applications. */ networkFunctionApplications?: (outputs.hybridnetwork.AzureCoreNetworkFunctionArmTemplateApplicationResponse | outputs.hybridnetwork.AzureCoreNetworkFunctionVhdApplicationResponse)[]; /** * The network function type. * Expected value is 'AzureCore'. */ nfviType: "AzureCore"; } /** * Azure core network function vhd application definition. */ interface AzureCoreNetworkFunctionVhdApplicationResponse { /** * Azure vhd image artifact profile. */ artifactProfile?: outputs.hybridnetwork.AzureCoreVhdImageArtifactProfileResponse; /** * The artifact type. * Expected value is 'VhdImageFile'. */ artifactType: "VhdImageFile"; /** * Depends on profile definition. */ dependsOnProfile?: outputs.hybridnetwork.DependsOnProfileResponse; /** * Deploy mapping rule profile. */ deployParametersMappingRuleProfile?: outputs.hybridnetwork.AzureCoreVhdImageDeployMappingRuleProfileResponse; /** * The name of the network function application. */ name?: string; } /** * Azure vhd artifact profile properties. */ interface AzureCoreVhdImageArtifactProfileResponse { /** * The reference to artifact store. */ artifactStore?: outputs.hybridnetwork.ReferencedResourceResponse; /** * Vhd artifact profile. */ vhdArtifactProfile?: outputs.hybridnetwork.VhdImageArtifactProfileResponse; } /** * Azure vhd deploy mapping rule profile. */ interface AzureCoreVhdImageDeployMappingRuleProfileResponse { /** * The application enablement. */ applicationEnablement?: string; /** * The vhd mapping rule profile. */ vhdImageMappingRuleProfile?: outputs.hybridnetwork.VhdImageMappingRuleProfileResponse; } /** * Azure Operator Distributed Services vhd artifact profile properties. */ interface AzureOperatorNexusArmTemplateArtifactProfileResponse { /** * The reference to artifact store. */ artifactStore?: outputs.hybridnetwork.ReferencedResourceResponse; /** * Template artifact profile. */ templateArtifactProfile?: outputs.hybridnetwork.ArmTemplateArtifactProfileResponse; } /** * Azure Operator Distributed Services template deploy mapping rule profile. */ interface AzureOperatorNexusArmTemplateDeployMappingRuleProfileResponse { /** * The application enablement. */ applicationEnablement?: string; /** * The template mapping rule profile. */ templateMappingRuleProfile?: outputs.hybridnetwork.ArmTemplateMappingRuleProfileResponse; } /** * The AzureOperatorNexusCluster NFVI detail. */ interface AzureOperatorNexusClusterNFVIDetailsResponse { /** * The reference to the custom location. */ customLocationReference?: outputs.hybridnetwork.ReferencedResourceResponse; /** * Name of the nfvi. */ name?: string; /** * The NFVI type. * Expected value is 'AzureOperatorNexus'. */ nfviType: "AzureOperatorNexus"; } /** * Azure Operator Distributed Services image artifact profile properties. */ interface AzureOperatorNexusImageArtifactProfileResponse { /** * The reference to artifact store. */ artifactStore?: outputs.hybridnetwork.ReferencedResourceResponse; /** * Image artifact profile. */ imageArtifactProfile?: outputs.hybridnetwork.ImageArtifactProfileResponse; } /** * Azure Operator Distributed Services image deploy mapping rule profile. */ interface AzureOperatorNexusImageDeployMappingRuleProfileResponse { /** * The application enablement. */ applicationEnablement?: string; /** * The vhd mapping rule profile. */ imageMappingRuleProfile?: outputs.hybridnetwork.ImageMappingRuleProfileResponse; } /** * Azure Operator Distributed Services network function Template application definition. */ interface AzureOperatorNexusNetworkFunctionArmTemplateApplicationResponse { /** * Azure Operator Distributed Services Template artifact profile. */ artifactProfile?: outputs.hybridnetwork.AzureOperatorNexusArmTemplateArtifactProfileResponse; /** * The artifact type. * Expected value is 'ArmTemplate'. */ artifactType: "ArmTemplate"; /** * Depends on profile definition. */ dependsOnProfile?: outputs.hybridnetwork.DependsOnProfileResponse; /** * Deploy mapping rule profile. */ deployParametersMappingRuleProfile?: outputs.hybridnetwork.AzureOperatorNexusArmTemplateDeployMappingRuleProfileResponse; /** * The name of the network function application. */ name?: string; } /** * Azure Operator Distributed Services network function image application definition. */ interface AzureOperatorNexusNetworkFunctionImageApplicationResponse { /** * Azure Operator Distributed Services image artifact profile. */ artifactProfile?: outputs.hybridnetwork.AzureOperatorNexusImageArtifactProfileResponse; /** * The artifact type. * Expected value is 'ImageFile'. */ artifactType: "ImageFile"; /** * Depends on profile definition. */ dependsOnProfile?: outputs.hybridnetwork.DependsOnProfileResponse; /** * Deploy mapping rule profile. */ deployParametersMappingRuleProfile?: outputs.hybridnetwork.AzureOperatorNexusImageDeployMappingRuleProfileResponse; /** * The name of the network function application. */ name?: string; } /** * Azure Operator Distributed Services network function template. */ interface AzureOperatorNexusNetworkFunctionTemplateResponse { /** * Network function applications. */ networkFunctionApplications?: (outputs.hybridnetwork.AzureOperatorNexusNetworkFunctionArmTemplateApplicationResponse | outputs.hybridnetwork.AzureOperatorNexusNetworkFunctionImageApplicationResponse)[]; /** * The network function type. * Expected value is 'AzureOperatorNexus'. */ nfviType: "AzureOperatorNexus"; } /** * Configuration group schema properties. */ interface ConfigurationGroupSchemaPropertiesFormatResponse { /** * Description of what schema can contain. */ description?: string; /** * The provisioning state of the Configuration group schema resource. */ provisioningState: string; /** * Name and value pairs that define the configuration value. It can be a well formed escaped JSON string. */ schemaDefinition?: string; /** * The configuration group schema version state. */ versionState: string; } /** * The ConfigurationValue with secrets. */ interface ConfigurationValueWithSecretsResponse { /** * The configuration group schema name. */ configurationGroupSchemaName: string; /** * The location of the configuration group schema offering. */ configurationGroupSchemaOfferingLocation: string; /** * The configuration group schema resource reference. */ configurationGroupSchemaResourceReference?: outputs.hybridnetwork.OpenDeploymentResourceReferenceResponse | outputs.hybridnetwork.SecretDeploymentResourceReferenceResponse; /** * The secret type which indicates if secret or not. * Expected value is 'Secret'. */ configurationType: "Secret"; /** * The provisioning state of the site resource. */ provisioningState: string; /** * The publisher name for the configuration group schema. */ publisherName: string; /** * The scope of the publisher. */ publisherScope: string; } /** * The ConfigurationValue with no secrets. */ interface ConfigurationValueWithoutSecretsResponse { /** * The configuration group schema name. */ configurationGroupSchemaName: string; /** * The location of the configuration group schema offering. */ configurationGroupSchemaOfferingLocation: string; /** * The configuration group schema resource reference. */ configurationGroupSchemaResourceReference?: outputs.hybridnetwork.OpenDeploymentResourceReferenceResponse | outputs.hybridnetwork.SecretDeploymentResourceReferenceResponse; /** * The secret type which indicates if secret or not. * Expected value is 'Open'. */ configurationType: "Open"; /** * Name and value pairs that define the configuration value. It can be a well formed escaped JSON string. */ configurationValue?: string; /** * The provisioning state of the site resource. */ provisioningState: string; /** * The publisher name for the configuration group schema. */ publisherName: string; /** * The scope of the publisher. */ publisherScope: string; } /** * Containerized network function network function definition version properties. */ interface ContainerizedNetworkFunctionDefinitionVersionResponse { /** * The deployment parameters of the network function definition version. */ deployParameters?: string; /** * The network function definition version description. */ description?: string; /** * Containerized network function template. */ networkFunctionTemplate?: outputs.hybridnetwork.AzureArcKubernetesNetworkFunctionTemplateResponse; /** * The network function type. * Expected value is 'ContainerizedNetworkFunction'. */ networkFunctionType: "ContainerizedNetworkFunction"; /** * The provisioning state of the network function definition version resource. */ provisioningState: string; /** * The network function definition version state. */ versionState: string; } /** * Specifies the custom settings for the virtual machine. */ interface CustomProfileResponse { /** * Path for metadata configuration. */ metadataConfigurationPath?: string; } /** * Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). */ interface DataDiskResponse { /** * Specifies how the virtual machine should be created. */ createOption?: string; /** * Specifies the size of an empty disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image. */ diskSizeGB?: number; /** * The name of data disk. */ name?: string; } /** * Depends on profile definition. */ interface DependsOnProfileResponse { /** * Application installation operation dependency. */ installDependsOn?: string[]; /** * Application deletion operation dependency. */ uninstallDependsOn?: string[]; /** * Application update operation dependency. */ updateDependsOn?: string[]; } /** * Helm artifact profile. */ interface HelmArtifactProfileResponse { /** * Helm package name. */ helmPackageName?: string; /** * Helm package version range. */ helmPackageVersionRange?: string; /** * The image pull secrets values path list. */ imagePullSecretsValuesPaths?: string[]; /** * The registry values path list. */ registryValuesPaths?: string[]; } /** * The helm deployment install options */ interface HelmInstallOptionsResponse { /** * The helm deployment atomic options */ atomic?: string; /** * The helm deployment timeout options */ timeout?: string; /** * The helm deployment wait options */ wait?: string; } /** * Helm mapping rule profile */ interface HelmMappingRuleProfileResponse { /** * Helm package version. */ helmPackageVersion?: string; /** * The helm deployment options */ options?: outputs.hybridnetwork.HelmMappingRuleProfileResponseOptions; /** * Helm release name. */ releaseName?: string; /** * Helm release namespace. */ releaseNamespace?: string; /** * Helm release values. */ values?: string; } /** * The helm deployment options */ interface HelmMappingRuleProfileResponseOptions { /** * The helm deployment install options */ installOptions?: outputs.hybridnetwork.HelmInstallOptionsResponse; /** * The helm deployment upgrade options */ upgradeOptions?: outputs.hybridnetwork.HelmUpgradeOptionsResponse; } /** * The helm deployment install options */ interface HelmUpgradeOptionsResponse { /** * The helm deployment atomic options */ atomic?: string; /** * The helm deployment timeout options */ timeout?: string; /** * The helm deployment wait options */ wait?: string; } /** * Image artifact profile. */ interface ImageArtifactProfileResponse { /** * Image name. */ imageName?: string; /** * Image version. */ imageVersion?: string; } /** * Image mapping rule profile */ interface ImageMappingRuleProfileResponse { /** * List of values. */ userConfiguration?: string; } /** * The image reference properties. */ interface ImageReferenceResponse { /** * Specifies in decimal numbers, the exact version of image used to create the virtual machine. */ exactVersion?: string; /** * Specifies the offer of the image used to create the virtual machine. */ offer?: string; /** * The image publisher. */ publisher?: string; /** * The image SKU. */ sku?: string; /** * Specifies the version of the image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. */ version?: string; } /** * Specifies the Linux operating system settings on the virtual machine. */ interface LinuxConfigurationResponse { /** * Specifies the ssh key configuration for a Linux OS. */ ssh?: outputs.hybridnetwork.SshConfigurationResponse; } /** * Managed resource group configuration. */ interface ManagedResourceGroupConfigurationResponse { /** * Managed resource group location. */ location?: string; /** * Managed resource group name. */ name?: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.hybridnetwork.UserAssignedIdentityResponse; }; } /** * Manifest artifact properties. */ interface ManifestArtifactFormatResponse { /** * The artifact name */ artifactName?: string; /** * The artifact type. */ artifactType?: string; /** * The artifact version. */ artifactVersion?: string; } /** * Artifact profile properties. */ interface NSDArtifactProfileResponse { /** * Artifact name. */ artifactName?: string; /** * The artifact store resource id */ artifactStoreReference?: outputs.hybridnetwork.ReferencedResourceResponse; /** * Artifact version. */ artifactVersion?: string; } /** * Network function definition group properties. */ interface NetworkFunctionDefinitionGroupPropertiesFormatResponse { /** * The network function definition group description. */ description?: string; /** * The provisioning state of the network function definition groups resource. */ provisioningState: string; } /** * The network function definition resource element template details. */ interface NetworkFunctionDefinitionResourceElementTemplateDetailsResponse { /** * The resource element template type. */ configuration?: outputs.hybridnetwork.ArmResourceDefinitionResourceElementTemplateResponse; /** * The depends on profile. */ dependsOnProfile?: outputs.hybridnetwork.DependsOnProfileResponse; /** * Name of the resource element template. */ name?: string; /** * The resource element template type. * Expected value is 'NetworkFunctionDefinition'. */ resourceElementType: "NetworkFunctionDefinition"; } /** * Network function role configuration. */ interface NetworkFunctionRoleConfigurationResponse { /** * Specifies the custom settings for the virtual machine. */ customProfile?: outputs.hybridnetwork.CustomProfileResponse; /** * The network interface configurations. */ networkInterfaces?: outputs.hybridnetwork.NetworkInterfaceResponse[]; /** * Specifies the operating system settings for the role instance. This value can be updated during the deployment of network function. */ osProfile?: outputs.hybridnetwork.OsProfileResponse; /** * The name of the network function role. */ roleName?: string; /** * Role type. */ roleType?: string; /** * Specifies the storage settings for the virtual machine disks. */ storageProfile?: outputs.hybridnetwork.StorageProfileResponse; /** * The user parameters for customers. The format of user data parameters has to be matched with the provided user data template. */ userDataParameters?: any; /** * The user data template for customers. This is a json schema template describing the format and data type of user data parameters. */ userDataTemplate?: any; /** * The size of the virtual machine. */ virtualMachineSize?: string; } /** * networkFunctionRoleConfigurationResponseProvideDefaults sets the appropriate defaults for NetworkFunctionRoleConfigurationResponse */ function networkFunctionRoleConfigurationResponseProvideDefaults(val: NetworkFunctionRoleConfigurationResponse): NetworkFunctionRoleConfigurationResponse; /** * The network function template. */ interface NetworkFunctionTemplateResponse { /** * An array of network function role definitions. */ networkFunctionRoleConfigurations?: outputs.hybridnetwork.NetworkFunctionRoleConfigurationResponse[]; } /** * NetworkFunction with secrets. */ interface NetworkFunctionValueWithSecretsResponse { /** * Indicates if software updates are allowed during deployment. */ allowSoftwareUpdate?: boolean; /** * The secret type which indicates if secret or not. * Expected value is 'Secret'. */ configurationType: "Secret"; /** * The network function definition group name for the network function. */ networkFunctionDefinitionGroupName?: string; /** * The location of the network function definition offering. */ networkFunctionDefinitionOfferingLocation?: string; /** * The network function definition version for the network function. */ networkFunctionDefinitionVersion?: string; /** * The network function definition version resource reference. */ networkFunctionDefinitionVersionResourceReference?: outputs.hybridnetwork.OpenDeploymentResourceReferenceResponse | outputs.hybridnetwork.SecretDeploymentResourceReferenceResponse; /** * The nfviId for the network function. */ nfviId?: string; /** * The nfvi type for the network function. */ nfviType?: string; /** * The provisioning state of the network function resource. */ provisioningState: string; /** * The publisher name for the network function. */ publisherName?: string; /** * The scope of the publisher. */ publisherScope?: string; /** * The role configuration override values from the user. */ roleOverrideValues?: string[]; } /** * NetworkFunction with no secrets. */ interface NetworkFunctionValueWithoutSecretsResponse { /** * Indicates if software updates are allowed during deployment. */ allowSoftwareUpdate?: boolean; /** * The secret type which indicates if secret or not. * Expected value is 'Open'. */ configurationType: "Open"; /** * The JSON-serialized deployment values from the user. */ deploymentValues?: string; /** * The network function definition group name for the network function. */ networkFunctionDefinitionGroupName?: string; /** * The location of the network function definition offering. */ networkFunctionDefinitionOfferingLocation?: string; /** * The network function definition version for the network function. */ networkFunctionDefinitionVersion?: string; /** * The network function definition version resource reference. */ networkFunctionDefinitionVersionResourceReference?: outputs.hybridnetwork.OpenDeploymentResourceReferenceResponse | outputs.hybridnetwork.SecretDeploymentResourceReferenceResponse; /** * The nfviId for the network function. */ nfviId?: string; /** * The nfvi type for the network function. */ nfviType?: string; /** * The provisioning state of the network function resource. */ provisioningState: string; /** * The publisher name for the network function. */ publisherName?: string; /** * The scope of the publisher. */ publisherScope?: string; /** * The role configuration override values from the user. */ roleOverrideValues?: string[]; } /** * Network interface IP configuration properties. */ interface NetworkInterfaceIPConfigurationResponse { /** * The list of DNS servers IP addresses. */ dnsServers?: string[]; /** * The value of the gateway. */ gateway?: string; /** * The value of the IP address. */ ipAddress?: string; /** * IP address allocation method. */ ipAllocationMethod?: string; /** * IP address version. */ ipVersion?: string; /** * The value of the subnet. */ subnet?: string; } /** * Network interface properties. */ interface NetworkInterfaceResponse { /** * A list of IP configurations of the network interface. */ ipConfigurations?: outputs.hybridnetwork.NetworkInterfaceIPConfigurationResponse[]; /** * The MAC address of the network interface. */ macAddress?: string; /** * The name of the network interface. */ networkInterfaceName?: string; /** * The type of the VM switch. */ vmSwitchType?: string; } /** * network service design group properties. */ interface NetworkServiceDesignGroupPropertiesFormatResponse { /** * The network service design group description. */ description?: string; /** * The provisioning state of the network service design groups resource. */ provisioningState: string; } /** * network service design version properties. */ interface NetworkServiceDesignVersionPropertiesFormatResponse { /** * The configuration schemas to used to define the values. */ configurationGroupSchemaReferences?: { [key: string]: outputs.hybridnetwork.ReferencedResourceResponse; }; /** * The network service design version description. */ description?: string; /** * The nfvis from the site. */ nfvisFromSite?: { [key: string]: outputs.hybridnetwork.NfviDetailsResponse; }; /** * The provisioning state of the network service design version resource. */ provisioningState: string; /** * List of resource element template */ resourceElementTemplates?: (outputs.hybridnetwork.ArmResourceDefinitionResourceElementTemplateDetailsResponse | outputs.hybridnetwork.NetworkFunctionDefinitionResourceElementTemplateDetailsResponse)[]; /** * The network service design version state. */ versionState: string; } /** * The nfvi details. */ interface NfviDetailsResponse { /** * The nfvi name. */ name?: string; /** * The nfvi type. */ type?: string; } /** * Non secret deployment resource id reference. */ interface OpenDeploymentResourceReferenceResponse { /** * Resource ID. */ id?: string; /** * The resource reference arm id type. * Expected value is 'Open'. */ idType: "Open"; } /** * Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json). */ interface OsDiskResponse { /** * Specifies the size of os disk in gigabytes. This is the fully expanded disk size needed of the VHD image on the ASE. This disk size should be greater than the size of the VHD provided in vhdUri. */ diskSizeGB?: number; /** * The VHD name. */ name?: string; /** * The OS type. */ osType?: string; } /** * Specifies the operating system settings for the role instance. */ interface OsProfileResponse { /** * Specifies the name of the administrator account.

**Windows-only restriction:** Cannot end in "."

**Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). */ adminUsername?: string; /** * Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the virtual machine. The maximum length of the binary array is 65535 bytes.

    **Note: Do not pass any secrets or passwords in customData property**

    This property cannot be updated after the VM is created.

    customData is passed to the VM to be saved as a file. For more information see [Custom Data on Azure VMs](https://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json) */ customData?: string; /** * Indicates if custom data is required to deploy this role. */ customDataRequired?: boolean; /** * Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). */ linuxConfiguration?: outputs.hybridnetwork.LinuxConfigurationResponse; } /** * osProfileResponseProvideDefaults sets the appropriate defaults for OsProfileResponse */ function osProfileResponseProvideDefaults(val: OsProfileResponse): OsProfileResponse; /** * publisher properties. */ interface PublisherPropertiesFormatResponse { /** * The provisioning state of the publisher resource. */ provisioningState: string; /** * The publisher scope. */ scope?: string; } /** * Reference to another resource. */ interface ReferencedResourceResponse { /** * Resource ID. */ id?: string; } /** * Secret deployment resource id reference. */ interface SecretDeploymentResourceReferenceResponse { /** * The resource reference arm id type. * Expected value is 'Secret'. */ idType: "Secret"; } /** * Site network service properties. */ interface SiteNetworkServicePropertiesFormatResponse { /** * The goal state of the site network service resource. This has references to the configuration group value objects that describe the desired state of the site network service. */ desiredStateConfigurationGroupValueReferences?: { [key: string]: outputs.hybridnetwork.ReferencedResourceResponse; }; /** * The last state of the site network service resource. */ lastStateConfigurationGroupValueReferences: { [key: string]: outputs.hybridnetwork.ReferencedResourceResponse; }; /** * The network service design version for the site network service. */ lastStateNetworkServiceDesignVersionName: string; /** * Managed resource group configuration. */ managedResourceGroupConfiguration?: outputs.hybridnetwork.ManagedResourceGroupConfigurationResponse; /** * The network service design group name for the site network service. */ networkServiceDesignGroupName: string; /** * The network service design version for the site network service. */ networkServiceDesignVersionName: string; /** * The location of the network service design offering. */ networkServiceDesignVersionOfferingLocation: string; /** * The network service design version resource reference. */ networkServiceDesignVersionResourceReference?: outputs.hybridnetwork.OpenDeploymentResourceReferenceResponse | outputs.hybridnetwork.SecretDeploymentResourceReferenceResponse; /** * The provisioning state of the site network service resource. */ provisioningState: string; /** * The publisher name for the site network service. */ publisherName: string; /** * The scope of the publisher. */ publisherScope: string; /** * The site details */ siteReference?: outputs.hybridnetwork.ReferencedResourceResponse; } /** * Site properties. */ interface SitePropertiesFormatResponse { /** * List of NFVIs */ nfvis?: (outputs.hybridnetwork.AzureArcK8sClusterNFVIDetailsResponse | outputs.hybridnetwork.AzureCoreNFVIDetailsResponse | outputs.hybridnetwork.AzureOperatorNexusClusterNFVIDetailsResponse)[]; /** * The provisioning state of the site resource. **TODO**: Confirm if this is needed. */ provisioningState: string; /** * The list of site network services on the site. */ siteNetworkServiceReferences: outputs.hybridnetwork.ReferencedResourceResponse[]; } /** * Sku, to be associated with a SiteNetworkService. */ interface SkuResponse { /** * Name of this Sku */ name: string; /** * The SKU tier based on the SKU name. */ tier: string; } /** * SSH configuration for Linux based VMs running on Azure */ interface SshConfigurationResponse { /** * The list of SSH public keys used to authenticate with linux based VMs. */ publicKeys?: outputs.hybridnetwork.SshPublicKeyResponse[]; } /** * Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. */ interface SshPublicKeyResponse { /** * SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

    For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json). */ keyData?: string; /** * Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys */ path?: string; } /** * Specifies the storage settings for the virtual machine disks. */ interface StorageProfileResponse { /** * Specifies the parameters that are used to add a data disk to a virtual machine. */ dataDisks?: outputs.hybridnetwork.DataDiskResponse[]; /** * The image reference properties. */ imageReference?: outputs.hybridnetwork.ImageReferenceResponse; /** * Specifies information about the operating system disk used by the virtual machine. */ osDisk?: outputs.hybridnetwork.OsDiskResponse; } /** * Reference to another sub resource. */ interface SubResourceResponse { /** * Resource ID. */ id?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Vhd artifact profile. */ interface VhdImageArtifactProfileResponse { /** * Vhd name. */ vhdName?: string; /** * Vhd version. */ vhdVersion?: string; } /** * Vhd mapping rule profile */ interface VhdImageMappingRuleProfileResponse { /** * List of values. */ userConfiguration?: string; } /** * Virtual network function network function definition version properties. */ interface VirtualNetworkFunctionNetworkFunctionDefinitionVersionResponse { /** * The deployment parameters of the network function definition version. */ deployParameters?: string; /** * The network function definition version description. */ description?: string; /** * Virtual network function template. */ networkFunctionTemplate?: outputs.hybridnetwork.AzureCoreNetworkFunctionTemplateResponse | outputs.hybridnetwork.AzureOperatorNexusNetworkFunctionTemplateResponse; /** * The network function type. * Expected value is 'VirtualNetworkFunction'. */ networkFunctionType: "VirtualNetworkFunction"; /** * The provisioning state of the network function definition version resource. */ provisioningState: string; /** * The network function definition version state. */ versionState: string; } } export declare namespace impact { /** * Client incident details ex: incidentId , incident source */ interface ClientIncidentDetailsResponse { /** * Client incident id. ex : id of the incident created to investigate and address the impact if any. */ clientIncidentId?: string; /** * Client incident source. ex : source system name where the incident is created */ clientIncidentSource?: string; } /** * Details about connectivity issue. Applicable when root resource causing the issue is not identified. For example, when a VM is impacted due to a network issue, the impacted resource could be VM or the network. In such cases, the connectivity field will have the details about both VM and network. */ interface ConnectivityResponse { /** * Port number for the connection */ port?: number; /** * Protocol used for the connection */ protocol?: string; /** * Source from which the connection was attempted */ source?: outputs.impact.SourceOrTargetResponse; /** * target which connection was attempted */ target?: outputs.impact.SourceOrTargetResponse; } /** * Details of the Connector. */ interface ConnectorPropertiesResponse { /** * unique id of the connector. */ connectorId: string; /** * connector type */ connectorType: string; /** * last run time stamp of this connector in UTC time zone */ lastRunTimeStamp: string; /** * Resource provisioning state. */ provisioningState: string; /** * tenant id of this connector */ tenantId: string; } /** * Article details of the insight like title, description etc */ interface ContentResponse { /** * Description of the insight */ description: string; /** * Title of the insight */ title: string; } /** * ARM error code and error message associated with the impact */ interface ErrorDetailPropertiesResponse { /** * ARM Error code associated with the impact. */ errorCode?: string; /** * ARM Error Message associated with the impact */ errorMessage?: string; } /** * Max and Min Threshold values for the metric */ interface ExpectedValueRangeResponse { /** * Max threshold value for the metric */ max: number; /** * Min threshold value for the metric */ min: number; } /** * details of of the impact for which insight has been generated. */ interface ImpactDetailsResponse { /** * Time at which impact was ended according to reported impact. */ endTime?: string; /** * Azure Id of the impact. */ impactId: string; /** * List of impacted Azure resources. */ impactedResourceId: string; /** * Time at which impact was started according to reported impact. */ startTime: string; } /** * Impact category properties. */ interface InsightPropertiesResponse { /** * additional details of the insight. */ additionalDetails?: any; /** * category of the insight. */ category: string; /** * Contains title & description for the insight */ content: outputs.impact.ContentResponse; /** * Identifier of the event that has been correlated with this insight. This can be used to aggregate insights for the same event. */ eventId?: string; /** * Time of the event, which has been correlated the impact. */ eventTime?: string; /** * Identifier that can be used to group similar insights. */ groupId?: string; /** * details of of the impact for which insight has been generated. */ impact: outputs.impact.ImpactDetailsResponse; /** * unique id of the insight. */ insightUniqueId: string; /** * Resource provisioning state. */ provisioningState: string; /** * status of the insight. example resolved, repaired, other. */ status?: string; } /** * Details about impacted performance metrics. Applicable for performance related impact */ interface PerformanceResponse { /** * Observed value for the metric */ actual?: number; /** * Threshold value for the metric */ expected?: number; /** * Max and Min Threshold values for the metric */ expectedValueRange?: outputs.impact.ExpectedValueRangeResponse; /** * Name of the Metric examples: Disk, IOPs, CPU, GPU, Memory, details can be found from /impactCategories API */ metricName?: string; /** * Unit of the metric ex: Bytes, Percentage, Count, Seconds, Milliseconds, Bytes/Second, Count/Second, etc.., Other */ unit?: string; } /** * Resource details */ interface SourceOrTargetResponse { /** * Azure resource id, example /subscription/{subscription}/resourceGroup/{rg}/Microsoft.compute/virtualMachine/{vmName} */ azureResourceId?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Workload impact properties */ interface WorkloadImpactPropertiesResponse { /** * Additional fields related to impact, applicable fields per resource type are list under /impactCategories API */ additionalProperties?: any; /** * The ARM correlation ids, this is important field for control plane related impacts */ armCorrelationIds?: string[]; /** * Client incident details ex: incidentId , incident source */ clientIncidentDetails?: outputs.impact.ClientIncidentDetailsResponse; /** * Degree of confidence on the impact being a platform issue */ confidenceLevel?: string; /** * Details about connectivity issue. Applicable when root resource causing the issue is not identified. For example, when a VM is impacted due to a network issue, the impacted resource is identified as the VM, but the root cause is the network. In such cases, the connectivity field will have the details about the network issue */ connectivity?: outputs.impact.ConnectivityResponse; /** * Time at which impact has ended */ endDateTime?: string; /** * ARM error code and error message associated with the impact */ errorDetails?: outputs.impact.ErrorDetailPropertiesResponse; /** * Category of the impact, details can found from /impactCategories API */ impactCategory: string; /** * A detailed description of the impact */ impactDescription?: string; /** * Use this field to group impacts */ impactGroupId?: string; /** * Unique ID of the impact (UUID) */ impactUniqueId: string; /** * Azure resource id of the impacted resource */ impactedResourceId: string; /** * Details about performance issue. Applicable for performance impacts. */ performance?: outputs.impact.PerformanceResponse[]; /** * Resource provisioning state. */ provisioningState: string; /** * Time at which impact is reported */ reportedTimeUtc: string; /** * Time at which impact was observed */ startDateTime: string; /** * Information about the impacted workload */ workload?: outputs.impact.WorkloadResponse; } /** * Information about the impacted workload */ interface WorkloadResponse { /** * the scenario for the workload */ context?: string; /** * Tool used to interact with Azure. SDK, AzPortal, etc.., Other */ toolset?: string; } } export declare namespace importexport { /** * Contains information about the delivery package being shipped by the customer to the Microsoft data center. */ interface DeliveryPackageInformationResponse { /** * The name of the carrier that is used to ship the import or export drives. */ carrierName: string; /** * The number of drives included in the package. */ driveCount?: number; /** * The date when the package is shipped. */ shipDate?: string; /** * The tracking number of the package. */ trackingNumber: string; } /** * BitLocker recovery key or password to the specified drive */ interface DriveBitLockerKeyResponse { /** * BitLocker recovery key or password */ bitLockerKey?: string; /** * Drive ID */ driveId?: string; } /** * Provides information about the drive's status */ interface DriveStatusResponse { /** * The BitLocker key used to encrypt the drive. */ bitLockerKey?: string; /** * Bytes successfully transferred for the drive. */ bytesSucceeded?: number; /** * Detailed status about the data transfer process. This field is not returned in the response until the drive is in the Transferring state. */ copyStatus?: string; /** * The drive header hash value. */ driveHeaderHash?: string; /** * The drive's hardware serial number, without spaces. */ driveId?: string; /** * A URI that points to the blob containing the error log for the data transfer operation. */ errorLogUri?: string; /** * The relative path of the manifest file on the drive. */ manifestFile?: string; /** * The Base16-encoded MD5 hash of the manifest file on the drive. */ manifestHash?: string; /** * A URI that points to the blob containing the drive manifest file. */ manifestUri?: string; /** * Percentage completed for the drive. */ percentComplete?: number; /** * The drive's current state. */ state?: string; /** * A URI that points to the blob containing the verbose log for the data transfer operation. */ verboseLogUri?: string; } /** * driveStatusResponseProvideDefaults sets the appropriate defaults for DriveStatusResponse */ function driveStatusResponseProvideDefaults(val: DriveStatusResponse): DriveStatusResponse; /** * Specifies the encryption key properties */ interface EncryptionKeyDetailsResponse { /** * The type of kek encryption key */ kekType?: string; /** * Specifies the url for kek encryption key. */ kekUrl?: string; /** * Specifies the keyvault resource id for kek encryption key. */ kekVaultResourceID?: string; } /** * encryptionKeyDetailsResponseProvideDefaults sets the appropriate defaults for EncryptionKeyDetailsResponse */ function encryptionKeyDetailsResponseProvideDefaults(val: EncryptionKeyDetailsResponse): EncryptionKeyDetailsResponse; /** * A property containing information about the blobs to be exported for an export job. This property is required for export jobs, but must not be specified for import jobs. */ interface ExportResponse { /** * The relative URI to the block blob that contains the list of blob paths or blob path prefixes as defined above, beginning with the container name. If the blob is in root container, the URI must begin with $root. */ blobListBlobPath?: string; /** * A collection of blob-path strings. */ blobPath?: string[]; /** * A collection of blob-prefix strings. */ blobPathPrefix?: string[]; } /** * Specifies the identity properties. */ interface IdentityDetailsResponse { /** * Specifies the principal id for the identity for the job. */ principalId: string; /** * Specifies the tenant id for the identity for the job. */ tenantId: string; /** * The type of identity */ type?: string; } /** * identityDetailsResponseProvideDefaults sets the appropriate defaults for IdentityDetailsResponse */ function identityDetailsResponseProvideDefaults(val: IdentityDetailsResponse): IdentityDetailsResponse; /** * Specifies the job properties */ interface JobDetailsResponse { /** * Default value is false. Indicates whether the manifest files on the drives should be copied to block blobs. */ backupDriveManifest?: boolean; /** * Indicates whether a request has been submitted to cancel the job. */ cancelRequested?: boolean; /** * Contains information about the package being shipped by the customer to the Microsoft data center. */ deliveryPackage?: outputs.importexport.DeliveryPackageInformationResponse; /** * The virtual blob directory to which the copy logs and backups of drive manifest files (if enabled) will be stored. */ diagnosticsPath?: string; /** * List of up to ten drives that comprise the job. The drive list is a required element for an import job; it is not specified for export jobs. */ driveList?: outputs.importexport.DriveStatusResponse[]; /** * Contains information about the encryption key. */ encryptionKey?: outputs.importexport.EncryptionKeyDetailsResponse; /** * A property containing information about the blobs to be exported for an export job. This property is included for export jobs only. */ export?: outputs.importexport.ExportResponse; /** * A blob path that points to a block blob containing a list of blob names that were not exported due to insufficient drive space. If all blobs were exported successfully, then this element is not included in the response. */ incompleteBlobListUri?: string; /** * The type of job */ jobType?: string; /** * Default value is Error. Indicates whether error logging or verbose logging will be enabled. */ logLevel?: string; /** * Overall percentage completed for the job. */ percentComplete?: number; /** * Specifies the provisioning state of the job. */ provisioningState?: string; /** * Specifies the return address information for the job. */ returnAddress?: outputs.importexport.ReturnAddressResponse; /** * Contains information about the package being shipped from the Microsoft data center to the customer to return the drives. The format is the same as the deliveryPackage property above. This property is not included if the drives have not yet been returned. */ returnPackage?: outputs.importexport.PackageInformationResponse; /** * Specifies the return carrier and customer's account with the carrier. */ returnShipping?: outputs.importexport.ReturnShippingResponse; /** * Contains information about the Microsoft datacenter to which the drives should be shipped. */ shippingInformation?: outputs.importexport.ShippingInformationResponse; /** * Current state of the job. */ state?: string; /** * The resource identifier of the storage account where data will be imported to or exported from. */ storageAccountId?: string; } /** * jobDetailsResponseProvideDefaults sets the appropriate defaults for JobDetailsResponse */ function jobDetailsResponseProvideDefaults(val: JobDetailsResponse): JobDetailsResponse; /** * Contains information about the package being shipped by the customer to the Microsoft data center. */ interface PackageInformationResponse { /** * The name of the carrier that is used to ship the import or export drives. */ carrierName: string; /** * The number of drives included in the package. */ driveCount: number; /** * The date when the package is shipped. */ shipDate: string; /** * The tracking number of the package. */ trackingNumber: string; } /** * Specifies the return address information for the job. */ interface ReturnAddressResponse { /** * The city name to use when returning the drives. */ city: string; /** * The country or region to use when returning the drives. */ countryOrRegion: string; /** * Email address of the recipient of the returned drives. */ email: string; /** * Phone number of the recipient of the returned drives. */ phone: string; /** * The postal code to use when returning the drives. */ postalCode: string; /** * The name of the recipient who will receive the hard drives when they are returned. */ recipientName: string; /** * The state or province to use when returning the drives. */ stateOrProvince?: string; /** * The first line of the street address to use when returning the drives. */ streetAddress1: string; /** * The second line of the street address to use when returning the drives. */ streetAddress2?: string; } /** * Specifies the return carrier and customer's account with the carrier. */ interface ReturnShippingResponse { /** * The customer's account number with the carrier. */ carrierAccountNumber: string; /** * The carrier's name. */ carrierName: string; } /** * Contains information about the Microsoft datacenter to which the drives should be shipped. */ interface ShippingInformationResponse { /** * Additional shipping information for customer, specific to datacenter to which customer should send their disks. */ additionalInformation: string; /** * The city name to use when returning the drives. */ city?: string; /** * The country or region to use when returning the drives. */ countryOrRegion?: string; /** * Phone number of the recipient of the returned drives. */ phone?: string; /** * The postal code to use when returning the drives. */ postalCode?: string; /** * The name of the recipient who will receive the hard drives when they are returned. */ recipientName?: string; /** * The state or province to use when returning the drives. */ stateOrProvince?: string; /** * The first line of the street address to use when returning the drives. */ streetAddress1?: string; /** * The second line of the street address to use when returning the drives. */ streetAddress2?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace integrationspaces { /** * The properties of business process development artifact. */ interface BusinessProcessDevelopmentArtifactPropertiesResponse { /** * The business process mapping. */ businessProcessMapping?: { [key: string]: outputs.integrationspaces.BusinessProcessMappingItemResponse; }; /** * The business process stages. */ businessProcessStages?: { [key: string]: outputs.integrationspaces.BusinessProcessStageResponse; }; /** * The description of the business process. */ description?: string; /** * The business process identifier. */ identifier?: outputs.integrationspaces.BusinessProcessIdentifierResponse; /** * The tracking profile for the business process. */ trackingProfiles?: { [key: string]: outputs.integrationspaces.TrackingProfileDefinitionResponse; }; } /** * The properties of business process identifier. */ interface BusinessProcessIdentifierResponse { /** * The property name of the business process identifier. */ propertyName?: string; /** * The property type of the business process identifier. */ propertyType?: string; } /** * The properties of business process mapping. */ interface BusinessProcessMappingItemResponse { /** * The logic app resource id. */ logicAppResourceId?: string; /** * The operation name. */ operationName?: string; /** * The mapping item operation type of the business process. */ operationType?: string; /** * The workflow name within the logic app. */ workflowName?: string; } /** * The business process reference. */ interface BusinessProcessReferenceResponse { /** * The business process name. */ name?: string; /** * The business process version. */ version?: string; } /** * The properties of business process stage. */ interface BusinessProcessStageResponse { /** * The description of the business stage. */ description?: string; /** * The properties within the properties of the business process stage. */ properties?: { [key: string]: string; }; /** * The property to keep track of stages before current in the business process stage. */ stagesBefore?: string[]; } /** * The workflow tracking definition. */ interface FlowTrackingDefinitionResponse { /** * The tracking correlation context. */ correlationContext?: outputs.integrationspaces.TrackingCorrelationContextResponse; /** * The tracking events. */ events?: { [key: string]: outputs.integrationspaces.TrackingEventDefinitionResponse; }; } /** * The business process development artifact save or get response. */ interface SaveOrGetBusinessProcessDevelopmentArtifactResponseResponse { /** * The name of the business process development artifact. */ name: string; /** * The properties of the business process development artifact. */ properties?: outputs.integrationspaces.BusinessProcessDevelopmentArtifactPropertiesResponse; /** * The system data of the business process development artifact. */ systemData: outputs.integrationspaces.SystemDataResponse; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The tracking correlation context. */ interface TrackingCorrelationContextResponse { /** * The operation name for correlation context. */ operationName?: string; /** * The operation type for correlation context. */ operationType?: string; /** * The name of the correlation property. */ propertyName?: string; /** * The template expression for correlation context property value. */ value?: string; } /** * The properties of tracking data store. */ interface TrackingDataStoreResponse { /** * The data store ingestion URI. */ dataStoreIngestionUri?: string; /** * The data store resource id. */ dataStoreResourceId?: string; /** * The data store URI. */ dataStoreUri?: string; /** * The database name. */ databaseName?: string; } /** * The tracking event definition. */ interface TrackingEventDefinitionResponse { /** * The operation name. */ operationName?: string; /** * The operation type. */ operationType?: string; /** * The properties to be collected for event. */ properties?: { [key: string]: any; }; } /** * The tracking profile for the business process */ interface TrackingProfileDefinitionResponse { /** * The business process reference. */ businessProcess?: outputs.integrationspaces.BusinessProcessReferenceResponse; /** * The tracking definition schema uri. */ schema?: string; /** * The tracking definitions. */ trackingDefinitions?: { [key: string]: outputs.integrationspaces.FlowTrackingDefinitionResponse; }; } } export declare namespace iotcentral { /** * Information about the SKU of the IoT Central application. */ interface AppSkuInfoResponse { /** * The name of the SKU. */ name: string; } /** * An object for an IP range that will be allowed access. */ interface NetworkRuleSetIpRuleResponse { /** * The network action for the IP mask. */ action: string; /** * The readable name of the IP rule. */ filterName?: string; /** * The CIDR block defining the IP range. */ ipMask?: string; } /** * Network Rule Set Properties of this IoT Central application. */ interface NetworkRuleSetsResponse { /** * Whether these rules apply for device connectivity to IoT Hub and Device Provisioning service associated with this application. */ applyToDevices?: boolean; /** * Whether these rules apply for connectivity via IoT Central web portal and APIs. */ applyToIoTCentral?: boolean; /** * The default network action to apply. */ defaultAction?: string; /** * List of IP rules. */ ipRules?: outputs.iotcentral.NetworkRuleSetIpRuleResponse[]; } /** * networkRuleSetsResponseProvideDefaults sets the appropriate defaults for NetworkRuleSetsResponse */ function networkRuleSetsResponseProvideDefaults(val: NetworkRuleSetsResponse): NetworkRuleSetsResponse; /** * The private endpoint connection resource. */ interface PrivateEndpointConnectionResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint resource. */ privateEndpoint?: outputs.iotcentral.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.iotcentral.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.iotcentral.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Managed service identity (either system assigned, or none) */ interface SystemAssignedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (either system assigned, or none). */ type: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace iotfirmwaredefense { /** * Error and status message */ interface StatusMessageResponse { /** * The error code */ errorCode?: number; /** * The error or status message */ message?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace iothub { interface ArmIdentityResponse { /** * Principal Id */ principalId: string; /** * Tenant Id */ tenantId: string; /** * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service. */ type?: string; userAssignedIdentities?: { [key: string]: outputs.iothub.ArmUserIdentityResponse; }; } interface ArmUserIdentityResponse { clientId: string; principalId: string; } /** * The description of an X509 CA Certificate. */ interface CertificatePropertiesResponse { /** * The certificate content */ certificate?: string; /** * The certificate's create date and time. */ created: string; /** * The certificate's expiration date and time. */ expiry: string; /** * Determines whether certificate has been verified. */ isVerified?: boolean; /** * The certificate's subject name. */ subject: string; /** * The certificate's thumbprint. */ thumbprint: string; /** * The certificate's last update date and time. */ updated: string; } /** * The IoT hub cloud-to-device messaging properties. */ interface CloudToDevicePropertiesResponse { /** * The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. */ defaultTtlAsIso8601?: string; /** * The properties of the feedback queue for cloud-to-device messages. */ feedback?: outputs.iothub.FeedbackPropertiesResponse; /** * The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. */ maxDeliveryCount?: number; } /** * The properties of an enrichment that your IoT hub applies to messages delivered to endpoints. */ interface EnrichmentPropertiesResponse { /** * The list of endpoints for which the enrichment is applied to the message. */ endpointNames: string[]; /** * The key or name for the enrichment property. */ key: string; /** * The value for the enrichment property. */ value: string; } /** * The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub. */ interface EventHubPropertiesResponse { /** * The Event Hub-compatible endpoint. */ endpoint: string; /** * The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages. */ partitionCount?: number; /** * The partition ids in the Event Hub-compatible endpoint. */ partitionIds: string[]; /** * The Event Hub-compatible name. */ path: string; /** * The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages */ retentionTimeInDays?: number; } /** * The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint. */ interface FallbackRoutePropertiesResponse { /** * The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language */ condition?: string; /** * The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed. */ endpointNames: string[]; /** * Used to specify whether the fallback route is enabled. */ isEnabled: boolean; /** * The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. */ name?: string; /** * The source to which the routing rule is to be applied to. For example, DeviceMessages */ source: string; } /** * The properties of the feedback queue for cloud-to-device messages. */ interface FeedbackPropertiesResponse { /** * The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. */ lockDurationAsIso8601?: string; /** * The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. */ maxDeliveryCount?: number; /** * The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages. */ ttlAsIso8601?: string; } /** * Public representation of one of the locations where a resource is provisioned. */ interface IotHubLocationDescriptionResponse { /** * The name of the Azure region */ location?: string; /** * The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to. */ role?: string; } /** * The properties of an IoT hub. */ interface IotHubPropertiesResponse { /** * List of allowed FQDNs(Fully Qualified Domain Name) for egress from Iot Hub. */ allowedFqdnList?: string[]; /** * The shared access policies you can use to secure a connection to the IoT hub. */ authorizationPolicies?: outputs.iothub.SharedAccessSignatureAuthorizationRuleResponse[]; /** * The IoT hub cloud-to-device messaging properties. */ cloudToDevice?: outputs.iothub.CloudToDevicePropertiesResponse; /** * IoT hub comments. */ comments?: string; /** * If true, all device(including Edge devices but excluding modules) scoped SAS keys cannot be used for authentication. */ disableDeviceSAS?: boolean; /** * If true, SAS tokens with Iot hub scoped SAS keys cannot be used for authentication. */ disableLocalAuth?: boolean; /** * If true, all module scoped SAS keys cannot be used for authentication. */ disableModuleSAS?: boolean; /** * This property when set to true, will enable data residency, thus, disabling disaster recovery. */ enableDataResidency?: boolean; /** * If True, file upload notifications are enabled. */ enableFileUploadNotifications?: boolean; /** * The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub. */ eventHubEndpoints?: { [key: string]: outputs.iothub.EventHubPropertiesResponse; }; /** * The capabilities and features enabled for the IoT hub. */ features?: string; /** * The name of the host. */ hostName: string; /** * The IP filter rules. */ ipFilterRules?: outputs.iothub.IpFilterRuleResponse[]; /** * Primary and secondary location for iot hub */ locations: outputs.iothub.IotHubLocationDescriptionResponse[]; /** * The messaging endpoint properties for the file upload notification queue. */ messagingEndpoints?: { [key: string]: outputs.iothub.MessagingEndpointPropertiesResponse; }; /** * Specifies the minimum TLS version to support for this hub. Can be set to "1.2" to have clients that use a TLS version below 1.2 to be rejected. */ minTlsVersion?: string; /** * Network Rule Set Properties of IotHub */ networkRuleSets?: outputs.iothub.NetworkRuleSetPropertiesResponse; /** * Private endpoint connections created on this IotHub */ privateEndpointConnections?: outputs.iothub.PrivateEndpointConnectionResponse[]; /** * The provisioning state. */ provisioningState: string; /** * Whether requests from Public Network are allowed */ publicNetworkAccess?: string; /** * If true, egress from IotHub will be restricted to only the allowed FQDNs that are configured via allowedFqdnList. */ restrictOutboundNetworkAccess?: boolean; /** * The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging */ routing?: outputs.iothub.RoutingPropertiesResponse; /** * The hub state. */ state: string; /** * The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown. */ storageEndpoints?: { [key: string]: outputs.iothub.StorageEndpointPropertiesResponse; }; } /** * iotHubPropertiesResponseProvideDefaults sets the appropriate defaults for IotHubPropertiesResponse */ function iotHubPropertiesResponseProvideDefaults(val: IotHubPropertiesResponse): IotHubPropertiesResponse; /** * Information about the SKU of the IoT hub. */ interface IotHubSkuInfoResponse { /** * The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits. */ capacity?: number; /** * The name of the SKU. */ name: string; /** * The billing tier for the IoT hub. */ tier: string; } /** * The IP filter rules for the IoT hub. */ interface IpFilterRuleResponse { /** * The desired action for requests captured by this rule. */ action: string; /** * The name of the IP filter rule. */ filterName: string; /** * A string that contains the IP address range in CIDR notation for the rule. */ ipMask: string; } /** * The properties of the Managed identity. */ interface ManagedIdentityResponse { /** * The user assigned identity. */ userAssignedIdentity?: string; } /** * The properties of the messaging endpoints used by this IoT hub. */ interface MessagingEndpointPropertiesResponse { /** * The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. */ lockDurationAsIso8601?: string; /** * The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. */ maxDeliveryCount?: number; /** * The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload. */ ttlAsIso8601?: string; } /** * IP Rule to be applied as part of Network Rule Set */ interface NetworkRuleSetIpRuleResponse { /** * IP Filter Action */ action?: string; /** * Name of the IP filter rule. */ filterName: string; /** * A string that contains the IP address range in CIDR notation for the rule. */ ipMask: string; } /** * networkRuleSetIpRuleResponseProvideDefaults sets the appropriate defaults for NetworkRuleSetIpRuleResponse */ function networkRuleSetIpRuleResponseProvideDefaults(val: NetworkRuleSetIpRuleResponse): NetworkRuleSetIpRuleResponse; /** * Network Rule Set Properties of IotHub */ interface NetworkRuleSetPropertiesResponse { /** * If True, then Network Rule Set is also applied to BuiltIn EventHub EndPoint of IotHub */ applyToBuiltInEventHubEndpoint: boolean; /** * Default Action for Network Rule Set */ defaultAction?: string; /** * List of IP Rules */ ipRules: outputs.iothub.NetworkRuleSetIpRuleResponse[]; } /** * networkRuleSetPropertiesResponseProvideDefaults sets the appropriate defaults for NetworkRuleSetPropertiesResponse */ function networkRuleSetPropertiesResponseProvideDefaults(val: NetworkRuleSetPropertiesResponse): NetworkRuleSetPropertiesResponse; /** * The properties of a private endpoint connection */ interface PrivateEndpointConnectionPropertiesResponse { /** * The private endpoint property of a private endpoint connection */ privateEndpoint?: outputs.iothub.PrivateEndpointResponse; /** * The current state of a private endpoint connection */ privateLinkServiceConnectionState: outputs.iothub.PrivateLinkServiceConnectionStateResponse; } /** * The private endpoint connection of an IotHub */ interface PrivateEndpointConnectionResponse { /** * The resource identifier. */ id: string; /** * The resource name. */ name: string; /** * The properties of a private endpoint connection */ properties: outputs.iothub.PrivateEndpointConnectionPropertiesResponse; /** * The resource type. */ type: string; } /** * The private endpoint property of a private endpoint connection */ interface PrivateEndpointResponse { /** * The resource identifier. */ id: string; } /** * The current state of a private endpoint connection */ interface PrivateLinkServiceConnectionStateResponse { /** * Actions required for a private endpoint connection */ actionsRequired?: string; /** * The description for the current state of a private endpoint connection */ description: string; /** * The status of a private endpoint connection */ status: string; } /** * The properties of a routing rule that your IoT hub uses to route messages to endpoints. */ interface RoutePropertiesResponse { /** * The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language */ condition?: string; /** * The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed. */ endpointNames: string[]; /** * Used to specify whether a route is enabled. */ isEnabled: boolean; /** * The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique. */ name: string; /** * The source that the routing rule is to be applied to, such as DeviceMessages. */ source: string; } /** * The properties related to a cosmos DB sql container endpoint. */ interface RoutingCosmosDBSqlApiPropertiesResponse { /** * Method used to authenticate against the cosmos DB sql container endpoint */ authenticationType?: string; /** * The name of the cosmos DB sql container in the cosmos DB database. */ containerName: string; /** * The name of the cosmos DB database in the cosmos DB account. */ databaseName: string; /** * The url of the cosmos DB account. It must include the protocol https:// */ endpointUri: string; /** * Id of the cosmos DB sql container endpoint */ id: string; /** * Managed identity properties of routing cosmos DB container endpoint. */ identity?: outputs.iothub.ManagedIdentityResponse; /** * The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. */ name: string; /** * The name of the partition key associated with this cosmos DB sql container if one exists. This is an optional parameter. */ partitionKeyName?: string; /** * The template for generating a synthetic partition key value for use with this cosmos DB sql container. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified. */ partitionKeyTemplate?: string; /** * The primary key of the cosmos DB account. */ primaryKey?: string; /** * The name of the resource group of the cosmos DB account. */ resourceGroup?: string; /** * The secondary key of the cosmos DB account. */ secondaryKey?: string; /** * The subscription identifier of the cosmos DB account. */ subscriptionId?: string; } /** * The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. */ interface RoutingEndpointsResponse { /** * The list of Cosmos DB container endpoints that IoT hub routes messages to, based on the routing rules. */ cosmosDBSqlContainers?: outputs.iothub.RoutingCosmosDBSqlApiPropertiesResponse[]; /** * The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint. */ eventHubs?: outputs.iothub.RoutingEventHubPropertiesResponse[]; /** * The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules. */ serviceBusQueues?: outputs.iothub.RoutingServiceBusQueueEndpointPropertiesResponse[]; /** * The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules. */ serviceBusTopics?: outputs.iothub.RoutingServiceBusTopicEndpointPropertiesResponse[]; /** * The list of storage container endpoints that IoT hub routes messages to, based on the routing rules. */ storageContainers?: outputs.iothub.RoutingStorageContainerPropertiesResponse[]; } /** * The properties related to an event hub endpoint. */ interface RoutingEventHubPropertiesResponse { /** * Method used to authenticate against the event hub endpoint */ authenticationType?: string; /** * The connection string of the event hub endpoint. */ connectionString?: string; /** * The url of the event hub endpoint. It must include the protocol sb:// */ endpointUri?: string; /** * Event hub name on the event hub namespace */ entityPath?: string; /** * Id of the event hub endpoint */ id?: string; /** * Managed identity properties of routing event hub endpoint. */ identity?: outputs.iothub.ManagedIdentityResponse; /** * The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. */ name: string; /** * The name of the resource group of the event hub endpoint. */ resourceGroup?: string; /** * The subscription identifier of the event hub endpoint. */ subscriptionId?: string; } /** * The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging */ interface RoutingPropertiesResponse { /** * The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs. */ endpoints?: outputs.iothub.RoutingEndpointsResponse; /** * The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid */ enrichments?: outputs.iothub.EnrichmentPropertiesResponse[]; /** * The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not present in the template, the fallback route is disabled by default. */ fallbackRoute?: outputs.iothub.FallbackRoutePropertiesResponse; /** * The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs. */ routes?: outputs.iothub.RoutePropertiesResponse[]; } /** * The properties related to service bus queue endpoint types. */ interface RoutingServiceBusQueueEndpointPropertiesResponse { /** * Method used to authenticate against the service bus queue endpoint */ authenticationType?: string; /** * The connection string of the service bus queue endpoint. */ connectionString?: string; /** * The url of the service bus queue endpoint. It must include the protocol sb:// */ endpointUri?: string; /** * Queue name on the service bus namespace */ entityPath?: string; /** * Id of the service bus queue endpoint */ id?: string; /** * Managed identity properties of routing service bus queue endpoint. */ identity?: outputs.iothub.ManagedIdentityResponse; /** * The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name. */ name: string; /** * The name of the resource group of the service bus queue endpoint. */ resourceGroup?: string; /** * The subscription identifier of the service bus queue endpoint. */ subscriptionId?: string; } /** * The properties related to service bus topic endpoint types. */ interface RoutingServiceBusTopicEndpointPropertiesResponse { /** * Method used to authenticate against the service bus topic endpoint */ authenticationType?: string; /** * The connection string of the service bus topic endpoint. */ connectionString?: string; /** * The url of the service bus topic endpoint. It must include the protocol sb:// */ endpointUri?: string; /** * Queue name on the service bus topic */ entityPath?: string; /** * Id of the service bus topic endpoint */ id?: string; /** * Managed identity properties of routing service bus topic endpoint. */ identity?: outputs.iothub.ManagedIdentityResponse; /** * The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name. */ name: string; /** * The name of the resource group of the service bus topic endpoint. */ resourceGroup?: string; /** * The subscription identifier of the service bus topic endpoint. */ subscriptionId?: string; } /** * The properties related to a storage container endpoint. */ interface RoutingStorageContainerPropertiesResponse { /** * Method used to authenticate against the storage endpoint */ authenticationType?: string; /** * Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. */ batchFrequencyInSeconds?: number; /** * The connection string of the storage account. */ connectionString?: string; /** * The name of storage container in the storage account. */ containerName: string; /** * Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'. */ encoding?: string; /** * The url of the storage endpoint. It must include the protocol https:// */ endpointUri?: string; /** * File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. */ fileNameFormat?: string; /** * Id of the storage container endpoint */ id?: string; /** * Managed identity properties of routing storage endpoint. */ identity?: outputs.iothub.ManagedIdentityResponse; /** * Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). */ maxChunkSizeInBytes?: number; /** * The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. */ name: string; /** * The name of the resource group of the storage account. */ resourceGroup?: string; /** * The subscription identifier of the storage account. */ subscriptionId?: string; } /** * The properties of an IoT hub shared access policy. */ interface SharedAccessSignatureAuthorizationRuleResponse { /** * The name of the shared access policy. */ keyName: string; /** * The primary key. */ primaryKey?: string; /** * The permissions assigned to the shared access policy. */ rights: string; /** * The secondary key. */ secondaryKey?: string; } /** * The properties of the Azure Storage endpoint for file upload. */ interface StorageEndpointPropertiesResponse { /** * Specifies authentication type being used for connecting to the storage account. */ authenticationType?: string; /** * The connection string for the Azure Storage account to which files are uploaded. */ connectionString: string; /** * The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified. */ containerName: string; /** * Managed identity properties of storage endpoint for file upload. */ identity?: outputs.iothub.ManagedIdentityResponse; /** * The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options. */ sasTtlAsIso8601?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace iotoperations { /** * Broker Advanced Settings */ interface AdvancedSettingsResponse { /** * Configurations related to All Clients. */ clients?: outputs.iotoperations.ClientConfigResponse; /** * The setting to enable or disable encryption of internal Traffic. */ encryptInternalTraffic?: string; /** * Certificate rotation and private key configuration. */ internalCerts?: outputs.iotoperations.CertManagerCertOptionsResponse; } /** * advancedSettingsResponseProvideDefaults sets the appropriate defaults for AdvancedSettingsResponse */ function advancedSettingsResponseProvideDefaults(val: AdvancedSettingsResponse): AdvancedSettingsResponse; /** * AkriConnector properties. */ interface AkriConnectorPropertiesResponse { /** * The status of the last operation. */ provisioningState: string; } /** * AkriConnectorTemplateAioMetadata properties. */ interface AkriConnectorTemplateAioMetadataResponse { /** * The maximum version of AIO required for the connector. */ aioMaxVersion?: string; /** * The minimum version of AIO required for the connector. */ aioMinVersion?: string; } /** * AkriConnectorTemplateBucketizedAllocation properties. */ interface AkriConnectorTemplateBucketizedAllocationResponse { /** * The bucketized allocation of AEPs for connectors. */ bucketSize: number; /** * AkriConnectorTemplateAllocationPolicy properties. * Expected value is 'Bucketized'. */ policy: "Bucketized"; } /** * AkriConnectorTemplateDeviceInboundEndpointConfigurationSchemaRefs properties. */ interface AkriConnectorTemplateDeviceInboundEndpointConfigurationSchemaRefsResponse { /** * The additional configuration schema reference. */ additionalConfigSchemaRef?: string; /** * The default configuration schema reference for datasets. */ defaultDatasetConfigSchemaRef?: string; /** * The default configuration schema reference for events. */ defaultEventsConfigSchemaRef?: string; /** * The default configuration schema reference for process control. */ defaultProcessControlConfigSchemaRef?: string; /** * The default configuration schema reference for streams. */ defaultStreamsConfigSchemaRef?: string; } /** * AkriConnectorTemplateDeviceInboundEndpointType properties. */ interface AkriConnectorTemplateDeviceInboundEndpointTypeResponse { /** * The configuration schema references for the device inbound endpoint. */ configurationSchemaRefs?: outputs.iotoperations.AkriConnectorTemplateDeviceInboundEndpointConfigurationSchemaRefsResponse; /** * A description of the device inbound endpoint. */ description?: string; /** * The type of the device inbound endpoint. */ endpointType: string; /** * The version of the device inbound endpoint. */ version?: string; } /** * AkriConnectorTemplateDiagnostics properties. */ interface AkriConnectorTemplateDiagnosticsResponse { /** * The log settings for the Connector template. */ logs: outputs.iotoperations.AkriConnectorsDiagnosticsLogsResponse; } /** * akriConnectorTemplateDiagnosticsResponseProvideDefaults sets the appropriate defaults for AkriConnectorTemplateDiagnosticsResponse */ function akriConnectorTemplateDiagnosticsResponseProvideDefaults(val: AkriConnectorTemplateDiagnosticsResponse): AkriConnectorTemplateDiagnosticsResponse; /** * AkriConnectorTemplateHelmAdvancedConfiguration properties. */ interface AkriConnectorTemplateHelmAdvancedConfigurationResponse { /** * Delete operation configuration for the Helm chart. */ delete?: outputs.iotoperations.AkriConnectorTemplateHelmDeleteConfigurationResponse; /** * Install operation configuration for the Helm chart. */ install?: outputs.iotoperations.AkriConnectorTemplateHelmInstallConfigurationResponse; /** * Upgrade operation configuration for the Helm chart. */ upgrade?: outputs.iotoperations.AkriConnectorTemplateHelmUpgradeConfigurationResponse; } /** * AkriConnectorTemplateHelmAuthSecretRef properties. */ interface AkriConnectorTemplateHelmAuthSecretRefResponse { /** * The key of the password in the secret. */ passwordKey: string; /** * The name of the secret. */ secretRef: string; /** * The key of the username in the secret. */ usernameKey: string; } /** * AkriConnectorTemplateHelmConfiguration properties. */ interface AkriConnectorTemplateHelmConfigurationResponse { /** * The Helm configuration settings. */ helmConfigurationSettings: outputs.iotoperations.AkriConnectorTemplateHelmConfigurationSettingsResponse; /** * Runtime configuration types. * Expected value is 'HelmConfiguration'. */ runtimeConfigurationType: "HelmConfiguration"; } /** * AkriConnectorTemplateHelmConfiguration properties. */ interface AkriConnectorTemplateHelmConfigurationSettingsResponse { /** * Advanced configuration for the Helm chart. * Install, upgrade, and uninstall options for the helm chart such as atomic, wait, timeout, `wait_for_jobs`, and `disable_hooks`. */ advancedConfiguration?: outputs.iotoperations.AkriConnectorTemplateHelmAdvancedConfigurationResponse; /** * The registry settings for the helm chart to be used. */ registrySettings?: outputs.iotoperations.AkriConnectorTemplateHelmContainerRegistryResponse | outputs.iotoperations.AkriConnectorTemplateHelmRegistryEndpointRefResponse; /** * The release name of the Helm chart. */ releaseName: string; /** * The name of the repository */ repositoryName: string; /** * A map of values to pass to the helm chart. */ values?: { [key: string]: string; }; /** * The version of the Helm chart. */ version: string; } /** * AkriConnectorTemplateHelmContainerRegistry properties. */ interface AkriConnectorTemplateHelmContainerRegistryResponse { /** * The registry settings for the container registry. */ containerRegistrySettings: outputs.iotoperations.AkriConnectorTemplateHelmContainerRegistrySettingsResponse; /** * AkriConnectorTemplateHelmRegistrySettingsType values. * Expected value is 'ContainerRegistry'. */ registrySettingsType: "ContainerRegistry"; } /** * AkriConnectorTemplateHelmContainerRegistrySettings properties. */ interface AkriConnectorTemplateHelmContainerRegistrySettingsResponse { /** * Optional reference to a secret in the same namespace to use for pulling the Helm chart. */ authSecretRef?: outputs.iotoperations.AkriConnectorTemplateHelmAuthSecretRefResponse; /** * The registry to use for the Helm chart. */ registry: string; } /** * AkriConnectorTemplateHelmDeleteConfiguration properties. */ interface AkriConnectorTemplateHelmDeleteConfigurationResponse { /** * If set, the operation will be atomic. If the operation fails, all changes will be rolled back. */ atomic?: boolean; /** * Disable pre/post upgrade hooks for the operation. */ disableHooks?: boolean; /** * Time to wait for any individual Kubernetes operation (like `Jobs` for hooks). */ timeout?: number; /** * If set, the operation will wait until all Pods, PVCs, Services, and minimum number of Pods of a `Deployment`, `StatefulSet`, or `ReplicaSet` are in a ready state before marking the release as successful. */ wait?: boolean; /** * If set, the operation will wait for jobs to complete before marking the release as successful. */ waitForJobs?: boolean; } /** * AkriConnectorTemplateHelmInstallConfiguration properties. */ interface AkriConnectorTemplateHelmInstallConfigurationResponse { /** * If set, the operation will be atomic. If the operation fails, all changes will be rolled back. */ atomic?: boolean; /** * Disable pre/post upgrade hooks for the operation. */ disableHooks?: boolean; /** * Time to wait for any individual Kubernetes operation (like `Jobs` for hooks). */ timeout?: number; /** * If set, the operation will wait until all Pods, PVCs, Services, and minimum number of Pods of a `Deployment`, `StatefulSet`, or `ReplicaSet` are in a ready state before marking the release as successful. */ wait?: boolean; /** * If set, the operation will wait for jobs to complete before marking the release as successful. */ waitForJobs?: boolean; } /** * AkriConnectorTemplateHelmRegistryEndpointRef properties. */ interface AkriConnectorTemplateHelmRegistryEndpointRefResponse { /** * The name of the registry endpoint. */ registryEndpointRef: string; /** * AkriConnectorTemplateHelmRegistrySettingsType values. * Expected value is 'RegistryEndpointRef'. */ registrySettingsType: "RegistryEndpointRef"; } /** * AkriConnectorTemplateHelmUpgradeConfiguration properties. */ interface AkriConnectorTemplateHelmUpgradeConfigurationResponse { /** * If set, the operation will be atomic. If the operation fails, all changes will be rolled back. */ atomic?: boolean; /** * Disable pre/post upgrade hooks for the operation. */ disableHooks?: boolean; /** * Time to wait for any individual Kubernetes operation (like `Jobs` for hooks). */ timeout?: number; /** * If set, the operation will wait until all Pods, PVCs, Services, and minimum number of Pods of a `Deployment`, `StatefulSet`, or `ReplicaSet` are in a ready state before marking the release as successful. */ wait?: boolean; /** * If set, the operation will wait for jobs to complete before marking the release as successful. */ waitForJobs?: boolean; } /** * AkriConnectorTemplateManagedConfiguration properties. */ interface AkriConnectorTemplateManagedConfigurationResponse { /** * The managed configuration settings. */ managedConfigurationSettings: outputs.iotoperations.AkriConnectorTemplateRuntimeImageConfigurationResponse | outputs.iotoperations.AkriConnectorTemplateRuntimeStatefulSetConfigurationResponse; /** * Runtime configuration types. * Expected value is 'ManagedConfiguration'. */ runtimeConfigurationType: "ManagedConfiguration"; } /** * AkriConnectorTemplatePersistentVolumeClaim properties. */ interface AkriConnectorTemplatePersistentVolumeClaimResponse { /** * The name of the persistent volume claim. */ claimName: string; /** * The mount path for the persistent volume claim. */ mountPath: string; } /** * AkriConnectorTemplate properties. */ interface AkriConnectorTemplatePropertiesResponse { /** * Metadata about AIO. */ aioMetadata?: outputs.iotoperations.AkriConnectorTemplateAioMetadataResponse; /** * Device inbound endpoint types. */ deviceInboundEndpointTypes: outputs.iotoperations.AkriConnectorTemplateDeviceInboundEndpointTypeResponse[]; /** * Diagnostics settings for the Connector template. */ diagnostics?: outputs.iotoperations.AkriConnectorTemplateDiagnosticsResponse; /** * Mqtt connection configuration settings. */ mqttConnectionConfiguration?: outputs.iotoperations.AkriConnectorsMqttConnectionConfigurationResponse; /** * The status of the last operation. */ provisioningState: string; /** * The runtime configuration for the Connector template. */ runtimeConfiguration: outputs.iotoperations.AkriConnectorTemplateHelmConfigurationResponse | outputs.iotoperations.AkriConnectorTemplateManagedConfigurationResponse; } /** * akriConnectorTemplatePropertiesResponseProvideDefaults sets the appropriate defaults for AkriConnectorTemplatePropertiesResponse */ function akriConnectorTemplatePropertiesResponseProvideDefaults(val: AkriConnectorTemplatePropertiesResponse): AkriConnectorTemplatePropertiesResponse; /** * AkriConnectorTemplateRuntimeImageConfiguration properties. */ interface AkriConnectorTemplateRuntimeImageConfigurationResponse { /** * Additional configuration for the image of the managed configuration. */ additionalConfiguration?: { [key: string]: string; }; /** * Allocation settings for the managed configuration. */ allocation?: outputs.iotoperations.AkriConnectorTemplateBucketizedAllocationResponse; /** * The image configuration settings. */ imageConfigurationSettings: outputs.iotoperations.AkriConnectorTemplateRuntimeImageConfigurationSettingsResponse; /** * Managed configuration types. * Expected value is 'ImageConfiguration'. */ managedConfigurationType: "ImageConfiguration"; /** * The persistent volume claim templates for the managed configuration. * See https://raw.githubusercontent.com/kubernetes/kubernetes/refs/heads/master/api/openapi-spec/v3/apis__apps__v1_openapi.json. */ persistentVolumeClaimTemplates?: any[]; /** * The persistent volume claims for the managed configuration. */ persistentVolumeClaims?: outputs.iotoperations.AkriConnectorTemplatePersistentVolumeClaimResponse[]; /** * Connector secrets that will be mounted onto all connector instances. */ secrets?: outputs.iotoperations.AkriConnectorsSecretResponse[]; /** * Trust list for the connector. This is used to specify the certificates that all connector instances should trust. */ trustSettings?: outputs.iotoperations.AkriConnectorTemplateTrustListResponse; } /** * AkriConnectorTemplateRuntimeImageConfiguration properties. */ interface AkriConnectorTemplateRuntimeImageConfigurationSettingsResponse { /** * The image name without any registry reference, tag or digest. */ imageName: string; /** * The pull policy of the image. */ imagePullPolicy?: string; /** * The registry settings for the image. You can omit this field if using the default docker hub repository or using a local image. */ registrySettings?: outputs.iotoperations.AkriConnectorsContainerRegistryResponse | outputs.iotoperations.AkriConnectorsRegistryEndpointRefResponse; /** * The number of replicas to be set up. */ replicas?: number; /** * Optional image tag or digest. If not specified, the default tag is `latest`. */ tagDigestSettings?: outputs.iotoperations.AkriConnectorsDigestResponse | outputs.iotoperations.AkriConnectorsTagResponse; } /** * AkriConnectorTemplateRuntimeStatefulSetConfiguration properties. */ interface AkriConnectorTemplateRuntimeStatefulSetConfigurationResponse { /** * Additional configuration for the image of the managed configuration. */ additionalConfiguration?: { [key: string]: string; }; /** * Allocation settings for the managed configuration. */ allocation?: outputs.iotoperations.AkriConnectorTemplateBucketizedAllocationResponse; /** * Managed configuration types. * Expected value is 'StatefulSetConfiguration'. */ managedConfigurationType: "StatefulSetConfiguration"; /** * The persistent volume claim templates for the managed configuration. * See https://raw.githubusercontent.com/kubernetes/kubernetes/refs/heads/master/api/openapi-spec/v3/apis__apps__v1_openapi.json. */ persistentVolumeClaimTemplates?: any[]; /** * The persistent volume claims for the managed configuration. */ persistentVolumeClaims?: outputs.iotoperations.AkriConnectorTemplatePersistentVolumeClaimResponse[]; /** * Connector secrets that will be mounted onto all connector instances. */ secrets?: outputs.iotoperations.AkriConnectorsSecretResponse[]; /** * The stateful set configuration settings. This corresponds to the Kubernetes StatefulSet resource. * See https://raw.githubusercontent.com/kubernetes/kubernetes/refs/heads/master/api/openapi-spec/v3/apis__apps__v1_openapi.json#/components/schemas/io.k8s.api.apps.v1.StatefulSetSpec */ statefulSetConfigurationSettings: any; /** * Trust list for the connector. This is used to specify the certificates that all connector instances should trust. */ trustSettings?: outputs.iotoperations.AkriConnectorTemplateTrustListResponse; } /** * AkriConnectorTemplateTrustList properties. */ interface AkriConnectorTemplateTrustListResponse { /** * The secret reference for certificates to trust. */ trustListSecretRef: string; } /** * AkriConnectorsContainerRegistry properties. */ interface AkriConnectorsContainerRegistryResponse { /** * The registry settings for the container registry. */ containerRegistrySettings: outputs.iotoperations.AkriConnectorsContainerRegistrySettingsResponse; /** * AkriConnectorsRegistrySettings properties. * Expected value is 'ContainerRegistry'. */ registrySettingsType: "ContainerRegistry"; } /** * AkriConnectorsContainerRegistry properties. */ interface AkriConnectorsContainerRegistrySettingsResponse { /** * Optional list of references to secrets in the same namespace to use for pulling the connector image. */ imagePullSecrets?: outputs.iotoperations.AkriConnectorsImagePullSecretResponse[]; /** * The container registry to use for the artifact. */ registry: string; } /** * AkriConnectorsDiagnostic Log properties. */ interface AkriConnectorsDiagnosticsLogsResponse { /** * The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. */ level?: string; } /** * akriConnectorsDiagnosticsLogsResponseProvideDefaults sets the appropriate defaults for AkriConnectorsDiagnosticsLogsResponse */ function akriConnectorsDiagnosticsLogsResponseProvideDefaults(val: AkriConnectorsDiagnosticsLogsResponse): AkriConnectorsDiagnosticsLogsResponse; /** * AkriConnectorsDigest properties. */ interface AkriConnectorsDigestResponse { /** * The digest of the image. */ digest: string; /** * AkriConnectorsTagDigestType values. * Expected value is 'Digest'. */ tagDigestType: "Digest"; } /** * AkriConnectorsImagePullSecret properties. */ interface AkriConnectorsImagePullSecretResponse { /** * The name of the image pull secret. */ secretRef: string; } /** * AkriConnectorsMqttConnectionConfiguration properties. */ interface AkriConnectorsMqttConnectionConfigurationResponse { /** * Authentication properties. */ authentication?: outputs.iotoperations.AkriConnectorsServiceAccountAuthenticationResponse; /** * Host of the Broker in the form of :. */ host?: string; /** * KeepAlive for connection in seconds. */ keepAliveSeconds?: number; /** * The max number of messages to keep in flight. For subscribe, this is the receive maximum. For publish, this is the maximum number of messages to send before waiting for an ack. */ maxInflightMessages?: number; /** * The protocol to use for the connection. Currently only `mqtt` is supported. */ protocol?: string; /** * Session expiry in seconds. */ sessionExpirySeconds?: number; /** * TLS configuration. */ tls?: outputs.iotoperations.TlsPropertiesResponse; } /** * akriConnectorsMqttConnectionConfigurationResponseProvideDefaults sets the appropriate defaults for AkriConnectorsMqttConnectionConfigurationResponse */ function akriConnectorsMqttConnectionConfigurationResponseProvideDefaults(val: AkriConnectorsMqttConnectionConfigurationResponse): AkriConnectorsMqttConnectionConfigurationResponse; /** * AkriConnectorsRegistryEndpointRef properties. */ interface AkriConnectorsRegistryEndpointRefResponse { /** * The name of the registry endpoint. */ registryEndpointRef: string; /** * AkriConnectorsRegistrySettings properties. * Expected value is 'RegistryEndpointRef'. */ registrySettingsType: "RegistryEndpointRef"; } /** * AkriConnectorsSecret properties. */ interface AkriConnectorsSecretResponse { /** * The application-defined alias for the secret. */ secretAlias: string; /** * The key in the secret to be mounted. */ secretKey: string; /** * The name of the secret to be mounted. */ secretRef: string; } /** * AkriConnectorsServiceAccountAuthentication properties. */ interface AkriConnectorsServiceAccountAuthenticationResponse { /** * AkriConnectorsMqttAuthenticationMethod properties. * Expected value is 'ServiceAccountToken'. */ method: "ServiceAccountToken"; /** * The service account token for the MQTT connection. */ serviceAccountTokenSettings: outputs.iotoperations.AkriConnectorsServiceAccountTokenSettingsResponse; } /** * AkriConnectorsServiceAccountTokenSettings properties. */ interface AkriConnectorsServiceAccountTokenSettingsResponse { /** * The audience for the service account token. */ audience: string; } /** * AkriConnectorsTag properties. */ interface AkriConnectorsTagResponse { /** * The tag of the image. */ tag: string; /** * AkriConnectorsTagDigestType values. * Expected value is 'Tag'. */ tagDigestType: "Tag"; } /** * AkriService properties. */ interface AkriServicePropertiesResponse { /** * The status of the last operation. */ provisioningState: string; /** * The status for the service. */ status: outputs.iotoperations.AkriServiceStatusResponse; } /** * AkriService status. */ interface AkriServiceStatusResponse { /** * The health state of the AkriService. */ healthState: outputs.iotoperations.ResourceHealthStatusResponse; } /** * Broker AuthorizationConfig properties */ interface AuthorizationConfigResponse { /** * Enable caching of the authorization rules. */ cache?: string; /** * The authorization rules to follow. If no rule is set, but Authorization Resource is used that would mean DenyAll. */ rules?: outputs.iotoperations.AuthorizationRuleResponse[]; } /** * authorizationConfigResponseProvideDefaults sets the appropriate defaults for AuthorizationConfigResponse */ function authorizationConfigResponseProvideDefaults(val: AuthorizationConfigResponse): AuthorizationConfigResponse; /** * AuthorizationConfig Rule Properties */ interface AuthorizationRuleResponse { /** * Give access to Broker methods and topics. */ brokerResources: outputs.iotoperations.BrokerResourceRuleResponse[]; /** * Give access to clients based on the following properties. */ principals: outputs.iotoperations.PrincipalDefinitionResponse; /** * Give access to state store resources. */ stateStoreResources?: outputs.iotoperations.StateStoreResourceRuleResponse[]; } /** * Desired properties of the backend instances of the broker */ interface BackendChainResponse { /** * The desired number of physical backend partitions. */ partitions: number; /** * The desired numbers of backend replicas (pods) in a physical partition. */ redundancyFactor: number; /** * Number of logical backend workers per replica (pod). */ workers?: number; } /** * backendChainResponseProvideDefaults sets the appropriate defaults for BackendChainResponse */ function backendChainResponseProvideDefaults(val: BackendChainResponse): BackendChainResponse; /** * Batching configuration */ interface BatchingConfigurationResponse { /** * Batching latency in seconds. */ latencySeconds?: number; /** * Maximum number of messages in a batch. */ maxMessages?: number; } /** * batchingConfigurationResponseProvideDefaults sets the appropriate defaults for BatchingConfigurationResponse */ function batchingConfigurationResponseProvideDefaults(val: BatchingConfigurationResponse): BatchingConfigurationResponse; /** * BrokerAuthentication Resource properties */ interface BrokerAuthenticationPropertiesResponse { /** * Defines a set of Broker authentication methods to be used on `BrokerListeners`. For each array element one authenticator type supported. */ authenticationMethods: outputs.iotoperations.BrokerAuthenticatorMethodsResponse[]; /** * The status of the last operation. */ provisioningState: string; } /** * Custom Authentication properties */ interface BrokerAuthenticatorCustomAuthResponse { /** * X509 Custom Auth type details. */ x509: outputs.iotoperations.X509ManualCertificateResponse; } /** * Custom method for BrokerAuthentication */ interface BrokerAuthenticatorMethodCustomResponse { /** * Optional authentication needed for authenticating with the custom authentication server. */ auth?: outputs.iotoperations.BrokerAuthenticatorCustomAuthResponse; /** * Optional CA certificate for validating the custom authentication server's certificate. */ caCertConfigMap?: string; /** * Endpoint of the custom authentication server. Must be an HTTPS endpoint. */ endpoint: string; /** * Additional HTTP headers to pass to the custom authentication server. */ headers?: { [key: string]: string; }; } /** * Service Account Token for BrokerAuthentication */ interface BrokerAuthenticatorMethodSatResponse { /** * List of allowed audience. */ audiences: string[]; } /** * BrokerAuthenticatorMethodX509Attributes properties. */ interface BrokerAuthenticatorMethodX509AttributesResponse { /** * Attributes object. */ attributes: { [key: string]: string; }; /** * Subject of the X509 attribute. */ subject: string; } /** * X509 for BrokerAuthentication. */ interface BrokerAuthenticatorMethodX509Response { /** * X509 authorization attributes properties. */ authorizationAttributes?: { [key: string]: outputs.iotoperations.BrokerAuthenticatorMethodX509AttributesResponse; }; /** * Name of the trusted client ca cert resource. */ trustedClientCaCert?: string; } /** * brokerAuthenticatorMethodX509ResponseProvideDefaults sets the appropriate defaults for BrokerAuthenticatorMethodX509Response */ function brokerAuthenticatorMethodX509ResponseProvideDefaults(val: BrokerAuthenticatorMethodX509Response): BrokerAuthenticatorMethodX509Response; /** * Set of broker authentication policies. Only one method is supported for each entry. */ interface BrokerAuthenticatorMethodsResponse { /** * Custom authentication configuration. */ customSettings?: outputs.iotoperations.BrokerAuthenticatorMethodCustomResponse; /** * Custom authentication configuration. */ method: string; /** * ServiceAccountToken authentication configuration. */ serviceAccountTokenSettings?: outputs.iotoperations.BrokerAuthenticatorMethodSatResponse; /** * X.509 authentication configuration. */ x509Settings?: outputs.iotoperations.BrokerAuthenticatorMethodX509Response; } /** * brokerAuthenticatorMethodsResponseProvideDefaults sets the appropriate defaults for BrokerAuthenticatorMethodsResponse */ function brokerAuthenticatorMethodsResponseProvideDefaults(val: BrokerAuthenticatorMethodsResponse): BrokerAuthenticatorMethodsResponse; /** * BrokerAuthorization Resource properties */ interface BrokerAuthorizationPropertiesResponse { /** * The list of authorization policies supported by the Authorization Resource. */ authorizationPolicies: outputs.iotoperations.AuthorizationConfigResponse; /** * The status of the last operation. */ provisioningState: string; } /** * brokerAuthorizationPropertiesResponseProvideDefaults sets the appropriate defaults for BrokerAuthorizationPropertiesResponse */ function brokerAuthorizationPropertiesResponseProvideDefaults(val: BrokerAuthorizationPropertiesResponse): BrokerAuthorizationPropertiesResponse; /** * Broker Diagnostic Setting properties */ interface BrokerDiagnosticsResponse { /** * Diagnostic log settings for the resource. */ logs?: outputs.iotoperations.DiagnosticsLogsResponse; /** * The metrics settings for the resource. */ metrics?: outputs.iotoperations.MetricsResponse; /** * The self check properties. */ selfCheck?: outputs.iotoperations.SelfCheckResponse; /** * The trace properties. */ traces?: outputs.iotoperations.TracesResponse; } /** * brokerDiagnosticsResponseProvideDefaults sets the appropriate defaults for BrokerDiagnosticsResponse */ function brokerDiagnosticsResponseProvideDefaults(val: BrokerDiagnosticsResponse): BrokerDiagnosticsResponse; /** * Defines a Broker listener. A listener is a collection of ports on which the broker accepts connections from clients. */ interface BrokerListenerPropertiesResponse { /** * Ports on which this listener accepts client connections. */ ports: outputs.iotoperations.ListenerPortResponse[]; /** * The status of the last operation. */ provisioningState: string; /** * Kubernetes Service name of this listener. */ serviceName?: string; /** * Kubernetes Service type of this listener. */ serviceType?: string; } /** * brokerListenerPropertiesResponseProvideDefaults sets the appropriate defaults for BrokerListenerPropertiesResponse */ function brokerListenerPropertiesResponseProvideDefaults(val: BrokerListenerPropertiesResponse): BrokerListenerPropertiesResponse; /** * Broker Resource properties */ interface BrokerPropertiesResponse { /** * Advanced settings of Broker. */ advanced?: outputs.iotoperations.AdvancedSettingsResponse; /** * The cardinality details of the broker. */ cardinality?: outputs.iotoperations.CardinalityResponse; /** * Spec defines the desired identities of Broker diagnostics settings. */ diagnostics?: outputs.iotoperations.BrokerDiagnosticsResponse; /** * Settings of Disk Backed Message Buffer. */ diskBackedMessageBuffer?: outputs.iotoperations.DiskBackedMessageBufferResponse; /** * This setting controls whether Kubernetes CPU resource limits are requested. Increasing the number of replicas or workers proportionally increases the amount of CPU resources requested. If this setting is enabled and there are insufficient CPU resources, an error will be emitted. */ generateResourceLimits?: outputs.iotoperations.GenerateResourceLimitsResponse; /** * Memory profile of Broker. */ memoryProfile?: string; /** * The status of the last operation. */ provisioningState: string; } /** * brokerPropertiesResponseProvideDefaults sets the appropriate defaults for BrokerPropertiesResponse */ function brokerPropertiesResponseProvideDefaults(val: BrokerPropertiesResponse): BrokerPropertiesResponse; /** * Broker Resource Rule properties. This defines the objects that represent the actions or topics, such as - method.Connect, method.Publish, etc. */ interface BrokerResourceRuleResponse { /** * A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection. This subfield may be set if the method is Connect. */ clientIds?: string[]; /** * Give access for a Broker method (i.e., Connect, Subscribe, or Publish). */ method: string; /** * A list of topics or topic patterns that match the topics that the clients can publish or subscribe to. This subfield is required if the method is Publish or Subscribe. */ topics?: string[]; } /** * Cardinality properties */ interface CardinalityResponse { /** * The backend broker desired properties */ backendChain: outputs.iotoperations.BackendChainResponse; /** * The frontend desired properties */ frontend: outputs.iotoperations.FrontendResponse; } /** * cardinalityResponseProvideDefaults sets the appropriate defaults for CardinalityResponse */ function cardinalityResponseProvideDefaults(val: CardinalityResponse): CardinalityResponse; /** * Cert Manager Cert properties */ interface CertManagerCertOptionsResponse { /** * Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. */ duration: string; /** * Configuration of certificate private key. */ privateKey: outputs.iotoperations.CertManagerPrivateKeyResponse; /** * When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. */ renewBefore: string; } /** * Automatic TLS server certificate management with cert-manager */ interface CertManagerCertificateSpecResponse { /** * Lifetime of certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. */ duration?: string; /** * cert-manager issuerRef. */ issuerRef: outputs.iotoperations.CertManagerIssuerRefResponse; /** * Type of certificate private key. */ privateKey?: outputs.iotoperations.CertManagerPrivateKeyResponse; /** * When to begin renewing certificate. Must be specified using a Go time.Duration format (h|m|s). E.g. 240h for 240 hours and 45m for 45 minutes. */ renewBefore?: string; /** * Additional Subject Alternative Names (SANs) to include in the certificate. */ san?: outputs.iotoperations.SanForCertResponse; /** * Secret for storing server certificate. Any existing data will be overwritten. This is a reference to the secret through an identifying name, not the secret itself. */ secretName?: string; } /** * certManagerCertificateSpecResponseProvideDefaults sets the appropriate defaults for CertManagerCertificateSpecResponse */ function certManagerCertificateSpecResponseProvideDefaults(val: CertManagerCertificateSpecResponse): CertManagerCertificateSpecResponse; /** * Cert-Manager issuerRef properties */ interface CertManagerIssuerRefResponse { /** * group of issuer. */ group: string; /** * kind of issuer (Issuer or ClusterIssuer). */ kind: string; /** * name of issuer. */ name: string; } /** * certManagerIssuerRefResponseProvideDefaults sets the appropriate defaults for CertManagerIssuerRefResponse */ function certManagerIssuerRefResponseProvideDefaults(val: CertManagerIssuerRefResponse): CertManagerIssuerRefResponse; /** * Cert Manager private key properties */ interface CertManagerPrivateKeyResponse { /** * algorithm for private key. */ algorithm: string; /** * cert-manager private key rotationPolicy. */ rotationPolicy: string; } /** * The settings of Client Config. */ interface ClientConfigResponse { /** * Upper bound of a client's Keep Alive, in seconds. */ maxKeepAliveSeconds?: number; /** * Upper bound of Message Expiry Interval, in seconds. */ maxMessageExpirySeconds?: number; /** * Max message size for a packet in Bytes. */ maxPacketSizeBytes?: number; /** * Upper bound of Receive Maximum that a client can request in the CONNECT packet. */ maxReceiveMaximum?: number; /** * Upper bound of Session Expiry Interval, in seconds. */ maxSessionExpirySeconds?: number; /** * The limit on the number of queued messages for a subscriber. */ subscriberQueueLimit?: outputs.iotoperations.SubscriberQueueLimitResponse; } /** * clientConfigResponseProvideDefaults sets the appropriate defaults for ClientConfigResponse */ function clientConfigResponseProvideDefaults(val: ClientConfigResponse): ClientConfigResponse; /** * Dataflow BuiltIn Transformation dataset properties */ interface DataflowBuiltInTransformationDatasetResponse { /** * A user provided optional description of the dataset. */ description?: string; /** * Condition to enrich data from Broker State Store. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided) */ expression?: string; /** * List of fields for enriching from the Broker State Store. */ inputs: string[]; /** * The key of the dataset. */ key: string; /** * The reference to the schema that describes the dataset. Allowed: JSON Schema/draft-7. */ schemaRef?: string; } /** * Dataflow BuiltIn Transformation filter properties */ interface DataflowBuiltInTransformationFilterResponse { /** * A user provided optional description of the filter. */ description?: string; /** * Condition to filter data. Can reference input fields with {n} where n is the index of the input field starting from 1. Example: $1 < 0 || $1 > $2 (Assuming inputs section $1 and $2 are provided) */ expression: string; /** * List of fields for filtering in JSON path expression. */ inputs: string[]; /** * The type of dataflow operation. */ type?: string; } /** * dataflowBuiltInTransformationFilterResponseProvideDefaults sets the appropriate defaults for DataflowBuiltInTransformationFilterResponse */ function dataflowBuiltInTransformationFilterResponseProvideDefaults(val: DataflowBuiltInTransformationFilterResponse): DataflowBuiltInTransformationFilterResponse; /** * Dataflow BuiltIn Transformation map properties */ interface DataflowBuiltInTransformationMapResponse { /** * A user provided optional description of the mapping function. */ description?: string; /** * Modify the inputs field(s) to the final output field. Example: $1 * 2.2 (Assuming inputs section $1 is provided) */ expression?: string; /** * List of fields for mapping in JSON path expression. */ inputs: string[]; /** * Where and how the input fields to be organized in the output record. */ output: string; /** * Type of transformation. */ type?: string; } /** * Dataflow BuiltIn Transformation properties */ interface DataflowBuiltInTransformationSettingsResponse { /** * Enrich data from Broker State Store. Dataset references a key in Broker State Store. */ datasets?: outputs.iotoperations.DataflowBuiltInTransformationDatasetResponse[]; /** * Filters input record or datapoints based on condition. */ filter?: outputs.iotoperations.DataflowBuiltInTransformationFilterResponse[]; /** * Maps input to output message. */ map?: outputs.iotoperations.DataflowBuiltInTransformationMapResponse[]; /** * Reference to the schema that describes the output of the transformation. */ schemaRef?: string; /** * Serialization format. Optional; defaults to JSON. Allowed value JSON Schema/draft-7, Parquet. Default: Json */ serializationFormat?: string; } /** * dataflowBuiltInTransformationSettingsResponseProvideDefaults sets the appropriate defaults for DataflowBuiltInTransformationSettingsResponse */ function dataflowBuiltInTransformationSettingsResponseProvideDefaults(val: DataflowBuiltInTransformationSettingsResponse): DataflowBuiltInTransformationSettingsResponse; /** * Dataflow Destination Operation properties */ interface DataflowDestinationOperationSettingsResponse { /** * Destination location, can be a topic or table name. Supports dynamic values with $topic, $systemProperties, $userProperties, $payload, $context, and $subscription. */ dataDestination: string; /** * Reference to the Endpoint CR. Can be of Broker, Kafka, Fabric, ADLS, ADX type. */ endpointRef: string; } /** * DataflowEndpoint Authentication Access Token properties */ interface DataflowEndpointAuthenticationAccessTokenResponse { /** * Token secret name. */ secretRef: string; } /** * DataflowEndpoint Authentication Sasl properties */ interface DataflowEndpointAuthenticationSaslResponse { /** * Type of SASL authentication. Can be PLAIN, SCRAM-SHA-256, or SCRAM-SHA-512. */ saslType: string; /** * Token secret name. */ secretRef: string; } /** * Service Account Token for BrokerAuthentication */ interface DataflowEndpointAuthenticationServiceAccountTokenResponse { /** * Audience of the service account. Optional, defaults to the broker internal service account audience. */ audience: string; } /** * DataflowEndpoint Authentication SystemAssignedManagedIdentity properties */ interface DataflowEndpointAuthenticationSystemAssignedManagedIdentityResponse { /** * Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. */ audience?: string; } /** * DataflowEndpoint Authentication UserAssignedManagedIdentity properties */ interface DataflowEndpointAuthenticationUserAssignedManagedIdentityResponse { /** * Client ID for the user-assigned managed identity. */ clientId: string; /** * Resource identifier (application ID URI) of the resource, affixed with the .default suffix. */ scope?: string; /** * Tenant ID. */ tenantId: string; } /** * DataflowEndpoint Authentication X509 properties */ interface DataflowEndpointAuthenticationX509Response { /** * Secret reference of the X.509 certificate. */ secretRef: string; } /** * Azure Data Explorer Authentication properties. NOTE - only authentication property is allowed per entry. */ interface DataflowEndpointDataExplorerAuthenticationResponse { /** * Mode of Authentication. */ method: any; /** * System-assigned managed identity authentication. */ systemAssignedManagedIdentitySettings?: outputs.iotoperations.DataflowEndpointAuthenticationSystemAssignedManagedIdentityResponse; /** * User-assigned managed identity authentication. */ userAssignedManagedIdentitySettings?: outputs.iotoperations.DataflowEndpointAuthenticationUserAssignedManagedIdentityResponse; } /** * Azure Data Explorer endpoint properties */ interface DataflowEndpointDataExplorerResponse { /** * Authentication configuration. NOTE - only authentication property is allowed per entry. */ authentication: outputs.iotoperations.DataflowEndpointDataExplorerAuthenticationResponse; /** * Azure Data Explorer endpoint batching configuration. */ batching?: outputs.iotoperations.BatchingConfigurationResponse; /** * Database name. */ database: string; /** * Host of the Azure Data Explorer in the form of ..kusto.windows.net . */ host: string; } /** * dataflowEndpointDataExplorerResponseProvideDefaults sets the appropriate defaults for DataflowEndpointDataExplorerResponse */ function dataflowEndpointDataExplorerResponseProvideDefaults(val: DataflowEndpointDataExplorerResponse): DataflowEndpointDataExplorerResponse; /** * Azure Data Lake endpoint Authentication properties. NOTE Enum - Only one method is supported for one entry */ interface DataflowEndpointDataLakeStorageAuthenticationResponse { /** * SAS token authentication. */ accessTokenSettings?: outputs.iotoperations.DataflowEndpointAuthenticationAccessTokenResponse; /** * Mode of Authentication. */ method: string; /** * System-assigned managed identity authentication. */ systemAssignedManagedIdentitySettings?: outputs.iotoperations.DataflowEndpointAuthenticationSystemAssignedManagedIdentityResponse; /** * User-assigned managed identity authentication. */ userAssignedManagedIdentitySettings?: outputs.iotoperations.DataflowEndpointAuthenticationUserAssignedManagedIdentityResponse; } /** * Azure Data Lake endpoint properties */ interface DataflowEndpointDataLakeStorageResponse { /** * Authentication configuration. NOTE - only authentication property is allowed per entry. */ authentication: outputs.iotoperations.DataflowEndpointDataLakeStorageAuthenticationResponse; /** * Azure Data Lake endpoint batching configuration. */ batching?: outputs.iotoperations.BatchingConfigurationResponse; /** * Host of the Azure Data Lake in the form of .blob.core.windows.net . */ host: string; } /** * dataflowEndpointDataLakeStorageResponseProvideDefaults sets the appropriate defaults for DataflowEndpointDataLakeStorageResponse */ function dataflowEndpointDataLakeStorageResponseProvideDefaults(val: DataflowEndpointDataLakeStorageResponse): DataflowEndpointDataLakeStorageResponse; /** * Microsoft Fabric endpoint. Authentication properties. NOTE - Only one method is supported for one entry */ interface DataflowEndpointFabricOneLakeAuthenticationResponse { /** * Mode of Authentication. */ method: any; /** * System-assigned managed identity authentication. */ systemAssignedManagedIdentitySettings?: outputs.iotoperations.DataflowEndpointAuthenticationSystemAssignedManagedIdentityResponse; /** * User-assigned managed identity authentication. */ userAssignedManagedIdentitySettings?: outputs.iotoperations.DataflowEndpointAuthenticationUserAssignedManagedIdentityResponse; } /** * Microsoft Fabric endpoint Names properties */ interface DataflowEndpointFabricOneLakeNamesResponse { /** * Lakehouse name. */ lakehouseName: string; /** * Workspace name. */ workspaceName: string; } /** * Microsoft Fabric endpoint properties */ interface DataflowEndpointFabricOneLakeResponse { /** * Authentication configuration. NOTE - only one authentication property is allowed per entry. */ authentication: outputs.iotoperations.DataflowEndpointFabricOneLakeAuthenticationResponse; /** * Batching configuration. */ batching?: outputs.iotoperations.BatchingConfigurationResponse; /** * Host of the Microsoft Fabric in the form of https://.fabric.microsoft.com. */ host: string; /** * Names of the workspace and lakehouse. */ names: outputs.iotoperations.DataflowEndpointFabricOneLakeNamesResponse; /** * Type of location of the data in the workspace. Can be either tables or files. */ oneLakePathType: string; } /** * dataflowEndpointFabricOneLakeResponseProvideDefaults sets the appropriate defaults for DataflowEndpointFabricOneLakeResponse */ function dataflowEndpointFabricOneLakeResponseProvideDefaults(val: DataflowEndpointFabricOneLakeResponse): DataflowEndpointFabricOneLakeResponse; /** * Kafka endpoint Authentication properties. NOTE - only authentication property is allowed per entry */ interface DataflowEndpointKafkaAuthenticationResponse { /** * Mode of Authentication. */ method: string; /** * SASL authentication. */ saslSettings?: outputs.iotoperations.DataflowEndpointAuthenticationSaslResponse; /** * System-assigned managed identity authentication. */ systemAssignedManagedIdentitySettings?: outputs.iotoperations.DataflowEndpointAuthenticationSystemAssignedManagedIdentityResponse; /** * User-assigned managed identity authentication. */ userAssignedManagedIdentitySettings?: outputs.iotoperations.DataflowEndpointAuthenticationUserAssignedManagedIdentityResponse; /** * X.509 certificate authentication. */ x509CertificateSettings?: outputs.iotoperations.DataflowEndpointAuthenticationX509Response; } /** * Kafka endpoint Batching properties */ interface DataflowEndpointKafkaBatchingResponse { /** * Batching latency in milliseconds. */ latencyMs?: number; /** * Maximum number of bytes in a batch. */ maxBytes?: number; /** * Maximum number of messages in a batch. */ maxMessages?: number; /** * Mode for batching. */ mode?: string; } /** * dataflowEndpointKafkaBatchingResponseProvideDefaults sets the appropriate defaults for DataflowEndpointKafkaBatchingResponse */ function dataflowEndpointKafkaBatchingResponseProvideDefaults(val: DataflowEndpointKafkaBatchingResponse): DataflowEndpointKafkaBatchingResponse; /** * Kafka endpoint properties */ interface DataflowEndpointKafkaResponse { /** * Authentication configuration. NOTE - only authentication property is allowed per entry. */ authentication: outputs.iotoperations.DataflowEndpointKafkaAuthenticationResponse; /** * Batching configuration. */ batching?: outputs.iotoperations.DataflowEndpointKafkaBatchingResponse; /** * Cloud event mapping config. */ cloudEventAttributes?: string; /** * Compression. Can be none, gzip, lz4, or snappy. No effect if the endpoint is used as a source. */ compression?: string; /** * Consumer group ID. */ consumerGroupId?: string; /** * Copy Broker properties. No effect if the endpoint is used as a source or if the dataflow doesn't have an Broker source. */ copyMqttProperties?: string; /** * Kafka endpoint host. */ host: string; /** * Kafka acks. Can be all, one, or zero. No effect if the endpoint is used as a source. */ kafkaAcks?: string; /** * Partition handling strategy. Can be default or static. No effect if the endpoint is used as a source. */ partitionStrategy?: string; /** * TLS configuration. */ tls?: outputs.iotoperations.TlsPropertiesResponse; } /** * dataflowEndpointKafkaResponseProvideDefaults sets the appropriate defaults for DataflowEndpointKafkaResponse */ function dataflowEndpointKafkaResponseProvideDefaults(val: DataflowEndpointKafkaResponse): DataflowEndpointKafkaResponse; /** * Local persistent volume endpoint properties */ interface DataflowEndpointLocalStorageResponse { /** * Persistent volume claim name. */ persistentVolumeClaimRef: string; } /** * Mqtt endpoint Authentication properties. NOTE - only authentication property is allowed per entry. */ interface DataflowEndpointMqttAuthenticationResponse { /** * Mode of Authentication. */ method: string; /** * Kubernetes service account token authentication. Default audience if not set is aio-internal */ serviceAccountTokenSettings?: outputs.iotoperations.DataflowEndpointAuthenticationServiceAccountTokenResponse; /** * System-assigned managed identity authentication. */ systemAssignedManagedIdentitySettings?: outputs.iotoperations.DataflowEndpointAuthenticationSystemAssignedManagedIdentityResponse; /** * User-assigned managed identity authentication. */ userAssignedManagedIdentitySettings?: outputs.iotoperations.DataflowEndpointAuthenticationUserAssignedManagedIdentityResponse; /** * X.509 certificate authentication. */ x509CertificateSettings?: outputs.iotoperations.DataflowEndpointAuthenticationX509Response; } /** * Broker endpoint properties */ interface DataflowEndpointMqttResponse { /** * authentication properties. DEFAULT: kubernetes.audience=aio-internal. NOTE - Enum field only property is allowed */ authentication: outputs.iotoperations.DataflowEndpointMqttAuthenticationResponse; /** * Client ID prefix. Client ID generated by the dataflow is -TBD. Optional; no prefix if omitted. */ clientIdPrefix?: string; /** * Cloud event mapping config. */ cloudEventAttributes?: string; /** * Host of the Broker in the form of :. Optional; connects to Broker if omitted. */ host?: string; /** * Broker KeepAlive for connection in seconds. */ keepAliveSeconds?: number; /** * The max number of messages to keep in flight. For subscribe, this is the receive maximum. For publish, this is the maximum number of messages to send before waiting for an ack. */ maxInflightMessages?: number; /** * Enable or disable websockets. */ protocol?: string; /** * Qos for Broker connection. */ qos?: number; /** * Whether or not to keep the retain setting. */ retain?: string; /** * Session expiry in seconds. */ sessionExpirySeconds?: number; /** * TLS configuration. */ tls?: outputs.iotoperations.TlsPropertiesResponse; } /** * dataflowEndpointMqttResponseProvideDefaults sets the appropriate defaults for DataflowEndpointMqttResponse */ function dataflowEndpointMqttResponseProvideDefaults(val: DataflowEndpointMqttResponse): DataflowEndpointMqttResponse; /** * DataflowEndpoint Resource properties. NOTE - Only one type of endpoint is supported for one Resource */ interface DataflowEndpointPropertiesResponse { /** * Azure Data Explorer endpoint. */ dataExplorerSettings?: outputs.iotoperations.DataflowEndpointDataExplorerResponse; /** * Azure Data Lake endpoint. */ dataLakeStorageSettings?: outputs.iotoperations.DataflowEndpointDataLakeStorageResponse; /** * Endpoint Type. */ endpointType: string; /** * Microsoft Fabric endpoint. */ fabricOneLakeSettings?: outputs.iotoperations.DataflowEndpointFabricOneLakeResponse; /** * Kafka endpoint. */ kafkaSettings?: outputs.iotoperations.DataflowEndpointKafkaResponse; /** * Local persistent volume endpoint. */ localStorageSettings?: outputs.iotoperations.DataflowEndpointLocalStorageResponse; /** * Broker endpoint. */ mqttSettings?: outputs.iotoperations.DataflowEndpointMqttResponse; /** * The status of the last operation. */ provisioningState: string; } /** * dataflowEndpointPropertiesResponseProvideDefaults sets the appropriate defaults for DataflowEndpointPropertiesResponse */ function dataflowEndpointPropertiesResponseProvideDefaults(val: DataflowEndpointPropertiesResponse): DataflowEndpointPropertiesResponse; /** * DataflowGraph DataflowGraphNode Connection Input. */ interface DataflowGraphConnectionInputResponse { /** * Name of the input node. */ name: string; /** * Schema settings for the input node. */ schema?: outputs.iotoperations.DataflowGraphConnectionSchemaSettingsResponse; } /** * DataflowGraph DataflowGraphNode Connection Output. */ interface DataflowGraphConnectionOutputResponse { /** * Name of the destination node. */ name: string; } /** * DataflowGraph connection node output schema settings. */ interface DataflowGraphConnectionSchemaSettingsResponse { /** * Reference to the schema that describes the output of the transformation. */ schemaRef?: string; /** * Output serialization format. */ serializationFormat?: string; } /** * DataflowGraph destination node properties. */ interface DataflowGraphDestinationNodeResponse { /** * Destination configuration. */ destinationSettings: outputs.iotoperations.DataflowGraphDestinationNodeSettingsResponse; /** * Name of the node. */ name: string; /** * DataflowGraph node types. * Expected value is 'Destination'. */ nodeType: "Destination"; } /** * DataflowGraph destination node settings. */ interface DataflowGraphDestinationNodeSettingsResponse { /** * Data destination at the endpoint. */ dataDestination: string; /** * The name of the DataflowEndpoint resource . */ endpointRef: string; /** * Output schema settings. */ outputSchemaSettings?: outputs.iotoperations.DataflowGraphDestinationSchemaSettingsResponse; } /** * DataflowGraph destination node output schema settings. */ interface DataflowGraphDestinationSchemaSettingsResponse { /** * Reference to the schema that describes the output of the transformation. */ schemaRef?: string; /** * The format of the output data. */ serializationFormat: string; } /** * DataflowGraph graph node configuration. */ interface DataflowGraphGraphNodeConfigurationResponse { /** * Key of the configuration. */ key: string; /** * Value of the configuration. */ value: string; } /** * DataflowGraph graph node properties. */ interface DataflowGraphGraphNodeResponse { /** * Graph configuration. */ graphSettings: outputs.iotoperations.DataflowGraphNodeGraphSettingsResponse; /** * Name of the node. */ name: string; /** * DataflowGraph node types. * Expected value is 'Graph'. */ nodeType: "Graph"; } /** * DataflowGraph DataflowGraphNode Connection. */ interface DataflowGraphNodeConnectionResponse { /** * Information about the source node. */ from: outputs.iotoperations.DataflowGraphConnectionInputResponse; /** * Information about the destination node. */ to: outputs.iotoperations.DataflowGraphConnectionOutputResponse; } /** * DataflowGraph graph node settings. */ interface DataflowGraphNodeGraphSettingsResponse { /** * The artifact name and version to pull. This should be in the format `:`. */ artifact: string; /** * Configuration key-value pairs. */ configuration?: outputs.iotoperations.DataflowGraphGraphNodeConfigurationResponse[]; /** * Reference to the registry endpoint for pulling the artifact. */ registryEndpointRef: string; } /** * DataflowGraph properties. */ interface DataflowGraphPropertiesResponse { /** * The mode of the dataflow graph. */ mode?: string; /** * List of connections between nodes in the dataflow graph. */ nodeConnections: outputs.iotoperations.DataflowGraphNodeConnectionResponse[]; /** * List of nodes in the dataflow graph. */ nodes: (outputs.iotoperations.DataflowGraphDestinationNodeResponse | outputs.iotoperations.DataflowGraphGraphNodeResponse | outputs.iotoperations.DataflowGraphSourceNodeResponse)[]; /** * The provisioning state of the dataflow graph. */ provisioningState: string; /** * Disk persistence mode. */ requestDiskPersistence?: string; } /** * dataflowGraphPropertiesResponseProvideDefaults sets the appropriate defaults for DataflowGraphPropertiesResponse */ function dataflowGraphPropertiesResponseProvideDefaults(val: DataflowGraphPropertiesResponse): DataflowGraphPropertiesResponse; /** * DataflowGraph source node properties. */ interface DataflowGraphSourceNodeResponse { /** * Name of the node. */ name: string; /** * DataflowGraph node types. * Expected value is 'Source'. */ nodeType: "Source"; /** * Source configuration. */ sourceSettings: outputs.iotoperations.DataflowGraphSourceSettingsResponse; } /** * DataflowGraph source node settings. */ interface DataflowGraphSourceSettingsResponse { /** * Reference to the resource in Azure Device Registry where the data in the endpoint originates from. */ assetRef?: string; /** * List of data sources. */ dataSources: string[]; /** * The endpoint reference for the source. */ endpointRef: string; } /** * Dataflow Operation properties. NOTE - One only method is allowed to be used for one entry. */ interface DataflowOperationResponse { /** * Built In Transformation configuration. */ builtInTransformationSettings?: outputs.iotoperations.DataflowBuiltInTransformationSettingsResponse; /** * Destination configuration. */ destinationSettings?: outputs.iotoperations.DataflowDestinationOperationSettingsResponse; /** * Optional user provided name of the transformation. */ name?: string; /** * Type of operation. */ operationType: string; /** * Source configuration. */ sourceSettings?: outputs.iotoperations.DataflowSourceOperationSettingsResponse; } /** * dataflowOperationResponseProvideDefaults sets the appropriate defaults for DataflowOperationResponse */ function dataflowOperationResponseProvideDefaults(val: DataflowOperationResponse): DataflowOperationResponse; /** * DataflowProfile Resource properties */ interface DataflowProfilePropertiesResponse { /** * Spec defines the desired identities of NBC diagnostics settings. */ diagnostics?: outputs.iotoperations.ProfileDiagnosticsResponse; /** * To manually scale the dataflow profile, specify the maximum number of instances you want to run. */ instanceCount?: number; /** * The status of the last operation. */ provisioningState: string; } /** * dataflowProfilePropertiesResponseProvideDefaults sets the appropriate defaults for DataflowProfilePropertiesResponse */ function dataflowProfilePropertiesResponseProvideDefaults(val: DataflowProfilePropertiesResponse): DataflowProfilePropertiesResponse; /** * Dataflow Resource properties */ interface DataflowPropertiesResponse { /** * Mode for Dataflow. Optional; defaults to Enabled. */ mode?: string; /** * List of operations including source and destination references as well as transformation. */ operations: outputs.iotoperations.DataflowOperationResponse[]; /** * The status of the last operation. */ provisioningState: string; } /** * dataflowPropertiesResponseProvideDefaults sets the appropriate defaults for DataflowPropertiesResponse */ function dataflowPropertiesResponseProvideDefaults(val: DataflowPropertiesResponse): DataflowPropertiesResponse; /** * Dataflow Source Operation properties */ interface DataflowSourceOperationSettingsResponse { /** * Reference to the resource in Azure Device Registry where the data in the endpoint originates from. */ assetRef?: string; /** * List of source locations. Can be Broker or Kafka topics. Supports wildcards # and +. */ dataSources: string[]; /** * Reference to the Dataflow Endpoint resource. Can only be of Broker and Kafka type. */ endpointRef: string; /** * Schema CR reference. Data will be deserialized according to the schema, and dropped if it doesn't match. */ schemaRef?: string; /** * Content is a JSON Schema. Allowed: JSON Schema/draft-7. */ serializationFormat?: string; } /** * dataflowSourceOperationSettingsResponseProvideDefaults sets the appropriate defaults for DataflowSourceOperationSettingsResponse */ function dataflowSourceOperationSettingsResponseProvideDefaults(val: DataflowSourceOperationSettingsResponse): DataflowSourceOperationSettingsResponse; /** * Diagnostic Log properties */ interface DiagnosticsLogsResponse { /** * The log level. Examples - 'debug', 'info', 'warn', 'error', 'trace'. */ level?: string; } /** * diagnosticsLogsResponseProvideDefaults sets the appropriate defaults for DiagnosticsLogsResponse */ function diagnosticsLogsResponseProvideDefaults(val: DiagnosticsLogsResponse): DiagnosticsLogsResponse; /** * DiskBackedMessageBuffer properties */ interface DiskBackedMessageBufferResponse { /** * Use the specified persistent volume claim template to mount a "generic ephemeral volume" for the message buffer. See for details. */ ephemeralVolumeClaimSpec?: outputs.iotoperations.VolumeClaimSpecResponse; /** * The max size of the message buffer on disk. If a PVC template is specified using one of ephemeralVolumeClaimSpec or persistentVolumeClaimSpec, then this size is used as the request and limit sizes of that template. If neither ephemeralVolumeClaimSpec nor persistentVolumeClaimSpec are specified, then an emptyDir volume is mounted with this size as its limit. See for details. */ maxSize: string; /** * Use the specified persistent volume claim template to mount a persistent volume for the message buffer. */ persistentVolumeClaimSpec?: outputs.iotoperations.VolumeClaimSpecResponse; } /** * Extended location is an extension of Azure locations. They provide a way to use their Azure ARC enabled Kubernetes clusters as target locations for deploying Azure services instances. */ interface ExtendedLocationResponse { /** * The name of the extended location. */ name: string; /** * Type of ExtendedLocation. */ type: string; } /** * The desired properties of the frontend instances of the Broker */ interface FrontendResponse { /** * The desired number of frontend instances (pods). */ replicas: number; /** * Number of logical frontend workers per instance (pod). */ workers?: number; } /** * frontendResponseProvideDefaults sets the appropriate defaults for FrontendResponse */ function frontendResponseProvideDefaults(val: FrontendResponse): FrontendResponse; /** * GenerateResourceLimits properties */ interface GenerateResourceLimitsResponse { /** * The toggle to enable/disable cpu resource limits. */ cpu?: string; } /** * generateResourceLimitsResponseProvideDefaults sets the appropriate defaults for GenerateResourceLimitsResponse */ function generateResourceLimitsResponseProvideDefaults(val: GenerateResourceLimitsResponse): GenerateResourceLimitsResponse; /** * The properties of the Instance resource. */ interface InstancePropertiesResponse { /** * Detailed description of the Instance. */ description?: string; /** * The status of the last operation. */ provisioningState: string; /** * The reference to the Schema Registry for this AIO Instance. */ schemaRegistryRef: outputs.iotoperations.SchemaRegistryRefResponse; /** * The Azure IoT Operations version. */ version: string; } /** * Kubernetes reference */ interface KubernetesReferenceResponse { /** * APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. */ apiGroup?: string; /** * Kind is the type of resource being referenced */ kind: string; /** * Name is the name of resource being referenced */ name: string; /** * Namespace is the namespace of the resource being referenced. This field is required when the resource has a namespace. */ namespace?: string; } /** * Defines a TCP port on which a `BrokerListener` listens. */ interface ListenerPortResponse { /** * Reference to client authentication settings. Omit to disable authentication. */ authenticationRef?: string; /** * Reference to client authorization settings. Omit to disable authorization. */ authorizationRef?: string; /** * Kubernetes node port. Only relevant when this port is associated with a `NodePort` listener. */ nodePort?: number; /** * TCP port for accepting client connections. */ port: number; /** * Protocol to use for client connections. */ protocol?: string; /** * TLS server certificate settings for this port. Omit to disable TLS. */ tls?: outputs.iotoperations.TlsCertMethodResponse; } /** * listenerPortResponseProvideDefaults sets the appropriate defaults for ListenerPortResponse */ function listenerPortResponseProvideDefaults(val: ListenerPortResponse): ListenerPortResponse; /** * Kubernetes reference */ interface LocalKubernetesReferenceResponse { /** * APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. */ apiGroup?: string; /** * Kind is the type of resource being referenced */ kind: string; /** * Name is the name of resource being referenced */ name: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.iotoperations.UserAssignedIdentityResponse; }; } /** * Diagnostic Metrics properties */ interface MetricsResponse { /** * The prometheus port to expose the metrics. */ prometheusPort?: number; } /** * metricsResponseProvideDefaults sets the appropriate defaults for MetricsResponse */ function metricsResponseProvideDefaults(val: MetricsResponse): MetricsResponse; /** * PrincipalDefinition properties of Rule */ interface PrincipalDefinitionResponse { /** * A list of key-value pairs that match the attributes of the clients. The attributes are case-sensitive and must match the attributes provided by the clients during authentication. */ attributes?: { [key: string]: string; }[]; /** * A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection. */ clientIds?: string[]; /** * A list of usernames that match the clients. The usernames are case-sensitive and must match the usernames provided by the clients during authentication. */ usernames?: string[]; } /** * DataflowProfile Diagnostics properties */ interface ProfileDiagnosticsResponse { /** * Diagnostic log settings for the resource. */ logs?: outputs.iotoperations.DiagnosticsLogsResponse; /** * The metrics settings for the resource. */ metrics?: outputs.iotoperations.MetricsResponse; } /** * profileDiagnosticsResponseProvideDefaults sets the appropriate defaults for ProfileDiagnosticsResponse */ function profileDiagnosticsResponseProvideDefaults(val: ProfileDiagnosticsResponse): ProfileDiagnosticsResponse; /** * Anonymous authentication */ interface RegistryEndpointAnonymousAuthenticationResponse { /** * Anonymous authentication properties */ anonymousSettings: any; /** * The authentication method. * Expected value is 'Anonymous'. */ method: "Anonymous"; } /** * Artifact Pull Secret authentication */ interface RegistryEndpointArtifactPullSecretAuthenticationResponse { /** * Artifact Pull Secret authentication properties */ artifactPullSecretSettings: outputs.iotoperations.RegistryEndpointArtifactPullSecretSettingsResponse; /** * The authentication method. * Expected value is 'ArtifactPullSecret'. */ method: "ArtifactPullSecret"; } /** * RegistryEndpoint Artifact Pull Secret authentication properties */ interface RegistryEndpointArtifactPullSecretSettingsResponse { /** * The name of the kubernetes secret that contains the artifact pull secret. */ secretRef: string; } /** * RegistryEndpoint properties */ interface RegistryEndpointPropertiesResponse { /** * The authentication settings for the Azure Container Registry. */ authentication: outputs.iotoperations.RegistryEndpointAnonymousAuthenticationResponse | outputs.iotoperations.RegistryEndpointArtifactPullSecretAuthenticationResponse | outputs.iotoperations.RegistryEndpointSystemAssignedIdentityAuthenticationResponse | outputs.iotoperations.RegistryEndpointUserAssignedIdentityAuthenticationResponse; /** * The Container Registry endpoint hostname. */ host: string; /** * The status of the last operation. */ provisioningState: string; /** * Trust settings for the registry endpoint */ trustSettings?: outputs.iotoperations.RegistryEndpointTrustedSettingsResponse; } /** * System assigned identity authentication */ interface RegistryEndpointSystemAssignedIdentityAuthenticationResponse { /** * The authentication method. * Expected value is 'SystemAssignedManagedIdentity'. */ method: "SystemAssignedManagedIdentity"; /** * System assigned managed identity properties */ systemAssignedManagedIdentitySettings: outputs.iotoperations.RegistryEndpointSystemAssignedManagedIdentitySettingsResponse; } /** * System assigned managed identity properties */ interface RegistryEndpointSystemAssignedManagedIdentitySettingsResponse { /** * Audience of the service to authenticate against. Optional; defaults to the audience for Service host configuration. */ audience?: string; } /** * RegistryEndpointTrustedSettings properties */ interface RegistryEndpointTrustedSettingsResponse { /** * The trust properties for the registry endpoint. */ trustedSigningKeys: outputs.iotoperations.RegistryEndpointTrustedSigningKeyConfigMapResponse | outputs.iotoperations.RegistryEndpointTrustedSigningKeySecretResponse; } /** * Settings for RegistryEndpoint trust provided through a configmap. */ interface RegistryEndpointTrustedSigningKeyConfigMapResponse { /** * The name of the configmap. */ configMapRef: string; /** * RegistryEndpointTrustedSigningKeyType values * Expected value is 'ConfigMap'. */ type: "ConfigMap"; } /** * Settings for RegistryEndpoint trust provided through a secret. */ interface RegistryEndpointTrustedSigningKeySecretResponse { /** * The name of the secret. */ secretRef: string; /** * RegistryEndpointTrustedSigningKeyType values * Expected value is 'Secret'. */ type: "Secret"; } /** * User assigned identity authentication */ interface RegistryEndpointUserAssignedIdentityAuthenticationResponse { /** * The authentication method. * Expected value is 'UserAssignedManagedIdentity'. */ method: "UserAssignedManagedIdentity"; /** * User assigned managed identity properties */ userAssignedManagedIdentitySettings: outputs.iotoperations.RegistryEndpointUserAssignedManagedIdentitySettingsResponse; } /** * User assigned managed identity properties */ interface RegistryEndpointUserAssignedManagedIdentitySettingsResponse { /** * Client ID for the user-assigned managed identity. */ clientId: string; /** * Resource identifier (application ID URI) of the resource, affixed with the .default suffix. */ scope?: string; /** * Tenant ID. */ tenantId: string; } /** * Represents the health state of a resource. */ interface ResourceHealthStatusResponse { /** * The timestamp (RFC3339) when the health status last changed. */ lastTransitionTime: string; /** * The timestamp (RFC3339) when the health status was last updated, even if the status did not change. */ lastUpdateTime: string; /** * A human-readable message describing the last transition. */ message: string; /** * Unique, CamelCase reason code describing the cause of the last health state transition. */ reasonCode: string; /** * The high-level health status of the resource. */ status: string; } /** * Subject Alternative Names (SANs) for certificate. */ interface SanForCertResponse { /** * DNS SANs. */ dns: string[]; /** * IP address SANs. */ ip: string[]; } /** * The reference to the Schema Registry for this AIO Instance. */ interface SchemaRegistryRefResponse { /** * The resource ID of the Schema Registry. */ resourceId: string; } /** * Broker Diagnostic Self check properties */ interface SelfCheckResponse { /** * The self check interval. */ intervalSeconds?: number; /** * The toggle to enable/disable self check. */ mode?: string; /** * The timeout for self check. */ timeoutSeconds?: number; } /** * selfCheckResponseProvideDefaults sets the appropriate defaults for SelfCheckResponse */ function selfCheckResponseProvideDefaults(val: SelfCheckResponse): SelfCheckResponse; /** * Diagnostic Self tracing properties */ interface SelfTracingResponse { /** * The self tracing interval. */ intervalSeconds?: number; /** * The toggle to enable/disable self tracing. */ mode?: string; } /** * selfTracingResponseProvideDefaults sets the appropriate defaults for SelfTracingResponse */ function selfTracingResponseProvideDefaults(val: SelfTracingResponse): SelfTracingResponse; /** * State Store Resource Rule properties. */ interface StateStoreResourceRuleResponse { /** * Allowed keyTypes pattern, string, binary. The key type used for matching, for example pattern tries to match the key to a glob-style pattern and string checks key is equal to value provided in keys. */ keyType: string; /** * Give access to state store keys for the corresponding principals defined. When key type is pattern set glob-style pattern (e.g., '*', 'clients/*'). */ keys: string[]; /** * Give access for `Read`, `Write` and `ReadWrite` access level. */ method: string; } /** * The settings of Subscriber Queue Limit. */ interface SubscriberQueueLimitResponse { /** * The maximum length of the queue before messages start getting dropped. */ length?: number; /** * The strategy to use for dropping messages from the queue. */ strategy?: string; } /** * subscriberQueueLimitResponseProvideDefaults sets the appropriate defaults for SubscriberQueueLimitResponse */ function subscriberQueueLimitResponseProvideDefaults(val: SubscriberQueueLimitResponse): SubscriberQueueLimitResponse; /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Collection of different TLS types, NOTE- Enum at a time only one of them needs to be supported */ interface TlsCertMethodResponse { /** * Option 1 - Automatic TLS server certificate management with cert-manager. */ certManagerCertificateSpec?: outputs.iotoperations.CertManagerCertificateSpecResponse; /** * Option 2 - Manual TLS server certificate management through a defined secret. */ manual?: outputs.iotoperations.X509ManualCertificateResponse; /** * Mode of TLS server certificate management. */ mode: string; } /** * tlsCertMethodResponseProvideDefaults sets the appropriate defaults for TlsCertMethodResponse */ function tlsCertMethodResponseProvideDefaults(val: TlsCertMethodResponse): TlsCertMethodResponse; /** * Tls properties */ interface TlsPropertiesResponse { /** * Mode for TLS. */ mode?: string; /** * Trusted CA certificate config map. */ trustedCaCertificateConfigMapRef?: string; } /** * tlsPropertiesResponseProvideDefaults sets the appropriate defaults for TlsPropertiesResponse */ function tlsPropertiesResponseProvideDefaults(val: TlsPropertiesResponse): TlsPropertiesResponse; /** * Broker Diagnostic Trace properties */ interface TracesResponse { /** * The cache size in megabytes. */ cacheSizeMegabytes?: number; /** * The toggle to enable/disable traces. */ mode?: string; /** * The self tracing properties. */ selfTracing?: outputs.iotoperations.SelfTracingResponse; /** * The span channel capacity. */ spanChannelCapacity?: number; } /** * tracesResponseProvideDefaults sets the appropriate defaults for TracesResponse */ function tracesResponseProvideDefaults(val: TracesResponse): TracesResponse; /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * VolumeClaimResourceRequirements properties */ interface VolumeClaimResourceRequirementsResponse { /** * Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ limits?: { [key: string]: string; }; /** * Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ requests?: { [key: string]: string; }; } /** * VolumeClaimSpec properties */ interface VolumeClaimSpecResponse { /** * AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 */ accessModes?: string[]; /** * This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. */ dataSource?: outputs.iotoperations.LocalKubernetesReferenceResponse; /** * Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. */ dataSourceRef?: outputs.iotoperations.KubernetesReferenceResponse; /** * Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources */ resources?: outputs.iotoperations.VolumeClaimResourceRequirementsResponse; /** * A label query over volumes to consider for binding. */ selector?: outputs.iotoperations.VolumeClaimSpecSelectorResponse; /** * Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 */ storageClassName?: string; /** * volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature. */ volumeMode?: string; /** * VolumeName is the binding reference to the PersistentVolume backing this claim. */ volumeName?: string; } /** * VolumeClaimSpecSelectorMatchExpressions properties */ interface VolumeClaimSpecSelectorMatchExpressionsResponse { /** * key is the label key that the selector applies to. */ key: string; /** * operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** * values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * VolumeClaimSpecSelector properties */ interface VolumeClaimSpecSelectorResponse { /** * MatchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: outputs.iotoperations.VolumeClaimSpecSelectorMatchExpressionsResponse[]; /** * MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: { [key: string]: string; }; } /** * X509 Certificate Authentication properties. */ interface X509ManualCertificateResponse { /** * Kubernetes secret containing an X.509 client certificate. This is a reference to the secret through an identifying name, not the secret itself. */ secretRef: string; } } export declare namespace iotoperationsdataprocessor { /** * Key that can be used for joining on enrich. */ interface DatasetPropertyKeyResponse { /** * Path to the input value from the message. */ path: string; /** * If true the property will be used as a primary key. At most one primary key can exists. */ primaryKey?: boolean; } /** * Extended location is an extension of Azure locations. They provide a way to use their Azure ARC enabled Kubernetes clusters as target locations for deploying Azure services instances. */ interface ExtendedLocationResponse { /** * The name of the extended location. */ name: string; /** * The type of the extended location. */ type: string; } /** * Stage configuration for Pipeline input stage. */ interface PipelineInputResponse { /** * Description for stage. */ description?: string; /** * Next stage in the pipeline. */ next: string[]; /** * ARM resource type. */ type: string; } /** * Stage configurations for all Pipeline processing and output stages. */ interface PipelineStageResponse { /** * Description for stage. */ description?: string; /** * Next stage in the pipeline. Not required if output stage. */ next?: string[]; /** * ARM resource type. */ type: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace iotoperationsmq { /** * BasicRules of AuthorizationConfig Polar rules are not supported */ interface AuthorizationBasicRuleResponse { /** * This subfield defines the broker resources that the Basic Rule is applied on. */ brokerResources: outputs.iotoperationsmq.ResourceInfoDefinitionResponse[]; /** * This subfield defines the identities that represent the clients. */ principals: outputs.iotoperationsmq.PrincipalDefinitionResponse; } /** * Broker AuthorizationConfig properties */ interface AuthorizationConfigResponse { /** * Enable caching of the authorization rules. */ enableCache?: boolean; /** * Authorization Rules to be used. If no rule is set, but Authorization Resource is used that would mean DenyAll. */ rules?: outputs.iotoperationsmq.AuthorizationBasicRuleResponse[]; } /** * authorizationConfigResponseProvideDefaults sets the appropriate defaults for AuthorizationConfigResponse */ function authorizationConfigResponseProvideDefaults(val: AuthorizationConfigResponse): AuthorizationConfigResponse; /** * Automatic TLS server certificate management with cert-manager */ interface AutomaticCertMethodResponse { /** * Lifetime of automatically-managed certificate. */ duration?: string; /** * cert-manager issuerRef. */ issuerRef: outputs.iotoperationsmq.CertManagerIssuerRefResponse; /** * Cert Manager private key. */ privateKey?: outputs.iotoperationsmq.CertManagerPrivateKeyResponse; /** * When to begin renewing automatically-managed certificate. */ renewBefore?: string; /** * Additional SANs to include in the certificate. */ san?: outputs.iotoperationsmq.SanForCertResponse; /** * Secret for storing server certificate. Any existing data will be overwritten. */ secretName?: string; /** * Certificate K8S namespace. Omit to use default namespace. */ secretNamespace?: string; } /** * automaticCertMethodResponseProvideDefaults sets the appropriate defaults for AutomaticCertMethodResponse */ function automaticCertMethodResponseProvideDefaults(val: AutomaticCertMethodResponse): AutomaticCertMethodResponse; /** * Desired properties of the Frontend Instances of the DMQTT Broker */ interface BackendChainResponse { /** * Partitions is desired number of physical backend chains of the given distributed MQTT broker. */ partitions: number; /** * Redundancy Factor is desired numbers of broker instances in one chain. */ redundancyFactor: number; /** * Defines whether disk transfer is enabled or not. */ temporaryDiskTransferEnabled?: boolean; /** * Defines the percentage usage of buffer pool above which disk transfer will start. */ temporaryDiskTransferHighWatermarkPercent?: number; /** * Defines the percentage usage of buffer pool below which disk transfer will stop. */ temporaryDiskTransferLowWatermarkPercent?: number; /** * Defines the limits for memory usage percent of the backend instances of the MQTT broker. */ temporaryMaxBackendMemUsagePercent?: number; /** * Defines the limits for resources of the backend instances of the MQTT broker. */ temporaryResourceLimits?: outputs.iotoperationsmq.TemporaryResourceLimitsConfigResponse; /** * Number of logical backend workers per pod. */ workers?: number; } /** * backendChainResponseProvideDefaults sets the appropriate defaults for BackendChainResponse */ function backendChainResponseProvideDefaults(val: BackendChainResponse): BackendChainResponse; /** * Custom Authentication properties */ interface BrokerAuthenticatorCustomAuthResponse { /** * X509 Custom Auth type details. */ x509: outputs.iotoperationsmq.BrokerAuthenticatorCustomAuthX509Response; } /** * X509 Custom Authentication properties. NOTE - Enum only authenticator type supported at a time. */ interface BrokerAuthenticatorCustomAuthX509Response { /** * Keyvault X509 secret properties. */ keyVault?: outputs.iotoperationsmq.KeyVaultCertificatePropertiesResponse; /** * Secret where cert details are stored. */ secretName?: string; } /** * Custom method for BrokerAuthentication */ interface BrokerAuthenticatorMethodCustomResponse { /** * Custom Broker Authentication Method. */ auth?: outputs.iotoperationsmq.BrokerAuthenticatorCustomAuthResponse; /** * CA cert config map to use. */ caCertConfigMap?: string; /** * Endpoint to connect to. */ endpoint: string; /** * Configuration Headers to use. */ headers?: { [key: string]: string; }; } /** * Service Account Token for BrokerAuthentication */ interface BrokerAuthenticatorMethodSatResponse { /** * List of allowed audience. */ audiences: string[]; } /** * SVID for BrokerAuthentication */ interface BrokerAuthenticatorMethodSvidResponse { /** * Mounted socket path for spiffe agent. */ agentSocketPath: string; /** * Maximum number of re-tries to fetch identity. */ identityMaxRetry?: number; /** * Maximum time to wait before fetching identity again. */ identityWaitRetryMs?: number; } /** * brokerAuthenticatorMethodSvidResponseProvideDefaults sets the appropriate defaults for BrokerAuthenticatorMethodSvidResponse */ function brokerAuthenticatorMethodSvidResponseProvideDefaults(val: BrokerAuthenticatorMethodSvidResponse): BrokerAuthenticatorMethodSvidResponse; /** * UsernamePassword for BrokerAuthentication */ interface BrokerAuthenticatorMethodUsernamePasswordResponse { /** * Keyvault username password secret properties. */ keyVault?: outputs.iotoperationsmq.KeyVaultSecretPropertiesResponse; /** * Secret where username and password are stored. */ secretName?: string; } /** * BrokerAuthenticatorMethodX509Attributes properties. NOTE - Enum only type supported at a time. */ interface BrokerAuthenticatorMethodX509AttributesResponse { /** * Keyvault x509 attributes secret properties. */ keyVault?: outputs.iotoperationsmq.KeyVaultSecretPropertiesResponse; /** * Secret where x509 attributes are stored. */ secretName?: string; } /** * X509 for BrokerAuthentication. */ interface BrokerAuthenticatorMethodX509Response { /** * K8S Secret name to mount for username and password. */ attributes?: outputs.iotoperationsmq.BrokerAuthenticatorMethodX509AttributesResponse; /** * Trusted client ca cert config map. */ trustedClientCaCertConfigMap?: string; } /** * brokerAuthenticatorMethodX509ResponseProvideDefaults sets the appropriate defaults for BrokerAuthenticatorMethodX509Response */ function brokerAuthenticatorMethodX509ResponseProvideDefaults(val: BrokerAuthenticatorMethodX509Response): BrokerAuthenticatorMethodX509Response; /** * Collection of different CrdAuthenticator methods of Broker Resource. NOTE Enum - Only one method is supported for each entry. */ interface BrokerAuthenticatorMethodsResponse { /** * Custom Authentication Method. */ custom?: outputs.iotoperationsmq.BrokerAuthenticatorMethodCustomResponse; /** * Service Account Token Method. */ sat?: outputs.iotoperationsmq.BrokerAuthenticatorMethodSatResponse; /** * Service Account Token Method. */ svid?: outputs.iotoperationsmq.BrokerAuthenticatorMethodSvidResponse; /** * UsernamePassword Method. */ usernamePassword?: outputs.iotoperationsmq.BrokerAuthenticatorMethodUsernamePasswordResponse; /** * X509 Method. */ x509?: outputs.iotoperationsmq.BrokerAuthenticatorMethodX509Response; } /** * brokerAuthenticatorMethodsResponseProvideDefaults sets the appropriate defaults for BrokerAuthenticatorMethodsResponse */ function brokerAuthenticatorMethodsResponseProvideDefaults(val: BrokerAuthenticatorMethodsResponse): BrokerAuthenticatorMethodsResponse; /** * Diagnostics setting specific to Broker */ interface BrokerDiagnosticsResponse { /** * Diagnostic Service endpoint */ diagnosticServiceEndpoint?: string; /** * Knob to enable/disable metrics. Default = true */ enableMetrics?: boolean; /** * Enable self check on Broker via Probe. */ enableSelfCheck?: boolean; /** * Enable self tracing on the Broker so that every selfCheckFrequencySeconds a random message is traced even if it didn't have trace context. */ enableSelfTracing?: boolean; /** * Knob to enable/disable entire tracing infrastructure. */ enableTracing?: boolean; /** * Format for the logs generated. */ logFormat?: string; /** * Log level for the Broker. */ logLevel?: string; /** * Maximum time for the CellMap to live. */ maxCellMapLifetime?: number; /** * Metric update frequency in seconds. */ metricUpdateFrequencySeconds?: number; /** * Probe Image to run. */ probeImage?: string; /** * Frequency for the self check to run. */ selfCheckFrequencySeconds?: number; /** * Time out period of the self check. */ selfCheckTimeoutSeconds?: number; /** * The frequency at which selfTrace should run. */ selfTraceFrequencySeconds?: number; /** * The number of the spans generated by the Tracing. */ spanChannelCapacity?: number; } /** * brokerDiagnosticsResponseProvideDefaults sets the appropriate defaults for BrokerDiagnosticsResponse */ function brokerDiagnosticsResponseProvideDefaults(val: BrokerDiagnosticsResponse): BrokerDiagnosticsResponse; /** * Cardinality properties */ interface CardinalityResponse { /** * The backend broker desired properties */ backendChain: outputs.iotoperationsmq.BackendChainResponse; /** * The frontend broker desired properties */ frontend: outputs.iotoperationsmq.FrontendResponse; } /** * cardinalityResponseProvideDefaults sets the appropriate defaults for CardinalityResponse */ function cardinalityResponseProvideDefaults(val: CardinalityResponse): CardinalityResponse; /** * Cert Manager CA Cert properties */ interface CertManagerCertOptionsResponse { /** * Duration of CA cert. */ duration: string; /** * Cert Manager private key. */ privateKey: outputs.iotoperationsmq.CertManagerPrivateKeyResponse; /** * Renew before time of CA cert. */ renewBefore: string; } /** * certManagerCertOptionsResponseProvideDefaults sets the appropriate defaults for CertManagerCertOptionsResponse */ function certManagerCertOptionsResponseProvideDefaults(val: CertManagerCertOptionsResponse): CertManagerCertOptionsResponse; /** * Cert-Manager issuerRef properties */ interface CertManagerIssuerRefResponse { /** * group of issuer. */ group: string; /** * kind of issuer (Issuer or ClusterIssuer). */ kind: string; /** * name of issuer. */ name: string; } /** * certManagerIssuerRefResponseProvideDefaults sets the appropriate defaults for CertManagerIssuerRefResponse */ function certManagerIssuerRefResponseProvideDefaults(val: CertManagerIssuerRefResponse): CertManagerIssuerRefResponse; /** * Cert Manager private key properties */ interface CertManagerPrivateKeyResponse { /** * algorithm for private key. */ algorithm: string; /** * cert-manager rotationPolicy. */ rotationPolicy: string; /** * size of private key. */ size: number; } /** * certManagerPrivateKeyResponseProvideDefaults sets the appropriate defaults for CertManagerPrivateKeyResponse */ function certManagerPrivateKeyResponseProvideDefaults(val: CertManagerPrivateKeyResponse): CertManagerPrivateKeyResponse; /** * Defines the Docker image details */ interface ContainerImageResponse { /** * Image pull policy. */ pullPolicy?: string; /** * Image pull secrets. */ pullSecrets?: string; /** * The Docker image name. */ repository: string; /** * The Docker image tag. */ tag: string; } /** * DataLake connector map route properties */ interface DataLakeConnectorMapResponse { /** * Allowed latency for transferring data. */ allowedLatencySecs: number; /** * Client Id to use. */ clientId: string; /** * Maximum messages to send per Batch. */ maxMessagesPerBatch: number; /** * Message payload type. */ messagePayloadType: string; /** * Mqtt source topic. */ mqttSourceTopic: string; /** * Quality of Service. */ qos?: number; /** * Delta table properties to use. */ table: outputs.iotoperationsmq.DeltaTableResponse; } /** * dataLakeConnectorMapResponseProvideDefaults sets the appropriate defaults for DataLakeConnectorMapResponse */ function dataLakeConnectorMapResponseProvideDefaults(val: DataLakeConnectorMapResponse): DataLakeConnectorMapResponse; /** * DataLake Fabric Storage authentication details. */ interface DataLakeFabricStorageAuthenticationResponse { /** * Configuration for managed identity authentication. */ systemAssignedManagedIdentity: outputs.iotoperationsmq.ManagedIdentityAuthenticationResponse; } /** * DataLake Fabric Storage details. */ interface DataLakeFabricStorageResponse { /** * DataLake fabric storage authentication details. */ authentication: outputs.iotoperationsmq.DataLakeFabricStorageAuthenticationResponse; /** * DataLake fabric storage endpoint to use. */ endpoint: string; /** * Fabric path type to use. */ fabricPath: string; /** * Fabric one lake Guids. */ guids?: outputs.iotoperationsmq.FabricGuidsResponse; /** * Fabric one lake Names. */ names?: outputs.iotoperationsmq.FabricNamesResponse; } /** * DataLake Local Storage details. */ interface DataLakeLocalStorageResponse { /** * Volume name to write to. */ volumeName: string; } /** * DataLake Service Storage authentication details. NOTE - Enum only one method is supported. */ interface DataLakeServiceStorageAuthenticationResponse { /** * Access token secret name. */ accessTokenSecretName?: string; /** * Configuration for managed identity authentication. */ systemAssignedManagedIdentity?: outputs.iotoperationsmq.ManagedIdentityAuthenticationResponse; } /** * DataLake Service Storage details. */ interface DataLakeServiceStorageResponse { /** * DataLake service storage authentication details. NOTE - Enum only one method is supported. */ authentication: outputs.iotoperationsmq.DataLakeServiceStorageAuthenticationResponse; /** * DataLake service storage endpoint to use. */ endpoint: string; } /** * Target storage for the DataLake. NOTE - Enum only storage is supported at a time. */ interface DataLakeTargetStorageResponse { /** * DataLake service storage details. */ datalakeStorage?: outputs.iotoperationsmq.DataLakeServiceStorageResponse; /** * Fabric one lake storage details. */ fabricOneLake?: outputs.iotoperationsmq.DataLakeFabricStorageResponse; /** * Local storage details. */ localStorage?: outputs.iotoperationsmq.DataLakeLocalStorageResponse; } /** * Delta table properties */ interface DeltaTableResponse { /** * Schema list supported. */ schema: outputs.iotoperationsmq.DeltaTableSchemaResponse[]; /** * Delta table name. */ tableName: string; /** * Delta table path. */ tablePath?: string; } /** * Delta table schema properties */ interface DeltaTableSchemaResponse { /** * Delta table format supported. */ format: string; /** * Delta table schema mapping. */ mapping: string; /** * Delta table schema name. */ name: string; /** * Delta table schema optional. */ optional: boolean; } /** * DiskBackedMessageBufferSettings properties */ interface DiskBackedMessageBufferSettingsResponse { /** * Use the specified persistent volume claim template to mount a "generic ephemeral volume" for the message buffer. See for details. */ ephemeralVolumeClaimSpec?: outputs.iotoperationsmq.VolumeClaimSpecResponse; /** * The max size of the message buffer on disk. If a PVC template is specified using one of ephemeralVolumeClaimSpec or persistentVolumeClaimSpec, then this size is used as the request and limit sizes of that template. If neither ephemeralVolumeClaimSpec nor persistentVolumeClaimSpec are specified, then an emptyDir volume is mounted with this size as its limit. See for details. */ maxSize: string; /** * Use the specified persistent volume claim template to mount a persistent volume for the message buffer. */ persistentVolumeClaimSpec?: outputs.iotoperationsmq.VolumeClaimSpecResponse; } /** * ExtendedLocation properties */ interface ExtendedLocationPropertyResponse { /** * The name of the extended location. */ name: string; /** * Type of ExtendedLocation. */ type: string; } /** * Fabric one lake guids. */ interface FabricGuidsResponse { /** * Fabric one lake house guid. */ lakehouseGuid: string; /** * Fabric one lake workspace guid. */ workspaceGuid: string; } /** * Fabric one lake names. */ interface FabricNamesResponse { /** * Fabric one lake house name. */ lakehouseName: string; /** * Fabric one lake workspace name. */ workspaceName: string; } /** * Desired properties of the Frontend Instances of the DMQTT Broker */ interface FrontendResponse { /** * Replicas is desired number of frontend replicas of the given distributed MQTT broker. */ replicas: number; /** * Defines the limits for resources of the frontend instances of the MQTT broker. */ temporaryResourceLimits?: outputs.iotoperationsmq.TemporaryResourceLimitsConfigResponse; /** * Number of logical frontend workers per pod. */ workers?: number; } /** * frontendResponseProvideDefaults sets the appropriate defaults for FrontendResponse */ function frontendResponseProvideDefaults(val: FrontendResponse): FrontendResponse; /** * Kafka RemoteBrokerConnection Authentication methods */ interface KafkaRemoteBrokerAuthenticationPropertiesResponse { /** * The type of authentication to use for Kafka remote broker. */ authType?: outputs.iotoperationsmq.KafkaRemoteBrokerAuthenticationTypesResponse; /** * If authentication is enabled for Kafka remote broker. */ enabled: boolean; } /** * Kafka RemoteBrokerConnection Authentication types. NOTE - Enum only one method is allowed to be passed. */ interface KafkaRemoteBrokerAuthenticationTypesResponse { /** * Sasl remote broker authentication method. */ sasl?: outputs.iotoperationsmq.SaslRemoteBrokerBasicAuthenticationResponse; /** * Managed identity remote broker authentication method. */ systemAssignedManagedIdentity?: outputs.iotoperationsmq.ManagedIdentityAuthenticationResponse; /** * X509 remote broker authentication method. */ x509?: outputs.iotoperationsmq.KafkaX509AuthenticationResponse; } /** * Kafka RemoteBrokerConnectionSpec details */ interface KafkaRemoteBrokerConnectionSpecResponse { /** * The remote broker authentication methods. */ authentication: outputs.iotoperationsmq.KafkaRemoteBrokerAuthenticationPropertiesResponse; /** * The endpoint of remote broker to connect to. */ endpoint: string; /** * TLS details for Remote broker Connection. */ tls: outputs.iotoperationsmq.KafkaRemoteBrokerConnectionTlsResponse; } /** * Kafka RemoteBrokerConnection TLS details */ interface KafkaRemoteBrokerConnectionTlsResponse { /** * Tls Enabled on Remote Broker Connection. */ tlsEnabled: boolean; /** * Trusted CA certificate name for Remote Broker. */ trustedCaCertificateConfigMap?: string; } /** * Kafka Routes properties. NOTE - Enum only one method is allowed to be passed. */ interface KafkaRoutesResponse { /** * Kafka to Mqtt route. */ kafkaToMqtt?: outputs.iotoperationsmq.KafkaToMqttRoutesResponse; /** * Mqtt to Kafka route. */ mqttToKafka?: outputs.iotoperationsmq.MqttToKafkaRoutesResponse; } /** * kafkaRoutesResponseProvideDefaults sets the appropriate defaults for KafkaRoutesResponse */ function kafkaRoutesResponseProvideDefaults(val: KafkaRoutesResponse): KafkaRoutesResponse; /** * Kafka Shared Subscription properties */ interface KafkaSharedSubscriptionPropertiesResponse { /** * The minimum number to use in a group for subscription. */ groupMinimumShareNumber: number; /** * The name of the shared subscription. */ groupName: string; } /** * Kafka to Mqtt route properties */ interface KafkaToMqttRoutesResponse { /** * The consumer group id to use. */ consumerGroupId?: string; /** * The kafka topic to pull from. */ kafkaTopic: string; /** * The mqtt topic to publish to. */ mqttTopic: string; /** * The name of the route. */ name: string; /** * The qos to use for mqtt. */ qos?: number; } /** * kafkaToMqttRoutesResponseProvideDefaults sets the appropriate defaults for KafkaToMqttRoutesResponse */ function kafkaToMqttRoutesResponseProvideDefaults(val: KafkaToMqttRoutesResponse): KafkaToMqttRoutesResponse; /** * Kafka Token KeyVault properties. */ interface KafkaTokenKeyVaultPropertiesResponse { /** * Username to connect with. */ username?: string; /** * KeyVault properties. */ vault: outputs.iotoperationsmq.KeyVaultConnectionPropertiesResponse; /** * KeyVault secret details. */ vaultSecret: outputs.iotoperationsmq.KeyVaultSecretObjectResponse; } /** * Kafka TopicMap Batching properties */ interface KafkaTopicMapBatchingResponse { /** * The setting to enable or disable batching. */ enabled?: boolean; /** * The latency of message batching. */ latencyMs?: number; /** * The maximum bytes to send in a batch. */ maxBytes?: number; /** * The maximum messages to send in a batch. */ maxMessages?: number; } /** * kafkaTopicMapBatchingResponseProvideDefaults sets the appropriate defaults for KafkaTopicMapBatchingResponse */ function kafkaTopicMapBatchingResponseProvideDefaults(val: KafkaTopicMapBatchingResponse): KafkaTopicMapBatchingResponse; /** * Kafka RemoteBrokerConnection X509 Authentication properties. */ interface KafkaX509AuthenticationResponse { /** * Keyvault X509 secret properties. */ keyVault?: outputs.iotoperationsmq.KeyVaultCertificatePropertiesResponse; /** * Secret where cert details are stored. */ secretName?: string; } /** * KeyVault certificate properties */ interface KeyVaultCertificatePropertiesResponse { /** * KeyVault properties. */ vault: outputs.iotoperationsmq.KeyVaultConnectionPropertiesResponse; /** * KeyVault CA chain secret details. */ vaultCaChainSecret?: outputs.iotoperationsmq.KeyVaultSecretObjectResponse; /** * KeyVault Cert secret details. */ vaultCert: outputs.iotoperationsmq.KeyVaultSecretObjectResponse; } /** * KeyVault properties */ interface KeyVaultConnectionPropertiesResponse { /** * KeyVault credentials. */ credentials: outputs.iotoperationsmq.KeyVaultCredentialsPropertiesResponse; /** * KeyVault directoryId. */ directoryId: string; /** * KeyVault name. */ name: string; } /** * KeyVault credentials properties. NOTE - Future this will be ENUM. */ interface KeyVaultCredentialsPropertiesResponse { /** * KeyVault service principal local secret name. */ servicePrincipalLocalSecretName: string; } /** * KeyVault secret object properties */ interface KeyVaultSecretObjectResponse { /** * KeyVault secret name. */ name: string; /** * KeyVault secret version. */ version?: string; } /** * KeyVault secret properties */ interface KeyVaultSecretPropertiesResponse { /** * KeyVault properties. */ vault: outputs.iotoperationsmq.KeyVaultConnectionPropertiesResponse; /** * KeyVault secret details. */ vaultSecret: outputs.iotoperationsmq.KeyVaultSecretObjectResponse; } /** * Mqtt Local Broker Authentication details. Only one method at a time is supported. Default - kubernetes authentication */ interface LocalBrokerAuthenticationMethodsResponse { /** * Kubernetes local broker authentication method. */ kubernetes: outputs.iotoperationsmq.LocalBrokerKubernetesAuthenticationResponse; } /** * localBrokerAuthenticationMethodsResponseProvideDefaults sets the appropriate defaults for LocalBrokerAuthenticationMethodsResponse */ function localBrokerAuthenticationMethodsResponseProvideDefaults(val: LocalBrokerAuthenticationMethodsResponse): LocalBrokerAuthenticationMethodsResponse; /** * Mqtt Local Broker ConnectionSpec details */ interface LocalBrokerConnectionSpecResponse { /** * The authentication methods for LocalBroker connection. NOTE - Enum only one method at a time is supported. */ authentication?: outputs.iotoperationsmq.LocalBrokerAuthenticationMethodsResponse; /** * The endpoint of local broker to connect to. */ endpoint?: string; /** * TLS details for Local broker Connection. */ tls?: outputs.iotoperationsmq.LocalBrokerConnectionTlsResponse; } /** * localBrokerConnectionSpecResponseProvideDefaults sets the appropriate defaults for LocalBrokerConnectionSpecResponse */ function localBrokerConnectionSpecResponseProvideDefaults(val: LocalBrokerConnectionSpecResponse): LocalBrokerConnectionSpecResponse; /** * Mqtt Local Broker Connection TLS details */ interface LocalBrokerConnectionTlsResponse { /** * Tls Enabled on Local Broker Connection. */ tlsEnabled?: boolean; /** * Trusted CA certificate config map name for Local Broker. */ trustedCaCertificateConfigMap?: string; } /** * localBrokerConnectionTlsResponseProvideDefaults sets the appropriate defaults for LocalBrokerConnectionTlsResponse */ function localBrokerConnectionTlsResponseProvideDefaults(val: LocalBrokerConnectionTlsResponse): LocalBrokerConnectionTlsResponse; /** * Local Broker Kubernetes Authentication */ interface LocalBrokerKubernetesAuthenticationResponse { /** * Secret Path where SAT is mounted. */ secretPath?: string; /** * Token name where SAT is mounted on secret path. */ serviceAccountTokenName?: string; } /** * localBrokerKubernetesAuthenticationResponseProvideDefaults sets the appropriate defaults for LocalBrokerKubernetesAuthenticationResponse */ function localBrokerKubernetesAuthenticationResponseProvideDefaults(val: LocalBrokerKubernetesAuthenticationResponse): LocalBrokerKubernetesAuthenticationResponse; /** * Managed identity authentication details. */ interface ManagedIdentityAuthenticationResponse { /** * Token audience. */ audience: string; /** * Arc Extension name. */ extensionName?: string; } /** * Manual TLS server certificate management through a defined secret */ interface ManualCertMethodResponse { /** * secret containing TLS cert. */ secretName: string; /** * namespace of secret; omit to use default namespace. */ secretNamespace?: string; } /** * MqttBridge RemoteBrokerConnection Authentication methods. NOTE - Enum only one is allowed to be passed. */ interface MqttBridgeRemoteBrokerAuthenticationMethodsResponse { /** * Managed identity remote broker authentication method. */ systemAssignedManagedIdentity?: outputs.iotoperationsmq.ManagedIdentityAuthenticationResponse; /** * X509 remote broker authentication method. */ x509?: outputs.iotoperationsmq.MqttBridgeRemoteBrokerX509AuthenticationResponse; } /** * MqttBridge RemoteBrokerConnectionSpec details */ interface MqttBridgeRemoteBrokerConnectionSpecResponse { /** * The remote broker authentication methods. NOTE - Enum only one method is allowed to be passed. */ authentication: outputs.iotoperationsmq.MqttBridgeRemoteBrokerAuthenticationMethodsResponse; /** * The endpoint of remote broker to connect to. */ endpoint: string; /** * Protocol for remote connection. */ protocol?: string; /** * TLS details for Remote broker Connection. */ tls: outputs.iotoperationsmq.MqttBridgeRemoteBrokerConnectionTlsResponse; } /** * mqttBridgeRemoteBrokerConnectionSpecResponseProvideDefaults sets the appropriate defaults for MqttBridgeRemoteBrokerConnectionSpecResponse */ function mqttBridgeRemoteBrokerConnectionSpecResponseProvideDefaults(val: MqttBridgeRemoteBrokerConnectionSpecResponse): MqttBridgeRemoteBrokerConnectionSpecResponse; /** * MqttBridge RemoteBrokerConnection TLS details */ interface MqttBridgeRemoteBrokerConnectionTlsResponse { /** * Tls Enabled on Remote Broker Connection. */ tlsEnabled: boolean; /** * Trusted CA certificate name for Remote Broker. */ trustedCaCertificateConfigMap?: string; } /** * MqttBridge RemoteBroker X509 Authentication properties. */ interface MqttBridgeRemoteBrokerX509AuthenticationResponse { /** * Keyvault X509 secret properties. */ keyVault?: outputs.iotoperationsmq.KeyVaultCertificatePropertiesResponse; /** * Secret where cert details are stored. */ secretName?: string; } /** * MqttBridgeRoute Shared subscription properties */ interface MqttBridgeRouteSharedSubscriptionResponse { /** * The group shared subscription minimum share number. */ groupMinimumShareNumber: number; /** * The group name for Shared subscription. */ groupName: string; } /** * MqttBridgeTopicMap route properties */ interface MqttBridgeRoutesResponse { /** * Direction of the route. */ direction: string; /** * Name of the route. */ name: string; /** * Qos for MQTT connection. */ qos?: number; /** * Shared subscription topic details. */ sharedSubscription?: outputs.iotoperationsmq.MqttBridgeRouteSharedSubscriptionResponse; /** * Source topic of the route. */ source: string; /** * Target topic of the route. Ignore if same as source */ target?: string; } /** * mqttBridgeRoutesResponseProvideDefaults sets the appropriate defaults for MqttBridgeRoutesResponse */ function mqttBridgeRoutesResponseProvideDefaults(val: MqttBridgeRoutesResponse): MqttBridgeRoutesResponse; /** * Mqtt to Kafka route properties */ interface MqttToKafkaRoutesResponse { /** * The kafka acks to use. */ kafkaAcks: string; /** * The kafka topic to publish to. */ kafkaTopic: string; /** * The mqtt topic to pull from. */ mqttTopic: string; /** * The name of the route. */ name: string; /** * The qos to use for mqtt. */ qos?: number; /** * The properties for shared subscription. */ sharedSubscription?: outputs.iotoperationsmq.KafkaSharedSubscriptionPropertiesResponse; } /** * mqttToKafkaRoutesResponseProvideDefaults sets the appropriate defaults for MqttToKafkaRoutesResponse */ function mqttToKafkaRoutesResponseProvideDefaults(val: MqttToKafkaRoutesResponse): MqttToKafkaRoutesResponse; /** * Defines the Node Tolerations details */ interface NodeTolerationsResponse { /** * Toleration effect. */ effect: string; /** * Toleration key. */ key: string; /** * Toleration operator like 'Exists', 'Equal' etc. */ operator: string; /** * Toleration Value. */ value: string; } /** * PrincipalDefinition properties of Basic Rule */ interface PrincipalDefinitionResponse { /** * A list of key-value pairs that match the attributes of the clients. The attributes are case-sensitive and must match the attributes provided by the clients during authentication. */ attributes?: { [key: string]: string; }[]; /** * A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection. */ clientids?: string[]; /** * A list of usernames that match the clients. The usernames are case-sensitive and must match the usernames provided by the clients during authentication. */ usernames?: string[]; } /** * ResourceInfoDefinition properties of Basic Rule. This defines the objects that represent the actions or topics, such as - method.Connect, method.Publish, etc. */ interface ResourceInfoDefinitionResponse { /** * The type of action that the clients can perform on the broker: Connect, Publish or Subscribe. */ method: string; /** * A list of topics or topic patterns that match the topics that the clients can publish or subscribe to. This subfield is required if the method is Publish or Subscribe. */ topics?: string[]; } /** * SANs for certificate. */ interface SanForCertResponse { /** * DNS SANs. */ dns: string[]; /** * IP address SANs. */ ip: string[]; } /** * Kafka RemoteBrokerConnection Sasl Authentication properties. */ interface SaslRemoteBrokerBasicAuthenticationResponse { /** * Sasl Mechanism for remote broker authentication. */ saslType: string; /** * Sasl token for remote broker authentication. */ token: outputs.iotoperationsmq.SaslRemoteBrokerBasicAuthenticationTokenResponse; } /** * Kafka RemoteBrokerConnection Sasl Authentication token properties. NOTE - Enum only one method is allowed to be passed. */ interface SaslRemoteBrokerBasicAuthenticationTokenResponse { /** * Keyvault token keyvault secret properties. */ keyVault?: outputs.iotoperationsmq.KafkaTokenKeyVaultPropertiesResponse; /** * Secret where cert details are stored. */ secretName?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Internal knobs of Resource Limits for FE and BE */ interface TemporaryResourceLimitsConfigResponse { /** * Maximum number of messages a client can have inflight. */ maxInflightMessages: number; /** * Maximum number of patch inflight per node. */ maxInflightPatches: number; /** * Maximum number of patch a client can have in flight. */ maxInflightPatchesPerClient: number; /** * Maximum message expiry interval, in seconds. */ maxMessageExpirySecs?: number; /** * Maximum receive for external clients. */ maxQueuedMessages: number; /** * Maximum receive QoS0 for external clients. */ maxQueuedQos0Messages: number; /** * Maximum session expiry interval, in seconds. */ maxSessionExpirySecs: number; } /** * Collection of different TLS types, NOTE- Enum at a time only one of them needs to be supported */ interface TlsCertMethodResponse { /** * Option 1 - Automatic TLS server certificate management with cert-manager. */ automatic?: outputs.iotoperationsmq.AutomaticCertMethodResponse; /** * Option 3 - TLS server certificate retrieved from Key Vault.. */ keyVault?: outputs.iotoperationsmq.KeyVaultCertificatePropertiesResponse; /** * Option 2 - Manual TLS server certificate management through a defined secret. */ manual?: outputs.iotoperationsmq.ManualCertMethodResponse; } /** * tlsCertMethodResponseProvideDefaults sets the appropriate defaults for TlsCertMethodResponse */ function tlsCertMethodResponseProvideDefaults(val: TlsCertMethodResponse): TlsCertMethodResponse; /** * VolumeClaimDataSourceRef properties */ interface VolumeClaimDataSourceRefResponse { /** * APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. */ apiGroup?: string; /** * Kind is the type of resource being referenced */ kind: string; /** * Name is the name of resource being referenced */ name: string; } /** * VolumeClaimDataSource properties */ interface VolumeClaimDataSourceResponse { /** * APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required. */ apiGroup?: string; /** * Kind is the type of resource being referenced */ kind: string; /** * Name is the name of resource being referenced */ name: string; } /** * VolumeClaimResourceRequirements properties */ interface VolumeClaimResourceRequirementsResponse { /** * Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ limits?: { [key: string]: string; }; /** * Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ */ requests?: { [key: string]: string; }; } /** * VolumeClaimSpec properties */ interface VolumeClaimSpecResponse { /** * AccessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 */ accessModes?: string[]; /** * This field can be used to specify either: * An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot) * An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. If the AnyVolumeDataSource feature gate is enabled, this field will always have the same contents as the DataSourceRef field. */ dataSource?: outputs.iotoperationsmq.VolumeClaimDataSourceResponse; /** * Specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any local object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the DataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, both fields (DataSource and DataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. There are two important differences between DataSource and DataSourceRef: * While DataSource only allows two specific types of objects, DataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects. * While DataSource ignores disallowed values (dropping them), DataSourceRef preserves all values, and generates an error if a disallowed value is specified. (Alpha) Using this field requires the AnyVolumeDataSource feature gate to be enabled. */ dataSourceRef?: outputs.iotoperationsmq.VolumeClaimDataSourceRefResponse; /** * Resources represents the minimum resources the volume should have. If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements that are lower than previous value but must still be higher than capacity recorded in the status field of the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources */ resources?: outputs.iotoperationsmq.VolumeClaimResourceRequirementsResponse; /** * A label query over volumes to consider for binding. */ selector?: outputs.iotoperationsmq.VolumeClaimSpecSelectorResponse; /** * Name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 */ storageClassName?: string; /** * volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. This is a beta feature. */ volumeMode?: string; /** * VolumeName is the binding reference to the PersistentVolume backing this claim. */ volumeName?: string; } /** * VolumeClaimSpecSelectorMatchExpressions properties */ interface VolumeClaimSpecSelectorMatchExpressionsResponse { /** * key is the label key that the selector applies to. */ key: string; /** * operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. */ operator: string; /** * values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. */ values?: string[]; } /** * VolumeClaimSpecSelector properties */ interface VolumeClaimSpecSelectorResponse { /** * MatchExpressions is a list of label selector requirements. The requirements are ANDed. */ matchExpressions?: outputs.iotoperationsmq.VolumeClaimSpecSelectorMatchExpressionsResponse[]; /** * MatchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. */ matchLabels?: { [key: string]: string; }; } } export declare namespace iotoperationsorchestrator { /** * Defines a component binding for a provider. */ interface BindingPropertiesResponse { /** * Configuration values for the binding. */ config: any; /** * Name of the provider. */ provider: string; /** * Role that the provider binds to with the component. */ role: string; } /** * Defines a desired runtime component. */ interface ComponentPropertiesResponse { /** * Component dependencies. */ dependencies?: string[]; /** * Name of the component. */ name: string; /** * Properties of the component. */ properties?: any; /** * Component type. */ type: string; } /** * Extended location is an extension of Azure locations. They provide a way to use their Azure ARC enabled Kubernetes clusters as target locations for deploying Azure services instances. */ interface ExtendedLocationResponse { /** * The name of the extended location. */ name: string; /** * The type of the extended location. */ type: string; } /** * Reconciliation Policy. */ interface ReconciliationPolicyResponse { /** * Policy interval. */ interval?: string; /** * Policy type */ type: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Properties of the reference target. */ interface TargetSelectorPropertiesResponse { /** * Name of the target. */ name?: string; } /** * Defines a desired runtime component. */ interface TopologiesPropertiesResponse { /** * bindings description. */ bindings?: outputs.iotoperationsorchestrator.BindingPropertiesResponse[]; } } export declare namespace keyvault { /** * An identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. */ interface AccessPolicyEntry { /** * Application ID of the client making request on behalf of a principal */ applicationId?: string; /** * The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies. */ objectId: string; /** * Permissions the identity has for keys, secrets and certificates. */ permissions: outputs.keyvault.Permissions; /** * The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. */ tenantId: string; } /** * An identity that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. */ interface AccessPolicyEntryResponse { /** * Application ID of the client making request on behalf of a principal */ applicationId?: string; /** * The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies. */ objectId: string; /** * Permissions the identity has for keys, secrets and certificates. */ permissions: outputs.keyvault.PermissionsResponse; /** * The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. */ tenantId: string; } interface ActionResponse { /** * The type of action. */ type?: string; } /** * A rule governing the accessibility of a vault from a specific ip address or ip range. */ interface IPRuleResponse { /** * An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78). */ value: string; } /** * The object attributes managed by the Azure Key Vault service. */ interface KeyAttributesResponse { /** * Creation time in seconds since 1970-01-01T00:00:00Z. */ created: number; /** * Determines whether or not the object is enabled. */ enabled?: boolean; /** * Expiry date in seconds since 1970-01-01T00:00:00Z. */ expires?: number; /** * Indicates if the private key can be exported. */ exportable?: boolean; /** * Not before date in seconds since 1970-01-01T00:00:00Z. */ notBefore?: number; /** * The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval. */ recoveryLevel: string; /** * Last updated time in seconds since 1970-01-01T00:00:00Z. */ updated: number; } /** * keyAttributesResponseProvideDefaults sets the appropriate defaults for KeyAttributesResponse */ function keyAttributesResponseProvideDefaults(val: KeyAttributesResponse): KeyAttributesResponse; interface KeyReleasePolicyResponse { /** * Content type and version of key release policy */ contentType?: string; /** * Blob encoding the policy rules under which the key can be released. */ data?: string; } /** * keyReleasePolicyResponseProvideDefaults sets the appropriate defaults for KeyReleasePolicyResponse */ function keyReleasePolicyResponseProvideDefaults(val: KeyReleasePolicyResponse): KeyReleasePolicyResponse; interface KeyRotationPolicyAttributesResponse { /** * Creation time in seconds since 1970-01-01T00:00:00Z. */ created: number; /** * The expiration time for the new key version. It should be in ISO8601 format. Eg: 'P90D', 'P1Y'. */ expiryTime?: string; /** * Last updated time in seconds since 1970-01-01T00:00:00Z. */ updated: number; } interface LifetimeActionResponse { /** * The action of key rotation policy lifetimeAction. */ action?: outputs.keyvault.ActionResponse; /** * The trigger of key rotation policy lifetimeAction. */ trigger?: outputs.keyvault.TriggerResponse; } /** * A region that this managed HSM Pool has been extended to. */ interface MHSMGeoReplicatedRegionResponse { /** * A boolean value that indicates whether the region is the primary region or a secondary region. */ isPrimary?: boolean; /** * Name of the geo replicated region. */ name?: string; /** * Provisioning state of the geo replicated region. */ provisioningState: string; } /** * A rule governing the accessibility of a managed HSM pool from a specific IP address or IP range. */ interface MHSMIPRuleResponse { /** * An IPv4 address range in CIDR notation, such as '124.56.78.91' (simple IP address) or '124.56.78.0/24' (all addresses that start with 124.56.78). */ value: string; } /** * A set of rules governing the network accessibility of a managed hsm pool. */ interface MHSMNetworkRuleSetResponse { /** * Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'. */ bypass?: string; /** * The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. */ defaultAction?: string; /** * The list of IP address rules. */ ipRules?: outputs.keyvault.MHSMIPRuleResponse[]; /** * The list of virtual network rules. */ virtualNetworkRules?: outputs.keyvault.MHSMVirtualNetworkRuleResponse[]; } /** * Private endpoint connection item. */ interface MHSMPrivateEndpointConnectionItemResponse { /** * Modified whenever there is a change in the state of private endpoint connection. */ etag?: string; /** * Id of private endpoint connection. */ id?: string; /** * Properties of the private endpoint object. */ privateEndpoint?: outputs.keyvault.MHSMPrivateEndpointResponse; /** * Approval state of the private link connection. */ privateLinkServiceConnectionState?: outputs.keyvault.MHSMPrivateLinkServiceConnectionStateResponse; /** * Provisioning state of the private endpoint connection. */ provisioningState: string; } /** * Private endpoint object properties. */ interface MHSMPrivateEndpointResponse { /** * Full identifier of the private endpoint resource. */ id: string; } /** * An object that represents the approval state of the private link connection. */ interface MHSMPrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval or rejection. */ description?: string; /** * Indicates whether the connection has been approved, rejected or removed by the key vault owner. */ status?: string; } /** * A rule governing the accessibility of a managed hsm pool from a specific virtual network. */ interface MHSMVirtualNetworkRuleResponse { /** * Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. */ id: string; } /** * The security domain properties of the managed hsm. */ interface ManagedHSMSecurityDomainPropertiesResponse { /** * Activation Status */ activationStatus: string; /** * Activation Status Message. */ activationStatusMessage: string; } /** * Properties of the managed HSM Pool */ interface ManagedHsmPropertiesResponse { /** * Property specifying whether protection against purge is enabled for this managed HSM pool. Setting this property to true activates protection against purge for this managed HSM pool and its content - only the Managed HSM service may initiate a hard, irrecoverable deletion. Enabling this functionality is irreversible. */ enablePurgeProtection?: boolean; /** * Property to specify whether the 'soft delete' functionality is enabled for this managed HSM pool. Soft delete is enabled by default for all managed HSMs and is immutable. */ enableSoftDelete?: boolean; /** * The URI of the managed hsm pool for performing operations on keys. */ hsmUri: string; /** * Array of initial administrators object ids for this managed hsm pool. */ initialAdminObjectIds?: string[]; /** * Rules governing the accessibility of the key vault from specific network locations. */ networkAcls?: outputs.keyvault.MHSMNetworkRuleSetResponse; /** * List of private endpoint connections associated with the managed hsm pool. */ privateEndpointConnections: outputs.keyvault.MHSMPrivateEndpointConnectionItemResponse[]; /** * Provisioning state. */ provisioningState: string; /** * Control permission to the managed HSM from public networks. */ publicNetworkAccess?: string; /** * List of all regions associated with the managed hsm pool. */ regions?: outputs.keyvault.MHSMGeoReplicatedRegionResponse[]; /** * The scheduled purge date in UTC. */ scheduledPurgeDate: string; /** * Managed HSM security domain properties. */ securityDomainProperties: outputs.keyvault.ManagedHSMSecurityDomainPropertiesResponse; /** * Soft deleted data retention days. When you delete an HSM or a key, it will remain recoverable for the configured retention period or for a default period of 90 days. It accepts values between 7 and 90. */ softDeleteRetentionInDays?: number; /** * Resource Status Message. */ statusMessage: string; /** * The Azure Active Directory tenant ID that should be used for authenticating requests to the managed HSM pool. */ tenantId?: string; } /** * managedHsmPropertiesResponseProvideDefaults sets the appropriate defaults for ManagedHsmPropertiesResponse */ function managedHsmPropertiesResponseProvideDefaults(val: ManagedHsmPropertiesResponse): ManagedHsmPropertiesResponse; /** * SKU details */ interface ManagedHsmSkuResponse { /** * SKU Family of the managed HSM Pool */ family: string; /** * SKU of the managed HSM Pool */ name: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.keyvault.UserAssignedIdentityResponse; }; } /** * A set of rules governing the network accessibility of a vault. */ interface NetworkRuleSetResponse { /** * Tells what traffic can bypass network rules. This can be 'AzureServices' or 'None'. If not specified the default is 'AzureServices'. */ bypass?: string; /** * The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated. */ defaultAction?: string; /** * The list of IP address rules. */ ipRules?: outputs.keyvault.IPRuleResponse[]; /** * The list of virtual network rules. */ virtualNetworkRules?: outputs.keyvault.VirtualNetworkRuleResponse[]; } /** * Permissions the identity has for keys, secrets, certificates and storage. */ interface Permissions { /** * Permissions to certificates */ certificates?: (string | enums.keyvault.CertificatePermissions)[]; /** * Permissions to keys */ keys?: (string | enums.keyvault.KeyPermissions)[]; /** * Permissions to secrets */ secrets?: (string | enums.keyvault.SecretPermissions)[]; /** * Permissions to storage accounts */ storage?: (string | enums.keyvault.StoragePermissions)[]; } /** * Permissions the identity has for keys, secrets, certificates and storage. */ interface PermissionsResponse { /** * Permissions to certificates */ certificates?: string[]; /** * Permissions to keys */ keys?: string[]; /** * Permissions to secrets */ secrets?: string[]; /** * Permissions to storage accounts */ storage?: string[]; } /** * Private endpoint connection item. */ interface PrivateEndpointConnectionItemResponse { /** * Modified whenever there is a change in the state of private endpoint connection. */ etag?: string; /** * Id of private endpoint connection. */ id?: string; /** * Properties of the private endpoint object. */ privateEndpoint?: outputs.keyvault.PrivateEndpointResponse; /** * Approval state of the private link connection. */ privateLinkServiceConnectionState?: outputs.keyvault.PrivateLinkServiceConnectionStateResponse; /** * Provisioning state of the private endpoint connection. */ provisioningState: string; } /** * Private endpoint object properties. */ interface PrivateEndpointResponse { /** * Full identifier of the private endpoint resource. */ id: string; } /** * An object that represents the approval state of the private link connection. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval or rejection. */ description?: string; /** * Indicates whether the connection has been approved, rejected or removed by the key vault owner. */ status?: string; } interface RotationPolicyResponse { /** * The attributes of key rotation policy. */ attributes?: outputs.keyvault.KeyRotationPolicyAttributesResponse; /** * The lifetimeActions for key rotation action. */ lifetimeActions?: outputs.keyvault.LifetimeActionResponse[]; } /** * The secret management attributes. */ interface SecretAttributesResponse { /** * Creation time in seconds since 1970-01-01T00:00:00Z. */ created: number; /** * Determines whether the object is enabled. */ enabled?: boolean; /** * Expiry date in seconds since 1970-01-01T00:00:00Z. */ expires?: number; /** * Not before date in seconds since 1970-01-01T00:00:00Z. */ notBefore?: number; /** * Last updated time in seconds since 1970-01-01T00:00:00Z. */ updated: number; } /** * Properties of the secret */ interface SecretPropertiesResponse { /** * The attributes of the secret. */ attributes?: outputs.keyvault.SecretAttributesResponse; /** * The content type of the secret. */ contentType?: string; /** * The URI to retrieve the current version of the secret. */ secretUri: string; /** * The URI to retrieve the specific version of the secret. */ secretUriWithVersion: string; /** * The value of the secret. NOTE: 'value' will never be returned from the service, as APIs using this model are is intended for internal use in ARM deployments. Users should use the data-plane REST service for interaction with vault secrets. */ value?: string; } /** * SKU details */ interface SkuResponse { /** * SKU family name */ family: string; /** * SKU name to specify whether the key vault is a standard vault or a premium vault. */ name: string; } /** * Metadata pertaining to creation and last modification of the key vault resource. */ interface SystemDataResponse { /** * The timestamp of the key vault resource creation (UTC). */ createdAt?: string; /** * The identity that created the key vault resource. */ createdBy?: string; /** * The type of identity that created the key vault resource. */ createdByType?: string; /** * The timestamp of the key vault resource last modification (UTC). */ lastModifiedAt?: string; /** * The identity that last modified the key vault resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the key vault resource. */ lastModifiedByType?: string; } interface TriggerResponse { /** * The time duration after key creation to rotate the key. It only applies to rotate. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'. */ timeAfterCreate?: string; /** * The time duration before key expiring to rotate or notify. It will be in ISO 8601 duration format. Eg: 'P90D', 'P1Y'. */ timeBeforeExpiry?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Properties of the vault */ interface VaultPropertiesResponse { /** * An array of 0 to 1024 identities that have access to the key vault. All identities in the array must use the same tenant ID as the key vault's tenant ID. When `createMode` is set to `recover`, access policies are not required. Otherwise, access policies are required. * These are also available as standalone resources. Do not mix inline and standalone resource as they will conflict with each other, leading to resources deletion. */ accessPolicies?: outputs.keyvault.AccessPolicyEntryResponse[]; /** * Property specifying whether protection against purge is enabled for this vault. Setting this property to true activates protection against purge for this vault and its content - only the Key Vault service may initiate a hard, irrecoverable deletion. The setting is effective only if soft delete is also enabled. Enabling this functionality is irreversible - that is, the property does not accept false as its value. */ enablePurgeProtection?: boolean; /** * Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC. */ enableRbacAuthorization?: boolean; /** * Property to specify whether the 'soft delete' functionality is enabled for this key vault. If it's not set to any value(true or false) when creating new key vault, it will be set to true by default. Once set to true, it cannot be reverted to false. */ enableSoftDelete?: boolean; /** * Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. */ enabledForDeployment?: boolean; /** * Property to specify whether Azure Disk Encryption is permitted to retrieve secrets from the vault and unwrap keys. */ enabledForDiskEncryption?: boolean; /** * Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault. */ enabledForTemplateDeployment?: boolean; /** * The resource id of HSM Pool. */ hsmPoolResourceId: string; /** * Rules governing the accessibility of the key vault from specific network locations. */ networkAcls?: outputs.keyvault.NetworkRuleSetResponse; /** * List of private endpoint connections associated with the key vault. */ privateEndpointConnections: outputs.keyvault.PrivateEndpointConnectionItemResponse[]; /** * Provisioning state of the vault. */ provisioningState: string; /** * Property to specify whether the vault will accept traffic from public internet. If set to 'disabled' all traffic except private endpoint traffic and that that originates from trusted services will be blocked. This will override the set firewall rules, meaning that even if the firewall rules are present we will not honor the rules. */ publicNetworkAccess?: string; /** * SKU details */ sku: outputs.keyvault.SkuResponse; /** * softDelete data retention days. It accepts >=7 and <=90. */ softDeleteRetentionInDays?: number; /** * The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. */ tenantId: string; /** * The URI of the vault for performing operations on keys and secrets. */ vaultUri: string; } /** * vaultPropertiesResponseProvideDefaults sets the appropriate defaults for VaultPropertiesResponse */ function vaultPropertiesResponseProvideDefaults(val: VaultPropertiesResponse): VaultPropertiesResponse; /** * A rule governing the accessibility of a vault from a specific virtual network. */ interface VirtualNetworkRuleResponse { /** * Full resource id of a vnet subnet, such as '/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1'. */ id: string; /** * Property to specify whether NRP will ignore the check if parent subnet has serviceEndpoints configured. */ ignoreMissingVnetServiceEndpoint?: boolean; } } export declare namespace kubernetes { /** * AAD Profile specifies attributes for Azure Active Directory integration. */ interface AadProfileResponse { /** * The list of AAD group object IDs that will have admin role of the cluster. */ adminGroupObjectIDs?: string[]; /** * Whether to enable Azure RBAC for Kubernetes authorization. */ enableAzureRBAC?: boolean; /** * The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription. */ tenantID?: string; } /** * Agent Errors if any during agent or system component upgrade. */ interface AgentErrorResponse { /** * Agent component where error message occured. */ component: string; /** * Agent error message. */ message: string; /** * Severity of the error message. */ severity: string; /** * The timestamp of error occured (UTC). */ time: string; } /** * Defines the Arc Agent properties for the clusters. */ interface ArcAgentProfileResponse { /** * Indicates whether the Arc agents on the be upgraded automatically to the latest version. Defaults to Enabled. */ agentAutoUpgrade?: string; /** * List of system extensions can be installed on the cluster resource. */ agentErrors?: outputs.kubernetes.AgentErrorResponse[]; /** * Version of the Arc agents to be installed on the cluster resource */ desiredAgentVersion?: string; /** * List of system extensions can be installed on the cluster resource. */ systemComponents?: outputs.kubernetes.SystemComponentResponse[]; } /** * arcAgentProfileResponseProvideDefaults sets the appropriate defaults for ArcAgentProfileResponse */ function arcAgentProfileResponseProvideDefaults(val: ArcAgentProfileResponse): ArcAgentProfileResponse; /** * Identity for the connected cluster. */ interface ConnectedClusterIdentityResponse { /** * The principal id of connected cluster identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity. */ tenantId: string; /** * The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster. */ type: string; } /** * connectedClusterIdentityResponseProvideDefaults sets the appropriate defaults for ConnectedClusterIdentityResponse */ function connectedClusterIdentityResponseProvideDefaults(val: ConnectedClusterIdentityResponse): ConnectedClusterIdentityResponse; /** * The credential result response. */ interface CredentialResultResponse { /** * The name of the credential. */ name: string; /** * Base64-encoded Kubernetes configuration file. */ value: string; } /** * Contains the REP (rendezvous endpoint) and “Sender” access token. */ interface HybridConnectionConfigResponse { /** * Timestamp when this token will be expired. */ expirationTime: number; /** * Name of the connection */ hybridConnectionName: string; /** * Name of the relay. */ relay: string; /** * Sender access token */ token: string; } /** * System Extension and its desired versions to be installed on the cluster resource. */ interface SystemComponentResponse { /** * Version of the system extension is currently installed on the cluster resource. */ currentVersion: string; /** * Major Version of the system extension to be installed on the cluster resource. */ majorVersion?: number; /** * Type of the system extension */ type?: string; /** * Version of the system extension to be installed on the cluster resource. */ userSpecifiedVersion?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource modification (UTC). */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace kubernetesconfiguration { /** * Parameters to reconcile to the AzureBlob source kind type. */ interface AzureBlobDefinitionResponse { /** * The account key (shared key) to access the storage account */ accountKey?: string; /** * The Azure Blob container name to sync from the url endpoint for the flux configuration. */ containerName?: string; /** * Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets. */ localAuthRef?: string; /** * Parameters to authenticate using a Managed Identity. */ managedIdentity?: outputs.kubernetesconfiguration.ManagedIdentityDefinitionResponse; /** * The Shared Access token to access the storage container */ sasToken?: string; /** * Parameters to authenticate using Service Principal. */ servicePrincipal?: outputs.kubernetesconfiguration.ServicePrincipalDefinitionResponse; /** * The interval at which to re-reconcile the cluster Azure Blob source with the remote. */ syncIntervalInSeconds?: number; /** * The maximum time to attempt to reconcile the cluster Azure Blob source with the remote. */ timeoutInSeconds?: number; /** * The URL to sync for the flux configuration Azure Blob storage account. */ url?: string; } /** * azureBlobDefinitionResponseProvideDefaults sets the appropriate defaults for AzureBlobDefinitionResponse */ function azureBlobDefinitionResponseProvideDefaults(val: AzureBlobDefinitionResponse): AzureBlobDefinitionResponse; /** * Parameters to reconcile to the Bucket source kind type. */ interface BucketDefinitionResponse { /** * Plaintext access key used to securely access the S3 bucket */ accessKey?: string; /** * The bucket name to sync from the url endpoint for the flux configuration. */ bucketName?: string; /** * Specify whether to use insecure communication when puling data from the S3 bucket. */ insecure?: boolean; /** * Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets. */ localAuthRef?: string; /** * The interval at which to re-reconcile the cluster bucket source with the remote. */ syncIntervalInSeconds?: number; /** * The maximum time to attempt to reconcile the cluster bucket source with the remote. */ timeoutInSeconds?: number; /** * The URL to sync for the flux configuration S3 bucket. */ url?: string; } /** * bucketDefinitionResponseProvideDefaults sets the appropriate defaults for BucketDefinitionResponse */ function bucketDefinitionResponseProvideDefaults(val: BucketDefinitionResponse): BucketDefinitionResponse; /** * Compliance Status details */ interface ComplianceStatusResponse { /** * The compliance state of the configuration. */ complianceState: string; /** * Datetime the configuration was last applied. */ lastConfigApplied?: string; /** * Message from when the configuration was applied. */ message?: string; /** * Level of the message. */ messageLevel?: string; } /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.kubernetesconfiguration.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.kubernetesconfiguration.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * Identity of the Extension resource in an AKS cluster */ interface ExtensionResponseAksAssignedIdentity { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The identity type. */ type?: string; } /** * Status from the extension. */ interface ExtensionStatusResponse { /** * Status code provided by the Extension */ code?: string; /** * Short description of status of the extension. */ displayStatus?: string; /** * Level of the status. */ level?: string; /** * Detailed message of the status from the Extension. */ message?: string; /** * DateLiteral (per ISO8601) noting the time of installation status. */ time?: string; } /** * extensionStatusResponseProvideDefaults sets the appropriate defaults for ExtensionStatusResponse */ function extensionStatusResponseProvideDefaults(val: ExtensionStatusResponse): ExtensionStatusResponse; /** * Parameters to reconcile to the GitRepository source kind type. */ interface GitRepositoryDefinitionResponse { /** * Base64-encoded HTTPS certificate authority contents used to access git private git repositories over HTTPS */ httpsCACert?: string; /** * Plaintext HTTPS username used to access private git repositories over HTTPS */ httpsUser?: string; /** * Name of a local secret on the Kubernetes cluster to use as the authentication secret rather than the managed or user-provided configuration secrets. */ localAuthRef?: string; /** * The source reference for the GitRepository object. */ repositoryRef?: outputs.kubernetesconfiguration.RepositoryRefDefinitionResponse; /** * Base64-encoded known_hosts value containing public SSH keys required to access private git repositories over SSH */ sshKnownHosts?: string; /** * The interval at which to re-reconcile the cluster git repository source with the remote. */ syncIntervalInSeconds?: number; /** * The maximum time to attempt to reconcile the cluster git repository source with the remote. */ timeoutInSeconds?: number; /** * The URL to sync for the flux configuration git repository. */ url?: string; } /** * gitRepositoryDefinitionResponseProvideDefaults sets the appropriate defaults for GitRepositoryDefinitionResponse */ function gitRepositoryDefinitionResponseProvideDefaults(val: GitRepositoryDefinitionResponse): GitRepositoryDefinitionResponse; /** * Properties for Helm operator. */ interface HelmOperatorPropertiesResponse { /** * Values override for the operator Helm chart. */ chartValues?: string; /** * Version of the operator Helm chart. */ chartVersion?: string; } /** * Properties for HelmRelease objects */ interface HelmReleasePropertiesDefinitionResponse { /** * Total number of times that the HelmRelease failed to install or upgrade */ failureCount?: number; /** * The reference to the HelmChart object used as the source to this HelmRelease */ helmChartRef?: outputs.kubernetesconfiguration.ObjectReferenceDefinitionResponse; /** * Number of times that the HelmRelease failed to install */ installFailureCount?: number; /** * The revision number of the last released object change */ lastRevisionApplied?: number; /** * Number of times that the HelmRelease failed to upgrade */ upgradeFailureCount?: number; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The identity type. */ type?: string; } /** * Properties that define a Azure Arc PrivateLinkScope resource. */ interface KubernetesConfigurationPrivateLinkScopePropertiesResponse { /** * Managed Cluster ARM ID for the private link scope (Required) */ clusterResourceId: string; /** * The collection of associated Private Endpoint Connections. */ privateEndpointConnections: outputs.kubernetesconfiguration.PrivateEndpointConnectionResponse[]; /** * The Guid id of the private link scope. */ privateLinkScopeId: string; /** * Current state of this PrivateLinkScope: whether or not is has been provisioned within the resource group it is defined. Users cannot change this value but are able to read from it. Values will include Provisioning ,Succeeded, Canceled and Failed. */ provisioningState: string; /** * Indicates whether machines associated with the private link scope can also use public Azure Arc service endpoints. */ publicNetworkAccess?: string; } /** * The Kustomization defining how to reconcile the artifact pulled by the source type on the cluster. */ interface KustomizationDefinitionResponse { /** * Specifies other Kustomizations that this Kustomization depends on. This Kustomization will not reconcile until all dependencies have completed their reconciliation. */ dependsOn?: string[]; /** * Enable/disable re-creating Kubernetes resources on the cluster when patching fails due to an immutable field change. */ force?: boolean; /** * Name of the Kustomization, matching the key in the Kustomizations object map. */ name: string; /** * The path in the source reference to reconcile on the cluster. */ path?: string; /** * Used for variable substitution for this Kustomization after kustomize build. */ postBuild?: outputs.kubernetesconfiguration.PostBuildDefinitionResponse; /** * Enable/disable garbage collections of Kubernetes objects created by this Kustomization. */ prune?: boolean; /** * The interval at which to re-reconcile the Kustomization on the cluster in the event of failure on reconciliation. */ retryIntervalInSeconds?: number; /** * The interval at which to re-reconcile the Kustomization on the cluster. */ syncIntervalInSeconds?: number; /** * The maximum time to attempt to reconcile the Kustomization on the cluster. */ timeoutInSeconds?: number; /** * Enable/disable health check for all Kubernetes objects created by this Kustomization. */ wait?: boolean; } /** * kustomizationDefinitionResponseProvideDefaults sets the appropriate defaults for KustomizationDefinitionResponse */ function kustomizationDefinitionResponseProvideDefaults(val: KustomizationDefinitionResponse): KustomizationDefinitionResponse; /** * Parameters to authenticate using a Managed Identity. */ interface ManagedIdentityDefinitionResponse { /** * The client Id for authenticating a Managed Identity. */ clientId?: string; } /** * Object reference to a Kubernetes object on a cluster */ interface ObjectReferenceDefinitionResponse { /** * Name of the object */ name?: string; /** * Namespace of the object */ namespace?: string; } /** * Status condition of Kubernetes object */ interface ObjectStatusConditionDefinitionResponse { /** * Last time this status condition has changed */ lastTransitionTime?: string; /** * A more verbose description of the object status condition */ message?: string; /** * Reason for the specified status condition type status */ reason?: string; /** * Status of the Kubernetes object condition type */ status?: string; /** * Object status condition type for this object */ type?: string; } /** * Statuses of objects deployed by the user-specified kustomizations from the git repository. */ interface ObjectStatusDefinitionResponse { /** * Object reference to the Kustomization that applied this object */ appliedBy?: outputs.kubernetesconfiguration.ObjectReferenceDefinitionResponse; /** * Compliance state of the applied object showing whether the applied object has come into a ready state on the cluster. */ complianceState?: string; /** * Additional properties that are provided from objects of the HelmRelease kind */ helmReleaseProperties?: outputs.kubernetesconfiguration.HelmReleasePropertiesDefinitionResponse; /** * Kind of the applied object */ kind?: string; /** * Name of the applied object */ name?: string; /** * Namespace of the applied object */ namespace?: string; /** * List of Kubernetes object status conditions present on the cluster */ statusConditions?: outputs.kubernetesconfiguration.ObjectStatusConditionDefinitionResponse[]; } /** * Plan for the resource. */ interface PlanResponse { /** * A user defined name of the 3rd Party Artifact that is being procured. */ name: string; /** * The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. */ product: string; /** * A publisher provided promotion code as provisioned in Data Market for the said product/artifact. */ promotionCode?: string; /** * The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic */ publisher: string; /** * The version of the desired product/artifact. */ version?: string; } /** * The postBuild definitions defining variable substitutions for this Kustomization after kustomize build. */ interface PostBuildDefinitionResponse { /** * Key/value pairs holding the variables to be substituted in this Kustomization. */ substitute?: { [key: string]: string; }; /** * Array of ConfigMaps/Secrets from which the variables are substituted for this Kustomization. */ substituteFrom?: outputs.kubernetesconfiguration.SubstituteFromDefinitionResponse[]; } /** * The Private Endpoint Connection resource. */ interface PrivateEndpointConnectionResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * The resource of private end point. */ privateEndpoint?: outputs.kubernetesconfiguration.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.kubernetesconfiguration.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.kubernetesconfiguration.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The Private Endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * The source reference for the GitRepository object. */ interface RepositoryRefDefinitionResponse { /** * The git repository branch name to checkout. */ branch?: string; /** * The commit SHA to checkout. This value must be combined with the branch name to be valid. This takes precedence over semver. */ commit?: string; /** * The semver range used to match against git repository tags. This takes precedence over tag. */ semver?: string; /** * The git repository tag name to checkout. This takes precedence over branch. */ tag?: string; } /** * Specifies that the scope of the extension is Cluster */ interface ScopeClusterResponse { /** * Namespace where the extension Release must be placed, for a Cluster scoped extension. If this namespace does not exist, it will be created */ releaseNamespace?: string; } /** * Specifies that the scope of the extension is Namespace */ interface ScopeNamespaceResponse { /** * Namespace where the extension will be created for an Namespace scoped extension. If this namespace does not exist, it will be created */ targetNamespace?: string; } /** * Scope of the extension. It can be either Cluster or Namespace; but not both. */ interface ScopeResponse { /** * Specifies that the scope of the extension is Cluster */ cluster?: outputs.kubernetesconfiguration.ScopeClusterResponse; /** * Specifies that the scope of the extension is Namespace */ namespace?: outputs.kubernetesconfiguration.ScopeNamespaceResponse; } /** * Parameters to authenticate using Service Principal. */ interface ServicePrincipalDefinitionResponse { /** * Base64-encoded certificate used to authenticate a Service Principal */ clientCertificate?: string; /** * The password for the certificate used to authenticate a Service Principal */ clientCertificatePassword?: string; /** * Specifies whether to include x5c header in client claims when acquiring a token to enable subject name / issuer based authentication for the Client Certificate */ clientCertificateSendChain?: boolean; /** * The client Id for authenticating a Service Principal. */ clientId?: string; /** * The client secret for authenticating a Service Principal */ clientSecret?: string; /** * The tenant Id for authenticating a Service Principal */ tenantId?: string; } /** * servicePrincipalDefinitionResponseProvideDefaults sets the appropriate defaults for ServicePrincipalDefinitionResponse */ function servicePrincipalDefinitionResponseProvideDefaults(val: ServicePrincipalDefinitionResponse): ServicePrincipalDefinitionResponse; /** * Array of ConfigMaps/Secrets from which the variables are substituted for this Kustomization. */ interface SubstituteFromDefinitionResponse { /** * Define whether it is ConfigMap or Secret that holds the variables to be used in substitution. */ kind?: string; /** * Name of the ConfigMap/Secret that holds the variables to be used in substitution. */ name?: string; /** * Set to True to proceed without ConfigMap/Secret, if it is not present. */ optional?: boolean; } /** * substituteFromDefinitionResponseProvideDefaults sets the appropriate defaults for SubstituteFromDefinitionResponse */ function substituteFromDefinitionResponseProvideDefaults(val: SubstituteFromDefinitionResponse): SubstituteFromDefinitionResponse; /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace kubernetesruntime { /** * The properties of Blob StorageClass */ interface BlobStorageClassTypePropertiesResponse { /** * Azure Storage Account Key */ azureStorageAccountKey: string; /** * Azure Storage Account Name */ azureStorageAccountName: string; /** * Type of a storage class * Expected value is 'Blob'. */ type: "Blob"; } /** * The properties of Native StorageClass */ interface NativeStorageClassTypePropertiesResponse { /** * Type of a storage class * Expected value is 'Native'. */ type: "Native"; } /** * The properties of NFS StorageClass */ interface NfsStorageClassTypePropertiesResponse { /** * Mounted folder permissions. Default is 0. If set as non-zero, driver will perform `chmod` after mount */ mountPermissions?: string; /** * The action to take when a NFS volume is deleted. Default is Delete */ onDelete?: string; /** * NFS Server */ server: string; /** * NFS share */ share: string; /** * Sub directory under share. If the sub directory doesn't exist, driver will create it */ subDir?: string; /** * Type of a storage class * Expected value is 'NFS'. */ type: "NFS"; } /** * The properties of RWX StorageClass */ interface RwxStorageClassTypePropertiesResponse { /** * The backing storageclass used to create new storageclass */ backingStorageClassName: string; /** * Type of a storage class * Expected value is 'RWX'. */ type: "RWX"; } /** * The properties of SMB StorageClass */ interface SmbStorageClassTypePropertiesResponse { /** * Server domain */ domain?: string; /** * Server password */ password?: string; /** * SMB Source */ source: string; /** * Sub directory under share. If the sub directory doesn't exist, driver will create it */ subDir?: string; /** * Type of a storage class * Expected value is 'SMB'. */ type: "SMB"; /** * Server username */ username?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace kusto { /** * Represents an accepted audience trusted by the cluster. */ interface AcceptedAudiencesResponse { /** * GUID or valid URL representing an accepted audience. */ value?: string; } /** * Azure SKU definition. */ interface AzureSkuResponse { /** * The number of instances of the cluster. */ capacity?: number; /** * SKU name. */ name: string; /** * SKU tier. */ tier: string; } /** * Configuration for external callout policies, including URI patterns, access types, and service types. */ interface CalloutPolicyResponse { /** * Unique identifier for the callout configuration. */ calloutId: string; /** * Type of the callout service, specifying the kind of external resource or service being accessed. */ calloutType?: string; /** * Regular expression or FQDN pattern for the callout URI. */ calloutUriRegex?: string; /** * Indicates whether outbound access is permitted for the specified URI pattern. */ outboundAccess?: string; } /** * A class representing database principal entity. */ interface DatabasePrincipalResponse { /** * Application id - relevant only for application principal type. */ appId?: string; /** * Database principal email if exists. */ email?: string; /** * Database principal fully qualified name. */ fqn?: string; /** * Database principal name. */ name: string; /** * Database principal role. */ role: string; /** * The tenant name of the principal */ tenantName: string; /** * Database principal type. */ type: string; } /** * A class that contains database statistics information. */ interface DatabaseStatisticsResponse { /** * The database size - the total size of compressed data and index in bytes. */ size?: number; } /** * A class representing follower database request. */ interface FollowerDatabaseDefinitionResponse { /** * Resource name of the attached database configuration in the follower cluster. */ attachedDatabaseConfigurationName: string; /** * Resource id of the cluster that follows a database owned by this cluster. */ clusterResourceId: string; /** * The database name owned by this cluster that was followed. * in case following all databases. */ databaseName: string; /** * The origin of the following setup. */ databaseShareOrigin: string; /** * Table level sharing specifications */ tableLevelSharingProperties: outputs.kusto.TableLevelSharingPropertiesResponse; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove all identities. */ type: string; /** * The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.kusto.IdentityResponseUserAssignedIdentities; }; } interface IdentityResponseUserAssignedIdentities { /** * The client id of user assigned identity. */ clientId: string; /** * The principal id of user assigned identity. */ principalId: string; } /** * Properties of the key vault. */ interface KeyVaultPropertiesResponse { /** * The name of the key vault key. */ keyName?: string; /** * The Uri of the key vault. */ keyVaultUri?: string; /** * The version of the key vault key. */ keyVersion?: string; /** * The user assigned identity (ARM resource id) that has access to the key. */ userIdentity?: string; } /** * The language extension object. */ interface LanguageExtensionResponse { /** * The language extension custom image name. */ languageExtensionCustomImageName?: string; /** * The language extension image name. */ languageExtensionImageName?: string; /** * The language extension name. */ languageExtensionName?: string; } /** * The list of language extension objects. */ interface LanguageExtensionsListResponse { /** * The list of language extensions. */ value?: outputs.kusto.LanguageExtensionResponse[]; } /** * Represents a properties of a cluster that is part of a migration. */ interface MigrationClusterPropertiesResponse { /** * The public data ingestion URL of the cluster. */ dataIngestionUri: string; /** * The resource ID of the cluster. */ id: string; /** * The role of the cluster in the migration process. */ role: string; /** * The public URL of the cluster. */ uri: string; } /** * A class that contains the optimized auto scale definition. */ interface OptimizedAutoscaleResponse { /** * A boolean value that indicate if the optimized autoscale feature is enabled or not. */ isEnabled: boolean; /** * Maximum allowed instances count. */ maximum: number; /** * Minimum allowed instances count. */ minimum: number; /** * The version of the template defined, for instance 1. */ version: number; } /** * A private endpoint connection */ interface PrivateEndpointConnectionResponse { /** * Group id of the private endpoint. */ groupId: string; /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * Private endpoint which the connection belongs to. */ privateEndpoint: outputs.kusto.PrivateEndpointPropertyResponse; /** * Connection State of the Private Endpoint Connection. */ privateLinkServiceConnectionState: outputs.kusto.PrivateLinkServiceConnectionStatePropertyResponse; /** * Provisioning state of the private endpoint. */ provisioningState: string; /** * Metadata pertaining to creation and last modification of the resource. */ systemData: outputs.kusto.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Private endpoint which the connection belongs to. */ interface PrivateEndpointPropertyResponse { /** * Resource id of the private endpoint. */ id: string; } /** * Connection State of the Private Endpoint Connection. */ interface PrivateLinkServiceConnectionStatePropertyResponse { /** * Any action that is required beyond basic workflow (approve/ reject/ disconnect) */ actionsRequired: string; /** * The private link service connection description. */ description?: string; /** * The private link service connection status. */ status?: string; } /** * The database suspension details. If the database is suspended, this object contains information related to the database's suspension state. */ interface SuspensionDetailsResponse { /** * The starting date and time of the suspension state. */ suspensionStartDate?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Tables that will be included and excluded in the follower database */ interface TableLevelSharingPropertiesResponse { /** * List of external tables to exclude from the follower database */ externalTablesToExclude?: string[]; /** * List of external tables to include in the follower database */ externalTablesToInclude?: string[]; /** * List of functions to exclude from the follower database */ functionsToExclude?: string[]; /** * List of functions to include in the follower database */ functionsToInclude?: string[]; /** * List of materialized views to exclude from the follower database */ materializedViewsToExclude?: string[]; /** * List of materialized views to include in the follower database */ materializedViewsToInclude?: string[]; /** * List of tables to exclude from the follower database */ tablesToExclude?: string[]; /** * List of tables to include in the follower database */ tablesToInclude?: string[]; } /** * Represents a tenant ID that is trusted by the cluster. */ interface TrustedExternalTenantResponse { /** * GUID representing an external tenant. */ value?: string; } /** * A class that contains virtual network definition. */ interface VirtualNetworkConfigurationResponse { /** * Data management's service public IP address resource id. */ dataManagementPublicIpId: string; /** * Engine service's public IP address resource id. */ enginePublicIpId: string; /** * When enabled, the cluster is deployed into the configured subnet, when disabled it will be removed from the subnet. */ state?: string; /** * The subnet resource id. */ subnetId: string; } /** * virtualNetworkConfigurationResponseProvideDefaults sets the appropriate defaults for VirtualNetworkConfigurationResponse */ function virtualNetworkConfigurationResponseProvideDefaults(val: VirtualNetworkConfigurationResponse): VirtualNetworkConfigurationResponse; } export declare namespace labservices { /** * Profile for how to handle shutting down virtual machines. */ interface AutoShutdownProfileResponse { /** * The amount of time a VM will stay running after a user disconnects if this behavior is enabled. */ disconnectDelay?: string; /** * The amount of time a VM will idle before it is shutdown if this behavior is enabled. */ idleDelay?: string; /** * The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. */ noConnectDelay?: string; /** * Whether shutdown on disconnect is enabled */ shutdownOnDisconnect?: string; /** * Whether a VM will get shutdown when it has idled for a period of time. */ shutdownOnIdle?: string; /** * Whether a VM will get shutdown when it hasn't been connected to after a period of time. */ shutdownWhenNotConnected?: string; } /** * autoShutdownProfileResponseProvideDefaults sets the appropriate defaults for AutoShutdownProfileResponse */ function autoShutdownProfileResponseProvideDefaults(val: AutoShutdownProfileResponse): AutoShutdownProfileResponse; /** * Connection profile for how users connect to lab virtual machines. */ interface ConnectionProfileResponse { /** * The enabled access level for Client Access over RDP. */ clientRdpAccess?: string; /** * The enabled access level for Client Access over SSH. */ clientSshAccess?: string; /** * The enabled access level for Web Access over RDP. */ webRdpAccess?: string; /** * The enabled access level for Web Access over SSH. */ webSshAccess?: string; } /** * connectionProfileResponseProvideDefaults sets the appropriate defaults for ConnectionProfileResponse */ function connectionProfileResponseProvideDefaults(val: ConnectionProfileResponse): ConnectionProfileResponse; /** * Credentials for a user on a lab VM. */ interface CredentialsResponse { /** * The username to use when signing in to lab VMs. */ username: string; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The identity type. */ type?: string; } /** * Image reference information. Used in the virtual machine profile. */ interface ImageReferenceResponse { /** * The actual version of the image after use. */ exactVersion: string; /** * Image resource ID */ id?: string; /** * The image offer if applicable. */ offer?: string; /** * The image publisher */ publisher?: string; /** * The image SKU */ sku?: string; /** * The image version specified on creation. */ version?: string; } /** * Profile for how to handle networking for Labs. */ interface LabNetworkProfileResponse { /** * The external load balancer resource id */ loadBalancerId?: string; /** * The external public IP resource id */ publicIpId?: string; /** * The external subnet resource id */ subnetId?: string; } /** * Profile for how to handle networking for Lab Plans. */ interface LabPlanNetworkProfileResponse { /** * The external subnet resource id */ subnetId?: string; } /** * Recurrence pattern of a lab schedule. */ interface RecurrencePatternResponse { /** * When the recurrence will expire. This date is inclusive. */ expirationDate: string; /** * The frequency of the recurrence. */ frequency: string; /** * The interval to invoke the schedule on. For example, interval = 2 and RecurrenceFrequency.Daily will run every 2 days. When no interval is supplied, an interval of 1 is used. */ interval?: number; /** * The week days the schedule runs. Used for when the Frequency is set to Weekly. */ weekDays?: string[]; } /** * Error details of the latest operation failure on this resource */ interface ResourceOperationErrorResponse { /** * The operation action that failed */ action?: string; /** * The code that corresponds to the type of operation failure */ code?: string; /** * The operation failure message */ message?: string; /** * The datetime of when the error occured */ timestamp?: string; } /** * The lab user list management profile. */ interface RosterProfileResponse { /** * The AAD group ID which this lab roster is populated from. Having this set enables AAD sync mode. */ activeDirectoryGroupId?: string; /** * The base URI identifying the lms instance. */ lmsInstance?: string; /** * The unique id of the azure lab services tool in the lms. */ ltiClientId?: string; /** * The unique context identifier for the lab in the lms. */ ltiContextId?: string; /** * The uri of the names and roles service endpoint on the lms for the class attached to this lab. */ ltiRosterEndpoint?: string; } /** * The lab security profile. */ interface SecurityProfileResponse { /** * Whether any user or only specified users can register to a lab. */ openAccess?: string; /** * The registration code for the lab. */ registrationCode: string; } /** * The resource model definition representing SKU */ interface SkuResponse { /** * If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. */ capacity?: number; /** * If the service has different generations of hardware, for the same SKU, then that can be captured here. */ family?: string; /** * The name of the SKU. Ex - P3. It is typically a letter+number code */ name: string; /** * The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. */ size?: string; /** * This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. */ tier?: string; } /** * Support contact information and instructions. */ interface SupportInfoResponse { /** * Support contact email address. */ email?: string; /** * Support instructions. */ instructions?: string; /** * Support contact phone number. */ phone?: string; /** * Support web address. */ url?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The additional capabilities for a lab VM. */ interface VirtualMachineAdditionalCapabilitiesResponse { /** * Flag to pre-install dedicated GPU drivers. */ installGpuDrivers?: string; } /** * virtualMachineAdditionalCapabilitiesResponseProvideDefaults sets the appropriate defaults for VirtualMachineAdditionalCapabilitiesResponse */ function virtualMachineAdditionalCapabilitiesResponseProvideDefaults(val: VirtualMachineAdditionalCapabilitiesResponse): VirtualMachineAdditionalCapabilitiesResponse; /** * The base virtual machine configuration for a lab. */ interface VirtualMachineProfileResponse { /** * Additional VM capabilities. */ additionalCapabilities?: outputs.labservices.VirtualMachineAdditionalCapabilitiesResponse; /** * Credentials for the admin user on the VM. */ adminUser: outputs.labservices.CredentialsResponse; /** * Indicates what lab virtual machines are created from. */ createOption: string; /** * The image configuration for lab virtual machines. */ imageReference: outputs.labservices.ImageReferenceResponse; /** * Credentials for the non-admin user on the VM, if one exists. */ nonAdminUser?: outputs.labservices.CredentialsResponse; /** * The OS type of the image */ osType: string; /** * The SKU for the lab. Defines the type of virtual machines used in the lab. */ sku: outputs.labservices.SkuResponse; /** * The initial quota alloted to each lab user. Must be a time span between 0 and 9999 hours. */ usageQuota: string; /** * Enabling this option will use the same password for all user VMs. */ useSharedPassword?: string; } /** * virtualMachineProfileResponseProvideDefaults sets the appropriate defaults for VirtualMachineProfileResponse */ function virtualMachineProfileResponseProvideDefaults(val: VirtualMachineProfileResponse): VirtualMachineProfileResponse; } export declare namespace loadtestservice { /** * All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. */ interface EncryptionPropertiesIdentityResponse { /** * User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/a0a0a0a0-bbbb-cccd-dddd-e1e1e1e1e1e1/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. */ resourceId?: string; /** * Managed identity type to use for accessing encryption key Url. */ type?: string; } /** * Key and identity details for Customer Managed Key encryption of load test resource. */ interface EncryptionPropertiesResponse { /** * All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. */ identity?: outputs.loadtestservice.EncryptionPropertiesIdentityResponse; /** * key encryption key Url, versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. */ keyUrl?: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.loadtestservice.UserAssignedIdentityResponse; }; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace logic { /** * The AS2 agreement acknowledgement connection settings. */ interface AS2AcknowledgementConnectionSettingsResponse { /** * Indicates whether to ignore mismatch in certificate name. */ ignoreCertificateNameMismatch: boolean; /** * Indicates whether to keep the connection alive. */ keepHttpConnectionAlive: boolean; /** * Indicates whether to support HTTP status code 'CONTINUE'. */ supportHttpStatusCodeContinue: boolean; /** * Indicates whether to unfold the HTTP headers. */ unfoldHttpHeaders: boolean; } /** * The integration account AS2 agreement content. */ interface AS2AgreementContentResponse { /** * The AS2 one-way receive agreement. */ receiveAgreement: outputs.logic.AS2OneWayAgreementResponse; /** * The AS2 one-way send agreement. */ sendAgreement: outputs.logic.AS2OneWayAgreementResponse; } /** * The AS2 agreement envelope settings. */ interface AS2EnvelopeSettingsResponse { /** * The value indicating whether to auto generate file name. */ autogenerateFileName: boolean; /** * The template for file name. */ fileNameTemplate: string; /** * The message content type. */ messageContentType: string; /** * The value indicating whether to suspend message on file name generation error. */ suspendMessageOnFileNameGenerationError: boolean; /** * The value indicating whether to transmit file name in mime header. */ transmitFileNameInMimeHeader: boolean; } /** * The AS2 agreement error settings. */ interface AS2ErrorSettingsResponse { /** * The value indicating whether to resend message If MDN is not received. */ resendIfMDNNotReceived: boolean; /** * The value indicating whether to suspend duplicate message. */ suspendDuplicateMessage: boolean; } /** * The AS2 agreement mdn settings. */ interface AS2MdnSettingsResponse { /** * The disposition notification to header value. */ dispositionNotificationTo?: string; /** * The MDN text. */ mdnText?: string; /** * The signing or hashing algorithm. */ micHashingAlgorithm: string; /** * The value indicating whether to send or request a MDN. */ needMDN: boolean; /** * The receipt delivery URL. */ receiptDeliveryUrl?: string; /** * The value indicating whether to send inbound MDN to message box. */ sendInboundMDNToMessageBox: boolean; /** * The value indicating whether to send the asynchronous MDN. */ sendMDNAsynchronously: boolean; /** * The value indicating whether the MDN needs to be signed or not. */ signMDN: boolean; /** * The value indicating whether to sign the outbound MDN if optional. */ signOutboundMDNIfOptional: boolean; } /** * The AS2 agreement message connection settings. */ interface AS2MessageConnectionSettingsResponse { /** * The value indicating whether to ignore mismatch in certificate name. */ ignoreCertificateNameMismatch: boolean; /** * The value indicating whether to keep the connection alive. */ keepHttpConnectionAlive: boolean; /** * The value indicating whether to support HTTP status code 'CONTINUE'. */ supportHttpStatusCodeContinue: boolean; /** * The value indicating whether to unfold the HTTP headers. */ unfoldHttpHeaders: boolean; } /** * The integration account AS2 one-way agreement. */ interface AS2OneWayAgreementResponse { /** * The AS2 protocol settings. */ protocolSettings: outputs.logic.AS2ProtocolSettingsResponse; /** * The receiver business identity */ receiverBusinessIdentity: outputs.logic.BusinessIdentityResponse; /** * The sender business identity */ senderBusinessIdentity: outputs.logic.BusinessIdentityResponse; } /** * The AS2 agreement protocol settings. */ interface AS2ProtocolSettingsResponse { /** * The acknowledgement connection settings. */ acknowledgementConnectionSettings: outputs.logic.AS2AcknowledgementConnectionSettingsResponse; /** * The envelope settings. */ envelopeSettings: outputs.logic.AS2EnvelopeSettingsResponse; /** * The error settings. */ errorSettings: outputs.logic.AS2ErrorSettingsResponse; /** * The MDN settings. */ mdnSettings: outputs.logic.AS2MdnSettingsResponse; /** * The message connection settings. */ messageConnectionSettings: outputs.logic.AS2MessageConnectionSettingsResponse; /** * The security settings. */ securitySettings: outputs.logic.AS2SecuritySettingsResponse; /** * The validation settings. */ validationSettings: outputs.logic.AS2ValidationSettingsResponse; } /** * The AS2 agreement security settings. */ interface AS2SecuritySettingsResponse { /** * The value indicating whether to enable NRR for inbound decoded messages. */ enableNRRForInboundDecodedMessages: boolean; /** * The value indicating whether to enable NRR for inbound encoded messages. */ enableNRRForInboundEncodedMessages: boolean; /** * The value indicating whether to enable NRR for inbound MDN. */ enableNRRForInboundMDN: boolean; /** * The value indicating whether to enable NRR for outbound decoded messages. */ enableNRRForOutboundDecodedMessages: boolean; /** * The value indicating whether to enable NRR for outbound encoded messages. */ enableNRRForOutboundEncodedMessages: boolean; /** * The value indicating whether to enable NRR for outbound MDN. */ enableNRRForOutboundMDN: boolean; /** * The name of the encryption certificate. */ encryptionCertificateName?: string; /** * The value indicating whether to send or request a MDN. */ overrideGroupSigningCertificate: boolean; /** * The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. */ sha2AlgorithmFormat?: string; /** * The name of the signing certificate. */ signingCertificateName?: string; } /** * The AS2 agreement validation settings. */ interface AS2ValidationSettingsResponse { /** * The value indicating whether to check for certificate revocation list on receive. */ checkCertificateRevocationListOnReceive: boolean; /** * The value indicating whether to check for certificate revocation list on send. */ checkCertificateRevocationListOnSend: boolean; /** * The value indicating whether to check for duplicate message. */ checkDuplicateMessage: boolean; /** * The value indicating whether the message has to be compressed. */ compressMessage: boolean; /** * The value indicating whether the message has to be encrypted. */ encryptMessage: boolean; /** * The encryption algorithm. */ encryptionAlgorithm: string; /** * The number of days to look back for duplicate interchange. */ interchangeDuplicatesValidityDays: number; /** * The value indicating whether to override incoming message properties with those in agreement. */ overrideMessageProperties: boolean; /** * The value indicating whether the message has to be signed. */ signMessage: boolean; /** * The signing algorithm. */ signingAlgorithm?: string; } /** * The integration account agreement content. */ interface AgreementContentResponse { /** * The AS2 agreement content. */ aS2?: outputs.logic.AS2AgreementContentResponse; /** * The EDIFACT agreement content. */ edifact?: outputs.logic.EdifactAgreementContentResponse; /** * The X12 agreement content. */ x12?: outputs.logic.X12AgreementContentResponse; } /** * The API deployment parameter metadata. */ interface ApiDeploymentParameterMetadataResponse { /** * The description. */ description?: string; /** * The display name. */ displayName?: string; /** * Indicates whether its required. */ isRequired?: boolean; /** * The type. */ type?: string; /** * The visibility. */ visibility?: string; } /** * The API deployment parameters metadata. */ interface ApiDeploymentParameterMetadataSetResponse { /** * The package content link parameter. */ packageContentLink?: outputs.logic.ApiDeploymentParameterMetadataResponse; /** * The package content link parameter. */ redisCacheConnectionString?: outputs.logic.ApiDeploymentParameterMetadataResponse; } /** * The API backend service. */ interface ApiResourceBackendServiceResponse { /** * The service URL. */ serviceUrl?: string; } /** * The Api resource definition. */ interface ApiResourceDefinitionsResponse { /** * The modified swagger url. */ modifiedSwaggerUrl?: string; /** * The original swagger url. */ originalSwaggerUrl?: string; } /** * The API general information. */ interface ApiResourceGeneralInformationResponse { /** * The description. */ description?: string; /** * The display name. */ displayName?: string; /** * The icon url. */ iconUrl?: string; /** * The release tag. */ releaseTag?: string; /** * The terms of use url. */ termsOfUseUrl?: string; /** * The tier. */ tier?: string; } /** * The api resource metadata. */ interface ApiResourceMetadataResponse { /** * The api type. */ apiType?: string; /** * The brand color. */ brandColor?: string; /** * The connection type. */ connectionType?: string; /** * The connector deployment parameters metadata. */ deploymentParameters?: outputs.logic.ApiDeploymentParameterMetadataSetResponse; /** * The hide key. */ hideKey?: string; /** * The provisioning state. */ provisioningState?: string; /** * The source. */ source?: string; /** * The tags. */ tags?: { [key: string]: string; }; /** * The WSDL import method. */ wsdlImportMethod?: string; /** * The WSDL service. */ wsdlService?: outputs.logic.WsdlServiceResponse; } /** * The API resource policies. */ interface ApiResourcePoliciesResponse { /** * The API level only policies XML as embedded content. */ content?: string; /** * The content link to the policies. */ contentLink?: string; } /** * The assembly properties definition. */ interface AssemblyPropertiesResponse { /** * The assembly culture. */ assemblyCulture?: string; /** * The assembly name. */ assemblyName: string; /** * The assembly public key token. */ assemblyPublicKeyToken?: string; /** * The assembly version. */ assemblyVersion?: string; /** * The artifact changed time. */ changedTime?: string; content?: any; /** * The content link. */ contentLink?: outputs.logic.ContentLinkResponse; /** * The content type. */ contentType?: string; /** * The artifact creation time. */ createdTime?: string; metadata?: any; } /** * The azure resource error info. */ interface AzureResourceErrorInfoResponse { /** * The error code. */ code: string; /** * The error details. */ details?: outputs.logic.AzureResourceErrorInfoResponse[]; /** * The error message. */ message: string; } /** * The B2B partner content. */ interface B2BPartnerContentResponse { /** * The list of partner business identities. */ businessIdentities?: outputs.logic.BusinessIdentityResponse[]; } /** * The batch configuration properties definition. */ interface BatchConfigurationPropertiesResponse { /** * The name of the batch group. */ batchGroupName: string; /** * The artifact changed time. */ changedTime?: string; /** * The artifact creation time. */ createdTime?: string; metadata?: any; /** * The batch release criteria. */ releaseCriteria: outputs.logic.BatchReleaseCriteriaResponse; } /** * The batch release criteria. */ interface BatchReleaseCriteriaResponse { /** * The batch size in bytes. */ batchSize?: number; /** * The message count. */ messageCount?: number; /** * The recurrence. */ recurrence?: outputs.logic.WorkflowTriggerRecurrenceResponse; } /** * The integration account partner's business identity. */ interface BusinessIdentityResponse { /** * The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 */ qualifier: string; /** * The user defined business identity value. */ value: string; } /** * The content hash. */ interface ContentHashResponse { /** * The algorithm of the content hash. */ algorithm?: string; /** * The value of the content hash. */ value?: string; } /** * The content link. */ interface ContentLinkResponse { /** * The content hash. */ contentHash: outputs.logic.ContentHashResponse; /** * The content size. */ contentSize: number; /** * The content version. */ contentVersion: string; /** * The metadata. */ metadata: any; /** * The content link URI. */ uri?: string; } /** * The Edifact agreement acknowledgement settings. */ interface EdifactAcknowledgementSettingsResponse { /** * The acknowledgement control number lower bound. */ acknowledgementControlNumberLowerBound: number; /** * The acknowledgement control number prefix. */ acknowledgementControlNumberPrefix?: string; /** * The acknowledgement control number suffix. */ acknowledgementControlNumberSuffix?: string; /** * The acknowledgement control number upper bound. */ acknowledgementControlNumberUpperBound: number; /** * The value indicating whether to batch functional acknowledgements. */ batchFunctionalAcknowledgements: boolean; /** * The value indicating whether to batch the technical acknowledgements. */ batchTechnicalAcknowledgements: boolean; /** * The value indicating whether functional acknowledgement is needed. */ needFunctionalAcknowledgement: boolean; /** * The value indicating whether a loop is needed for valid messages. */ needLoopForValidMessages: boolean; /** * The value indicating whether technical acknowledgement is needed. */ needTechnicalAcknowledgement: boolean; /** * The value indicating whether to rollover acknowledgement control number. */ rolloverAcknowledgementControlNumber: boolean; /** * The value indicating whether to send synchronous acknowledgement. */ sendSynchronousAcknowledgement: boolean; } /** * The Edifact agreement content. */ interface EdifactAgreementContentResponse { /** * The EDIFACT one-way receive agreement. */ receiveAgreement: outputs.logic.EdifactOneWayAgreementResponse; /** * The EDIFACT one-way send agreement. */ sendAgreement: outputs.logic.EdifactOneWayAgreementResponse; } /** * The Edifact delimiter override settings. */ interface EdifactDelimiterOverrideResponse { /** * The component separator. */ componentSeparator: number; /** * The data element separator. */ dataElementSeparator: number; /** * The decimal point indicator. */ decimalPointIndicator: string; /** * The message association assigned code. */ messageAssociationAssignedCode?: string; /** * The message id. */ messageId?: string; /** * The message release. */ messageRelease?: string; /** * The message version. */ messageVersion?: string; /** * The release indicator. */ releaseIndicator: number; /** * The repetition separator. */ repetitionSeparator: number; /** * The segment terminator. */ segmentTerminator: number; /** * The segment terminator suffix. */ segmentTerminatorSuffix: string; /** * The target namespace on which this delimiter settings has to be applied. */ targetNamespace?: string; } /** * The Edifact envelope override settings. */ interface EdifactEnvelopeOverrideResponse { /** * The application password. */ applicationPassword?: string; /** * The association assigned code. */ associationAssignedCode?: string; /** * The controlling agency code. */ controllingAgencyCode?: string; /** * The functional group id. */ functionalGroupId?: string; /** * The group header message release. */ groupHeaderMessageRelease?: string; /** * The group header message version. */ groupHeaderMessageVersion?: string; /** * The message association assigned code. */ messageAssociationAssignedCode?: string; /** * The message id on which this envelope settings has to be applied. */ messageId?: string; /** * The message release version on which this envelope settings has to be applied. */ messageRelease?: string; /** * The message version on which this envelope settings has to be applied. */ messageVersion?: string; /** * The receiver application id. */ receiverApplicationId?: string; /** * The receiver application qualifier. */ receiverApplicationQualifier?: string; /** * The sender application id. */ senderApplicationId?: string; /** * The sender application qualifier. */ senderApplicationQualifier?: string; /** * The target namespace on which this envelope settings has to be applied. */ targetNamespace?: string; } /** * The Edifact agreement envelope settings. */ interface EdifactEnvelopeSettingsResponse { /** * The application reference id. */ applicationReferenceId?: string; /** * The value indicating whether to apply delimiter string advice. */ applyDelimiterStringAdvice: boolean; /** * The communication agreement id. */ communicationAgreementId?: string; /** * The value indicating whether to create grouping segments. */ createGroupingSegments: boolean; /** * The value indicating whether to enable default group headers. */ enableDefaultGroupHeaders: boolean; /** * The functional group id. */ functionalGroupId?: string; /** * The group application password. */ groupApplicationPassword?: string; /** * The group application receiver id. */ groupApplicationReceiverId?: string; /** * The group application receiver qualifier. */ groupApplicationReceiverQualifier?: string; /** * The group application sender id. */ groupApplicationSenderId?: string; /** * The group application sender qualifier. */ groupApplicationSenderQualifier?: string; /** * The group association assigned code. */ groupAssociationAssignedCode?: string; /** * The group control number lower bound. */ groupControlNumberLowerBound: number; /** * The group control number prefix. */ groupControlNumberPrefix?: string; /** * The group control number suffix. */ groupControlNumberSuffix?: string; /** * The group control number upper bound. */ groupControlNumberUpperBound: number; /** * The group controlling agency code. */ groupControllingAgencyCode?: string; /** * The group message release. */ groupMessageRelease?: string; /** * The group message version. */ groupMessageVersion?: string; /** * The interchange control number lower bound. */ interchangeControlNumberLowerBound: number; /** * The interchange control number prefix. */ interchangeControlNumberPrefix?: string; /** * The interchange control number suffix. */ interchangeControlNumberSuffix?: string; /** * The interchange control number upper bound. */ interchangeControlNumberUpperBound: number; /** * The value indicating whether the message is a test interchange. */ isTestInterchange: boolean; /** * The value indicating whether to overwrite existing transaction set control number. */ overwriteExistingTransactionSetControlNumber: boolean; /** * The processing priority code. */ processingPriorityCode?: string; /** * The receiver internal identification. */ receiverInternalIdentification?: string; /** * The receiver internal sub identification. */ receiverInternalSubIdentification?: string; /** * The receiver reverse routing address. */ receiverReverseRoutingAddress?: string; /** * The recipient reference password qualifier. */ recipientReferencePasswordQualifier?: string; /** * The recipient reference password value. */ recipientReferencePasswordValue?: string; /** * The value indicating whether to rollover group control number. */ rolloverGroupControlNumber: boolean; /** * The value indicating whether to rollover interchange control number. */ rolloverInterchangeControlNumber: boolean; /** * The value indicating whether to rollover transaction set control number. */ rolloverTransactionSetControlNumber: boolean; /** * The sender internal identification. */ senderInternalIdentification?: string; /** * The sender internal sub identification. */ senderInternalSubIdentification?: string; /** * The sender reverse routing address. */ senderReverseRoutingAddress?: string; /** * The transaction set control number lower bound. */ transactionSetControlNumberLowerBound: number; /** * The transaction set control number prefix. */ transactionSetControlNumberPrefix?: string; /** * The transaction set control number suffix. */ transactionSetControlNumberSuffix?: string; /** * The transaction set control number upper bound. */ transactionSetControlNumberUpperBound: number; } /** * The Edifact agreement framing settings. */ interface EdifactFramingSettingsResponse { /** * The character encoding. */ characterEncoding?: string; /** * The EDIFACT frame setting characterSet. */ characterSet: string; /** * The component separator. */ componentSeparator: number; /** * The data element separator. */ dataElementSeparator: number; /** * The EDIFACT frame setting decimal indicator. */ decimalPointIndicator: string; /** * The protocol version. */ protocolVersion: number; /** * The release indicator. */ releaseIndicator: number; /** * The repetition separator. */ repetitionSeparator: number; /** * The segment terminator. */ segmentTerminator: number; /** * The EDIFACT frame setting segment terminator suffix. */ segmentTerminatorSuffix: string; /** * The service code list directory version. */ serviceCodeListDirectoryVersion?: string; } /** * The Edifact message filter for odata query. */ interface EdifactMessageFilterResponse { /** * The message filter type. */ messageFilterType: string; } /** * The Edifact message identifier. */ interface EdifactMessageIdentifierResponse { /** * The message id on which this envelope settings has to be applied. */ messageId: string; } /** * The Edifact one way agreement. */ interface EdifactOneWayAgreementResponse { /** * The EDIFACT protocol settings. */ protocolSettings: outputs.logic.EdifactProtocolSettingsResponse; /** * The receiver business identity */ receiverBusinessIdentity: outputs.logic.BusinessIdentityResponse; /** * The sender business identity */ senderBusinessIdentity: outputs.logic.BusinessIdentityResponse; } /** * The Edifact agreement protocol settings. */ interface EdifactProcessingSettingsResponse { /** * The value indicating whether to create empty xml tags for trailing separators. */ createEmptyXmlTagsForTrailingSeparators: boolean; /** * The value indicating whether to mask security information. */ maskSecurityInfo: boolean; /** * The value indicating whether to preserve interchange. */ preserveInterchange: boolean; /** * The value indicating whether to suspend interchange on error. */ suspendInterchangeOnError: boolean; /** * The value indicating whether to use dot as decimal separator. */ useDotAsDecimalSeparator: boolean; } /** * The Edifact agreement protocol settings. */ interface EdifactProtocolSettingsResponse { /** * The EDIFACT acknowledgement settings. */ acknowledgementSettings: outputs.logic.EdifactAcknowledgementSettingsResponse; /** * The EDIFACT delimiter override settings. */ edifactDelimiterOverrides?: outputs.logic.EdifactDelimiterOverrideResponse[]; /** * The EDIFACT envelope override settings. */ envelopeOverrides?: outputs.logic.EdifactEnvelopeOverrideResponse[]; /** * The EDIFACT envelope settings. */ envelopeSettings: outputs.logic.EdifactEnvelopeSettingsResponse; /** * The EDIFACT framing settings. */ framingSettings: outputs.logic.EdifactFramingSettingsResponse; /** * The EDIFACT message filter. */ messageFilter: outputs.logic.EdifactMessageFilterResponse; /** * The EDIFACT message filter list. */ messageFilterList?: outputs.logic.EdifactMessageIdentifierResponse[]; /** * The EDIFACT processing Settings. */ processingSettings: outputs.logic.EdifactProcessingSettingsResponse; /** * The EDIFACT schema references. */ schemaReferences: outputs.logic.EdifactSchemaReferenceResponse[]; /** * The EDIFACT validation override settings. */ validationOverrides?: outputs.logic.EdifactValidationOverrideResponse[]; /** * The EDIFACT validation settings. */ validationSettings: outputs.logic.EdifactValidationSettingsResponse; } /** * The Edifact schema reference. */ interface EdifactSchemaReferenceResponse { /** * The association assigned code. */ associationAssignedCode?: string; /** * The message id. */ messageId: string; /** * The message release version. */ messageRelease: string; /** * The message version. */ messageVersion: string; /** * The schema name. */ schemaName: string; /** * The sender application id. */ senderApplicationId?: string; /** * The sender application qualifier. */ senderApplicationQualifier?: string; } /** * The Edifact validation override settings. */ interface EdifactValidationOverrideResponse { /** * The value indicating whether to allow leading and trailing spaces and zeroes. */ allowLeadingAndTrailingSpacesAndZeroes: boolean; /** * The value indicating whether to validate character Set. */ enforceCharacterSet: boolean; /** * The message id on which the validation settings has to be applied. */ messageId: string; /** * The trailing separator policy. */ trailingSeparatorPolicy: string; /** * The value indicating whether to trim leading and trailing spaces and zeroes. */ trimLeadingAndTrailingSpacesAndZeroes: boolean; /** * The value indicating whether to validate EDI types. */ validateEDITypes: boolean; /** * The value indicating whether to validate XSD types. */ validateXSDTypes: boolean; } /** * The Edifact agreement validation settings. */ interface EdifactValidationSettingsResponse { /** * The value indicating whether to allow leading and trailing spaces and zeroes. */ allowLeadingAndTrailingSpacesAndZeroes: boolean; /** * The value indicating whether to check for duplicate group control number. */ checkDuplicateGroupControlNumber: boolean; /** * The value indicating whether to check for duplicate interchange control number. */ checkDuplicateInterchangeControlNumber: boolean; /** * The value indicating whether to check for duplicate transaction set control number. */ checkDuplicateTransactionSetControlNumber: boolean; /** * The validity period of interchange control number. */ interchangeControlNumberValidityDays: number; /** * The trailing separator policy. */ trailingSeparatorPolicy: string; /** * The value indicating whether to trim leading and trailing spaces and zeroes. */ trimLeadingAndTrailingSpacesAndZeroes: boolean; /** * The value indicating whether to validate character set in the message. */ validateCharacterSet: boolean; /** * The value indicating whether to Whether to validate EDI types. */ validateEDITypes: boolean; /** * The value indicating whether to Whether to validate XSD types. */ validateXSDTypes: boolean; } /** * The expression. */ interface ExpressionResponse { /** * The azure resource error info. */ error?: outputs.logic.AzureResourceErrorInfoResponse; /** * The sub expressions. */ subexpressions?: outputs.logic.ExpressionResponse[]; /** * The text. */ text?: string; value?: any; } /** * The expression root. */ interface ExpressionRootResponse { /** * The azure resource error info. */ error?: outputs.logic.AzureResourceErrorInfoResponse; /** * The path. */ path?: string; /** * The sub expressions. */ subexpressions?: outputs.logic.ExpressionResponse[]; /** * The text. */ text?: string; value?: any; } /** * The access control configuration policy. */ interface FlowAccessControlConfigurationPolicyResponse { /** * The allowed caller IP address ranges. */ allowedCallerIpAddresses?: outputs.logic.IpAddressRangeResponse[]; /** * The authentication policies for workflow. */ openAuthenticationPolicies?: outputs.logic.OpenAuthenticationAccessPoliciesResponse; } /** * The access control configuration. */ interface FlowAccessControlConfigurationResponse { /** * The access control configuration for workflow actions. */ actions?: outputs.logic.FlowAccessControlConfigurationPolicyResponse; /** * The access control configuration for accessing workflow run contents. */ contents?: outputs.logic.FlowAccessControlConfigurationPolicyResponse; /** * The access control configuration for invoking workflow triggers. */ triggers?: outputs.logic.FlowAccessControlConfigurationPolicyResponse; /** * The access control configuration for workflow management. */ workflowManagement?: outputs.logic.FlowAccessControlConfigurationPolicyResponse; } /** * The endpoints configuration. */ interface FlowEndpointsConfigurationResponse { /** * The connector endpoints. */ connector?: outputs.logic.FlowEndpointsResponse; /** * The workflow endpoints. */ workflow?: outputs.logic.FlowEndpointsResponse; } /** * The flow endpoints configuration. */ interface FlowEndpointsResponse { /** * The access endpoint ip address. */ accessEndpointIpAddresses?: outputs.logic.IpAddressResponse[]; /** * The outgoing ip address. */ outgoingIpAddresses?: outputs.logic.IpAddressResponse[]; } /** * The parameters schema of integration account map. */ interface IntegrationAccountMapPropertiesResponseParametersSchema { /** * The reference name. */ ref?: string; } /** * The integration account sku. */ interface IntegrationAccountSkuResponse { /** * The sku name. */ name: string; } /** * The encryption configuration for the integration service environment. */ interface IntegrationServiceEnvironmenEncryptionConfigurationResponse { /** * The encryption key reference. */ encryptionKeyReference?: outputs.logic.IntegrationServiceEnvironmenEncryptionKeyReferenceResponse; } /** * The encryption key details for the integration service environment. */ interface IntegrationServiceEnvironmenEncryptionKeyReferenceResponse { /** * Gets the key name in the Key Vault. */ keyName?: string; /** * The key vault reference. */ keyVault?: outputs.logic.ResourceReferenceResponse; /** * Gets the version of the key specified in the keyName property. */ keyVersion?: string; } /** * The integration service environment access endpoint. */ interface IntegrationServiceEnvironmentAccessEndpointResponse { /** * The access endpoint type. */ type?: string; } /** * The integration service environment managed api deployment parameters. */ interface IntegrationServiceEnvironmentManagedApiDeploymentParametersResponse { /** * The integration service environment managed api content link for deployment. */ contentLinkDefinition?: outputs.logic.ContentLinkResponse; } /** * The integration service environment properties. */ interface IntegrationServiceEnvironmentPropertiesResponse { /** * The encryption configuration. */ encryptionConfiguration?: outputs.logic.IntegrationServiceEnvironmenEncryptionConfigurationResponse; /** * The endpoints configuration. */ endpointsConfiguration?: outputs.logic.FlowEndpointsConfigurationResponse; /** * Gets the tracking id. */ integrationServiceEnvironmentId?: string; /** * The network configuration. */ networkConfiguration?: outputs.logic.NetworkConfigurationResponse; /** * The provisioning state. */ provisioningState?: string; /** * The integration service environment state. */ state?: string; } /** * The integration service environment sku. */ interface IntegrationServiceEnvironmentSkuResponse { /** * The sku capacity. */ capacity?: number; /** * The sku name. */ name?: string; } /** * The ip address range. */ interface IpAddressRangeResponse { /** * The IP address range. */ addressRange?: string; } /** * The ip address. */ interface IpAddressResponse { /** * The address. */ address?: string; } /** * The reference to the key vault key. */ interface KeyVaultKeyReferenceResponse { /** * The private key name in key vault. */ keyName: string; /** * The key vault reference. */ keyVault: outputs.logic.KeyVaultKeyReferenceResponseKeyVault; /** * The private key version in key vault. */ keyVersion?: string; } /** * The key vault reference. */ interface KeyVaultKeyReferenceResponseKeyVault { /** * The resource id. */ id?: string; /** * The resource name. */ name: string; /** * The resource type. */ type: string; } /** * The key vault key. */ interface KeyVaultKeyResponse { /** * The key attributes. */ attributes?: outputs.logic.KeyVaultKeyResponseAttributes; /** * The key id. */ kid?: string; } /** * The key attributes. */ interface KeyVaultKeyResponseAttributes { /** * When the key was created. */ created?: number; /** * Whether the key is enabled or not. */ enabled?: boolean; /** * When the key was updated. */ updated?: number; } /** * Managed service identity properties. */ interface ManagedServiceIdentityResponse { /** * Principal Id of managed service identity. */ principalId: string; /** * Tenant of managed service identity. */ tenantId: string; /** * Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. */ type: string; /** * The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} */ userAssignedIdentities?: { [key: string]: outputs.logic.UserAssignedIdentityResponse; }; } /** * The network configuration. */ interface NetworkConfigurationResponse { /** * The access endpoint. */ accessEndpoint?: outputs.logic.IntegrationServiceEnvironmentAccessEndpointResponse; /** * The subnets. */ subnets?: outputs.logic.ResourceReferenceResponse[]; /** * Gets the virtual network address space. */ virtualNetworkAddressSpace?: string; } /** * AuthenticationPolicy of type Open. */ interface OpenAuthenticationAccessPoliciesResponse { /** * Open authentication policies. */ policies?: { [key: string]: outputs.logic.OpenAuthenticationAccessPolicyResponse; }; } /** * Open authentication access policy defined by user. */ interface OpenAuthenticationAccessPolicyResponse { /** * The access policy claims. */ claims?: outputs.logic.OpenAuthenticationPolicyClaimResponse[]; /** * Type of provider for OAuth. */ type?: string; } /** * Open authentication policy claim. */ interface OpenAuthenticationPolicyClaimResponse { /** * The name of the claim. */ name?: string; /** * The value of the claim. */ value?: string; } /** * The integration account partner content. */ interface PartnerContentResponse { /** * The B2B partner content. */ b2b?: outputs.logic.B2BPartnerContentResponse; } /** * The recurrence schedule occurrence. */ interface RecurrenceScheduleOccurrenceResponse { /** * The day of the week. */ day?: string; /** * The occurrence. */ occurrence?: number; } /** * The recurrence schedule. */ interface RecurrenceScheduleResponse { /** * The hours. */ hours?: number[]; /** * The minutes. */ minutes?: number[]; /** * The month days. */ monthDays?: number[]; /** * The monthly occurrences. */ monthlyOccurrences?: outputs.logic.RecurrenceScheduleOccurrenceResponse[]; /** * The days of the week. */ weekDays?: string[]; } /** * The resource reference. */ interface ResourceReferenceResponse { /** * The resource id. */ id?: string; /** * Gets the resource name. */ name: string; /** * Gets the resource type. */ type: string; } /** * The integration account RosettaNet ProcessConfiguration Acknowledgement settings. */ interface RosettaNetPipAcknowledgmentOfReceiptSettingsResponse { /** * The non-repudiation is required or not. */ isNonRepudiationRequired: boolean; /** * The time to acknowledge in seconds. */ timeToAcknowledgeInSeconds: number; } /** * The integration account RosettaNet ProcessConfiguration activity behavior. */ interface RosettaNetPipActivityBehaviorResponse { /** * The value indicating whether the RosettaNet PIP is used for a single action. */ actionType: string; /** * The value indicating whether authorization is required. */ isAuthorizationRequired: boolean; /** * The value indicating whether secured transport is required. */ isSecuredTransportRequired: boolean; /** * The value indicating whether non-repudiation is for origin and content. */ nonRepudiationOfOriginAndContent: boolean; /** * The persistent confidentiality encryption scope. */ persistentConfidentialityScope: string; /** * The value indicating whether the RosettaNet PIP communication is synchronous. */ responseType: string; /** * The value indicating retry count. */ retryCount: number; /** * The time to perform in seconds. */ timeToPerformInSeconds: number; } /** * The integration account RosettaNet ProcessConfiguration activity settings. */ interface RosettaNetPipActivitySettingsResponse { /** * The RosettaNet ProcessConfiguration acknowledgement settings. */ acknowledgmentOfReceiptSettings: outputs.logic.RosettaNetPipAcknowledgmentOfReceiptSettingsResponse; /** * The RosettaNet ProcessConfiguration activity behavior. */ activityBehavior: outputs.logic.RosettaNetPipActivityBehaviorResponse; /** * The RosettaNet ProcessConfiguration activity type. */ activityType: string; } /** * The RosettaNet ProcessConfiguration business document settings. */ interface RosettaNetPipBusinessDocumentResponse { /** * The business document description. */ description?: string; /** * The business document name. */ name: string; /** * The business document version. */ version: string; } /** * The integration account RosettaNet ProcessConfiguration role settings. */ interface RosettaNetPipRoleSettingsResponse { /** * The action name. */ action: string; /** * The RosettaNet ProcessConfiguration business document. */ businessDocument: outputs.logic.RosettaNetPipBusinessDocumentResponse; /** * The description. */ description?: string; /** * The role name. */ role: string; /** * The RosettaNet ProcessConfiguration role type. */ roleType: string; /** * The service name. */ service: string; /** * The service classification name. */ serviceClassification: string; } /** * The sku type. */ interface SkuResponse { /** * The name. */ name: string; /** * The reference to plan. */ plan?: outputs.logic.ResourceReferenceResponse; } /** * User Assigned identity properties. */ interface UserAssignedIdentityResponse { /** * Client Id of user assigned identity */ clientId: string; /** * Principal Id of user assigned identity */ principalId: string; } /** * The workflow parameters. */ interface WorkflowParameterResponse { /** * The description. */ description?: string; /** * The metadata. */ metadata?: any; /** * The type. */ type?: string; /** * The value. */ value?: any; } /** * Gets the workflow trigger callback URL query parameters. */ interface WorkflowTriggerListCallbackUrlQueriesResponse { /** * The api version. */ apiVersion?: string; /** * The SAS timestamp. */ se?: string; /** * The SAS signature. */ sig?: string; /** * The SAS permissions. */ sp?: string; /** * The SAS version. */ sv?: string; } /** * The workflow trigger recurrence. */ interface WorkflowTriggerRecurrenceResponse { /** * The end time. */ endTime?: string; /** * The frequency. */ frequency?: string; /** * The interval. */ interval?: number; /** * The recurrence schedule. */ schedule?: outputs.logic.RecurrenceScheduleResponse; /** * The start time. */ startTime?: string; /** * The time zone. */ timeZone?: string; } /** * The WSDL service. */ interface WsdlServiceResponse { /** * The list of endpoints' qualified names. */ endpointQualifiedNames?: string[]; /** * The qualified name. */ qualifiedName?: string; } /** * The X12 agreement acknowledgement settings. */ interface X12AcknowledgementSettingsResponse { /** * The acknowledgement control number lower bound. */ acknowledgementControlNumberLowerBound: number; /** * The acknowledgement control number prefix. */ acknowledgementControlNumberPrefix?: string; /** * The acknowledgement control number suffix. */ acknowledgementControlNumberSuffix?: string; /** * The acknowledgement control number upper bound. */ acknowledgementControlNumberUpperBound: number; /** * The value indicating whether to batch functional acknowledgements. */ batchFunctionalAcknowledgements: boolean; /** * The value indicating whether to batch implementation acknowledgements. */ batchImplementationAcknowledgements: boolean; /** * The value indicating whether to batch the technical acknowledgements. */ batchTechnicalAcknowledgements: boolean; /** * The functional acknowledgement version. */ functionalAcknowledgementVersion?: string; /** * The implementation acknowledgement version. */ implementationAcknowledgementVersion?: string; /** * The value indicating whether functional acknowledgement is needed. */ needFunctionalAcknowledgement: boolean; /** * The value indicating whether implementation acknowledgement is needed. */ needImplementationAcknowledgement: boolean; /** * The value indicating whether a loop is needed for valid messages. */ needLoopForValidMessages: boolean; /** * The value indicating whether technical acknowledgement is needed. */ needTechnicalAcknowledgement: boolean; /** * The value indicating whether to rollover acknowledgement control number. */ rolloverAcknowledgementControlNumber: boolean; /** * The value indicating whether to send synchronous acknowledgement. */ sendSynchronousAcknowledgement: boolean; } /** * The X12 agreement content. */ interface X12AgreementContentResponse { /** * The X12 one-way receive agreement. */ receiveAgreement: outputs.logic.X12OneWayAgreementResponse; /** * The X12 one-way send agreement. */ sendAgreement: outputs.logic.X12OneWayAgreementResponse; } /** * The X12 delimiter override settings. */ interface X12DelimiterOverridesResponse { /** * The component separator. */ componentSeparator: number; /** * The data element separator. */ dataElementSeparator: number; /** * The message id. */ messageId?: string; /** * The protocol version. */ protocolVersion?: string; /** * The replacement character. */ replaceCharacter: number; /** * The value indicating whether to replace separators in payload. */ replaceSeparatorsInPayload: boolean; /** * The segment terminator. */ segmentTerminator: number; /** * The segment terminator suffix. */ segmentTerminatorSuffix: string; /** * The target namespace on which this delimiter settings has to be applied. */ targetNamespace?: string; } /** * The X12 envelope override settings. */ interface X12EnvelopeOverrideResponse { /** * The date format. */ dateFormat: string; /** * The functional identifier code. */ functionalIdentifierCode?: string; /** * The header version. */ headerVersion: string; /** * The message id on which this envelope settings has to be applied. */ messageId: string; /** * The protocol version on which this envelope settings has to be applied. */ protocolVersion: string; /** * The receiver application id. */ receiverApplicationId: string; /** * The responsible agency code. */ responsibleAgencyCode: string; /** * The sender application id. */ senderApplicationId: string; /** * The target namespace on which this envelope settings has to be applied. */ targetNamespace: string; /** * The time format. */ timeFormat: string; } /** * The X12 agreement envelope settings. */ interface X12EnvelopeSettingsResponse { /** * The controls standards id. */ controlStandardsId: number; /** * The control version number. */ controlVersionNumber: string; /** * The value indicating whether to enable default group headers. */ enableDefaultGroupHeaders: boolean; /** * The functional group id. */ functionalGroupId?: string; /** * The group control number lower bound. */ groupControlNumberLowerBound: number; /** * The group control number upper bound. */ groupControlNumberUpperBound: number; /** * The group header agency code. */ groupHeaderAgencyCode: string; /** * The group header date format. */ groupHeaderDateFormat: string; /** * The group header time format. */ groupHeaderTimeFormat: string; /** * The group header version. */ groupHeaderVersion: string; /** * The interchange control number lower bound. */ interchangeControlNumberLowerBound: number; /** * The interchange control number upper bound. */ interchangeControlNumberUpperBound: number; /** * The value indicating whether to overwrite existing transaction set control number. */ overwriteExistingTransactionSetControlNumber: boolean; /** * The receiver application id. */ receiverApplicationId: string; /** * The value indicating whether to rollover group control number. */ rolloverGroupControlNumber: boolean; /** * The value indicating whether to rollover interchange control number. */ rolloverInterchangeControlNumber: boolean; /** * The value indicating whether to rollover transaction set control number. */ rolloverTransactionSetControlNumber: boolean; /** * The sender application id. */ senderApplicationId: string; /** * The transaction set control number lower bound. */ transactionSetControlNumberLowerBound: number; /** * The transaction set control number prefix. */ transactionSetControlNumberPrefix?: string; /** * The transaction set control number suffix. */ transactionSetControlNumberSuffix?: string; /** * The transaction set control number upper bound. */ transactionSetControlNumberUpperBound: number; /** * The usage indicator. */ usageIndicator: string; /** * The value indicating whether to use control standards id as repetition character. */ useControlStandardsIdAsRepetitionCharacter: boolean; } /** * The X12 agreement framing settings. */ interface X12FramingSettingsResponse { /** * The X12 character set. */ characterSet: string; /** * The component separator. */ componentSeparator: number; /** * The data element separator. */ dataElementSeparator: number; /** * The replacement character. */ replaceCharacter: number; /** * The value indicating whether to replace separators in payload. */ replaceSeparatorsInPayload: boolean; /** * The segment terminator. */ segmentTerminator: number; /** * The segment terminator suffix. */ segmentTerminatorSuffix: string; } /** * The X12 message filter for odata query. */ interface X12MessageFilterResponse { /** * The message filter type. */ messageFilterType: string; } /** * The X12 message identifier. */ interface X12MessageIdentifierResponse { /** * The message id. */ messageId: string; } /** * The X12 one-way agreement. */ interface X12OneWayAgreementResponse { /** * The X12 protocol settings. */ protocolSettings: outputs.logic.X12ProtocolSettingsResponse; /** * The receiver business identity */ receiverBusinessIdentity: outputs.logic.BusinessIdentityResponse; /** * The sender business identity */ senderBusinessIdentity: outputs.logic.BusinessIdentityResponse; } /** * The X12 processing settings. */ interface X12ProcessingSettingsResponse { /** * The value indicating whether to convert numerical type to implied decimal. */ convertImpliedDecimal: boolean; /** * The value indicating whether to create empty xml tags for trailing separators. */ createEmptyXmlTagsForTrailingSeparators: boolean; /** * The value indicating whether to mask security information. */ maskSecurityInfo: boolean; /** * The value indicating whether to preserve interchange. */ preserveInterchange: boolean; /** * The value indicating whether to suspend interchange on error. */ suspendInterchangeOnError: boolean; /** * The value indicating whether to use dot as decimal separator. */ useDotAsDecimalSeparator: boolean; } /** * The X12 agreement protocol settings. */ interface X12ProtocolSettingsResponse { /** * The X12 acknowledgment settings. */ acknowledgementSettings: outputs.logic.X12AcknowledgementSettingsResponse; /** * The X12 envelope override settings. */ envelopeOverrides?: outputs.logic.X12EnvelopeOverrideResponse[]; /** * The X12 envelope settings. */ envelopeSettings: outputs.logic.X12EnvelopeSettingsResponse; /** * The X12 framing settings. */ framingSettings: outputs.logic.X12FramingSettingsResponse; /** * The X12 message filter. */ messageFilter: outputs.logic.X12MessageFilterResponse; /** * The X12 message filter list. */ messageFilterList?: outputs.logic.X12MessageIdentifierResponse[]; /** * The X12 processing settings. */ processingSettings: outputs.logic.X12ProcessingSettingsResponse; /** * The X12 schema references. */ schemaReferences: outputs.logic.X12SchemaReferenceResponse[]; /** * The X12 security settings. */ securitySettings: outputs.logic.X12SecuritySettingsResponse; /** * The X12 validation override settings. */ validationOverrides?: outputs.logic.X12ValidationOverrideResponse[]; /** * The X12 validation settings. */ validationSettings: outputs.logic.X12ValidationSettingsResponse; /** * The X12 delimiter override settings. */ x12DelimiterOverrides?: outputs.logic.X12DelimiterOverridesResponse[]; } /** * The X12 schema reference. */ interface X12SchemaReferenceResponse { /** * The message id. */ messageId: string; /** * The schema name. */ schemaName: string; /** * The schema version. */ schemaVersion: string; /** * The sender application id. */ senderApplicationId?: string; } /** * The X12 agreement security settings. */ interface X12SecuritySettingsResponse { /** * The authorization qualifier. */ authorizationQualifier: string; /** * The authorization value. */ authorizationValue?: string; /** * The password value. */ passwordValue?: string; /** * The security qualifier. */ securityQualifier: string; } /** * The X12 validation override settings. */ interface X12ValidationOverrideResponse { /** * The value indicating whether to allow leading and trailing spaces and zeroes. */ allowLeadingAndTrailingSpacesAndZeroes: boolean; /** * The message id on which the validation settings has to be applied. */ messageId: string; /** * The trailing separator policy. */ trailingSeparatorPolicy: string; /** * The value indicating whether to trim leading and trailing spaces and zeroes. */ trimLeadingAndTrailingSpacesAndZeroes: boolean; /** * The value indicating whether to validate character Set. */ validateCharacterSet: boolean; /** * The value indicating whether to validate EDI types. */ validateEDITypes: boolean; /** * The value indicating whether to validate XSD types. */ validateXSDTypes: boolean; } /** * The X12 agreement validation settings. */ interface X12ValidationSettingsResponse { /** * The value indicating whether to allow leading and trailing spaces and zeroes. */ allowLeadingAndTrailingSpacesAndZeroes: boolean; /** * The value indicating whether to check for duplicate group control number. */ checkDuplicateGroupControlNumber: boolean; /** * The value indicating whether to check for duplicate interchange control number. */ checkDuplicateInterchangeControlNumber: boolean; /** * The value indicating whether to check for duplicate transaction set control number. */ checkDuplicateTransactionSetControlNumber: boolean; /** * The validity period of interchange control number. */ interchangeControlNumberValidityDays: number; /** * The trailing separator policy. */ trailingSeparatorPolicy: string; /** * The value indicating whether to trim leading and trailing spaces and zeroes. */ trimLeadingAndTrailingSpacesAndZeroes: boolean; /** * The value indicating whether to validate character set in the message. */ validateCharacterSet: boolean; /** * The value indicating whether to Whether to validate EDI types. */ validateEDITypes: boolean; /** * The value indicating whether to Whether to validate XSD types. */ validateXSDTypes: boolean; } } export declare namespace m365securityandcompliance { /** * The Private Endpoint Connection resource. */ interface PrivateEndpointConnectionResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * The resource of private end point. */ privateEndpoint?: outputs.m365securityandcompliance.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.m365securityandcompliance.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Required property for system data */ systemData: outputs.m365securityandcompliance.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The Private Endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * An access policy entry. */ interface ServiceAccessPolicyEntryResponse { /** * An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. */ objectId: string; } /** * Authentication configuration information */ interface ServiceAuthenticationConfigurationInfoResponse { /** * The audience url for the service */ audience?: string; /** * The authority url for the service */ authority?: string; /** * If the SMART on FHIR proxy is enabled */ smartProxyEnabled?: boolean; } /** * The settings for the CORS configuration of the service instance. */ interface ServiceCorsConfigurationInfoResponse { /** * If credentials are allowed via CORS. */ allowCredentials?: boolean; /** * The headers to be allowed via CORS. */ headers?: string[]; /** * The max age to be allowed via CORS. */ maxAge?: number; /** * The methods to be allowed via CORS. */ methods?: string[]; /** * The origins to be allowed via CORS. */ origins?: string[]; } /** * The settings for the Cosmos DB database backing the service. */ interface ServiceCosmosDbConfigurationInfoResponse { /** * The URI of the customer-managed key for the backing database. */ keyVaultKeyUri?: string; /** * The provisioned throughput for the backing database. */ offerThroughput?: number; } /** * Export operation configuration information */ interface ServiceExportConfigurationInfoResponse { /** * The name of the default export storage account. */ storageAccountName?: string; } /** * The properties of a service instance. */ interface ServicesPropertiesResponse { /** * The access policies of the service instance. */ accessPolicies?: outputs.m365securityandcompliance.ServiceAccessPolicyEntryResponse[]; /** * The authentication configuration for the service instance. */ authenticationConfiguration?: outputs.m365securityandcompliance.ServiceAuthenticationConfigurationInfoResponse; /** * The settings for the CORS configuration of the service instance. */ corsConfiguration?: outputs.m365securityandcompliance.ServiceCorsConfigurationInfoResponse; /** * The settings for the Cosmos DB database backing the service. */ cosmosDbConfiguration?: outputs.m365securityandcompliance.ServiceCosmosDbConfigurationInfoResponse; /** * The settings for the export operation of the service instance. */ exportConfiguration?: outputs.m365securityandcompliance.ServiceExportConfigurationInfoResponse; /** * The list of private endpoint connections that are set up for this resource. */ privateEndpointConnections?: outputs.m365securityandcompliance.PrivateEndpointConnectionResponse[]; /** * The provisioning state. */ provisioningState: string; /** * Control permission for data plane traffic coming from public networks while private endpoint is enabled. */ publicNetworkAccess?: string; } /** * Setting indicating whether the service has a managed identity associated with it. */ interface ServicesResourceResponseIdentity { /** * The principal ID of the resource identity. */ principalId: string; /** * The tenant ID of the resource. */ tenantId: string; /** * Type of identity being specified, currently SystemAssigned and None are allowed. */ type?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace machinelearning { /** * Sku of the resource */ interface SkuResponse { /** * Name of the sku */ name?: string; /** * Tier of the sku like Basic or Enterprise */ tier?: string; } } export declare namespace machinelearningservices { /** * This connection type covers the AAD auth for any applicable Azure service */ interface AADAuthTypeWorkspaceConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'AAD'. */ authType: "AAD"; /** * Category of the connection */ category?: string; /** * A type definition that refers the id to an Azure Resource Manager resource. */ createdByWorkspaceArmId: string; error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; peRequirement?: string; peStatus?: string; sharedUserList?: string[]; target?: string; useWorkspaceManagedIdentity?: boolean; } /** * A Machine Learning compute based on AKS. */ interface AKSResponse { /** * Location for the underlying compute */ computeLocation?: string; /** * The type of compute * Expected value is 'AKS'. */ computeType: "AKS"; /** * The time at which the compute was created. */ createdOn: string; /** * The description of the Machine Learning compute. */ description?: string; /** * Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. */ disableLocalAuth?: boolean; /** * Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. */ isAttachedCompute: boolean; /** * The time at which the compute was last modified. */ modifiedOn: string; /** * AKS properties */ properties?: outputs.machinelearningservices.AKSSchemaPropertiesResponse; /** * Errors during provisioning */ provisioningErrors: outputs.machinelearningservices.ErrorResponseResponse[]; /** * The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. */ provisioningState: string; /** * ARM resource id of the underlying compute */ resourceId?: string; } /** * aksresponseProvideDefaults sets the appropriate defaults for AKSResponse */ function aksresponseProvideDefaults(val: AKSResponse): AKSResponse; /** * AKS properties */ interface AKSSchemaPropertiesResponse { /** * Number of agents */ agentCount?: number; /** * Agent virtual machine size */ agentVmSize?: string; /** * AKS networking configuration for vnet */ aksNetworkingConfiguration?: outputs.machinelearningservices.AksNetworkingConfigurationResponse; /** * Cluster full qualified domain name */ clusterFqdn?: string; /** * Intended usage of the cluster */ clusterPurpose?: string; /** * Load Balancer Subnet */ loadBalancerSubnet?: string; /** * Load Balancer Type */ loadBalancerType?: string; /** * SSL configuration */ sslConfiguration?: outputs.machinelearningservices.SslConfigurationResponse; /** * System services */ systemServices: outputs.machinelearningservices.SystemServiceResponse[]; } /** * aksschemaPropertiesResponseProvideDefaults sets the appropriate defaults for AKSSchemaPropertiesResponse */ function aksschemaPropertiesResponseProvideDefaults(val: AKSSchemaPropertiesResponse): AKSSchemaPropertiesResponse; interface AccessKeyAuthTypeWorkspaceConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'AccessKey'. */ authType: "AccessKey"; /** * Category of the connection */ category?: string; /** * A type definition that refers the id to an Azure Resource Manager resource. */ createdByWorkspaceArmId: string; credentials?: outputs.machinelearningservices.WorkspaceConnectionAccessKeyResponse; error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; peRequirement?: string; peStatus?: string; sharedUserList?: string[]; target?: string; useWorkspaceManagedIdentity?: boolean; } interface AccountApiKeysResponse { key1?: string; key2?: string; } /** * This connection type covers the account key connection for Azure storage */ interface AccountKeyAuthTypeWorkspaceConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'AccountKey'. */ authType: "AccountKey"; /** * Category of the connection */ category?: string; /** * A type definition that refers the id to an Azure Resource Manager resource. */ createdByWorkspaceArmId: string; /** * Account key object for workspace connection credential. */ credentials?: outputs.machinelearningservices.WorkspaceConnectionAccountKeyResponse; error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; peRequirement?: string; peStatus?: string; sharedUserList?: string[]; target?: string; useWorkspaceManagedIdentity?: boolean; } /** * Account key datastore credentials configuration. */ interface AccountKeyDatastoreCredentialsResponse { /** * Enum to determine the datastore credentials type. * Expected value is 'AccountKey'. */ credentialsType: "AccountKey"; } /** * Details of ACR account to be used for the Registry */ interface AcrDetailsResponse { /** * Details of system created ACR account to be used for the Registry */ systemCreatedAcrAccount?: outputs.machinelearningservices.SystemCreatedAcrAccountResponse; } interface ActualCapacityInfoResponse { /** * Gets or sets the number of instances (scale units) which have Failed provisioning state and have target group payload. */ failed?: number; /** * Gets or sets the number of instances (scale units) which have Failed provisioning state but do not have target group payload. */ outdatedFailed?: number; /** * Gets or sets the number of instances (scale units) which have Succeeded provisioning state but do not have target group payload. */ outdatedSucceeded?: number; /** * Gets or sets the number of instances (scale units) which have Succeeded provisioning state and target group payload. */ succeeded?: number; /** * Gets or sets the total number of instances (scale units) regardless of provisioning state or whether current group payload version matches the target group payload. */ total?: number; } /** * actualCapacityInfoResponseProvideDefaults sets the appropriate defaults for ActualCapacityInfoResponse */ function actualCapacityInfoResponseProvideDefaults(val: ActualCapacityInfoResponse): ActualCapacityInfoResponse; /** * Advance configuration for AKS networking */ interface AksNetworkingConfigurationResponse { /** * An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr. */ dnsServiceIP?: string; /** * A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range. */ dockerBridgeCidr?: string; /** * A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges. */ serviceCidr?: string; /** * Virtual network subnet resource ID the compute nodes belong to */ subnetId?: string; } interface AllFeaturesResponse { /** * Expected value is 'AllFeatures'. */ filterType: "AllFeatures"; } /** * All nodes means the service will be running on all of the nodes of the job */ interface AllNodesResponse { /** * The enumerated types for the nodes value * Expected value is 'All'. */ nodesValueType: "All"; } /** * Compute node information related to a AmlCompute. */ interface AmlComputeNodeInformationResponse { /** * ID of the compute node. */ nodeId: string; /** * State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted. */ nodeState: string; /** * SSH port number of the node. */ port: number; /** * Private IP address of the compute node. */ privateIpAddress: string; /** * Public IP address of the compute node. */ publicIpAddress: string; /** * ID of the Experiment running on the node, if any else null. */ runId: string; } /** * AML Compute properties */ interface AmlComputePropertiesResponse { /** * Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute. */ allocationState: string; /** * The time at which the compute entered its current allocation state. */ allocationStateTransitionTime: string; /** * The number of compute nodes currently assigned to the compute. */ currentNodeCount: number; /** * Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs. */ enableNodePublicIp?: boolean; /** * Collection of errors encountered by various compute nodes during node setup. */ errors: outputs.machinelearningservices.ErrorResponseResponse[]; /** * Network is isolated or not */ isolatedNetwork?: boolean; /** * Counts of various node states on the compute. */ nodeStateCounts: outputs.machinelearningservices.NodeStateCountsResponse; /** * Compute OS Type */ osType?: string; /** * A property bag containing additional properties. */ propertyBag?: any; /** * State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled. */ remoteLoginPortPublicAccess?: string; /** * Scale settings for AML Compute */ scaleSettings?: outputs.machinelearningservices.ScaleSettingsResponse; /** * Virtual network subnet resource ID the compute nodes belong to. */ subnet?: outputs.machinelearningservices.ResourceIdResponse; /** * The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation. */ targetNodeCount: number; /** * Credentials for an administrator user account that will be created on each compute node. */ userAccountCredentials?: outputs.machinelearningservices.UserAccountCredentialsResponse; /** * Virtual Machine image for AML Compute - windows only */ virtualMachineImage?: outputs.machinelearningservices.VirtualMachineImageResponse; /** * Virtual Machine priority */ vmPriority?: string; /** * Virtual Machine Size */ vmSize?: string; } /** * amlComputePropertiesResponseProvideDefaults sets the appropriate defaults for AmlComputePropertiesResponse */ function amlComputePropertiesResponseProvideDefaults(val: AmlComputePropertiesResponse): AmlComputePropertiesResponse; /** * An Azure Machine Learning compute. */ interface AmlComputeResponse { /** * Location for the underlying compute */ computeLocation?: string; /** * The type of compute * Expected value is 'AmlCompute'. */ computeType: "AmlCompute"; /** * The time at which the compute was created. */ createdOn: string; /** * The description of the Machine Learning compute. */ description?: string; /** * Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. */ disableLocalAuth?: boolean; /** * Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. */ isAttachedCompute: boolean; /** * The time at which the compute was last modified. */ modifiedOn: string; /** * Properties of AmlCompute */ properties?: outputs.machinelearningservices.AmlComputePropertiesResponse; /** * Errors during provisioning */ provisioningErrors: outputs.machinelearningservices.ErrorResponseResponse[]; /** * The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. */ provisioningState: string; /** * ARM resource id of the underlying compute */ resourceId?: string; } /** * amlComputeResponseProvideDefaults sets the appropriate defaults for AmlComputeResponse */ function amlComputeResponseProvideDefaults(val: AmlComputeResponse): AmlComputeResponse; /** * AML token compute identity definition. */ interface AmlTokenComputeIdentityResponse { /** * Monitor compute identity type enum. * Expected value is 'AmlToken'. */ computeIdentityType: "AmlToken"; } /** * AML Token identity configuration. */ interface AmlTokenResponse { /** * Enum to determine identity framework. * Expected value is 'AMLToken'. */ identityType: "AMLToken"; } /** * This connection type covers the generic ApiKey auth connection categories, for examples: * AzureOpenAI: * Category:= AzureOpenAI * AuthType:= ApiKey (as type discriminator) * Credentials:= {ApiKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey * Target:= {ApiBase} * * CognitiveService: * Category:= CognitiveService * AuthType:= ApiKey (as type discriminator) * Credentials:= {SubscriptionKey} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey * Target:= ServiceRegion={serviceRegion} * * CognitiveSearch: * Category:= CognitiveSearch * AuthType:= ApiKey (as type discriminator) * Credentials:= {Key} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.ApiKey * Target:= {Endpoint} * * Use Metadata property bag for ApiType, ApiVersion, Kind and other metadata fields */ interface ApiKeyAuthWorkspaceConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'ApiKey'. */ authType: "ApiKey"; /** * Category of the connection */ category?: string; /** * A type definition that refers the id to an Azure Resource Manager resource. */ createdByWorkspaceArmId: string; /** * Api key object for workspace connection credential. */ credentials?: outputs.machinelearningservices.WorkspaceConnectionApiKeyResponse; error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; peRequirement?: string; peStatus?: string; sharedUserList?: string[]; target?: string; useWorkspaceManagedIdentity?: boolean; } /** * ARM ResourceId of a resource */ interface ArmResourceIdResponse { /** * Arm ResourceId is in the format "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Storage/storageAccounts/{StorageAccountName}" * or "/subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.ContainerRegistry/registries/{AcrName}" */ resourceId?: string; } /** * A user that can be assigned to a compute instance. */ interface AssignedUserResponse { /** * User’s AAD Object Id. */ objectId: string; /** * User’s AAD Tenant Id. */ tenantId: string; } /** * Forecast horizon determined automatically by system. */ interface AutoForecastHorizonResponse { /** * Enum to determine forecast horizon selection mode. * Expected value is 'Auto'. */ mode: "Auto"; } /** * AutoMLJob class. * Use this class for executing AutoML tasks like Classification/Regression etc. * See TaskType enum for all the tasks supported. */ interface AutoMLJobResponse { /** * ARM resource ID of the component resource. */ componentId?: string; /** * ARM resource ID of the compute resource. */ computeId?: string; /** * The asset description text. */ description?: string; /** * Display name of job. */ displayName?: string; /** * The ARM resource ID of the Environment specification for the job. * This is optional value to provide, if not provided, AutoML will default this to Production AutoML curated environment version when running the job. */ environmentId?: string; /** * Environment variables included in the job. */ environmentVariables?: { [key: string]: string; }; /** * The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment. */ experimentName?: string; /** * Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. * Defaults to AmlToken if null. */ identity?: outputs.machinelearningservices.AmlTokenResponse | outputs.machinelearningservices.ManagedIdentityResponse | outputs.machinelearningservices.UserIdentityResponse; /** * Is the asset archived? */ isArchived?: boolean; /** * Enum to determine the type of job. * Expected value is 'AutoML'. */ jobType: "AutoML"; /** * Notification setting for the job */ notificationSetting?: outputs.machinelearningservices.NotificationSettingResponse; /** * Mapping of output data bindings used in the job. */ outputs?: { [key: string]: outputs.machinelearningservices.CustomModelJobOutputResponse | outputs.machinelearningservices.MLFlowModelJobOutputResponse | outputs.machinelearningservices.MLTableJobOutputResponse | outputs.machinelearningservices.TritonModelJobOutputResponse | outputs.machinelearningservices.UriFileJobOutputResponse | outputs.machinelearningservices.UriFolderJobOutputResponse; }; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Queue settings for the job */ queueSettings?: outputs.machinelearningservices.QueueSettingsResponse; /** * Compute Resource configuration for the job. */ resources?: outputs.machinelearningservices.JobResourceConfigurationResponse; /** * List of JobEndpoints. * For local jobs, a job endpoint will have an endpoint value of FileStreamObject. */ services?: { [key: string]: outputs.machinelearningservices.JobServiceResponse; }; /** * Status of the job. */ status: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; /** * [Required] This represents scenario which can be one of Tables/NLP/Image */ taskDetails: outputs.machinelearningservices.ClassificationResponse | outputs.machinelearningservices.ForecastingResponse | outputs.machinelearningservices.ImageClassificationResponse | outputs.machinelearningservices.ImageClassificationMultilabelResponse | outputs.machinelearningservices.ImageInstanceSegmentationResponse | outputs.machinelearningservices.ImageObjectDetectionResponse | outputs.machinelearningservices.RegressionResponse | outputs.machinelearningservices.TextClassificationResponse | outputs.machinelearningservices.TextClassificationMultilabelResponse | outputs.machinelearningservices.TextNerResponse; } /** * autoMLJobResponseProvideDefaults sets the appropriate defaults for AutoMLJobResponse */ function autoMLJobResponseProvideDefaults(val: AutoMLJobResponse): AutoMLJobResponse; /** * N-Cross validations determined automatically. */ interface AutoNCrossValidationsResponse { /** * Determines how N-Cross validations value is determined. * Expected value is 'Auto'. */ mode: "Auto"; } /** * Auto pause properties */ interface AutoPausePropertiesResponse { delayInMinutes?: number; enabled?: boolean; } /** * Auto scale properties */ interface AutoScalePropertiesResponse { enabled?: boolean; maxNodeCount?: number; minNodeCount?: number; } interface AutoSeasonalityResponse { /** * Forecasting seasonality mode. * Expected value is 'Auto'. */ mode: "Auto"; } interface AutoTargetLagsResponse { /** * Target lags selection modes. * Expected value is 'Auto'. */ mode: "Auto"; } /** * Target lags rolling window determined automatically. */ interface AutoTargetRollingWindowSizeResponse { /** * Target rolling windows size mode. * Expected value is 'Auto'. */ mode: "Auto"; } /** * Azure Blob datastore configuration. */ interface AzureBlobDatastoreResponse { /** * Storage account name. */ accountName?: string; /** * Storage account container name. */ containerName?: string; /** * [Required] Account credentials. */ credentials: outputs.machinelearningservices.AccountKeyDatastoreCredentialsResponse | outputs.machinelearningservices.CertificateDatastoreCredentialsResponse | outputs.machinelearningservices.NoneDatastoreCredentialsResponse | outputs.machinelearningservices.SasDatastoreCredentialsResponse | outputs.machinelearningservices.ServicePrincipalDatastoreCredentialsResponse; /** * Enum to determine the datastore contents type. * Expected value is 'AzureBlob'. */ datastoreType: "AzureBlob"; /** * The asset description text. */ description?: string; /** * Azure cloud endpoint for the storage account. */ endpoint?: string; /** * Readonly property to indicate if datastore is the workspace default datastore */ isDefault: boolean; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Protocol used to communicate with the storage account. */ protocol?: string; /** * Azure Resource Group name */ resourceGroup?: string; /** * Indicates which identity to use to authenticate service data access to customer's storage. */ serviceDataAccessAuthIdentity?: string; /** * Azure Subscription Id */ subscriptionId?: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * azureBlobDatastoreResponseProvideDefaults sets the appropriate defaults for AzureBlobDatastoreResponse */ function azureBlobDatastoreResponseProvideDefaults(val: AzureBlobDatastoreResponse): AzureBlobDatastoreResponse; /** * Azure Data Lake Gen1 datastore configuration. */ interface AzureDataLakeGen1DatastoreResponse { /** * [Required] Account credentials. */ credentials: outputs.machinelearningservices.AccountKeyDatastoreCredentialsResponse | outputs.machinelearningservices.CertificateDatastoreCredentialsResponse | outputs.machinelearningservices.NoneDatastoreCredentialsResponse | outputs.machinelearningservices.SasDatastoreCredentialsResponse | outputs.machinelearningservices.ServicePrincipalDatastoreCredentialsResponse; /** * Enum to determine the datastore contents type. * Expected value is 'AzureDataLakeGen1'. */ datastoreType: "AzureDataLakeGen1"; /** * The asset description text. */ description?: string; /** * Readonly property to indicate if datastore is the workspace default datastore */ isDefault: boolean; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Azure Resource Group name */ resourceGroup?: string; /** * Indicates which identity to use to authenticate service data access to customer's storage. */ serviceDataAccessAuthIdentity?: string; /** * [Required] Azure Data Lake store name. */ storeName: string; /** * Azure Subscription Id */ subscriptionId?: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * azureDataLakeGen1DatastoreResponseProvideDefaults sets the appropriate defaults for AzureDataLakeGen1DatastoreResponse */ function azureDataLakeGen1DatastoreResponseProvideDefaults(val: AzureDataLakeGen1DatastoreResponse): AzureDataLakeGen1DatastoreResponse; /** * Azure Data Lake Gen2 datastore configuration. */ interface AzureDataLakeGen2DatastoreResponse { /** * [Required] Storage account name. */ accountName: string; /** * [Required] Account credentials. */ credentials: outputs.machinelearningservices.AccountKeyDatastoreCredentialsResponse | outputs.machinelearningservices.CertificateDatastoreCredentialsResponse | outputs.machinelearningservices.NoneDatastoreCredentialsResponse | outputs.machinelearningservices.SasDatastoreCredentialsResponse | outputs.machinelearningservices.ServicePrincipalDatastoreCredentialsResponse; /** * Enum to determine the datastore contents type. * Expected value is 'AzureDataLakeGen2'. */ datastoreType: "AzureDataLakeGen2"; /** * The asset description text. */ description?: string; /** * Azure cloud endpoint for the storage account. */ endpoint?: string; /** * [Required] The name of the Data Lake Gen2 filesystem. */ filesystem: string; /** * Readonly property to indicate if datastore is the workspace default datastore */ isDefault: boolean; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Protocol used to communicate with the storage account. */ protocol?: string; /** * Azure Resource Group name */ resourceGroup?: string; /** * Indicates which identity to use to authenticate service data access to customer's storage. */ serviceDataAccessAuthIdentity?: string; /** * Azure Subscription Id */ subscriptionId?: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * azureDataLakeGen2DatastoreResponseProvideDefaults sets the appropriate defaults for AzureDataLakeGen2DatastoreResponse */ function azureDataLakeGen2DatastoreResponseProvideDefaults(val: AzureDataLakeGen2DatastoreResponse): AzureDataLakeGen2DatastoreResponse; interface AzureDataLakeSectionResponse { /** * The authority URL used for authentication. */ authorityUrl?: string; /** * The content of the certificate used for authentication. */ certificate?: string; /** * The Client ID/Application ID */ clientId?: string; /** * The client secret. */ clientSecret?: string; /** * The Azure Data Lake credential type. */ credentialType?: string; /** * Is it using certificate to authenticate. If false then use client secret. */ isCertAuth?: boolean; /** * Resource Group. */ resourceGroup?: string; /** * The resource the service principal/app has access to. */ resourceUri?: string; /** * Indicates which identity to use to authenticate service data access to customer's storage. */ serviceDataAccessAuthIdentity?: string; /** * The Azure Data Lake store name. */ storeName?: string; /** * Subscription ID. */ subscriptionId?: string; /** * The ID of the tenant the service principal/app belongs to. */ tenantId?: string; /** * The thumbprint of the certificate above. */ thumbprint?: string; } /** * Webhook details specific for Azure DevOps */ interface AzureDevOpsWebhookResponse { /** * Send callback on a specified notification event */ eventType?: string; /** * Enum to determine the webhook callback service type. * Expected value is 'AzureDevOps'. */ webhookType: "AzureDevOps"; } /** * Azure File datastore configuration. */ interface AzureFileDatastoreResponse { /** * [Required] Storage account name. */ accountName: string; /** * [Required] Account credentials. */ credentials: outputs.machinelearningservices.AccountKeyDatastoreCredentialsResponse | outputs.machinelearningservices.CertificateDatastoreCredentialsResponse | outputs.machinelearningservices.NoneDatastoreCredentialsResponse | outputs.machinelearningservices.SasDatastoreCredentialsResponse | outputs.machinelearningservices.ServicePrincipalDatastoreCredentialsResponse; /** * Enum to determine the datastore contents type. * Expected value is 'AzureFile'. */ datastoreType: "AzureFile"; /** * The asset description text. */ description?: string; /** * Azure cloud endpoint for the storage account. */ endpoint?: string; /** * [Required] The name of the Azure file share that the datastore points to. */ fileShareName: string; /** * Readonly property to indicate if datastore is the workspace default datastore */ isDefault: boolean; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Protocol used to communicate with the storage account. */ protocol?: string; /** * Azure Resource Group name */ resourceGroup?: string; /** * Indicates which identity to use to authenticate service data access to customer's storage. */ serviceDataAccessAuthIdentity?: string; /** * Azure Subscription Id */ subscriptionId?: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * azureFileDatastoreResponseProvideDefaults sets the appropriate defaults for AzureFileDatastoreResponse */ function azureFileDatastoreResponseProvideDefaults(val: AzureFileDatastoreResponse): AzureFileDatastoreResponse; interface AzureMySqlSectionResponse { /** * The authority URL used for authentication. */ authorityUrl?: string; /** * The content of the certificate used for authentication. */ certificate?: string; /** * The Client ID/Application ID */ clientId?: string; /** * The client secret. */ clientSecret?: string; /** * Sql Authentication type. */ credentialType?: string; /** * The Azure SQL database name. */ databaseName?: string; /** * The server host endpoint. */ endpoint?: string; /** * Is it using certificate to authenticate. If false then use client secret. */ isCertAuth?: boolean; /** * / The Azure SQL port number. */ portNumber?: string; /** * Resource Group. */ resourceGroup?: string; /** * The resource the service principal/app has access to. */ resourceUri?: string; /** * The Azure SQL server name. */ serverName?: string; /** * Indicates which identity to use to authenticate service data access to customer's storage. */ serviceDataAccessAuthIdentity?: string; /** * Subscription ID. */ subscriptionId?: string; /** * The ID of the tenant the service principal/app belongs to. */ tenantId?: string; /** * The thumbprint of the certificate above. */ thumbprint?: string; /** * The Azure SQL user id. */ userId?: string; /** * The Azure SQL user password. */ userPassword?: string; } interface AzurePostgreSqlSectionResponse { /** * The authority URL used for authentication. */ authorityUrl?: string; /** * The content of the certificate used for authentication. */ certificate?: string; /** * The Client ID/Application ID */ clientId?: string; /** * The client secret. */ clientSecret?: string; /** * Sql Authentication type. */ credentialType?: string; /** * The Azure SQL database name. */ databaseName?: string; /** * Indicates SSL requirement of Azure Postgresql server. */ enableSsl?: boolean; /** * The server host endpoint. */ endpoint?: string; /** * Is it using certificate to authenticate. If false then use client secret. */ isCertAuth?: boolean; /** * / The Azure SQL port number. */ portNumber?: string; /** * Resource Group. */ resourceGroup?: string; /** * The resource the service principal/app has access to. */ resourceUri?: string; /** * The Azure SQL server name. */ serverName?: string; /** * Indicates which identity to use to authenticate service data access to customer's storage. */ serviceDataAccessAuthIdentity?: string; /** * Subscription ID. */ subscriptionId?: string; /** * The ID of the tenant the service principal/app belongs to. */ tenantId?: string; /** * The thumbprint of the certificate above. */ thumbprint?: string; /** * The Azure SQL user id. */ userId?: string; /** * The Azure SQL user password. */ userPassword?: string; } interface AzureSqlDatabaseSectionResponse { /** * The authority URL used for authentication. */ authorityUrl?: string; /** * The content of the certificate used for authentication. */ certificate?: string; /** * The Client ID/Application ID */ clientId?: string; /** * The client secret. */ clientSecret?: string; /** * Sql Authentication type. */ credentialType?: string; /** * The Azure SQL database name. */ databaseName?: string; /** * The server host endpoint. */ endpoint?: string; /** * Is it using certificate to authenticate. If false then use client secret. */ isCertAuth?: boolean; /** * / The Azure SQL port number. */ portNumber?: string; /** * Resource Group. */ resourceGroup?: string; /** * The resource the service principal/app has access to. */ resourceUri?: string; /** * The Azure SQL server name. */ serverName?: string; /** * Indicates which identity to use to authenticate service data access to customer's storage. */ serviceDataAccessAuthIdentity?: string; /** * Subscription ID. */ subscriptionId?: string; /** * The ID of the tenant the service principal/app belongs to. */ tenantId?: string; /** * The thumbprint of the certificate above. */ thumbprint?: string; /** * The Azure SQL user id. */ userId?: string; /** * The Azure SQL user password. */ userPassword?: string; } interface AzureStorageSectionResponse { /** * Storage Account Key (Deprecated). */ accountKey?: string; /** * Storage Account Name. */ accountName?: string; /** * Indicate if we are using Workspace ManagedIdentities/MSI token (Deprecated). */ areWorkspaceManagedIdentitiesAllowed?: boolean; /** * If this is an "DataStoreType.AzureBlob", the length of time (in seconds) to cache files locally after they are accessed (downloaded). */ blobCacheTimeout?: number; clientCredentials?: outputs.machinelearningservices.ClientCredentialsResponse; /** * The storage container name. */ containerName?: string; /** * The credential. */ credential?: string; /** * The credential type. */ credentialType?: string; /** * The host of the container. */ endpoint?: string; /** * Indicate if we are using SAS token or Account Key (Deprecated). */ isSas?: boolean; /** * The protocol to use. Defaults to https. */ protocol?: string; /** * Resource Group. */ resourceGroup?: string; /** * SAS Token for the container (Deprecated). */ sasToken?: string; /** * Indicates which identity to use to authenticate service data access to customer's storage. */ serviceDataAccessAuthIdentity?: string; /** * Subscription ID. */ subscriptionId?: string; } /** * Defines an early termination policy based on slack criteria, and a frequency and delay interval for evaluation */ interface BanditPolicyResponse { /** * Number of intervals by which to delay the first evaluation. */ delayEvaluation?: number; /** * Interval (number of runs) between policy evaluations. */ evaluationInterval?: number; /** * Expected value is 'Bandit'. */ policyType: "Bandit"; /** * Absolute distance allowed from the best performing run. */ slackAmount?: number; /** * Ratio of the allowed distance from the best performing run. */ slackFactor?: number; } /** * banditPolicyResponseProvideDefaults sets the appropriate defaults for BanditPolicyResponse */ function banditPolicyResponseProvideDefaults(val: BanditPolicyResponse): BanditPolicyResponse; /** * Batch inference settings per deployment. */ interface BatchDeploymentPropertiesResponse { /** * Code configuration for the endpoint deployment. */ codeConfiguration?: outputs.machinelearningservices.CodeConfigurationResponse; /** * Compute target for batch inference operation. */ compute?: string; /** * Properties relevant to different deployment types. */ deploymentConfiguration?: outputs.machinelearningservices.BatchPipelineComponentDeploymentConfigurationResponse; /** * Description of the endpoint deployment. */ description?: string; /** * ARM resource ID or AssetId of the environment specification for the endpoint deployment. */ environmentId?: string; /** * Environment variables configuration for the deployment. */ environmentVariables?: { [key: string]: string; }; /** * Error threshold, if the error count for the entire input goes above this value, * the batch inference will be aborted. Range is [-1, int.MaxValue]. * For FileDataset, this value is the count of file failures. * For TabularDataset, this value is the count of record failures. * If set to -1 (the lower bound), all failures during batch inference will be ignored. */ errorThreshold?: number; /** * Log verbosity for batch inferencing. * Increasing verbosity order for logging is : Warning, Info and Debug. * The default value is Info. */ loggingLevel?: string; /** * Indicates maximum number of parallelism per instance. */ maxConcurrencyPerInstance?: number; /** * Size of the mini-batch passed to each batch invocation. * For FileDataset, this is the number of files per mini-batch. * For TabularDataset, this is the size of the records in bytes, per mini-batch. */ miniBatchSize?: number; /** * Reference to the model asset for the endpoint deployment. */ model?: outputs.machinelearningservices.DataPathAssetReferenceResponse | outputs.machinelearningservices.IdAssetReferenceResponse | outputs.machinelearningservices.OutputPathAssetReferenceResponse; /** * Enum to determine how batch inferencing will handle output */ outputAction?: string; /** * Customized output file name for append_row output action. */ outputFileName?: string; /** * Property dictionary. Properties can be added, but not removed or altered. */ properties?: { [key: string]: string; }; /** * Provisioning state for the endpoint deployment. */ provisioningState: string; /** * Indicates compute configuration for the job. * If not provided, will default to the defaults defined in ResourceConfiguration. */ resources?: outputs.machinelearningservices.DeploymentResourceConfigurationResponse; /** * Retry Settings for the batch inference operation. * If not provided, will default to the defaults defined in BatchRetrySettings. */ retrySettings?: outputs.machinelearningservices.BatchRetrySettingsResponse; } /** * batchDeploymentPropertiesResponseProvideDefaults sets the appropriate defaults for BatchDeploymentPropertiesResponse */ function batchDeploymentPropertiesResponseProvideDefaults(val: BatchDeploymentPropertiesResponse): BatchDeploymentPropertiesResponse; /** * Batch endpoint default values */ interface BatchEndpointDefaultsResponse { /** * Name of the deployment that will be default for the endpoint. * This deployment will end up getting 100% traffic when the endpoint scoring URL is invoked. */ deploymentName?: string; } /** * Batch endpoint configuration. */ interface BatchEndpointPropertiesResponse { /** * [Required] The authentication method for invoking the endpoint (data plane operation). Use 'Key' for key-based authentication. Use 'AMLToken' for Azure Machine Learning token-based authentication. Use 'AADToken' for Microsoft Entra token-based authentication. */ authMode: string; /** * Default values for Batch Endpoint */ defaults?: outputs.machinelearningservices.BatchEndpointDefaultsResponse; /** * Description of the inference endpoint. */ description?: string; /** * Property dictionary. Properties can be added, but not removed or altered. */ properties?: { [key: string]: string; }; /** * Provisioning state for the endpoint. */ provisioningState: string; /** * Endpoint URI. */ scoringUri: string; /** * Endpoint Swagger URI. */ swaggerUri: string; } /** * Properties for a Batch Pipeline Component Deployment. */ interface BatchPipelineComponentDeploymentConfigurationResponse { /** * The ARM id of the component to be run. */ componentId?: outputs.machinelearningservices.IdAssetReferenceResponse; /** * The enumerated property types for batch deployments. * Expected value is 'PipelineComponent'. */ deploymentConfigurationType: "PipelineComponent"; /** * The description which will be applied to the job. */ description?: string; /** * Run-time settings for the pipeline job. */ settings?: { [key: string]: string; }; /** * The tags which will be applied to the job. */ tags?: { [key: string]: string; }; } /** * Retry settings for a batch inference operation. */ interface BatchRetrySettingsResponse { /** * Maximum retry count for a mini-batch */ maxRetries?: number; /** * Invocation timeout for a mini-batch, in ISO 8601 format. */ timeout?: string; } /** * batchRetrySettingsResponseProvideDefaults sets the appropriate defaults for BatchRetrySettingsResponse */ function batchRetrySettingsResponseProvideDefaults(val: BatchRetrySettingsResponse): BatchRetrySettingsResponse; /** * Defines a Sampling Algorithm that generates values based on previous values */ interface BayesianSamplingAlgorithmResponse { /** * Expected value is 'Bayesian'. */ samplingAlgorithmType: "Bayesian"; } interface BindOptionsResponse { /** * Indicate whether to create host path. */ createHostPath?: boolean; /** * Type of Bind Option */ propagation?: string; /** * Mention the selinux options. */ selinux?: string; } /** * Configuration settings for Docker build context */ interface BuildContextResponse { /** * [Required] URI of the Docker build context used to build the image. Supports blob URIs on environment creation and may return blob or Git URIs. * */ contextUri: string; /** * Path to the Dockerfile in the build context. * */ dockerfilePath?: string; } /** * buildContextResponseProvideDefaults sets the appropriate defaults for BuildContextResponse */ function buildContextResponseProvideDefaults(val: BuildContextResponse): BuildContextResponse; interface CapabilityHostPropertiesResponse { /** * List of Aca Environment connections. */ acaEnvironmentConnections?: string[]; /** * List of AI services connections. */ aiServicesConnections?: string[]; /** * Kind of this capability host. */ capabilityHostKind?: string; /** * Customer subnet info to help set up this capability host. */ customerSubnet?: string; /** * The asset description text. */ description?: string; /** * List of messages containing errors. */ messages: string[]; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Provisioning state for the CapabilityHost. */ provisioningState: string; /** * List of Storage connections. */ storageConnections?: string[]; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; /** * List of Thread storage connections. */ threadStorageConnections?: string[]; /** * List of VectorStore connections. */ vectorStoreConnections?: string[]; } /** * capabilityHostPropertiesResponseProvideDefaults sets the appropriate defaults for CapabilityHostPropertiesResponse */ function capabilityHostPropertiesResponseProvideDefaults(val: CapabilityHostPropertiesResponse): CapabilityHostPropertiesResponse; interface CapacityReservationGroupResponse { /** * Offer used by this capacity reservation group. */ offer?: outputs.machinelearningservices.ServerlessOfferResponse; /** * [Required] Specifies the amount of capacity to reserve. */ reservedCapacity: number; } interface CategoricalDataDriftMetricThresholdResponse { /** * Expected value is 'Categorical'. */ dataType: "Categorical"; /** * [Required] The categorical data drift metric to calculate. */ metric: string; /** * The threshold value. If null, a default value will be set depending on the selected metric. */ threshold?: outputs.machinelearningservices.MonitoringThresholdResponse; } interface CategoricalDataQualityMetricThresholdResponse { /** * Expected value is 'Categorical'. */ dataType: "Categorical"; /** * [Required] The categorical data quality metric to calculate. */ metric: string; /** * The threshold value. If null, a default value will be set depending on the selected metric. */ threshold?: outputs.machinelearningservices.MonitoringThresholdResponse; } interface CategoricalPredictionDriftMetricThresholdResponse { /** * Expected value is 'Categorical'. */ dataType: "Categorical"; /** * [Required] The categorical prediction drift metric to calculate. */ metric: string; /** * The threshold value. If null, a default value will be set depending on the selected metric. */ threshold?: outputs.machinelearningservices.MonitoringThresholdResponse; } /** * Certificate datastore credentials configuration. */ interface CertificateDatastoreCredentialsResponse { /** * Authority URL used for authentication. */ authorityUrl?: string; /** * [Required] Service principal client ID. */ clientId: string; /** * Enum to determine the datastore credentials type. * Expected value is 'Certificate'. */ credentialsType: "Certificate"; /** * Resource the service principal has access to. */ resourceUrl?: string; /** * [Required] ID of the tenant to which the service principal belongs. */ tenantId: string; /** * [Required] Thumbprint of the certificate used for authentication. */ thumbprint: string; } /** * Classification task in AutoML Table vertical. */ interface ClassificationResponse { /** * Columns to use for CVSplit data. */ cvSplitColumnNames?: string[]; /** * Featurization inputs needed for AutoML job. */ featurizationSettings?: outputs.machinelearningservices.TableVerticalFeaturizationSettingsResponse; /** * Execution constraints for AutoMLJob. */ limitSettings?: outputs.machinelearningservices.TableVerticalLimitSettingsResponse; /** * Enum for setting log verbosity. */ logVerbosity?: string; /** * Number of cross validation folds to be applied on training dataset * when validation dataset is not provided. */ nCrossValidations?: outputs.machinelearningservices.AutoNCrossValidationsResponse | outputs.machinelearningservices.CustomNCrossValidationsResponse; /** * Positive label for binary metrics calculation. */ positiveLabel?: string; /** * Primary metrics for classification tasks. */ primaryMetric?: string; /** * Target column name: This is prediction values column. * Also known as label column name in context of classification tasks. */ targetColumnName?: string; /** * AutoMLJob Task type. * Expected value is 'Classification'. */ taskType: "Classification"; /** * Test data input. */ testData?: outputs.machinelearningservices.MLTableJobInputResponse; /** * The fraction of test dataset that needs to be set aside for validation purpose. * Values between (0.0 , 1.0) * Applied when validation dataset is not provided. */ testDataSize?: number; /** * [Required] Training data input. */ trainingData: outputs.machinelearningservices.MLTableJobInputResponse; /** * Inputs for training phase for an AutoML Job. */ trainingSettings?: outputs.machinelearningservices.ClassificationTrainingSettingsResponse; /** * Validation data inputs. */ validationData?: outputs.machinelearningservices.MLTableJobInputResponse; /** * The fraction of training dataset that needs to be set aside for validation purpose. * Values between (0.0 , 1.0) * Applied when validation dataset is not provided. */ validationDataSize?: number; /** * The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to be weighted up or down. */ weightColumnName?: string; } /** * classificationResponseProvideDefaults sets the appropriate defaults for ClassificationResponse */ function classificationResponseProvideDefaults(val: ClassificationResponse): ClassificationResponse; /** * Classification Training related configuration. */ interface ClassificationTrainingSettingsResponse { /** * Allowed models for classification task. */ allowedTrainingAlgorithms?: string[]; /** * Blocked models for classification task. */ blockedTrainingAlgorithms?: string[]; /** * Enable recommendation of DNN models. */ enableDnnTraining?: boolean; /** * Flag to turn on explainability on best model. */ enableModelExplainability?: boolean; /** * Flag for enabling onnx compatible models. */ enableOnnxCompatibleModels?: boolean; /** * Enable stack ensemble run. */ enableStackEnsemble?: boolean; /** * Enable voting ensemble run. */ enableVoteEnsemble?: boolean; /** * During VotingEnsemble and StackEnsemble model generation, multiple fitted models from the previous child runs are downloaded. * Configure this parameter with a higher value than 300 secs, if more time is needed. */ ensembleModelDownloadTimeout?: string; /** * Stack ensemble settings for stack ensemble run. */ stackEnsembleSettings?: outputs.machinelearningservices.StackEnsembleSettingsResponse; } /** * classificationTrainingSettingsResponseProvideDefaults sets the appropriate defaults for ClassificationTrainingSettingsResponse */ function classificationTrainingSettingsResponseProvideDefaults(val: ClassificationTrainingSettingsResponse): ClassificationTrainingSettingsResponse; interface ClientCredentialsResponse { /** * The authority URL used for authentication. */ authorityUrl?: string; /** * The content of the certificate used for authentication. */ certificate?: string; /** * The Client ID/Application ID */ clientId?: string; /** * The client secret. */ clientSecret?: string; /** * Is it using certificate to authenticate. If false then use client secret. */ isCertAuth?: boolean; /** * Resource Group. */ resourceGroup?: string; /** * The resource the service principal/app has access to. */ resourceUri?: string; /** * Indicates which identity to use to authenticate service data access to customer's storage. */ serviceDataAccessAuthIdentity?: string; /** * Subscription ID. */ subscriptionId?: string; /** * The ID of the tenant the service principal/app belongs to. */ tenantId?: string; /** * The thumbprint of the certificate above. */ thumbprint?: string; } /** * Configuration for a scoring code asset. */ interface CodeConfigurationResponse { /** * ARM resource ID of the code asset. */ codeId?: string; /** * [Required] The script to execute on startup. eg. "score.py" */ scoringScript: string; } /** * Container for code asset versions. */ interface CodeContainerPropertiesResponse { /** * The asset description text. */ description?: string; /** * Is the asset archived? */ isArchived?: boolean; /** * The latest version inside this container. */ latestVersion: string; /** * The next auto incremental version */ nextVersion: string; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Provisioning state for the code container. */ provisioningState: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * codeContainerPropertiesResponseProvideDefaults sets the appropriate defaults for CodeContainerPropertiesResponse */ function codeContainerPropertiesResponseProvideDefaults(val: CodeContainerPropertiesResponse): CodeContainerPropertiesResponse; /** * Code asset version details. */ interface CodeVersionPropertiesResponse { /** * Uri where code is located */ codeUri?: string; /** * The asset description text. */ description?: string; /** * If the name version are system generated (anonymous registration). */ isAnonymous?: boolean; /** * Is the asset archived? */ isArchived?: boolean; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Provisioning state for the code version. */ provisioningState: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * codeVersionPropertiesResponseProvideDefaults sets the appropriate defaults for CodeVersionPropertiesResponse */ function codeVersionPropertiesResponseProvideDefaults(val: CodeVersionPropertiesResponse): CodeVersionPropertiesResponse; interface CognitiveServicesSkuResponse { capacity?: number; family?: string; name?: string; size?: string; tier?: string; } interface CollectionResponse { /** * The msi client id used to collect logging to blob storage. If it's null,backend will pick a registered endpoint identity to auth. */ clientId?: string; /** * Enable or disable data collection. */ dataCollectionMode?: string; /** * The data asset arm resource id. Client side will ensure data asset is pointing to the blob storage, and backend will collect data to the blob storage. */ dataId?: string; /** * The sampling rate for collection. Sampling rate 1.0 means we collect 100% of data by default. */ samplingRate?: number; } /** * collectionResponseProvideDefaults sets the appropriate defaults for CollectionResponse */ function collectionResponseProvideDefaults(val: CollectionResponse): CollectionResponse; /** * Column transformer parameters. */ interface ColumnTransformerResponse { /** * Fields to apply transformer logic on. */ fields?: string[]; /** * Different properties to be passed to transformer. * Input expected is dictionary of key,value pairs in JSON format. */ parameters?: any; } /** * Command Job limit class. */ interface CommandJobLimitsResponse { /** * Expected value is 'Command'. */ jobLimitsType: "Command"; /** * The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds. */ timeout?: string; } /** * Command job definition. */ interface CommandJobResponse { /** * ARM resource ID of the code asset. */ codeId?: string; /** * [Required] The command to execute on startup of the job. eg. "python train.py" */ command: string; /** * ARM resource ID of the component resource. */ componentId?: string; /** * ARM resource ID of the compute resource. */ computeId?: string; /** * The asset description text. */ description?: string; /** * Display name of job. */ displayName?: string; /** * Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null. */ distribution?: outputs.machinelearningservices.MpiResponse | outputs.machinelearningservices.PyTorchResponse | outputs.machinelearningservices.TensorFlowResponse; /** * [Required] The ARM resource ID of the Environment specification for the job. */ environmentId: string; /** * Environment variables included in the job. */ environmentVariables?: { [key: string]: string; }; /** * The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment. */ experimentName?: string; /** * Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. * Defaults to AmlToken if null. */ identity?: outputs.machinelearningservices.AmlTokenResponse | outputs.machinelearningservices.ManagedIdentityResponse | outputs.machinelearningservices.UserIdentityResponse; /** * Mapping of input data bindings used in the job. */ inputs?: { [key: string]: outputs.machinelearningservices.CustomModelJobInputResponse | outputs.machinelearningservices.LiteralJobInputResponse | outputs.machinelearningservices.MLFlowModelJobInputResponse | outputs.machinelearningservices.MLTableJobInputResponse | outputs.machinelearningservices.TritonModelJobInputResponse | outputs.machinelearningservices.UriFileJobInputResponse | outputs.machinelearningservices.UriFolderJobInputResponse; }; /** * Is the asset archived? */ isArchived?: boolean; /** * Enum to determine the type of job. * Expected value is 'Command'. */ jobType: "Command"; /** * Command Job limit. */ limits?: outputs.machinelearningservices.CommandJobLimitsResponse; /** * Notification setting for the job */ notificationSetting?: outputs.machinelearningservices.NotificationSettingResponse; /** * Mapping of output data bindings used in the job. */ outputs?: { [key: string]: outputs.machinelearningservices.CustomModelJobOutputResponse | outputs.machinelearningservices.MLFlowModelJobOutputResponse | outputs.machinelearningservices.MLTableJobOutputResponse | outputs.machinelearningservices.TritonModelJobOutputResponse | outputs.machinelearningservices.UriFileJobOutputResponse | outputs.machinelearningservices.UriFolderJobOutputResponse; }; /** * Input parameters. */ parameters: any; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Queue settings for the job */ queueSettings?: outputs.machinelearningservices.QueueSettingsResponse; /** * Compute Resource configuration for the job. */ resources?: outputs.machinelearningservices.JobResourceConfigurationResponse; /** * List of JobEndpoints. * For local jobs, a job endpoint will have an endpoint value of FileStreamObject. */ services?: { [key: string]: outputs.machinelearningservices.JobServiceResponse; }; /** * Status of the job. */ status: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * commandJobResponseProvideDefaults sets the appropriate defaults for CommandJobResponse */ function commandJobResponseProvideDefaults(val: CommandJobResponse): CommandJobResponse; /** * Component container definition. * */ interface ComponentContainerPropertiesResponse { /** * The asset description text. */ description?: string; /** * Is the asset archived? */ isArchived?: boolean; /** * The latest version inside this container. */ latestVersion: string; /** * The next auto incremental version */ nextVersion: string; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Provisioning state for the component container. */ provisioningState: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * componentContainerPropertiesResponseProvideDefaults sets the appropriate defaults for ComponentContainerPropertiesResponse */ function componentContainerPropertiesResponseProvideDefaults(val: ComponentContainerPropertiesResponse): ComponentContainerPropertiesResponse; /** * Definition of a component version: defines resources that span component types. */ interface ComponentVersionPropertiesResponse { /** * Defines Component definition details. * */ componentSpec?: any; /** * The asset description text. */ description?: string; /** * If the name version are system generated (anonymous registration). */ isAnonymous?: boolean; /** * Is the asset archived? */ isArchived?: boolean; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Provisioning state for the component version. */ provisioningState: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * componentVersionPropertiesResponseProvideDefaults sets the appropriate defaults for ComponentVersionPropertiesResponse */ function componentVersionPropertiesResponseProvideDefaults(val: ComponentVersionPropertiesResponse): ComponentVersionPropertiesResponse; /** * Defines an Aml Instance application and its connectivity endpoint URI. */ interface ComputeInstanceApplicationResponse { /** * Name of the ComputeInstance application. */ displayName?: string; /** * Application' endpoint URI. */ endpointUri?: string; } /** * Defines all connectivity endpoints and properties for an ComputeInstance. */ interface ComputeInstanceConnectivityEndpointsResponse { /** * Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed). */ privateIpAddress: string; /** * Public IP Address of this ComputeInstance. */ publicIpAddress: string; } /** * Defines an Aml Instance container. */ interface ComputeInstanceContainerResponse { /** * Auto save settings. */ autosave?: string; /** * Environment information of this container. */ environment?: outputs.machinelearningservices.ComputeInstanceEnvironmentInfoResponse; /** * Information of GPU. */ gpu?: string; /** * Name of the ComputeInstance container. */ name?: string; /** * network of this container. */ network?: string; /** * services of this containers. */ services: any[]; } /** * Describes information on user who created this ComputeInstance. */ interface ComputeInstanceCreatedByResponse { /** * Uniquely identifies the user within his/her organization. */ userId: string; /** * Name of the user. */ userName: string; /** * Uniquely identifies user' Azure Active Directory organization. */ userOrgId: string; } /** * Defines an Aml Instance DataDisk. */ interface ComputeInstanceDataDiskResponse { /** * Caching type of Data Disk. */ caching?: string; /** * The initial disk size in gigabytes. */ diskSizeGB?: number; /** * The lun is used to uniquely identify each data disk. If attaching multiple disks, each should have a distinct lun. */ lun?: number; /** * type of this storage account. */ storageAccountType?: string; } /** * computeInstanceDataDiskResponseProvideDefaults sets the appropriate defaults for ComputeInstanceDataDiskResponse */ function computeInstanceDataDiskResponseProvideDefaults(val: ComputeInstanceDataDiskResponse): ComputeInstanceDataDiskResponse; /** * Defines an Aml Instance DataMount. */ interface ComputeInstanceDataMountResponse { /** * who this data mount created by. */ createdBy?: string; /** * Error of this data mount. */ error?: string; /** * Mount Action. */ mountAction?: string; /** * Mount Mode. */ mountMode?: string; /** * name of the ComputeInstance data mount. */ mountName?: string; /** * Path of this data mount. */ mountPath?: string; /** * Mount state. */ mountState?: string; /** * The time when the disk mounted. */ mountedOn?: string; /** * Source of the ComputeInstance data mount. */ source?: string; /** * Data source type. */ sourceType?: string; } /** * Environment information */ interface ComputeInstanceEnvironmentInfoResponse { /** * name of environment. */ name?: string; /** * version of environment. */ version?: string; } /** * The last operation on ComputeInstance. */ interface ComputeInstanceLastOperationResponse { /** * Name of the last operation. */ operationName?: string; /** * Operation status. */ operationStatus?: string; /** * Time of the last operation. */ operationTime?: string; /** * Trigger of operation. */ operationTrigger?: string; } /** * Compute Instance properties */ interface ComputeInstancePropertiesResponse { /** * Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role. */ applicationSharingPolicy?: string; /** * Describes available applications and their endpoints on this ComputeInstance. */ applications: outputs.machinelearningservices.ComputeInstanceApplicationResponse[]; /** * The Compute Instance Authorization type. Available values are personal (default). */ computeInstanceAuthorizationType?: string; /** * Describes all connectivity endpoints available for this ComputeInstance. */ connectivityEndpoints: outputs.machinelearningservices.ComputeInstanceConnectivityEndpointsResponse; /** * Describes informations of containers on this ComputeInstance. */ containers: outputs.machinelearningservices.ComputeInstanceContainerResponse[]; /** * Describes information on user who created this ComputeInstance. */ createdBy: outputs.machinelearningservices.ComputeInstanceCreatedByResponse; /** * List of Custom Services added to the compute. */ customServices?: outputs.machinelearningservices.CustomServiceResponse[]; /** * Describes informations of dataDisks on this ComputeInstance. */ dataDisks: outputs.machinelearningservices.ComputeInstanceDataDiskResponse[]; /** * Describes informations of dataMounts on this ComputeInstance. */ dataMounts: outputs.machinelearningservices.ComputeInstanceDataMountResponse[]; /** * Enable or disable node public IP address provisioning. Possible values are: Possible values are: true - Indicates that the compute nodes will have public IPs provisioned. false - Indicates that the compute nodes will have a private endpoint and no public IPs. */ enableNodePublicIp?: boolean; /** * Enable SSO (single sign on). Possible values are: true, false. */ enableSSO?: boolean; /** * Collection of errors encountered on this ComputeInstance. */ errors: outputs.machinelearningservices.ErrorResponseResponse[]; /** * Stops compute instance after user defined period of inactivity. Time is defined in ISO8601 format. Minimum is 15 min, maximum is 3 days. */ idleTimeBeforeShutdown?: string; /** * The last operation on ComputeInstance. */ lastOperation: outputs.machinelearningservices.ComputeInstanceLastOperationResponse; /** * Returns metadata about the operating system image for this compute instance. */ osImageMetadata: outputs.machinelearningservices.ImageMetadataResponse; /** * Settings for a personal compute instance. */ personalComputeInstanceSettings?: outputs.machinelearningservices.PersonalComputeInstanceSettingsResponse; /** * The list of schedules to be applied on the computes. */ schedules?: outputs.machinelearningservices.ComputeSchedulesResponse; /** * Details of customized scripts to execute for setting up the cluster. */ setupScripts?: outputs.machinelearningservices.SetupScriptsResponse; /** * Specifies policy and settings for SSH access. */ sshSettings?: outputs.machinelearningservices.ComputeInstanceSshSettingsResponse; /** * The current state of this ComputeInstance. */ state: string; /** * Virtual network subnet resource ID the compute nodes belong to. */ subnet?: outputs.machinelearningservices.ResourceIdResponse; /** * ComputeInstance version. */ versions: outputs.machinelearningservices.ComputeInstanceVersionResponse; /** * Virtual Machine Size */ vmSize?: string; } /** * computeInstancePropertiesResponseProvideDefaults sets the appropriate defaults for ComputeInstancePropertiesResponse */ function computeInstancePropertiesResponseProvideDefaults(val: ComputeInstancePropertiesResponse): ComputeInstancePropertiesResponse; /** * An Azure Machine Learning compute instance. */ interface ComputeInstanceResponse { /** * Location for the underlying compute */ computeLocation?: string; /** * The type of compute * Expected value is 'ComputeInstance'. */ computeType: "ComputeInstance"; /** * The time at which the compute was created. */ createdOn: string; /** * The description of the Machine Learning compute. */ description?: string; /** * Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. */ disableLocalAuth?: boolean; /** * Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. */ isAttachedCompute: boolean; /** * The time at which the compute was last modified. */ modifiedOn: string; /** * Properties of ComputeInstance */ properties?: outputs.machinelearningservices.ComputeInstancePropertiesResponse; /** * Errors during provisioning */ provisioningErrors: outputs.machinelearningservices.ErrorResponseResponse[]; /** * The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. */ provisioningState: string; /** * ARM resource id of the underlying compute */ resourceId?: string; } /** * computeInstanceResponseProvideDefaults sets the appropriate defaults for ComputeInstanceResponse */ function computeInstanceResponseProvideDefaults(val: ComputeInstanceResponse): ComputeInstanceResponse; /** * Specifies policy and settings for SSH access. */ interface ComputeInstanceSshSettingsResponse { /** * Specifies the SSH rsa public key file as a string. Use "ssh-keygen -t rsa -b 2048" to generate your SSH key pairs. */ adminPublicKey?: string; /** * Describes the admin user name. */ adminUserName: string; /** * Describes the port for connecting through SSH. */ sshPort: number; /** * State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable. */ sshPublicAccess?: string; } /** * computeInstanceSshSettingsResponseProvideDefaults sets the appropriate defaults for ComputeInstanceSshSettingsResponse */ function computeInstanceSshSettingsResponseProvideDefaults(val: ComputeInstanceSshSettingsResponse): ComputeInstanceSshSettingsResponse; /** * Version of computeInstance. */ interface ComputeInstanceVersionResponse { /** * Runtime of compute instance. */ runtime?: string; } interface ComputeRecurrenceScheduleResponse { /** * [Required] List of hours for the schedule. */ hours: number[]; /** * [Required] List of minutes for the schedule. */ minutes: number[]; /** * List of month days for the schedule */ monthDays?: number[]; /** * List of days for the schedule. */ weekDays?: string[]; } interface ComputeRuntimeDtoResponse { sparkRuntimeVersion?: string; } /** * The list of schedules to be applied on the computes */ interface ComputeSchedulesResponse { /** * The list of compute start stop schedules to be applied. */ computeStartStop?: outputs.machinelearningservices.ComputeStartStopScheduleResponse[]; } /** * Compute start stop schedule properties */ interface ComputeStartStopScheduleResponse { /** * [Required] The compute power action. */ action?: string; /** * Required if triggerType is Cron. */ cron?: outputs.machinelearningservices.CronResponse; /** * A system assigned id for the schedule. */ id: string; /** * The current deployment state of schedule. */ provisioningStatus: string; /** * Required if triggerType is Recurrence. */ recurrence?: outputs.machinelearningservices.RecurrenceResponse; /** * [Deprecated] Not used any more. */ schedule?: outputs.machinelearningservices.ScheduleBaseResponse; /** * Is the schedule enabled or disabled? */ status?: string; /** * [Required] The schedule trigger type. */ triggerType?: string; } /** * computeStartStopScheduleResponseProvideDefaults sets the appropriate defaults for ComputeStartStopScheduleResponse */ function computeStartStopScheduleResponseProvideDefaults(val: ComputeStartStopScheduleResponse): ComputeStartStopScheduleResponse; /** * Resource requirements for each container instance within an online deployment. */ interface ContainerResourceRequirementsResponse { /** * Container resource limit info: */ containerResourceLimits?: outputs.machinelearningservices.ContainerResourceSettingsResponse; /** * Container resource request info: */ containerResourceRequests?: outputs.machinelearningservices.ContainerResourceSettingsResponse; } interface ContainerResourceSettingsResponse { /** * Number of vCPUs request/limit for container. More info: * https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ */ cpu?: string; /** * Number of Nvidia GPU cards request/limit for container. More info: * https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ */ gpu?: string; /** * Memory size request/limit for container. More info: * https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ */ memory?: string; } interface ContentSafetyEndpointDeploymentResourcePropertiesResponse { /** * The failure reason if the creation failed. */ failureReason?: string; /** * Model used for the endpoint deployment. */ model: outputs.machinelearningservices.EndpointDeploymentModelResponse; /** * Read-only provision state status property. */ provisioningState: string; /** * The name of RAI policy. */ raiPolicyName?: string; sku?: outputs.machinelearningservices.CognitiveServicesSkuResponse; /** * Kind of the deployment. * Expected value is 'Azure.ContentSafety'. */ type: "Azure.ContentSafety"; /** * Deployment model version upgrade option. */ versionUpgradeOption?: string; } interface ContentSafetyResponse { /** * [Required] Specifies the status of content safety. */ contentSafetyStatus: string; } interface CosmosDbSettingsResponse { collectionsThroughput?: number; } interface CreateMonitorActionResponse { /** * Expected value is 'CreateMonitor'. */ actionType: "CreateMonitor"; /** * [Required] Defines the monitor. */ monitorDefinition: outputs.machinelearningservices.MonitorDefinitionResponse; } /** * The workflow trigger cron for ComputeStartStop schedule type. */ interface CronResponse { /** * [Required] Specifies cron expression of schedule. * The expression should follow NCronTab format. */ expression?: string; /** * The start time in yyyy-MM-ddTHH:mm:ss format. */ startTime?: string; /** * Specifies time zone in which the schedule runs. * TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 */ timeZone?: string; } /** * cronResponseProvideDefaults sets the appropriate defaults for CronResponse */ function cronResponseProvideDefaults(val: CronResponse): CronResponse; interface CronTriggerResponse { /** * Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601. * Recommented format would be "2022-06-01T00:00:01" * If not present, the schedule will run indefinitely */ endTime?: string; /** * [Required] Specifies cron expression of schedule. * The expression should follow NCronTab format. */ expression: string; /** * Specifies start time of schedule in ISO 8601 format, but without a UTC offset. */ startTime?: string; /** * Specifies time zone in which the schedule runs. * TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 */ timeZone?: string; /** * Expected value is 'Cron'. */ triggerType: "Cron"; } /** * cronTriggerResponseProvideDefaults sets the appropriate defaults for CronTriggerResponse */ function cronTriggerResponseProvideDefaults(val: CronTriggerResponse): CronTriggerResponse; /** * The desired maximum forecast horizon in units of time-series frequency. */ interface CustomForecastHorizonResponse { /** * Enum to determine forecast horizon selection mode. * Expected value is 'Custom'. */ mode: "Custom"; /** * [Required] Forecast horizon value. */ value: number; } /** * Custom Keys credential object */ interface CustomKeysResponse { keys?: { [key: string]: string; }; } /** * Category:= CustomKeys * AuthType:= CustomKeys (as type discriminator) * Credentials:= {CustomKeys} as Microsoft.MachineLearning.AccountRP.Contracts.WorkspaceConnection.CustomKeys * Target:= {any value} * Use Metadata property bag for ApiVersion and other metadata fields */ interface CustomKeysWorkspaceConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'CustomKeys'. */ authType: "CustomKeys"; /** * Category of the connection */ category?: string; /** * A type definition that refers the id to an Azure Resource Manager resource. */ createdByWorkspaceArmId: string; /** * Custom Keys credential object */ credentials?: outputs.machinelearningservices.CustomKeysResponse; error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; peRequirement?: string; peStatus?: string; sharedUserList?: string[]; target?: string; useWorkspaceManagedIdentity?: boolean; } interface CustomMetricThresholdResponse { /** * [Required] The user-defined metric to calculate. */ metric: string; /** * The threshold value. If null, a default value will be set depending on the selected metric. */ threshold?: outputs.machinelearningservices.MonitoringThresholdResponse; } interface CustomModelJobInputResponse { /** * Description for the input. */ description?: string; /** * Enum to determine the Job Input Type. * Expected value is 'custom_model'. */ jobInputType: "custom_model"; /** * Enum to determine the input data delivery mode. */ mode?: string; /** * [Required] Input Asset URI. */ uri: string; } /** * customModelJobInputResponseProvideDefaults sets the appropriate defaults for CustomModelJobInputResponse */ function customModelJobInputResponseProvideDefaults(val: CustomModelJobInputResponse): CustomModelJobInputResponse; interface CustomModelJobOutputResponse { /** * Output Asset Name. */ assetName?: string; /** * Description for the output. */ description?: string; /** * Enum to determine the Job Output Type. * Expected value is 'custom_model'. */ jobOutputType: "custom_model"; /** * Output data delivery mode enums. */ mode?: string; /** * Output Asset URI. */ uri?: string; } /** * customModelJobOutputResponseProvideDefaults sets the appropriate defaults for CustomModelJobOutputResponse */ function customModelJobOutputResponseProvideDefaults(val: CustomModelJobOutputResponse): CustomModelJobOutputResponse; interface CustomMonitoringSignalResponse { /** * [Required] Reference to the component asset used to calculate the custom metrics. */ componentId: string; /** * Monitoring assets to take as input. Key is the component input port name, value is the data asset. */ inputAssets?: { [key: string]: outputs.machinelearningservices.FixedInputDataResponse | outputs.machinelearningservices.RollingInputDataResponse | outputs.machinelearningservices.StaticInputDataResponse; }; /** * Extra component parameters to take as input. Key is the component literal input port name, value is the parameter value. */ inputs?: { [key: string]: outputs.machinelearningservices.CustomModelJobInputResponse | outputs.machinelearningservices.LiteralJobInputResponse | outputs.machinelearningservices.MLFlowModelJobInputResponse | outputs.machinelearningservices.MLTableJobInputResponse | outputs.machinelearningservices.TritonModelJobInputResponse | outputs.machinelearningservices.UriFileJobInputResponse | outputs.machinelearningservices.UriFolderJobInputResponse; }; /** * [Required] A list of metrics to calculate and their associated thresholds. */ metricThresholds: outputs.machinelearningservices.CustomMetricThresholdResponse[]; /** * The current notification mode for this signal. */ notificationTypes?: string[]; /** * Property dictionary. Properties can be added, but not removed or altered. */ properties?: { [key: string]: string; }; /** * Expected value is 'Custom'. */ signalType: "Custom"; } /** * N-Cross validations are specified by user. */ interface CustomNCrossValidationsResponse { /** * Determines how N-Cross validations value is determined. * Expected value is 'Custom'. */ mode: "Custom"; /** * [Required] N-Cross validations value. */ value: number; } interface CustomSeasonalityResponse { /** * Forecasting seasonality mode. * Expected value is 'Custom'. */ mode: "Custom"; /** * [Required] Seasonality value. */ value: number; } /** * Specifies the custom service configuration */ interface CustomServiceResponse { /** * Describes the docker settings for the image */ docker?: outputs.machinelearningservices.DockerResponse; /** * Configuring the endpoints for the container */ endpoints?: outputs.machinelearningservices.EndpointResponse[]; /** * Environment Variable for the container */ environmentVariables?: { [key: string]: outputs.machinelearningservices.EnvironmentVariableResponse; }; /** * Describes the Image Specifications */ image?: outputs.machinelearningservices.ImageResponse; /** * Describes the jupyter kernel settings for the image if its a custom environment */ kernel?: outputs.machinelearningservices.JupyterKernelConfigResponse; /** * Name of the Custom Service */ name?: string; /** * Configuring the volumes for the container */ volumes?: outputs.machinelearningservices.VolumeDefinitionResponse[]; } /** * customServiceResponseProvideDefaults sets the appropriate defaults for CustomServiceResponse */ function customServiceResponseProvideDefaults(val: CustomServiceResponse): CustomServiceResponse; interface CustomTargetLagsResponse { /** * Target lags selection modes. * Expected value is 'Custom'. */ mode: "Custom"; /** * [Required] Set target lags values. */ values: number[]; } interface CustomTargetRollingWindowSizeResponse { /** * Target rolling windows size mode. * Expected value is 'Custom'. */ mode: "Custom"; /** * [Required] TargetRollingWindowSize value. */ value: number; } interface DataCollectorResponse { /** * [Required] The collection configuration. Each collection has it own configuration to collect model data and the name of collection can be arbitrary string. * Model data collector can be used for either payload logging or custom logging or both of them. Collection request and response are reserved for payload logging, others are for custom logging. */ collections: { [key: string]: outputs.machinelearningservices.CollectionResponse; }; /** * The request logging configuration for mdc, it includes advanced logging settings for all collections. It's optional. */ requestLogging?: outputs.machinelearningservices.RequestLoggingResponse; /** * When model data is collected to blob storage, we need to roll the data to different path to avoid logging all of them in a single blob file. * If the rolling rate is hour, all data will be collected in the blob path /yyyy/MM/dd/HH/. * If it's day, all data will be collected in blob path /yyyy/MM/dd/. * The other benefit of rolling path is that model monitoring ui is able to select a time range of data very quickly. */ rollingRate?: string; } /** * dataCollectorResponseProvideDefaults sets the appropriate defaults for DataCollectorResponse */ function dataCollectorResponseProvideDefaults(val: DataCollectorResponse): DataCollectorResponse; /** * Container for data asset versions. */ interface DataContainerPropertiesResponse { /** * [Required] Specifies the type of data. */ dataType: string; /** * The asset description text. */ description?: string; /** * Is the asset archived? */ isArchived?: boolean; /** * The latest version inside this container. */ latestVersion: string; /** * The next auto incremental version */ nextVersion: string; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * dataContainerPropertiesResponseProvideDefaults sets the appropriate defaults for DataContainerPropertiesResponse */ function dataContainerPropertiesResponseProvideDefaults(val: DataContainerPropertiesResponse): DataContainerPropertiesResponse; interface DataDriftMonitoringSignalResponse { /** * A dictionary that maps feature names to their respective data types. */ featureDataTypeOverride?: { [key: string]: string; }; /** * The settings for computing feature importance. */ featureImportanceSettings?: outputs.machinelearningservices.FeatureImportanceSettingsResponse; /** * The feature filter which identifies which feature to calculate drift over. */ features?: outputs.machinelearningservices.AllFeaturesResponse | outputs.machinelearningservices.FeatureSubsetResponse | outputs.machinelearningservices.TopNFeaturesByAttributionResponse; /** * [Required] A list of metrics to calculate and their associated thresholds. */ metricThresholds: (outputs.machinelearningservices.CategoricalDataDriftMetricThresholdResponse | outputs.machinelearningservices.NumericalDataDriftMetricThresholdResponse)[]; /** * The current notification mode for this signal. */ notificationTypes?: string[]; /** * [Required] The data which drift will be calculated for. */ productionData: outputs.machinelearningservices.FixedInputDataResponse | outputs.machinelearningservices.RollingInputDataResponse | outputs.machinelearningservices.StaticInputDataResponse; /** * Property dictionary. Properties can be added, but not removed or altered. */ properties?: { [key: string]: string; }; /** * [Required] The data to calculate drift against. */ referenceData: outputs.machinelearningservices.FixedInputDataResponse | outputs.machinelearningservices.RollingInputDataResponse | outputs.machinelearningservices.StaticInputDataResponse; /** * Expected value is 'DataDrift'. */ signalType: "DataDrift"; } /** * dataDriftMonitoringSignalResponseProvideDefaults sets the appropriate defaults for DataDriftMonitoringSignalResponse */ function dataDriftMonitoringSignalResponseProvideDefaults(val: DataDriftMonitoringSignalResponse): DataDriftMonitoringSignalResponse; /** * A DataFactory compute. */ interface DataFactoryResponse { /** * Location for the underlying compute */ computeLocation?: string; /** * The type of compute * Expected value is 'DataFactory'. */ computeType: "DataFactory"; /** * The time at which the compute was created. */ createdOn: string; /** * The description of the Machine Learning compute. */ description?: string; /** * Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. */ disableLocalAuth?: boolean; /** * Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. */ isAttachedCompute: boolean; /** * The time at which the compute was last modified. */ modifiedOn: string; /** * Errors during provisioning */ provisioningErrors: outputs.machinelearningservices.ErrorResponseResponse[]; /** * The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. */ provisioningState: string; /** * ARM resource id of the underlying compute */ resourceId?: string; } /** * A DataLakeAnalytics compute. */ interface DataLakeAnalyticsResponse { /** * Location for the underlying compute */ computeLocation?: string; /** * The type of compute * Expected value is 'DataLakeAnalytics'. */ computeType: "DataLakeAnalytics"; /** * The time at which the compute was created. */ createdOn: string; /** * The description of the Machine Learning compute. */ description?: string; /** * Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. */ disableLocalAuth?: boolean; /** * Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. */ isAttachedCompute: boolean; /** * The time at which the compute was last modified. */ modifiedOn: string; properties?: outputs.machinelearningservices.DataLakeAnalyticsSchemaPropertiesResponse; /** * Errors during provisioning */ provisioningErrors: outputs.machinelearningservices.ErrorResponseResponse[]; /** * The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. */ provisioningState: string; /** * ARM resource id of the underlying compute */ resourceId?: string; } interface DataLakeAnalyticsSchemaPropertiesResponse { /** * DataLake Store Account Name */ dataLakeStoreAccountName?: string; } /** * Reference to an asset via its path in a datastore. */ interface DataPathAssetReferenceResponse { /** * ARM resource ID of the datastore where the asset is located. */ datastoreId?: string; /** * The path of the file/directory in the datastore. */ path?: string; /** * Enum to determine which reference method to use for an asset. * Expected value is 'DataPath'. */ referenceType: "DataPath"; } interface DataQualityMonitoringSignalResponse { /** * A dictionary that maps feature names to their respective data types. */ featureDataTypeOverride?: { [key: string]: string; }; /** * The settings for computing feature importance. */ featureImportanceSettings?: outputs.machinelearningservices.FeatureImportanceSettingsResponse; /** * The features to calculate drift over. */ features?: outputs.machinelearningservices.AllFeaturesResponse | outputs.machinelearningservices.FeatureSubsetResponse | outputs.machinelearningservices.TopNFeaturesByAttributionResponse; /** * [Required] A list of metrics to calculate and their associated thresholds. */ metricThresholds: (outputs.machinelearningservices.CategoricalDataQualityMetricThresholdResponse | outputs.machinelearningservices.NumericalDataQualityMetricThresholdResponse)[]; /** * The current notification mode for this signal. */ notificationTypes?: string[]; /** * [Required] The data produced by the production service which drift will be calculated for. */ productionData: outputs.machinelearningservices.FixedInputDataResponse | outputs.machinelearningservices.RollingInputDataResponse | outputs.machinelearningservices.StaticInputDataResponse; /** * Property dictionary. Properties can be added, but not removed or altered. */ properties?: { [key: string]: string; }; /** * [Required] The data to calculate drift against. */ referenceData: outputs.machinelearningservices.FixedInputDataResponse | outputs.machinelearningservices.RollingInputDataResponse | outputs.machinelearningservices.StaticInputDataResponse; /** * Expected value is 'DataQuality'. */ signalType: "DataQuality"; } /** * dataQualityMonitoringSignalResponseProvideDefaults sets the appropriate defaults for DataQualityMonitoringSignalResponse */ function dataQualityMonitoringSignalResponseProvideDefaults(val: DataQualityMonitoringSignalResponse): DataQualityMonitoringSignalResponse; /** * Properties of Databricks */ interface DatabricksPropertiesResponse { /** * Databricks access token */ databricksAccessToken?: string; /** * Workspace Url */ workspaceUrl?: string; } /** * A DataFactory compute. */ interface DatabricksResponse { /** * Location for the underlying compute */ computeLocation?: string; /** * The type of compute * Expected value is 'Databricks'. */ computeType: "Databricks"; /** * The time at which the compute was created. */ createdOn: string; /** * The description of the Machine Learning compute. */ description?: string; /** * Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. */ disableLocalAuth?: boolean; /** * Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. */ isAttachedCompute: boolean; /** * The time at which the compute was last modified. */ modifiedOn: string; /** * Properties of Databricks */ properties?: outputs.machinelearningservices.DatabricksPropertiesResponse; /** * Errors during provisioning */ provisioningErrors: outputs.machinelearningservices.ErrorResponseResponse[]; /** * The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. */ provisioningState: string; /** * ARM resource id of the underlying compute */ resourceId?: string; } /** * Dataset reference object. */ interface DatasetReferenceResponse { /** * The fully qualified ARM id of the dataset reference. */ id?: string; /** * The name of the dataset reference. */ name?: string; } /** * Machine Learning dataset object. */ interface DatasetResponse { /** * The dataset creation time (UTC). */ createdTime: string; /** * Unique Dataset identifier. */ datasetId: string; /** * Dataset state */ datasetState?: outputs.machinelearningservices.DatasetStateResponse; /** * Dataset Type. */ datasetType: string; /** * Name of the default compute to be used for any Dataset actions (such as Profile, Write). */ defaultCompute: string; /** * Description about this dataset version. */ description: string; /** * eTag description */ etag: string; /** * Flag to hide Dataset in UI */ isVisible: boolean; /** * Last created Dataset definition. */ latest?: outputs.machinelearningservices.DatasetResponseLatest; /** * The dataset last modified time (UTC). */ modifiedTime: string; /** * Unique dataset name */ name: string; /** * Tags for this dataset version. */ tags: { [key: string]: string; }; } /** * Datastore and reference to location of data such as relativePath, Sql Query and etc. */ interface DatasetResponseDataPath { /** * Additional Properties. */ additionalProperties?: { [key: string]: any; }; /** * Azure path for Azure Blob or File */ azureFilePath: string; /** * Data store Name */ datastoreName: string; /** * HTTP URL. */ httpUrl: string; /** * Specify the partition format of path. Defaults to None. */ partitionFormat: string; /** * Whether or not to ignore unmatched path. */ partitionFormatIgnoreError: boolean; /** * List of files expanded from a file GLOB specified */ paths: string[]; /** * Relative path in the data store */ relativePath: string; /** * Sql Query/Table/Stored Procedure details. */ sqlDataPath?: outputs.machinelearningservices.DatasetResponseSqlDataPath; } /** * Last created Dataset definition. */ interface DatasetResponseLatest { /** * User who created. */ createdBy?: outputs.machinelearningservices.UserInfoResponse; /** * The dataset creation time (UTC). */ createdTime: string; /** * Datastore and reference to location of data such as relativePath, Sql Query and etc. */ dataPath?: outputs.machinelearningservices.DatasetResponseDataPath; /** * Dataflow Json */ dataflow: string; /** * Dataset state */ datasetDefinitionState?: outputs.machinelearningservices.DatasetStateResponse; /** * Unique Dataset identifier. */ datasetId: string; /** * Description about the dataset. */ description: string; /** * eTag description */ etag: string; /** * Dataset FileType, specified by user. */ fileType: string; /** * The dataset last modified time (UTC). */ modifiedTime: string; /** * Summary of Definition changes. */ notes: string; /** * Indicates how the source data is partitioned. This is defined to filter on a range of partitioned data before performing actions or materialization. */ partitionFormatInPath: boolean; /** * Properties stores information like name of time series column for time series dataset. */ properties?: { [key: string]: any; }; /** * Indicates the saved dataset this definition is mapping to, populated on Get. */ savedDatasetId: string; /** * Tags associated with the dataset. */ tags: { [key: string]: string; }; /** * Telemetry information about the dataset including information like which service the dataset was created from. */ telemetryInfo: { [key: string]: string; }; /** * Whether to use description and tags from the definition level as opposed to dataset level (old behavior). */ useDescriptionTagsFromDefinition: boolean; /** * An identifier uniquely identifies a definition change. */ versionId: string; } /** * Sql Query/Table/Stored Procedure details. */ interface DatasetResponseSqlDataPath { /** * SQL query timeout. Unit in seconds. */ queryTimeout: number; /** * SQL query */ sqlQuery: string; /** * SQL storedProcedure name */ sqlStoredProcedureName: string; /** * SQL table name */ sqlTableName: string; } /** * Dataset state */ interface DatasetStateResponse { /** * Reference to better Dataset or a Definition */ deprecatedBy?: outputs.machinelearningservices.DatasetStateResponseDeprecatedBy; /** * eTag description */ etag: string; /** * Dataset state */ state?: string; } /** * Reference to better Dataset or a Definition */ interface DatasetStateResponseDeprecatedBy { /** * Unique Dataset identifier. */ datasetId: string; /** * Definition Version */ definitionVersion?: string; } /** * Machine Learning datastore object. */ interface DatastoreResponse { azureDataLakeSection?: outputs.machinelearningservices.AzureDataLakeSectionResponse; azureMySqlSection?: outputs.machinelearningservices.AzureMySqlSectionResponse; azurePostgreSqlSection?: outputs.machinelearningservices.AzurePostgreSqlSectionResponse; azureSqlDatabaseSection?: outputs.machinelearningservices.AzureSqlDatabaseSectionResponse; azureStorageSection?: outputs.machinelearningservices.AzureStorageSectionResponse; /** * The User who created the datastore. */ createdBy: outputs.machinelearningservices.UserInfoResponse; /** * The date and time when the datastore was created. */ createdTime: string; /** * The datastore type. */ dataStoreType?: string; /** * Description of the datastore. */ description?: string; /** * Data specific to GlusterFS. */ glusterFsSection?: outputs.machinelearningservices.GlusterFsSectionResponse; /** * A read only property that denotes whether the service datastore has been validated with credentials. */ hasBeenValidated?: boolean; /** * Info about origin if it is linked. */ linkedInfo?: outputs.machinelearningservices.LinkedInfoResponse; /** * The User who modified the datastore. */ modifiedBy: outputs.machinelearningservices.UserInfoResponse; /** * The date and time when the datastore was last modified. */ modifiedTime: string; /** * Name of the datastore. */ name?: string; /** * Tags for this datastore. */ tags: { [key: string]: string; }; } /** * datastoreResponseProvideDefaults sets the appropriate defaults for DatastoreResponse */ function datastoreResponseProvideDefaults(val: DatastoreResponse): DatastoreResponse; interface DefaultScaleSettingsResponse { /** * Expected value is 'Default'. */ scaleType: "Default"; } /** * Contract for DeltaModelCurrentState. */ interface DeltaModelCurrentStateResponse { /** * Gets or sets Count of instances with model. */ count?: number; /** * Gets or sets sample of instances with model. */ sampleInstanceID?: string; /** * Gets or sets status. */ status?: string; } /** * deltaModelCurrentStateResponseProvideDefaults sets the appropriate defaults for DeltaModelCurrentStateResponse */ function deltaModelCurrentStateResponseProvideDefaults(val: DeltaModelCurrentStateResponse): DeltaModelCurrentStateResponse; interface DeploymentResourceConfigurationResponse { /** * Optional number of instances or nodes used by the compute target. */ instanceCount?: number; /** * Optional type of VM used as supported by the compute target. */ instanceType?: string; /** * Additional properties bag. */ properties?: { [key: string]: any; }; } /** * deploymentResourceConfigurationResponseProvideDefaults sets the appropriate defaults for DeploymentResourceConfigurationResponse */ function deploymentResourceConfigurationResponseProvideDefaults(val: DeploymentResourceConfigurationResponse): DeploymentResourceConfigurationResponse; /** * Class to represent configuration settings for Docker Build */ interface DockerBuildResponse { /** * Path to a snapshot of the Docker Context. This property is only valid if Dockerfile is specified. * The path is relative to the asset path which must contain a single Blob URI value. * */ context?: string; /** * Enum to determine docker specification type. Must be either Build or Image. * Expected value is 'Build'. */ dockerSpecificationType: "Build"; /** * [Required] Docker command line instructions to assemble an image. * */ dockerfile: string; /** * The platform information of the docker image. */ platform?: outputs.machinelearningservices.DockerImagePlatformResponse; } interface DockerImagePlatformResponse { /** * The OS type the Environment. */ operatingSystemType?: string; } /** * Class to represent configuration settings for Docker Build */ interface DockerImageResponse { /** * [Required] Image name of a custom base image. * */ dockerImageUri: string; /** * Enum to determine docker specification type. Must be either Build or Image. * Expected value is 'Image'. */ dockerSpecificationType: "Image"; /** * The platform information of the docker image. */ platform?: outputs.machinelearningservices.DockerImagePlatformResponse; } interface DockerResponse { /** * Indicate whether container shall run in privileged or non-privileged mode. */ privileged?: boolean; } interface EncryptionPropertyResponse { /** * The byok cosmosdb account that customer brings to store customer's data * with encryption */ cosmosDbResourceId?: string; /** * Identity to be used with the keyVault */ identity?: outputs.machinelearningservices.IdentityForCmkResponse; /** * KeyVault details to do the encryption */ keyVaultProperties: outputs.machinelearningservices.KeyVaultPropertiesResponse; /** * The byok search account that customer brings to store customer's data * with encryption */ searchAccountResourceId?: string; /** * Indicates whether or not the encryption is enabled for the workspace. */ status: string; /** * The byok storage account that customer brings to store customer's data * with encryption */ storageAccountResourceId?: string; } interface EndpointDeploymentModelResponse { /** * Model format */ format?: string; /** * Model name. */ name?: string; /** * Optional. Deployment model source ARM resource ID. */ source?: string; /** * Model version. */ version?: string; } interface EndpointModelDeprecationPropertiesResponse { /** * The datetime of deprecation of the fineTune Model. */ fineTune?: string; /** * The datetime of deprecation of the inference Model. */ inference?: string; } /** * Endpoint Model properties. */ interface EndpointModelPropertiesResponse { /** * The capabilities. */ capabilities?: { [key: string]: string; }; deprecation?: outputs.machinelearningservices.EndpointModelDeprecationPropertiesResponse; /** * The capabilities for finetune models. */ finetuneCapabilities?: { [key: string]: string; }; /** * Deployment model format. */ format?: string; /** * If the model is default version. */ isDefaultVersion?: boolean; /** * Model lifecycle status. */ lifecycleStatus?: string; /** * The max capacity. */ maxCapacity?: number; /** * Deployment model name. */ name?: string; /** * The list of Model Sku. */ skus?: outputs.machinelearningservices.EndpointModelSkuPropertiesResponse[]; /** * Metadata pertaining to creation and last modification of the resource. */ systemData: outputs.machinelearningservices.SystemDataResponse; /** * Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API. */ version?: string; } interface EndpointModelSkuCapacityPropertiesResponse { /** * The default capacity. */ default?: number; /** * The maximum capacity. */ maximum?: number; } interface EndpointModelSkuPropertiesResponse { capacity?: outputs.machinelearningservices.EndpointModelSkuCapacityPropertiesResponse; /** * The list of ARM id for the connection support this SKU. */ connectionIds?: string[]; /** * The datetime of deprecation of the model SKU. */ deprecationDate?: string; /** * The name of the model SKU. */ name?: string; rateLimits?: outputs.machinelearningservices.EndpointModelSkuRateLimitPropertiesResponse[]; /** * The usage name of the model SKU. */ usageName?: string; } interface EndpointModelSkuRateLimitPropertiesResponse { /** * The count value of Call Rate Limit. */ count?: number; /** * The renewal period in seconds of Call Rate Limit. */ renewalPeriod?: number; /** * The call rate limit for the model. */ rules?: outputs.machinelearningservices.EndpointModelSkuRateLimitRulePropertiesResponse[]; } interface EndpointModelSkuRateLimitRulePatternPropertiesResponse { method?: string; path?: string; } interface EndpointModelSkuRateLimitRulePropertiesResponse { count?: number; /** * If the dynamic throttling is enabled. */ dynamicThrottlingEnabled?: boolean; key?: string; matchPatterns?: outputs.machinelearningservices.EndpointModelSkuRateLimitRulePatternPropertiesResponse[]; minCount?: number; renewalPeriod?: number; } interface EndpointResponse { /** * Host IP over which the application is exposed from the container */ hostIp?: string; /** * Name of the Endpoint */ name?: string; /** * Protocol over which communication will happen over this endpoint */ protocol?: string; /** * Port over which the application is exposed from container. */ published?: number; /** * Application port inside the container. */ target?: number; } /** * endpointResponseProvideDefaults sets the appropriate defaults for EndpointResponse */ function endpointResponseProvideDefaults(val: EndpointResponse): EndpointResponse; interface EndpointScheduleActionResponse { /** * Expected value is 'InvokeBatchEndpoint'. */ actionType: "InvokeBatchEndpoint"; /** * [Required] Defines Schedule action definition details. * */ endpointInvocationDefinition: any; } /** * Container for environment specification versions. */ interface EnvironmentContainerPropertiesResponse { /** * The asset description text. */ description?: string; /** * Is the asset archived? */ isArchived?: boolean; /** * The latest version inside this container. */ latestVersion: string; /** * The next auto incremental version */ nextVersion: string; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Provisioning state for the environment container. */ provisioningState: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * environmentContainerPropertiesResponseProvideDefaults sets the appropriate defaults for EnvironmentContainerPropertiesResponse */ function environmentContainerPropertiesResponseProvideDefaults(val: EnvironmentContainerPropertiesResponse): EnvironmentContainerPropertiesResponse; /** * Environment specification version details. * */ interface EnvironmentSpecificationVersionResponse { /** * Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages. * */ condaFile?: string; /** * The asset description text. */ description?: string; /** * Configuration settings for Docker. */ docker?: outputs.machinelearningservices.DockerBuildResponse | outputs.machinelearningservices.DockerImageResponse; /** * Environment specification is either user managed or curated by the Azure ML service * */ environmentSpecificationType: string; /** * Defines configuration specific to inference. */ inferenceContainerProperties?: outputs.machinelearningservices.InferenceContainerPropertiesResponse; /** * If the name version are system generated (anonymous registration). */ isAnonymous?: boolean; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } interface EnvironmentVariableResponse { /** * Type of the Environment Variable. Possible values are: local - For local variable */ type?: string; /** * Value of the Environment variable */ value?: string; } /** * environmentVariableResponseProvideDefaults sets the appropriate defaults for EnvironmentVariableResponse */ function environmentVariableResponseProvideDefaults(val: EnvironmentVariableResponse): EnvironmentVariableResponse; /** * Environment version details. */ interface EnvironmentVersionPropertiesRegistryEnvironmentVersionResponse { /** * AutoRebuild setting for the derived image */ autoRebuild?: string; /** * Configuration settings for Docker build context. */ build?: outputs.machinelearningservices.BuildContextResponse; /** * Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages. * */ condaFile?: string; /** * The asset description text. */ description?: string; /** * Environment type is either user managed or curated by the Azure ML service * */ environmentType: string; /** * Name of the image that will be used for the environment. * */ image?: string; /** * Defines configuration specific to inference. */ inferenceConfig?: outputs.machinelearningservices.InferenceContainerPropertiesRegistryEnvironmentVersionResponse; /** * If the name version are system generated (anonymous registration). */ isAnonymous?: boolean; /** * Is the asset archived? */ isArchived?: boolean; /** * The type of operating system. */ osType?: string; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Provisioning state for the environment version. */ provisioningState: string; /** * Stage in the environment lifecycle assigned to this environment */ stage?: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * environmentVersionPropertiesRegistryEnvironmentVersionResponseProvideDefaults sets the appropriate defaults for EnvironmentVersionPropertiesRegistryEnvironmentVersionResponse */ function environmentVersionPropertiesRegistryEnvironmentVersionResponseProvideDefaults(val: EnvironmentVersionPropertiesRegistryEnvironmentVersionResponse): EnvironmentVersionPropertiesRegistryEnvironmentVersionResponse; /** * Environment version details. */ interface EnvironmentVersionPropertiesResponse { /** * AutoRebuild setting for the derived image */ autoRebuild?: string; /** * Configuration settings for Docker build context. */ build?: outputs.machinelearningservices.BuildContextResponse; /** * Standard configuration file used by Conda that lets you install any kind of package, including Python, R, and C/C++ packages. * */ condaFile?: string; /** * The asset description text. */ description?: string; /** * Environment type is either user managed or curated by the Azure ML service * */ environmentType: string; /** * Name of the image that will be used for the environment. * */ image?: string; /** * Defines configuration specific to inference. */ inferenceConfig?: outputs.machinelearningservices.InferenceContainerPropertiesEnvironmentVersionResponse; /** * If the name version are system generated (anonymous registration). */ isAnonymous?: boolean; /** * Is the asset archived? */ isArchived?: boolean; /** * The type of operating system. */ osType?: string; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Provisioning state for the environment version. */ provisioningState: string; /** * Stage in the environment lifecycle assigned to this environment */ stage?: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * environmentVersionPropertiesResponseProvideDefaults sets the appropriate defaults for EnvironmentVersionPropertiesResponse */ function environmentVersionPropertiesResponseProvideDefaults(val: EnvironmentVersionPropertiesResponse): EnvironmentVersionPropertiesResponse; /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.machinelearningservices.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.machinelearningservices.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.). */ interface ErrorResponseResponse { /** * The error object. */ error?: outputs.machinelearningservices.ErrorDetailResponse; } /** * The estimated price info for using a VM of a particular OS type, tier, etc. */ interface EstimatedVMPriceResponse { /** * Operating system type used by the VM. */ osType: string; /** * The price charged for using the VM. */ retailPrice: number; /** * The type of the VM. */ vmTier: string; } /** * The estimated price info for using a VM. */ interface EstimatedVMPricesResponse { /** * Three lettered code specifying the currency of the VM price. Example: USD */ billingCurrency: string; /** * The unit of time measurement for the specified VM price. Example: OneHour */ unitOfMeasure: string; /** * The list of estimated prices for using a VM of a particular OS type, tier, etc. */ values: outputs.machinelearningservices.EstimatedVMPriceResponse[]; } interface FeatureAttributionDriftMonitoringSignalResponse { /** * A dictionary that maps feature names to their respective data types. */ featureDataTypeOverride?: { [key: string]: string; }; /** * [Required] The settings for computing feature importance. */ featureImportanceSettings: outputs.machinelearningservices.FeatureImportanceSettingsResponse; /** * [Required] A list of metrics to calculate and their associated thresholds. */ metricThreshold: outputs.machinelearningservices.FeatureAttributionMetricThresholdResponse; /** * The current notification mode for this signal. */ notificationTypes?: string[]; /** * [Required] The data which drift will be calculated for. */ productionData: (outputs.machinelearningservices.FixedInputDataResponse | outputs.machinelearningservices.RollingInputDataResponse | outputs.machinelearningservices.StaticInputDataResponse)[]; /** * Property dictionary. Properties can be added, but not removed or altered. */ properties?: { [key: string]: string; }; /** * [Required] The data to calculate drift against. */ referenceData: outputs.machinelearningservices.FixedInputDataResponse | outputs.machinelearningservices.RollingInputDataResponse | outputs.machinelearningservices.StaticInputDataResponse; /** * Expected value is 'FeatureAttributionDrift'. */ signalType: "FeatureAttributionDrift"; } /** * featureAttributionDriftMonitoringSignalResponseProvideDefaults sets the appropriate defaults for FeatureAttributionDriftMonitoringSignalResponse */ function featureAttributionDriftMonitoringSignalResponseProvideDefaults(val: FeatureAttributionDriftMonitoringSignalResponse): FeatureAttributionDriftMonitoringSignalResponse; interface FeatureAttributionMetricThresholdResponse { /** * [Required] The feature attribution metric to calculate. */ metric: string; /** * The threshold value. If null, a default value will be set depending on the selected metric. */ threshold?: outputs.machinelearningservices.MonitoringThresholdResponse; } interface FeatureImportanceSettingsResponse { /** * The mode of operation for computing feature importance. */ mode?: string; /** * The name of the target column within the input data asset. */ targetColumn?: string; } /** * featureImportanceSettingsResponseProvideDefaults sets the appropriate defaults for FeatureImportanceSettingsResponse */ function featureImportanceSettingsResponseProvideDefaults(val: FeatureImportanceSettingsResponse): FeatureImportanceSettingsResponse; /** * Dto object representing feature */ interface FeatureResponse { /** * Specifies type */ dataType?: string; /** * Specifies description */ description?: string; /** * Specifies name */ featureName?: string; /** * Specifies tags */ tags?: { [key: string]: string; }; } /** * featureResponseProvideDefaults sets the appropriate defaults for FeatureResponse */ function featureResponseProvideDefaults(val: FeatureResponse): FeatureResponse; interface FeatureStoreSettingsResponse { computeRuntime?: outputs.machinelearningservices.ComputeRuntimeDtoResponse; offlineStoreConnectionName?: string; onlineStoreConnectionName?: string; } interface FeatureSubsetResponse { /** * [Required] The list of features to include. */ features: string[]; /** * Expected value is 'FeatureSubset'. */ filterType: "FeatureSubset"; } /** * Specifies the feature window */ interface FeatureWindowResponse { /** * Specifies the feature window end time */ featureWindowEnd?: string; /** * Specifies the feature window start time */ featureWindowStart?: string; } /** * DTO object representing feature set */ interface FeaturesetContainerPropertiesResponse { /** * The asset description text. */ description?: string; /** * Is the asset archived? */ isArchived?: boolean; /** * The latest version inside this container. */ latestVersion: string; /** * The next auto incremental version */ nextVersion: string; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Provisioning state for the featureset container. */ provisioningState: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * featuresetContainerPropertiesResponseProvideDefaults sets the appropriate defaults for FeaturesetContainerPropertiesResponse */ function featuresetContainerPropertiesResponseProvideDefaults(val: FeaturesetContainerPropertiesResponse): FeaturesetContainerPropertiesResponse; /** * Dto object representing the feature set job */ interface FeaturesetJobResponse { /** * Specifies the created date */ createdDate?: string; /** * Specifies the display name */ displayName?: string; /** * Specifies the duration */ duration?: string; /** * Specifies the experiment id */ experimentId?: string; /** * Specifies the backfill feature window to be materialized */ featureWindow?: outputs.machinelearningservices.FeatureWindowResponse; /** * Specifies the job id */ jobId?: string; /** * Specifies the job status */ status?: string; /** * Specifies the tags if any */ tags?: { [key: string]: string; }; /** * Specifies the feature store job type */ type?: string; } /** * featuresetJobResponseProvideDefaults sets the appropriate defaults for FeaturesetJobResponse */ function featuresetJobResponseProvideDefaults(val: FeaturesetJobResponse): FeaturesetJobResponse; /** * DTO object representing specification */ interface FeaturesetSpecificationResponse { /** * Specifies the spec path */ path?: string; } /** * DTO object representing feature set version */ interface FeaturesetVersionPropertiesResponse { /** * The asset description text. */ description?: string; /** * Specifies list of entities */ entities?: string[]; /** * If the name version are system generated (anonymous registration). */ isAnonymous?: boolean; /** * Is the asset archived? */ isArchived?: boolean; /** * Specifies the materialization settings */ materializationSettings?: outputs.machinelearningservices.MaterializationSettingsResponse; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Provisioning state for the featureset version container. */ provisioningState: string; /** * Specifies the feature spec details */ specification?: outputs.machinelearningservices.FeaturesetSpecificationResponse; /** * Specifies the asset stage */ stage?: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * featuresetVersionPropertiesResponseProvideDefaults sets the appropriate defaults for FeaturesetVersionPropertiesResponse */ function featuresetVersionPropertiesResponseProvideDefaults(val: FeaturesetVersionPropertiesResponse): FeaturesetVersionPropertiesResponse; /** * DTO object representing feature entity */ interface FeaturestoreEntityContainerPropertiesResponse { /** * The asset description text. */ description?: string; /** * Is the asset archived? */ isArchived?: boolean; /** * The latest version inside this container. */ latestVersion: string; /** * The next auto incremental version */ nextVersion: string; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Provisioning state for the featurestore entity container. */ provisioningState: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * featurestoreEntityContainerPropertiesResponseProvideDefaults sets the appropriate defaults for FeaturestoreEntityContainerPropertiesResponse */ function featurestoreEntityContainerPropertiesResponseProvideDefaults(val: FeaturestoreEntityContainerPropertiesResponse): FeaturestoreEntityContainerPropertiesResponse; /** * DTO object representing feature entity version */ interface FeaturestoreEntityVersionPropertiesResponse { /** * The asset description text. */ description?: string; /** * Specifies index columns */ indexColumns?: outputs.machinelearningservices.IndexColumnResponse[]; /** * If the name version are system generated (anonymous registration). */ isAnonymous?: boolean; /** * Is the asset archived? */ isArchived?: boolean; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Provisioning state for the featurestore entity version. */ provisioningState: string; /** * Specifies the asset stage */ stage?: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * featurestoreEntityVersionPropertiesResponseProvideDefaults sets the appropriate defaults for FeaturestoreEntityVersionPropertiesResponse */ function featurestoreEntityVersionPropertiesResponseProvideDefaults(val: FeaturestoreEntityVersionPropertiesResponse): FeaturestoreEntityVersionPropertiesResponse; /** * Fixed input data definition. */ interface FixedInputDataResponse { /** * Mapping of column names to special uses. */ columns?: { [key: string]: string; }; /** * The context metadata of the data source. */ dataContext?: string; /** * Monitoring input data type enum. * Expected value is 'Fixed'. */ inputDataType: "Fixed"; /** * [Required] Specifies the type of job. */ jobInputType: string; /** * [Required] Input Asset URI. */ uri: string; } interface FlavorDataResponse { /** * Model flavor-specific data. */ data?: { [key: string]: string; }; } /** * Forecasting task in AutoML Table vertical. */ interface ForecastingResponse { /** * Columns to use for CVSplit data. */ cvSplitColumnNames?: string[]; /** * Featurization inputs needed for AutoML job. */ featurizationSettings?: outputs.machinelearningservices.TableVerticalFeaturizationSettingsResponse; /** * Forecasting task specific inputs. */ forecastingSettings?: outputs.machinelearningservices.ForecastingSettingsResponse; /** * Execution constraints for AutoMLJob. */ limitSettings?: outputs.machinelearningservices.TableVerticalLimitSettingsResponse; /** * Enum for setting log verbosity. */ logVerbosity?: string; /** * Number of cross validation folds to be applied on training dataset * when validation dataset is not provided. */ nCrossValidations?: outputs.machinelearningservices.AutoNCrossValidationsResponse | outputs.machinelearningservices.CustomNCrossValidationsResponse; /** * Primary metrics for Forecasting task. */ primaryMetric?: string; /** * Target column name: This is prediction values column. * Also known as label column name in context of classification tasks. */ targetColumnName?: string; /** * AutoMLJob Task type. * Expected value is 'Forecasting'. */ taskType: "Forecasting"; /** * Test data input. */ testData?: outputs.machinelearningservices.MLTableJobInputResponse; /** * The fraction of test dataset that needs to be set aside for validation purpose. * Values between (0.0 , 1.0) * Applied when validation dataset is not provided. */ testDataSize?: number; /** * [Required] Training data input. */ trainingData: outputs.machinelearningservices.MLTableJobInputResponse; /** * Inputs for training phase for an AutoML Job. */ trainingSettings?: outputs.machinelearningservices.ForecastingTrainingSettingsResponse; /** * Validation data inputs. */ validationData?: outputs.machinelearningservices.MLTableJobInputResponse; /** * The fraction of training dataset that needs to be set aside for validation purpose. * Values between (0.0 , 1.0) * Applied when validation dataset is not provided. */ validationDataSize?: number; /** * The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to be weighted up or down. */ weightColumnName?: string; } /** * forecastingResponseProvideDefaults sets the appropriate defaults for ForecastingResponse */ function forecastingResponseProvideDefaults(val: ForecastingResponse): ForecastingResponse; /** * Forecasting specific parameters. */ interface ForecastingSettingsResponse { /** * Country or region for holidays for forecasting tasks. * These should be ISO 3166 two-letter country/region codes, for example 'US' or 'GB'. */ countryOrRegionForHolidays?: string; /** * Number of periods between the origin time of one CV fold and the next fold. For * example, if `CVStepSize` = 3 for daily data, the origin time for each fold will be * three days apart. */ cvStepSize?: number; /** * Flag for generating lags for the numeric features. */ featureLags?: string; /** * The desired maximum forecast horizon in units of time-series frequency. */ forecastHorizon?: outputs.machinelearningservices.AutoForecastHorizonResponse | outputs.machinelearningservices.CustomForecastHorizonResponse; /** * When forecasting, this parameter represents the period with which the forecast is desired, for example daily, weekly, yearly, etc. The forecast frequency is dataset frequency by default. */ frequency?: string; /** * Set time series seasonality as an integer multiple of the series frequency. * If seasonality is set to 'auto', it will be inferred. */ seasonality?: outputs.machinelearningservices.AutoSeasonalityResponse | outputs.machinelearningservices.CustomSeasonalityResponse; /** * The parameter defining how if AutoML should handle short time series. */ shortSeriesHandlingConfig?: string; /** * Target aggregate function. */ targetAggregateFunction?: string; /** * The number of past periods to lag from the target column. */ targetLags?: outputs.machinelearningservices.AutoTargetLagsResponse | outputs.machinelearningservices.CustomTargetLagsResponse; /** * The number of past periods used to create a rolling window average of the target column. */ targetRollingWindowSize?: outputs.machinelearningservices.AutoTargetRollingWindowSizeResponse | outputs.machinelearningservices.CustomTargetRollingWindowSizeResponse; /** * The name of the time column. This parameter is required when forecasting to specify the datetime column in the input data used for building the time series and inferring its frequency. */ timeColumnName?: string; /** * The names of columns used to group a timeseries. It can be used to create multiple series. * If grain is not defined, the data set is assumed to be one time-series. This parameter is used with task type forecasting. */ timeSeriesIdColumnNames?: string[]; /** * Configure STL Decomposition of the time-series target column. */ useStl?: string; } /** * forecastingSettingsResponseProvideDefaults sets the appropriate defaults for ForecastingSettingsResponse */ function forecastingSettingsResponseProvideDefaults(val: ForecastingSettingsResponse): ForecastingSettingsResponse; /** * Forecasting Training related configuration. */ interface ForecastingTrainingSettingsResponse { /** * Allowed models for forecasting task. */ allowedTrainingAlgorithms?: string[]; /** * Blocked models for forecasting task. */ blockedTrainingAlgorithms?: string[]; /** * Enable recommendation of DNN models. */ enableDnnTraining?: boolean; /** * Flag to turn on explainability on best model. */ enableModelExplainability?: boolean; /** * Flag for enabling onnx compatible models. */ enableOnnxCompatibleModels?: boolean; /** * Enable stack ensemble run. */ enableStackEnsemble?: boolean; /** * Enable voting ensemble run. */ enableVoteEnsemble?: boolean; /** * During VotingEnsemble and StackEnsemble model generation, multiple fitted models from the previous child runs are downloaded. * Configure this parameter with a higher value than 300 secs, if more time is needed. */ ensembleModelDownloadTimeout?: string; /** * Stack ensemble settings for stack ensemble run. */ stackEnsembleSettings?: outputs.machinelearningservices.StackEnsembleSettingsResponse; } /** * forecastingTrainingSettingsResponseProvideDefaults sets the appropriate defaults for ForecastingTrainingSettingsResponse */ function forecastingTrainingSettingsResponseProvideDefaults(val: ForecastingTrainingSettingsResponse): ForecastingTrainingSettingsResponse; /** * FQDN Outbound Rule for the managed network of a machine learning workspace. */ interface FqdnOutboundRuleResponse { /** * Category of a managed network Outbound Rule of a machine learning workspace. */ category?: string; destination?: string; /** * Error information about an outbound rule of a machine learning workspace if RuleStatus is failed. */ errorInformation: string; parentRuleNames: string[]; /** * Type of a managed network Outbound Rule of a machine learning workspace. */ status?: string; /** * Type of a managed network Outbound Rule of a machine learning workspace. * Expected value is 'FQDN'. */ type: "FQDN"; } /** * Data specific to GlusterFS. */ interface GlusterFsSectionResponse { /** * The server address of one of the servers that hosts the GlusterFS. Can be either the IP address or server name. */ serverAddress: string; /** * The name of the created GlusterFS volume. */ volumeName: string; } /** * Defines a Sampling Algorithm that exhaustively generates every value combination in the space */ interface GridSamplingAlgorithmResponse { /** * Expected value is 'Grid'. */ samplingAlgorithmType: "Grid"; } /** * Environment configuration options. */ interface GroupEnvironmentConfigurationResponse { /** * ARM resource ID of the environment specification for the inference pool. */ environmentId?: string; /** * Environment variables configuration for the inference pool. */ environmentVariables?: outputs.machinelearningservices.StringStringKeyValuePairResponse[]; /** * Liveness probe monitors the health of the container regularly. */ livenessProbe?: outputs.machinelearningservices.ProbeSettingsResponse; /** * Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe. */ readinessProbe?: outputs.machinelearningservices.ProbeSettingsResponse; /** * This verifies whether the application within a container is started. Startup probes run before any other probe, and, unless it finishes successfully, disables other probes. */ startupProbe?: outputs.machinelearningservices.ProbeSettingsResponse; } /** * groupEnvironmentConfigurationResponseProvideDefaults sets the appropriate defaults for GroupEnvironmentConfigurationResponse */ function groupEnvironmentConfigurationResponseProvideDefaults(val: GroupEnvironmentConfigurationResponse): GroupEnvironmentConfigurationResponse; /** * Model configuration options. */ interface GroupModelConfigurationResponse { /** * The URI path to the model. */ modelId?: string; } /** * HDInsight compute properties */ interface HDInsightPropertiesResponse { /** * Public IP address of the master node of the cluster. */ address?: string; /** * Admin credentials for master node of the cluster */ administratorAccount?: outputs.machinelearningservices.VirtualMachineSshCredentialsResponse; /** * Port open for ssh connections on the master node of the cluster. */ sshPort?: number; } /** * A HDInsight compute. */ interface HDInsightResponse { /** * Location for the underlying compute */ computeLocation?: string; /** * The type of compute * Expected value is 'HDInsight'. */ computeType: "HDInsight"; /** * The time at which the compute was created. */ createdOn: string; /** * The description of the Machine Learning compute. */ description?: string; /** * Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. */ disableLocalAuth?: boolean; /** * Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. */ isAttachedCompute: boolean; /** * The time at which the compute was last modified. */ modifiedOn: string; /** * HDInsight compute properties */ properties?: outputs.machinelearningservices.HDInsightPropertiesResponse; /** * Errors during provisioning */ provisioningErrors: outputs.machinelearningservices.ErrorResponseResponse[]; /** * The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. */ provisioningState: string; /** * ARM resource id of the underlying compute */ resourceId?: string; } /** * Reference to an asset via its ARM resource ID. */ interface IdAssetReferenceResponse { /** * [Required] ARM resource ID of the asset. */ assetId: string; /** * Enum to determine which reference method to use for an asset. * Expected value is 'Id'. */ referenceType: "Id"; } /** * Identity object used for encryption. */ interface IdentityForCmkResponse { /** * UserAssignedIdentity to be used to fetch the encryption key from keyVault */ userAssignedIdentity?: string; } /** * Identity for the resource. */ interface IdentityMachineLearningDatasetResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The identity type. */ type?: string; /** * The user assigned identities associated with the resource. */ userAssignedIdentities?: { [key: string]: outputs.machinelearningservices.UserAssignedIdentityMachineLearningDatasetResponse; }; } /** * Identity for the resource. */ interface IdentityMachineLearningDatastoreResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The identity type. */ type?: string; /** * The user assigned identities associated with the resource. */ userAssignedIdentities?: { [key: string]: outputs.machinelearningservices.UserAssignedIdentityMachineLearningDatastoreResponse; }; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The identity type. */ type?: string; /** * The user assigned identities associated with the resource. */ userAssignedIdentities?: { [key: string]: outputs.machinelearningservices.UserAssignedIdentityLinkedServiceResponse; }; } /** * Image Classification Multilabel. Multi-label image classification is used when an image could have one or more labels * from a set of labels - e.g. an image could be labeled with both 'cat' and 'dog'. */ interface ImageClassificationMultilabelResponse { /** * [Required] Limit settings for the AutoML job. */ limitSettings: outputs.machinelearningservices.ImageLimitSettingsResponse; /** * Enum for setting log verbosity. */ logVerbosity?: string; /** * Settings used for training the model. */ modelSettings?: outputs.machinelearningservices.ImageModelSettingsClassificationResponse; /** * Primary metrics for classification multilabel tasks. */ primaryMetric?: string; /** * Search space for sampling different combinations of models and their hyperparameters. */ searchSpace?: outputs.machinelearningservices.ImageModelDistributionSettingsClassificationResponse[]; /** * Model sweeping and hyperparameter sweeping related settings. */ sweepSettings?: outputs.machinelearningservices.ImageSweepSettingsResponse; /** * Target column name: This is prediction values column. * Also known as label column name in context of classification tasks. */ targetColumnName?: string; /** * AutoMLJob Task type. * Expected value is 'ImageClassificationMultilabel'. */ taskType: "ImageClassificationMultilabel"; /** * [Required] Training data input. */ trainingData: outputs.machinelearningservices.MLTableJobInputResponse; /** * Validation data inputs. */ validationData?: outputs.machinelearningservices.MLTableJobInputResponse; /** * The fraction of training dataset that needs to be set aside for validation purpose. * Values between (0.0 , 1.0) * Applied when validation dataset is not provided. */ validationDataSize?: number; } /** * imageClassificationMultilabelResponseProvideDefaults sets the appropriate defaults for ImageClassificationMultilabelResponse */ function imageClassificationMultilabelResponseProvideDefaults(val: ImageClassificationMultilabelResponse): ImageClassificationMultilabelResponse; /** * Image Classification. Multi-class image classification is used when an image is classified with only a single label * from a set of classes - e.g. each image is classified as either an image of a 'cat' or a 'dog' or a 'duck'. */ interface ImageClassificationResponse { /** * [Required] Limit settings for the AutoML job. */ limitSettings: outputs.machinelearningservices.ImageLimitSettingsResponse; /** * Enum for setting log verbosity. */ logVerbosity?: string; /** * Settings used for training the model. */ modelSettings?: outputs.machinelearningservices.ImageModelSettingsClassificationResponse; /** * Primary metrics for classification tasks. */ primaryMetric?: string; /** * Search space for sampling different combinations of models and their hyperparameters. */ searchSpace?: outputs.machinelearningservices.ImageModelDistributionSettingsClassificationResponse[]; /** * Model sweeping and hyperparameter sweeping related settings. */ sweepSettings?: outputs.machinelearningservices.ImageSweepSettingsResponse; /** * Target column name: This is prediction values column. * Also known as label column name in context of classification tasks. */ targetColumnName?: string; /** * AutoMLJob Task type. * Expected value is 'ImageClassification'. */ taskType: "ImageClassification"; /** * [Required] Training data input. */ trainingData: outputs.machinelearningservices.MLTableJobInputResponse; /** * Validation data inputs. */ validationData?: outputs.machinelearningservices.MLTableJobInputResponse; /** * The fraction of training dataset that needs to be set aside for validation purpose. * Values between (0.0 , 1.0) * Applied when validation dataset is not provided. */ validationDataSize?: number; } /** * imageClassificationResponseProvideDefaults sets the appropriate defaults for ImageClassificationResponse */ function imageClassificationResponseProvideDefaults(val: ImageClassificationResponse): ImageClassificationResponse; /** * Image Instance Segmentation. Instance segmentation is used to identify objects in an image at the pixel level, * drawing a polygon around each object in the image. */ interface ImageInstanceSegmentationResponse { /** * [Required] Limit settings for the AutoML job. */ limitSettings: outputs.machinelearningservices.ImageLimitSettingsResponse; /** * Enum for setting log verbosity. */ logVerbosity?: string; /** * Settings used for training the model. */ modelSettings?: outputs.machinelearningservices.ImageModelSettingsObjectDetectionResponse; /** * Primary metrics for InstanceSegmentation tasks. */ primaryMetric?: string; /** * Search space for sampling different combinations of models and their hyperparameters. */ searchSpace?: outputs.machinelearningservices.ImageModelDistributionSettingsObjectDetectionResponse[]; /** * Model sweeping and hyperparameter sweeping related settings. */ sweepSettings?: outputs.machinelearningservices.ImageSweepSettingsResponse; /** * Target column name: This is prediction values column. * Also known as label column name in context of classification tasks. */ targetColumnName?: string; /** * AutoMLJob Task type. * Expected value is 'ImageInstanceSegmentation'. */ taskType: "ImageInstanceSegmentation"; /** * [Required] Training data input. */ trainingData: outputs.machinelearningservices.MLTableJobInputResponse; /** * Validation data inputs. */ validationData?: outputs.machinelearningservices.MLTableJobInputResponse; /** * The fraction of training dataset that needs to be set aside for validation purpose. * Values between (0.0 , 1.0) * Applied when validation dataset is not provided. */ validationDataSize?: number; } /** * imageInstanceSegmentationResponseProvideDefaults sets the appropriate defaults for ImageInstanceSegmentationResponse */ function imageInstanceSegmentationResponseProvideDefaults(val: ImageInstanceSegmentationResponse): ImageInstanceSegmentationResponse; /** * Limit settings for the AutoML job. */ interface ImageLimitSettingsResponse { /** * Maximum number of concurrent AutoML iterations. */ maxConcurrentTrials?: number; /** * Maximum number of AutoML iterations. */ maxTrials?: number; /** * AutoML job timeout. */ timeout?: string; } /** * imageLimitSettingsResponseProvideDefaults sets the appropriate defaults for ImageLimitSettingsResponse */ function imageLimitSettingsResponseProvideDefaults(val: ImageLimitSettingsResponse): ImageLimitSettingsResponse; /** * Returns metadata about the operating system image for this compute instance. */ interface ImageMetadataResponse { /** * Specifies the current operating system image version this compute instance is running on. */ currentImageVersion?: string; /** * Specifies whether this compute instance is running on the latest operating system image. */ isLatestOsImageVersion?: boolean; /** * Specifies the latest available operating system image version. */ latestImageVersion?: string; /** * Metadata about the os patching. */ osPatchingStatus: outputs.machinelearningservices.OsPatchingStatusResponse; } /** * Distribution expressions to sweep over values of model settings. * * Some examples are: * ``` * ModelName = "choice('seresnext', 'resnest50')"; * LearningRate = "uniform(0.001, 0.01)"; * LayersToFreeze = "choice(0, 2)"; * ``` * For more details on how to compose distribution expressions please check the documentation: * https://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters * For more information on the available settings please visit the official documentation: * https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.``` */ interface ImageModelDistributionSettingsClassificationResponse { /** * Enable AMSGrad when optimizer is 'adam' or 'adamw'. */ amsGradient?: string; /** * Settings for using Augmentations. */ augmentations?: string; /** * Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1]. */ beta1?: string; /** * Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1]. */ beta2?: string; /** * Whether to use distributer training. */ distributed?: string; /** * Enable early stopping logic during training. */ earlyStopping?: string; /** * Minimum number of epochs or validation evaluations to wait before primary metric improvement * is tracked for early stopping. Must be a positive integer. */ earlyStoppingDelay?: string; /** * Minimum number of epochs or validation evaluations with no primary metric improvement before * the run is stopped. Must be a positive integer. */ earlyStoppingPatience?: string; /** * Enable normalization when exporting ONNX model. */ enableOnnxNormalization?: string; /** * Frequency to evaluate validation dataset to get metric scores. Must be a positive integer. */ evaluationFrequency?: string; /** * Gradient accumulation means running a configured number of "GradAccumulationStep" steps without * updating the model weights while accumulating the gradients of those steps, and then using * the accumulated gradients to compute the weight updates. Must be a positive integer. */ gradientAccumulationStep?: string; /** * Number of layers to freeze for the model. Must be a positive integer. * For instance, passing 2 as value for 'seresnext' means * freezing layer0 and layer1. For a full list of models supported and details on layer freeze, please * see: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models. */ layersToFreeze?: string; /** * Initial learning rate. Must be a float in the range [0, 1]. */ learningRate?: string; /** * Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'. */ learningRateScheduler?: string; /** * Name of the model to use for training. * For more information on the available models please visit the official documentation: * https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models. */ modelName?: string; /** * Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1]. */ momentum?: string; /** * Enable nesterov when optimizer is 'sgd'. */ nesterov?: string; /** * Number of training epochs. Must be a positive integer. */ numberOfEpochs?: string; /** * Number of data loader workers. Must be a non-negative integer. */ numberOfWorkers?: string; /** * Type of optimizer. Must be either 'sgd', 'adam', or 'adamw'. */ optimizer?: string; /** * Random seed to be used when using deterministic training. */ randomSeed?: string; /** * Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1]. */ stepLRGamma?: string; /** * Value of step size when learning rate scheduler is 'step'. Must be a positive integer. */ stepLRStepSize?: string; /** * Training batch size. Must be a positive integer. */ trainingBatchSize?: string; /** * Image crop size that is input to the neural network for the training dataset. Must be a positive integer. */ trainingCropSize?: string; /** * Validation batch size. Must be a positive integer. */ validationBatchSize?: string; /** * Image crop size that is input to the neural network for the validation dataset. Must be a positive integer. */ validationCropSize?: string; /** * Image size to which to resize before cropping for validation dataset. Must be a positive integer. */ validationResizeSize?: string; /** * Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1]. */ warmupCosineLRCycles?: string; /** * Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer. */ warmupCosineLRWarmupEpochs?: string; /** * Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1]. */ weightDecay?: string; /** * Weighted loss. The accepted values are 0 for no weighted loss. * 1 for weighted loss with sqrt.(class_weights). 2 for weighted loss with class_weights. Must be 0 or 1 or 2. */ weightedLoss?: string; } /** * Distribution expressions to sweep over values of model settings. * * Some examples are: * ``` * ModelName = "choice('seresnext', 'resnest50')"; * LearningRate = "uniform(0.001, 0.01)"; * LayersToFreeze = "choice(0, 2)"; * ``` * For more details on how to compose distribution expressions please check the documentation: * https://docs.microsoft.com/en-us/azure/machine-learning/how-to-tune-hyperparameters * For more information on the available settings please visit the official documentation: * https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models.``` */ interface ImageModelDistributionSettingsObjectDetectionResponse { /** * Enable AMSGrad when optimizer is 'adam' or 'adamw'. */ amsGradient?: string; /** * Settings for using Augmentations. */ augmentations?: string; /** * Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1]. */ beta1?: string; /** * Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1]. */ beta2?: string; /** * Maximum number of detections per image, for all classes. Must be a positive integer. * Note: This settings is not supported for the 'yolov5' algorithm. */ boxDetectionsPerImage?: string; /** * During inference, only return proposals with a classification score greater than * BoxScoreThreshold. Must be a float in the range[0, 1]. */ boxScoreThreshold?: string; /** * Whether to use distributer training. */ distributed?: string; /** * Enable early stopping logic during training. */ earlyStopping?: string; /** * Minimum number of epochs or validation evaluations to wait before primary metric improvement * is tracked for early stopping. Must be a positive integer. */ earlyStoppingDelay?: string; /** * Minimum number of epochs or validation evaluations with no primary metric improvement before * the run is stopped. Must be a positive integer. */ earlyStoppingPatience?: string; /** * Enable normalization when exporting ONNX model. */ enableOnnxNormalization?: string; /** * Frequency to evaluate validation dataset to get metric scores. Must be a positive integer. */ evaluationFrequency?: string; /** * Gradient accumulation means running a configured number of "GradAccumulationStep" steps without * updating the model weights while accumulating the gradients of those steps, and then using * the accumulated gradients to compute the weight updates. Must be a positive integer. */ gradientAccumulationStep?: string; /** * Image size for train and validation. Must be a positive integer. * Note: The training run may get into CUDA OOM if the size is too big. * Note: This settings is only supported for the 'yolov5' algorithm. */ imageSize?: string; /** * Number of layers to freeze for the model. Must be a positive integer. * For instance, passing 2 as value for 'seresnext' means * freezing layer0 and layer1. For a full list of models supported and details on layer freeze, please * see: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models. */ layersToFreeze?: string; /** * Initial learning rate. Must be a float in the range [0, 1]. */ learningRate?: string; /** * Type of learning rate scheduler. Must be 'warmup_cosine' or 'step'. */ learningRateScheduler?: string; /** * Maximum size of the image to be rescaled before feeding it to the backbone. * Must be a positive integer. Note: training run may get into CUDA OOM if the size is too big. * Note: This settings is not supported for the 'yolov5' algorithm. */ maxSize?: string; /** * Minimum size of the image to be rescaled before feeding it to the backbone. * Must be a positive integer. Note: training run may get into CUDA OOM if the size is too big. * Note: This settings is not supported for the 'yolov5' algorithm. */ minSize?: string; /** * Name of the model to use for training. * For more information on the available models please visit the official documentation: * https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models. */ modelName?: string; /** * Model size. Must be 'small', 'medium', 'large', or 'xlarge'. * Note: training run may get into CUDA OOM if the model size is too big. * Note: This settings is only supported for the 'yolov5' algorithm. */ modelSize?: string; /** * Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1]. */ momentum?: string; /** * Enable multi-scale image by varying image size by +/- 50%. * Note: training run may get into CUDA OOM if no sufficient GPU memory. * Note: This settings is only supported for the 'yolov5' algorithm. */ multiScale?: string; /** * Enable nesterov when optimizer is 'sgd'. */ nesterov?: string; /** * IOU threshold used during inference in NMS post processing. Must be float in the range [0, 1]. */ nmsIouThreshold?: string; /** * Number of training epochs. Must be a positive integer. */ numberOfEpochs?: string; /** * Number of data loader workers. Must be a non-negative integer. */ numberOfWorkers?: string; /** * Type of optimizer. Must be either 'sgd', 'adam', or 'adamw'. */ optimizer?: string; /** * Random seed to be used when using deterministic training. */ randomSeed?: string; /** * Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1]. */ stepLRGamma?: string; /** * Value of step size when learning rate scheduler is 'step'. Must be a positive integer. */ stepLRStepSize?: string; /** * The grid size to use for tiling each image. Note: TileGridSize must not be * None to enable small object detection logic. A string containing two integers in mxn format. * Note: This settings is not supported for the 'yolov5' algorithm. */ tileGridSize?: string; /** * Overlap ratio between adjacent tiles in each dimension. Must be float in the range [0, 1). * Note: This settings is not supported for the 'yolov5' algorithm. */ tileOverlapRatio?: string; /** * The IOU threshold to use to perform NMS while merging predictions from tiles and image. * Used in validation/ inference. Must be float in the range [0, 1]. * Note: This settings is not supported for the 'yolov5' algorithm. * NMS: Non-maximum suppression */ tilePredictionsNmsThreshold?: string; /** * Training batch size. Must be a positive integer. */ trainingBatchSize?: string; /** * Validation batch size. Must be a positive integer. */ validationBatchSize?: string; /** * IOU threshold to use when computing validation metric. Must be float in the range [0, 1]. */ validationIouThreshold?: string; /** * Metric computation method to use for validation metrics. Must be 'none', 'coco', 'voc', or 'coco_voc'. */ validationMetricType?: string; /** * Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1]. */ warmupCosineLRCycles?: string; /** * Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer. */ warmupCosineLRWarmupEpochs?: string; /** * Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1]. */ weightDecay?: string; } /** * Settings used for training the model. * For more information on the available settings please visit the official documentation: * https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models. */ interface ImageModelSettingsClassificationResponse { /** * Settings for advanced scenarios. */ advancedSettings?: string; /** * Enable AMSGrad when optimizer is 'adam' or 'adamw'. */ amsGradient?: boolean; /** * Settings for using Augmentations. */ augmentations?: string; /** * Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1]. */ beta1?: number; /** * Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1]. */ beta2?: number; /** * Frequency to store model checkpoints. Must be a positive integer. */ checkpointFrequency?: number; /** * The pretrained checkpoint model for incremental training. */ checkpointModel?: outputs.machinelearningservices.MLFlowModelJobInputResponse; /** * The id of a previous run that has a pretrained checkpoint for incremental training. */ checkpointRunId?: string; /** * Whether to use distributed training. */ distributed?: boolean; /** * Enable early stopping logic during training. */ earlyStopping?: boolean; /** * Minimum number of epochs or validation evaluations to wait before primary metric improvement * is tracked for early stopping. Must be a positive integer. */ earlyStoppingDelay?: number; /** * Minimum number of epochs or validation evaluations with no primary metric improvement before * the run is stopped. Must be a positive integer. */ earlyStoppingPatience?: number; /** * Enable normalization when exporting ONNX model. */ enableOnnxNormalization?: boolean; /** * Frequency to evaluate validation dataset to get metric scores. Must be a positive integer. */ evaluationFrequency?: number; /** * Gradient accumulation means running a configured number of "GradAccumulationStep" steps without * updating the model weights while accumulating the gradients of those steps, and then using * the accumulated gradients to compute the weight updates. Must be a positive integer. */ gradientAccumulationStep?: number; /** * Number of layers to freeze for the model. Must be a positive integer. * For instance, passing 2 as value for 'seresnext' means * freezing layer0 and layer1. For a full list of models supported and details on layer freeze, please * see: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models. */ layersToFreeze?: number; /** * Initial learning rate. Must be a float in the range [0, 1]. */ learningRate?: number; /** * Learning rate scheduler enum. */ learningRateScheduler?: string; /** * Name of the model to use for training. * For more information on the available models please visit the official documentation: * https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models. */ modelName?: string; /** * Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1]. */ momentum?: number; /** * Enable nesterov when optimizer is 'sgd'. */ nesterov?: boolean; /** * Number of training epochs. Must be a positive integer. */ numberOfEpochs?: number; /** * Number of data loader workers. Must be a non-negative integer. */ numberOfWorkers?: number; /** * Stochastic optimizer for image models. */ optimizer?: string; /** * Random seed to be used when using deterministic training. */ randomSeed?: number; /** * Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1]. */ stepLRGamma?: number; /** * Value of step size when learning rate scheduler is 'step'. Must be a positive integer. */ stepLRStepSize?: number; /** * Training batch size. Must be a positive integer. */ trainingBatchSize?: number; /** * Image crop size that is input to the neural network for the training dataset. Must be a positive integer. */ trainingCropSize?: number; /** * Validation batch size. Must be a positive integer. */ validationBatchSize?: number; /** * Image crop size that is input to the neural network for the validation dataset. Must be a positive integer. */ validationCropSize?: number; /** * Image size to which to resize before cropping for validation dataset. Must be a positive integer. */ validationResizeSize?: number; /** * Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1]. */ warmupCosineLRCycles?: number; /** * Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer. */ warmupCosineLRWarmupEpochs?: number; /** * Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1]. */ weightDecay?: number; /** * Weighted loss. The accepted values are 0 for no weighted loss. * 1 for weighted loss with sqrt.(class_weights). 2 for weighted loss with class_weights. Must be 0 or 1 or 2. */ weightedLoss?: number; } /** * imageModelSettingsClassificationResponseProvideDefaults sets the appropriate defaults for ImageModelSettingsClassificationResponse */ function imageModelSettingsClassificationResponseProvideDefaults(val: ImageModelSettingsClassificationResponse): ImageModelSettingsClassificationResponse; /** * Settings used for training the model. * For more information on the available settings please visit the official documentation: * https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models. */ interface ImageModelSettingsObjectDetectionResponse { /** * Settings for advanced scenarios. */ advancedSettings?: string; /** * Enable AMSGrad when optimizer is 'adam' or 'adamw'. */ amsGradient?: boolean; /** * Settings for using Augmentations. */ augmentations?: string; /** * Value of 'beta1' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1]. */ beta1?: number; /** * Value of 'beta2' when optimizer is 'adam' or 'adamw'. Must be a float in the range [0, 1]. */ beta2?: number; /** * Maximum number of detections per image, for all classes. Must be a positive integer. * Note: This settings is not supported for the 'yolov5' algorithm. */ boxDetectionsPerImage?: number; /** * During inference, only return proposals with a classification score greater than * BoxScoreThreshold. Must be a float in the range[0, 1]. */ boxScoreThreshold?: number; /** * Frequency to store model checkpoints. Must be a positive integer. */ checkpointFrequency?: number; /** * The pretrained checkpoint model for incremental training. */ checkpointModel?: outputs.machinelearningservices.MLFlowModelJobInputResponse; /** * The id of a previous run that has a pretrained checkpoint for incremental training. */ checkpointRunId?: string; /** * Whether to use distributed training. */ distributed?: boolean; /** * Enable early stopping logic during training. */ earlyStopping?: boolean; /** * Minimum number of epochs or validation evaluations to wait before primary metric improvement * is tracked for early stopping. Must be a positive integer. */ earlyStoppingDelay?: number; /** * Minimum number of epochs or validation evaluations with no primary metric improvement before * the run is stopped. Must be a positive integer. */ earlyStoppingPatience?: number; /** * Enable normalization when exporting ONNX model. */ enableOnnxNormalization?: boolean; /** * Frequency to evaluate validation dataset to get metric scores. Must be a positive integer. */ evaluationFrequency?: number; /** * Gradient accumulation means running a configured number of "GradAccumulationStep" steps without * updating the model weights while accumulating the gradients of those steps, and then using * the accumulated gradients to compute the weight updates. Must be a positive integer. */ gradientAccumulationStep?: number; /** * Image size for train and validation. Must be a positive integer. * Note: The training run may get into CUDA OOM if the size is too big. * Note: This settings is only supported for the 'yolov5' algorithm. */ imageSize?: number; /** * Number of layers to freeze for the model. Must be a positive integer. * For instance, passing 2 as value for 'seresnext' means * freezing layer0 and layer1. For a full list of models supported and details on layer freeze, please * see: https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models. */ layersToFreeze?: number; /** * Initial learning rate. Must be a float in the range [0, 1]. */ learningRate?: number; /** * Learning rate scheduler enum. */ learningRateScheduler?: string; /** * Maximum size of the image to be rescaled before feeding it to the backbone. * Must be a positive integer. Note: training run may get into CUDA OOM if the size is too big. * Note: This settings is not supported for the 'yolov5' algorithm. */ maxSize?: number; /** * Minimum size of the image to be rescaled before feeding it to the backbone. * Must be a positive integer. Note: training run may get into CUDA OOM if the size is too big. * Note: This settings is not supported for the 'yolov5' algorithm. */ minSize?: number; /** * Name of the model to use for training. * For more information on the available models please visit the official documentation: * https://docs.microsoft.com/en-us/azure/machine-learning/how-to-auto-train-image-models. */ modelName?: string; /** * Image model size. */ modelSize?: string; /** * Value of momentum when optimizer is 'sgd'. Must be a float in the range [0, 1]. */ momentum?: number; /** * Enable multi-scale image by varying image size by +/- 50%. * Note: training run may get into CUDA OOM if no sufficient GPU memory. * Note: This settings is only supported for the 'yolov5' algorithm. */ multiScale?: boolean; /** * Enable nesterov when optimizer is 'sgd'. */ nesterov?: boolean; /** * IOU threshold used during inference in NMS post processing. Must be a float in the range [0, 1]. */ nmsIouThreshold?: number; /** * Number of training epochs. Must be a positive integer. */ numberOfEpochs?: number; /** * Number of data loader workers. Must be a non-negative integer. */ numberOfWorkers?: number; /** * Stochastic optimizer for image models. */ optimizer?: string; /** * Random seed to be used when using deterministic training. */ randomSeed?: number; /** * Value of gamma when learning rate scheduler is 'step'. Must be a float in the range [0, 1]. */ stepLRGamma?: number; /** * Value of step size when learning rate scheduler is 'step'. Must be a positive integer. */ stepLRStepSize?: number; /** * The grid size to use for tiling each image. Note: TileGridSize must not be * None to enable small object detection logic. A string containing two integers in mxn format. * Note: This settings is not supported for the 'yolov5' algorithm. */ tileGridSize?: string; /** * Overlap ratio between adjacent tiles in each dimension. Must be float in the range [0, 1). * Note: This settings is not supported for the 'yolov5' algorithm. */ tileOverlapRatio?: number; /** * The IOU threshold to use to perform NMS while merging predictions from tiles and image. * Used in validation/ inference. Must be float in the range [0, 1]. * Note: This settings is not supported for the 'yolov5' algorithm. */ tilePredictionsNmsThreshold?: number; /** * Training batch size. Must be a positive integer. */ trainingBatchSize?: number; /** * Validation batch size. Must be a positive integer. */ validationBatchSize?: number; /** * IOU threshold to use when computing validation metric. Must be float in the range [0, 1]. */ validationIouThreshold?: number; /** * Metric computation method to use for validation metrics in image tasks. */ validationMetricType?: string; /** * Value of cosine cycle when learning rate scheduler is 'warmup_cosine'. Must be a float in the range [0, 1]. */ warmupCosineLRCycles?: number; /** * Value of warmup epochs when learning rate scheduler is 'warmup_cosine'. Must be a positive integer. */ warmupCosineLRWarmupEpochs?: number; /** * Value of weight decay when optimizer is 'sgd', 'adam', or 'adamw'. Must be a float in the range[0, 1]. */ weightDecay?: number; } /** * imageModelSettingsObjectDetectionResponseProvideDefaults sets the appropriate defaults for ImageModelSettingsObjectDetectionResponse */ function imageModelSettingsObjectDetectionResponseProvideDefaults(val: ImageModelSettingsObjectDetectionResponse): ImageModelSettingsObjectDetectionResponse; /** * Image Object Detection. Object detection is used to identify objects in an image and locate each object with a * bounding box e.g. locate all dogs and cats in an image and draw a bounding box around each. */ interface ImageObjectDetectionResponse { /** * [Required] Limit settings for the AutoML job. */ limitSettings: outputs.machinelearningservices.ImageLimitSettingsResponse; /** * Enum for setting log verbosity. */ logVerbosity?: string; /** * Settings used for training the model. */ modelSettings?: outputs.machinelearningservices.ImageModelSettingsObjectDetectionResponse; /** * Primary metrics for Image ObjectDetection task. */ primaryMetric?: string; /** * Search space for sampling different combinations of models and their hyperparameters. */ searchSpace?: outputs.machinelearningservices.ImageModelDistributionSettingsObjectDetectionResponse[]; /** * Model sweeping and hyperparameter sweeping related settings. */ sweepSettings?: outputs.machinelearningservices.ImageSweepSettingsResponse; /** * Target column name: This is prediction values column. * Also known as label column name in context of classification tasks. */ targetColumnName?: string; /** * AutoMLJob Task type. * Expected value is 'ImageObjectDetection'. */ taskType: "ImageObjectDetection"; /** * [Required] Training data input. */ trainingData: outputs.machinelearningservices.MLTableJobInputResponse; /** * Validation data inputs. */ validationData?: outputs.machinelearningservices.MLTableJobInputResponse; /** * The fraction of training dataset that needs to be set aside for validation purpose. * Values between (0.0 , 1.0) * Applied when validation dataset is not provided. */ validationDataSize?: number; } /** * imageObjectDetectionResponseProvideDefaults sets the appropriate defaults for ImageObjectDetectionResponse */ function imageObjectDetectionResponseProvideDefaults(val: ImageObjectDetectionResponse): ImageObjectDetectionResponse; interface ImageResponse { /** * Image reference URL if type is docker. Environment name if type is azureml */ reference?: string; /** * Type of the image. Possible values are: docker - For docker images. azureml - For AzureML Environment images (custom and curated) */ type?: string; /** * Version of image being used. If latest then skip this field */ version?: string; } /** * imageResponseProvideDefaults sets the appropriate defaults for ImageResponse */ function imageResponseProvideDefaults(val: ImageResponse): ImageResponse; /** * Model sweeping and hyperparameter sweeping related settings. */ interface ImageSweepSettingsResponse { /** * Type of early termination policy. */ earlyTermination?: outputs.machinelearningservices.BanditPolicyResponse | outputs.machinelearningservices.MedianStoppingPolicyResponse | outputs.machinelearningservices.TruncationSelectionPolicyResponse; /** * [Required] Type of the hyperparameter sampling algorithms. */ samplingAlgorithm: string; } /** * DTO object representing index column */ interface IndexColumnResponse { /** * Specifies the column name */ columnName?: string; /** * Specifies the data type */ dataType?: string; } /** * indexColumnResponseProvideDefaults sets the appropriate defaults for IndexColumnResponse */ function indexColumnResponseProvideDefaults(val: IndexColumnResponse): IndexColumnResponse; interface InferenceContainerPropertiesEnvironmentVersionResponse { /** * The route to check the liveness of the inference server container. */ livenessRoute?: outputs.machinelearningservices.RouteResponse; /** * The route to check the readiness of the inference server container. */ readinessRoute?: outputs.machinelearningservices.RouteResponse; /** * The port to send the scoring requests to, within the inference server container. */ scoringRoute?: outputs.machinelearningservices.RouteResponse; /** * The route to check the startup of the application in the container. */ startupRoute?: outputs.machinelearningservices.RouteResponse; } interface InferenceContainerPropertiesRegistryEnvironmentVersionResponse { /** * The route to check the liveness of the inference server container. */ livenessRoute?: outputs.machinelearningservices.RouteResponse; /** * The route to check the readiness of the inference server container. */ readinessRoute?: outputs.machinelearningservices.RouteResponse; /** * The port to send the scoring requests to, within the inference server container. */ scoringRoute?: outputs.machinelearningservices.RouteResponse; /** * The route to check the startup of the application in the container. */ startupRoute?: outputs.machinelearningservices.RouteResponse; } interface InferenceContainerPropertiesResponse { /** * The route to check the liveness of the inference server container. */ livenessRoute?: outputs.machinelearningservices.RouteResponse; /** * The route to check the readiness of the inference server container. */ readinessRoute?: outputs.machinelearningservices.RouteResponse; /** * The port to send the scoring requests to, within the inference server container. */ scoringRoute?: outputs.machinelearningservices.RouteResponse; } /** * InferenceEndpoint configuration */ interface InferenceEndpointResponse { /** * [Required] Authentication mode for the endpoint. */ authMode: string; /** * Description of the resource. */ description?: string; /** * Endpoint URI for the inference endpoint. */ endpointUri: string; /** * [Required] Group within the same pool with which this endpoint needs to be associated with. */ groupName: string; /** * Property dictionary. Properties can be added, but not removed or altered. */ properties?: outputs.machinelearningservices.StringStringKeyValuePairResponse[]; /** * Provisioning state for the endpoint. */ provisioningState: string; /** * RequestConfiguration for endpoint. */ requestConfiguration?: outputs.machinelearningservices.RequestConfigurationResponse; } /** * inferenceEndpointResponseProvideDefaults sets the appropriate defaults for InferenceEndpointResponse */ function inferenceEndpointResponseProvideDefaults(val: InferenceEndpointResponse): InferenceEndpointResponse; /** * Inference group configuration */ interface InferenceGroupResponse { /** * Description of the resource. */ description?: string; /** * Gets or sets environment configuration for the inference group. Used if PoolType=ScaleUnit. */ environmentConfiguration?: outputs.machinelearningservices.GroupEnvironmentConfigurationResponse; /** * Gets or sets model configuration for the inference group. Used if PoolType=ScaleUnit. */ modelConfiguration?: outputs.machinelearningservices.GroupModelConfigurationResponse; /** * Gets or sets compute instance type. */ nodeSkuType?: string; /** * Property dictionary. Properties can be added, but not removed or altered. */ properties?: outputs.machinelearningservices.StringStringKeyValuePairResponse[]; /** * Provisioning state for the inference group. */ provisioningState: string; /** * Gets or sets Scale Unit size. */ scaleUnitSize?: number; } /** * inferenceGroupResponseProvideDefaults sets the appropriate defaults for InferenceGroupResponse */ function inferenceGroupResponseProvideDefaults(val: InferenceGroupResponse): InferenceGroupResponse; /** * Inference pool configuration */ interface InferencePoolResponse { /** * Description of the resource. */ description?: string; /** * Property dictionary. Properties can be added, but not removed or altered. */ properties?: outputs.machinelearningservices.StringStringKeyValuePairResponse[]; /** * Provisioning state for the pool. */ provisioningState: string; /** * Gets or sets ScaleUnitConfiguration for the inference pool. Used if PoolType=ScaleUnit. */ scaleUnitConfiguration?: outputs.machinelearningservices.ScaleUnitConfigurationResponse; } /** * inferencePoolResponseProvideDefaults sets the appropriate defaults for InferencePoolResponse */ function inferencePoolResponseProvideDefaults(val: InferencePoolResponse): InferencePoolResponse; /** * Resource requests/limits for this instance type */ interface InstanceTypeSchemaResourcesResponse { /** * Resource limits for this instance type */ limits?: { [key: string]: string; }; /** * Resource requests for this instance type */ requests?: { [key: string]: string; }; } /** * Instance type schema. */ interface InstanceTypeSchemaResponse { /** * Node Selector */ nodeSelector?: { [key: string]: string; }; /** * Resource requests/limits for this instance type */ resources?: outputs.machinelearningservices.InstanceTypeSchemaResourcesResponse; } interface JobResourceConfigurationResponse { /** * Extra arguments to pass to the Docker run command. This would override any parameters that have already been set by the system, or in this section. This parameter is only supported for Azure ML compute types. */ dockerArgs?: string; /** * Extra arguments to pass to the Docker run command, as a collection. This would override any parameters that have already been set by the system, or in this section. This parameter is only supported for Azure ML compute types. */ dockerArgsList?: string[]; /** * Optional number of instances or nodes used by the compute target. */ instanceCount?: number; /** * Optional type of VM used as supported by the compute target. */ instanceType?: string; /** * Additional properties bag. */ properties?: { [key: string]: any; }; /** * Size of the docker container's shared memory block. This should be in the format of (number)(unit) where number as to be greater than 0 and the unit can be one of b(bytes), k(kilobytes), m(megabytes), or g(gigabytes). */ shmSize?: string; } /** * jobResourceConfigurationResponseProvideDefaults sets the appropriate defaults for JobResourceConfigurationResponse */ function jobResourceConfigurationResponseProvideDefaults(val: JobResourceConfigurationResponse): JobResourceConfigurationResponse; interface JobScheduleActionResponse { /** * Expected value is 'CreateJob'. */ actionType: "CreateJob"; /** * [Required] Defines Schedule action definition details. */ jobDefinition: outputs.machinelearningservices.AutoMLJobResponse | outputs.machinelearningservices.CommandJobResponse | outputs.machinelearningservices.PipelineJobResponse | outputs.machinelearningservices.SparkJobResponse | outputs.machinelearningservices.SweepJobResponse; } /** * Job endpoint definition */ interface JobServiceResponse { /** * Url for endpoint. */ endpoint?: string; /** * Any error in the service. */ errorMessage: string; /** * Endpoint type. */ jobServiceType?: string; /** * Nodes that user would like to start the service on. * If Nodes is not set or set to null, the service will only be started on leader node. */ nodes?: outputs.machinelearningservices.AllNodesResponse; /** * Port for endpoint. */ port?: number; /** * Additional properties to set on the endpoint. */ properties?: { [key: string]: string; }; /** * Status of endpoint. */ status: string; } /** * Jupyter kernel configuration. */ interface JupyterKernelConfigResponse { /** * Argument to the the runtime */ argv?: string[]; /** * Display name of the kernel */ displayName?: string; /** * Language of the kernel [Example value: python] */ language?: string; } /** * Customer Key vault properties. */ interface KeyVaultPropertiesResponse { /** * Currently, we support only SystemAssigned MSI. * We need this when we support UserAssignedIdentities */ identityClientId?: string; /** * KeyVault key identifier to encrypt the data */ keyIdentifier: string; /** * KeyVault Arm Id that contains the data encryption key */ keyVaultArmId: string; } /** * Properties specific to a KubernetesOnlineDeployment. */ interface KubernetesOnlineDeploymentResponse { /** * If true, enables Application Insights logging. */ appInsightsEnabled?: boolean; /** * Code configuration for the endpoint deployment. */ codeConfiguration?: outputs.machinelearningservices.CodeConfigurationResponse; /** * The resource requirements for the container (cpu and memory). */ containerResourceRequirements?: outputs.machinelearningservices.ContainerResourceRequirementsResponse; /** * The mdc configuration, we disable mdc when it's null. */ dataCollector?: outputs.machinelearningservices.DataCollectorResponse; /** * Description of the endpoint deployment. */ description?: string; /** * Enum to determine whether PublicNetworkAccess is Enabled or Disabled for egress of a deployment. */ egressPublicNetworkAccess?: string; /** * Enum to determine endpoint compute type. * Expected value is 'Kubernetes'. */ endpointComputeType: "Kubernetes"; /** * ARM resource ID or AssetId of the environment specification for the endpoint deployment. */ environmentId?: string; /** * Environment variables configuration for the deployment. */ environmentVariables?: { [key: string]: string; }; /** * Compute instance type. Default: Standard_F4s_v2. */ instanceType?: string; /** * Liveness probe monitors the health of the container regularly. */ livenessProbe?: outputs.machinelearningservices.ProbeSettingsResponse; /** * The URI path to the model. */ model?: string; /** * The path to mount the model in custom container. */ modelMountPath?: string; /** * Property dictionary. Properties can be added, but not removed or altered. */ properties?: { [key: string]: string; }; /** * Provisioning state for the endpoint deployment. */ provisioningState: string; /** * Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe. */ readinessProbe?: outputs.machinelearningservices.ProbeSettingsResponse; /** * Request settings for the deployment. */ requestSettings?: outputs.machinelearningservices.OnlineRequestSettingsResponse; /** * Scale settings for the deployment. * If it is null or not provided, * it defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment * and to DefaultScaleSettings for ManagedOnlineDeployment. */ scaleSettings?: outputs.machinelearningservices.DefaultScaleSettingsResponse | outputs.machinelearningservices.TargetUtilizationScaleSettingsResponse; /** * Startup probe verify whether an application within a container has started successfully. */ startupProbe?: outputs.machinelearningservices.ProbeSettingsResponse; } /** * kubernetesOnlineDeploymentResponseProvideDefaults sets the appropriate defaults for KubernetesOnlineDeploymentResponse */ function kubernetesOnlineDeploymentResponseProvideDefaults(val: KubernetesOnlineDeploymentResponse): KubernetesOnlineDeploymentResponse; /** * Kubernetes properties */ interface KubernetesPropertiesResponse { /** * Default instance type */ defaultInstanceType?: string; /** * Extension instance release train. */ extensionInstanceReleaseTrain?: string; /** * Extension principal-id. */ extensionPrincipalId?: string; /** * Instance Type Schema */ instanceTypes?: { [key: string]: outputs.machinelearningservices.InstanceTypeSchemaResponse; }; /** * Compute namespace */ namespace?: string; /** * Relay connection string. */ relayConnectionString?: string; /** * ServiceBus connection string. */ serviceBusConnectionString?: string; /** * VC name. */ vcName?: string; } /** * kubernetesPropertiesResponseProvideDefaults sets the appropriate defaults for KubernetesPropertiesResponse */ function kubernetesPropertiesResponseProvideDefaults(val: KubernetesPropertiesResponse): KubernetesPropertiesResponse; /** * A Machine Learning compute based on Kubernetes Compute. */ interface KubernetesResponse { /** * Location for the underlying compute */ computeLocation?: string; /** * The type of compute * Expected value is 'Kubernetes'. */ computeType: "Kubernetes"; /** * The time at which the compute was created. */ createdOn: string; /** * The description of the Machine Learning compute. */ description?: string; /** * Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. */ disableLocalAuth?: boolean; /** * Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. */ isAttachedCompute: boolean; /** * The time at which the compute was last modified. */ modifiedOn: string; /** * Properties of Kubernetes */ properties?: outputs.machinelearningservices.KubernetesPropertiesResponse; /** * Errors during provisioning */ provisioningErrors: outputs.machinelearningservices.ErrorResponseResponse[]; /** * The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. */ provisioningState: string; /** * ARM resource id of the underlying compute */ resourceId?: string; } /** * kubernetesResponseProvideDefaults sets the appropriate defaults for KubernetesResponse */ function kubernetesResponseProvideDefaults(val: KubernetesResponse): KubernetesResponse; /** * Label category definition */ interface LabelCategoryResponse { /** * Dictionary of label classes in this category. */ classes?: { [key: string]: outputs.machinelearningservices.LabelClassResponse; }; /** * Display name of the label category. */ displayName?: string; /** * Indicates whether it is allowed to select multiple classes in this category. */ multiSelect?: string; } /** * labelCategoryResponseProvideDefaults sets the appropriate defaults for LabelCategoryResponse */ function labelCategoryResponseProvideDefaults(val: LabelCategoryResponse): LabelCategoryResponse; /** * Label class definition */ interface LabelClassResponse { /** * Display name of the label class. */ displayName?: string; /** * Dictionary of subclasses of the label class. */ subclasses?: { [key: string]: outputs.machinelearningservices.LabelClassResponse; }; } /** * Labeling data configuration definition */ interface LabelingDataConfigurationResponse { /** * Resource Id of the data asset to perform labeling. */ dataId?: string; /** * Indicates whether to enable incremental data refresh. */ incrementalDataRefresh?: string; } /** * labelingDataConfigurationResponseProvideDefaults sets the appropriate defaults for LabelingDataConfigurationResponse */ function labelingDataConfigurationResponseProvideDefaults(val: LabelingDataConfigurationResponse): LabelingDataConfigurationResponse; /** * Properties of a labeling job for image data */ interface LabelingJobImagePropertiesResponse { /** * Annotation type of image labeling job. */ annotationType?: string; /** * Media type of data asset. * Expected value is 'Image'. */ mediaType: "Image"; } /** * labelingJobImagePropertiesResponseProvideDefaults sets the appropriate defaults for LabelingJobImagePropertiesResponse */ function labelingJobImagePropertiesResponseProvideDefaults(val: LabelingJobImagePropertiesResponse): LabelingJobImagePropertiesResponse; /** * Instructions for labeling job */ interface LabelingJobInstructionsResponse { /** * The link to a page with detailed labeling instructions for labelers. */ uri?: string; } /** * Labeling job definition */ interface LabelingJobResponse { /** * ARM resource ID of the component resource. */ componentId?: string; /** * ARM resource ID of the compute resource. */ computeId?: string; /** * Created time of the job in UTC timezone. */ createdDateTime: string; /** * Configuration of data used in the job. */ dataConfiguration?: outputs.machinelearningservices.LabelingDataConfigurationResponse; /** * The asset description text. */ description?: string; /** * Display name of job. */ displayName?: string; /** * The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment. */ experimentName?: string; /** * Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. * Defaults to AmlToken if null. */ identity?: outputs.machinelearningservices.AmlTokenResponse | outputs.machinelearningservices.ManagedIdentityResponse | outputs.machinelearningservices.UserIdentityResponse; /** * Is the asset archived? */ isArchived?: boolean; /** * Labeling instructions of the job. */ jobInstructions?: outputs.machinelearningservices.LabelingJobInstructionsResponse; /** * Enum to determine the type of job. * Expected value is 'Labeling'. */ jobType: "Labeling"; /** * Label categories of the job. */ labelCategories?: { [key: string]: outputs.machinelearningservices.LabelCategoryResponse; }; /** * Media type specific properties in the job. */ labelingJobMediaProperties?: outputs.machinelearningservices.LabelingJobImagePropertiesResponse | outputs.machinelearningservices.LabelingJobTextPropertiesResponse; /** * Configuration of MLAssist feature in the job. */ mlAssistConfiguration?: outputs.machinelearningservices.MLAssistConfigurationDisabledResponse | outputs.machinelearningservices.MLAssistConfigurationEnabledResponse; /** * Notification setting for the job */ notificationSetting?: outputs.machinelearningservices.NotificationSettingResponse; /** * Progress metrics of the job. */ progressMetrics: outputs.machinelearningservices.ProgressMetricsResponse; /** * Internal id of the job(Previously called project). */ projectId: string; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Specifies the labeling job provisioning state. */ provisioningState: string; /** * Configuration for secrets to be made available during runtime. */ secretsConfiguration?: { [key: string]: outputs.machinelearningservices.SecretConfigurationResponse; }; /** * List of JobEndpoints. * For local jobs, a job endpoint will have an endpoint value of FileStreamObject. */ services?: { [key: string]: outputs.machinelearningservices.JobServiceResponse; }; /** * Status of the job. */ status: string; /** * Status messages of the job. */ statusMessages: outputs.machinelearningservices.StatusMessageResponse[]; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * labelingJobResponseProvideDefaults sets the appropriate defaults for LabelingJobResponse */ function labelingJobResponseProvideDefaults(val: LabelingJobResponse): LabelingJobResponse; /** * Properties of a labeling job for text data */ interface LabelingJobTextPropertiesResponse { /** * Annotation type of text labeling job. */ annotationType?: string; /** * Media type of data asset. * Expected value is 'Text'. */ mediaType: "Text"; } /** * labelingJobTextPropertiesResponseProvideDefaults sets the appropriate defaults for LabelingJobTextPropertiesResponse */ function labelingJobTextPropertiesResponseProvideDefaults(val: LabelingJobTextPropertiesResponse): LabelingJobTextPropertiesResponse; interface LakeHouseArtifactResponse { /** * [Required] OneLake artifact name */ artifactName: string; /** * Enum to determine OneLake artifact type. * Expected value is 'LakeHouse'. */ artifactType: "LakeHouse"; } /** * Info about origin if it is linked. */ interface LinkedInfoResponse { /** * LinkedId id. */ linkedId?: string; /** * Linked resource name. */ linkedResourceName?: string; /** * Datastore origin */ origin?: string; } /** * LinkedService specific properties. */ interface LinkedServicePropsResponse { /** * The creation time of the linked service. */ createdTime?: string; /** * Type of the link target. */ linkType?: string; /** * ResourceId of the link target of the linked service. */ linkedServiceResourceId: string; /** * The last modified time of the linked service. */ modifiedTime?: string; } /** * LinkedWorkspace specific properties. */ interface LinkedWorkspacePropsResponse { /** * ResourceId of the link target of the linked workspace. */ linkedWorkspaceResourceId?: string; /** * ResourceId of the user assigned identity for the linked workspace. */ userAssignedIdentityResourceId?: string; } interface ListNotebookKeysResultResponse { /** * The primary access key of the Notebook */ primaryAccessKey: string; /** * The secondary access key of the Notebook */ secondaryAccessKey: string; } /** * Literal input type. */ interface LiteralJobInputResponse { /** * Description for the input. */ description?: string; /** * Enum to determine the Job Input Type. * Expected value is 'literal'. */ jobInputType: "literal"; /** * [Required] Literal value for the input. */ value: string; } /** * Labeling MLAssist configuration definition when MLAssist is disabled */ interface MLAssistConfigurationDisabledResponse { /** * Expected value is 'Disabled'. */ mlAssist: "Disabled"; } /** * Labeling MLAssist configuration definition when MLAssist is enabled */ interface MLAssistConfigurationEnabledResponse { /** * [Required] AML compute binding used in inferencing. */ inferencingComputeBinding: string; /** * Expected value is 'Enabled'. */ mlAssist: "Enabled"; /** * [Required] AML compute binding used in training. */ trainingComputeBinding: string; } interface MLFlowModelJobInputResponse { /** * Description for the input. */ description?: string; /** * Enum to determine the Job Input Type. * Expected value is 'mlflow_model'. */ jobInputType: "mlflow_model"; /** * Enum to determine the input data delivery mode. */ mode?: string; /** * [Required] Input Asset URI. */ uri: string; } /** * mlflowModelJobInputResponseProvideDefaults sets the appropriate defaults for MLFlowModelJobInputResponse */ function mlflowModelJobInputResponseProvideDefaults(val: MLFlowModelJobInputResponse): MLFlowModelJobInputResponse; interface MLFlowModelJobOutputResponse { /** * Output Asset Name. */ assetName?: string; /** * Description for the output. */ description?: string; /** * Enum to determine the Job Output Type. * Expected value is 'mlflow_model'. */ jobOutputType: "mlflow_model"; /** * Output data delivery mode enums. */ mode?: string; /** * Output Asset URI. */ uri?: string; } /** * mlflowModelJobOutputResponseProvideDefaults sets the appropriate defaults for MLFlowModelJobOutputResponse */ function mlflowModelJobOutputResponseProvideDefaults(val: MLFlowModelJobOutputResponse): MLFlowModelJobOutputResponse; /** * MLTable data definition */ interface MLTableDataResponse { /** * Enum to determine the type of data. * Expected value is 'mltable'. */ dataType: "mltable"; /** * [Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 */ dataUri: string; /** * The asset description text. */ description?: string; /** * If the name version are system generated (anonymous registration). */ isAnonymous?: boolean; /** * Is the asset archived? */ isArchived?: boolean; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Uris referenced in the MLTable definition (required for lineage) */ referencedUris?: string[]; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * mltableDataResponseProvideDefaults sets the appropriate defaults for MLTableDataResponse */ function mltableDataResponseProvideDefaults(val: MLTableDataResponse): MLTableDataResponse; interface MLTableJobInputResponse { /** * Description for the input. */ description?: string; /** * Enum to determine the Job Input Type. * Expected value is 'mltable'. */ jobInputType: "mltable"; /** * Enum to determine the input data delivery mode. */ mode?: string; /** * [Required] Input Asset URI. */ uri: string; } /** * mltableJobInputResponseProvideDefaults sets the appropriate defaults for MLTableJobInputResponse */ function mltableJobInputResponseProvideDefaults(val: MLTableJobInputResponse): MLTableJobInputResponse; interface MLTableJobOutputResponse { /** * Output Asset Name. */ assetName?: string; /** * Description for the output. */ description?: string; /** * Enum to determine the Job Output Type. * Expected value is 'mltable'. */ jobOutputType: "mltable"; /** * Output data delivery mode enums. */ mode?: string; /** * Output Asset URI. */ uri?: string; } /** * mltableJobOutputResponseProvideDefaults sets the appropriate defaults for MLTableJobOutputResponse */ function mltableJobOutputResponseProvideDefaults(val: MLTableJobOutputResponse): MLTableJobOutputResponse; /** * Managed compute identity definition. */ interface ManagedComputeIdentityResponse { /** * Monitor compute identity type enum. * Expected value is 'ManagedIdentity'. */ computeIdentityType: "ManagedIdentity"; /** * The identity which will be leveraged by the monitoring jobs. */ identity?: outputs.machinelearningservices.ManagedServiceIdentityResponse; } interface ManagedIdentityAuthTypeWorkspaceConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'ManagedIdentity'. */ authType: "ManagedIdentity"; /** * Category of the connection */ category?: string; /** * A type definition that refers the id to an Azure Resource Manager resource. */ createdByWorkspaceArmId: string; credentials?: outputs.machinelearningservices.WorkspaceConnectionManagedIdentityResponse; error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; peRequirement?: string; peStatus?: string; sharedUserList?: string[]; target?: string; useWorkspaceManagedIdentity?: boolean; } /** * Managed identity configuration. */ interface ManagedIdentityResponse { /** * Specifies a user-assigned identity by client ID. For system-assigned, do not set this field. */ clientId?: string; /** * Enum to determine identity framework. * Expected value is 'Managed'. */ identityType: "Managed"; /** * Specifies a user-assigned identity by object ID. For system-assigned, do not set this field. */ objectId?: string; /** * Specifies a user-assigned identity by ARM resource ID. For system-assigned, do not set this field. */ resourceId?: string; } /** * Status of the Provisioning for the managed network of a machine learning workspace. */ interface ManagedNetworkProvisionStatusResponse { sparkReady?: boolean; /** * Status for the managed network of a machine learning workspace. */ status?: string; } /** * Managed Network settings for a machine learning workspace. */ interface ManagedNetworkSettingsResponse { /** * A flag to indicate if monitoring needs to be enabled for the managed network. */ enableNetworkMonitor?: boolean; /** * Public IP address assigned to the Azure Firewall. */ firewallPublicIpAddress: string; /** * Firewall Sku used for FQDN Rules */ firewallSku?: string; /** * Isolation mode for the managed network of a machine learning workspace. */ isolationMode?: string; /** * The Kind of the managed network. Users can switch from V1 to V2 for granular access controls, but cannot switch back to V1 once V2 is enabled. */ managedNetworkKind?: string; networkId: string; /** * Dictionary of */ outboundRules?: { [key: string]: outputs.machinelearningservices.FqdnOutboundRuleResponse | outputs.machinelearningservices.PrivateEndpointOutboundRuleResponse | outputs.machinelearningservices.ServiceTagOutboundRuleResponse; }; /** * Status of the Provisioning for the managed network of a machine learning workspace. */ status?: outputs.machinelearningservices.ManagedNetworkProvisionStatusResponse; } /** * managedNetworkSettingsResponseProvideDefaults sets the appropriate defaults for ManagedNetworkSettingsResponse */ function managedNetworkSettingsResponseProvideDefaults(val: ManagedNetworkSettingsResponse): ManagedNetworkSettingsResponse; /** * Properties specific to a ManagedOnlineDeployment. */ interface ManagedOnlineDeploymentResponse { /** * If true, enables Application Insights logging. */ appInsightsEnabled?: boolean; /** * Code configuration for the endpoint deployment. */ codeConfiguration?: outputs.machinelearningservices.CodeConfigurationResponse; /** * The mdc configuration, we disable mdc when it's null. */ dataCollector?: outputs.machinelearningservices.DataCollectorResponse; /** * Description of the endpoint deployment. */ description?: string; /** * Enum to determine whether PublicNetworkAccess is Enabled or Disabled for egress of a deployment. */ egressPublicNetworkAccess?: string; /** * Enum to determine endpoint compute type. * Expected value is 'Managed'. */ endpointComputeType: "Managed"; /** * ARM resource ID or AssetId of the environment specification for the endpoint deployment. */ environmentId?: string; /** * Environment variables configuration for the deployment. */ environmentVariables?: { [key: string]: string; }; /** * Compute instance type. Default: Standard_F4s_v2. */ instanceType?: string; /** * Liveness probe monitors the health of the container regularly. */ livenessProbe?: outputs.machinelearningservices.ProbeSettingsResponse; /** * The URI path to the model. */ model?: string; /** * The path to mount the model in custom container. */ modelMountPath?: string; /** * Property dictionary. Properties can be added, but not removed or altered. */ properties?: { [key: string]: string; }; /** * Provisioning state for the endpoint deployment. */ provisioningState: string; /** * Readiness probe validates if the container is ready to serve traffic. The properties and defaults are the same as liveness probe. */ readinessProbe?: outputs.machinelearningservices.ProbeSettingsResponse; /** * Request settings for the deployment. */ requestSettings?: outputs.machinelearningservices.OnlineRequestSettingsResponse; /** * Scale settings for the deployment. * If it is null or not provided, * it defaults to TargetUtilizationScaleSettings for KubernetesOnlineDeployment * and to DefaultScaleSettings for ManagedOnlineDeployment. */ scaleSettings?: outputs.machinelearningservices.DefaultScaleSettingsResponse | outputs.machinelearningservices.TargetUtilizationScaleSettingsResponse; /** * Startup probe verify whether an application within a container has started successfully. */ startupProbe?: outputs.machinelearningservices.ProbeSettingsResponse; } /** * managedOnlineDeploymentResponseProvideDefaults sets the appropriate defaults for ManagedOnlineDeploymentResponse */ function managedOnlineDeploymentResponseProvideDefaults(val: ManagedOnlineDeploymentResponse): ManagedOnlineDeploymentResponse; interface ManagedOnlineEndpointDeploymentResourcePropertiesResponse { endpointComputeType?: string; /** * The failure reason if the creation failed. */ failureReason?: string; model?: string; /** * Read-only provision state status property. */ provisioningState: string; /** * Kind of the deployment. * Expected value is 'managedOnlineEndpoint'. */ type: "managedOnlineEndpoint"; } /** * Details for managed resource group assigned identities. */ interface ManagedResourceGroupAssignedIdentitiesResponse { /** * Identity principal Id */ principalId?: string; } /** * Managed resource group settings */ interface ManagedResourceGroupSettingsResponse { /** * List of assigned identities for the managed resource group */ assignedIdentities?: outputs.machinelearningservices.ManagedResourceGroupAssignedIdentitiesResponse[]; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.machinelearningservices.UserAssignedIdentityResponse; }; } interface MarketplacePlanResponse { /** * The identifying name of the Offer of the Marketplace Plan. */ offerId: string; /** * The identifying name of the Plan of the Marketplace Plan. */ planId: string; /** * The identifying name of the Publisher of the Marketplace Plan. */ publisherId: string; } interface MarketplaceSubscriptionPropertiesResponse { /** * Marketplace Plan associated with the Marketplace Subscription. */ marketplacePlan: outputs.machinelearningservices.MarketplacePlanResponse; /** * Current status of the Marketplace Subscription. */ marketplaceSubscriptionStatus: string; /** * [Required] Target Marketplace Model ID to create a Marketplace Subscription for. */ modelId: string; /** * Provisioning State of the Marketplace Subscription. */ provisioningState: string; } /** * DTO object representing compute resource */ interface MaterializationComputeResourceResponse { /** * Specifies the instance type */ instanceType?: string; } interface MaterializationSettingsResponse { /** * Specifies the notification details */ notification?: outputs.machinelearningservices.NotificationSettingResponse; /** * Specifies the compute resource settings */ resource?: outputs.machinelearningservices.MaterializationComputeResourceResponse; /** * Specifies the schedule details */ schedule?: outputs.machinelearningservices.RecurrenceTriggerResponse; /** * Specifies the spark compute settings */ sparkConfiguration?: { [key: string]: string; }; /** * Specifies the stores to which materialization should happen */ storeType?: string; } /** * materializationSettingsResponseProvideDefaults sets the appropriate defaults for MaterializationSettingsResponse */ function materializationSettingsResponseProvideDefaults(val: MaterializationSettingsResponse): MaterializationSettingsResponse; /** * Defines an early termination policy based on running averages of the primary metric of all runs */ interface MedianStoppingPolicyResponse { /** * Number of intervals by which to delay the first evaluation. */ delayEvaluation?: number; /** * Interval (number of runs) between policy evaluations. */ evaluationInterval?: number; /** * Expected value is 'MedianStopping'. */ policyType: "MedianStopping"; } /** * medianStoppingPolicyResponseProvideDefaults sets the appropriate defaults for MedianStoppingPolicyResponse */ function medianStoppingPolicyResponseProvideDefaults(val: MedianStoppingPolicyResponse): MedianStoppingPolicyResponse; interface ModelContainerPropertiesResponse { /** * The asset description text. */ description?: string; /** * Is the asset archived? */ isArchived?: boolean; /** * The latest version inside this container. */ latestVersion: string; /** * The next auto incremental version */ nextVersion: string; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Provisioning state for the model container. */ provisioningState: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * modelContainerPropertiesResponseProvideDefaults sets the appropriate defaults for ModelContainerPropertiesResponse */ function modelContainerPropertiesResponseProvideDefaults(val: ModelContainerPropertiesResponse): ModelContainerPropertiesResponse; interface ModelSettingsResponse { /** * The unique model identifier that this ServerlessEndpoint should provision. */ modelId?: string; } /** * Model asset version details. */ interface ModelVersionPropertiesResponse { /** * Array of dataset references */ datasets?: outputs.machinelearningservices.DatasetReferenceResponse[]; /** * The asset description text. */ description?: string; /** * Mapping of model flavors to their properties. */ flavors?: { [key: string]: outputs.machinelearningservices.FlavorDataResponse; }; /** * If the name version are system generated (anonymous registration). */ isAnonymous?: boolean; /** * Is the asset archived? */ isArchived?: boolean; /** * Name of the training job which produced this model */ jobName?: string; /** * The storage format for this entity. Used for NCD. */ modelType?: string; /** * The URI path to the model contents. */ modelUri?: string; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Provisioning state for the model version. */ provisioningState: string; /** * Stage in the model lifecycle assigned to this model */ stage?: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * modelVersionPropertiesResponseProvideDefaults sets the appropriate defaults for ModelVersionPropertiesResponse */ function modelVersionPropertiesResponseProvideDefaults(val: ModelVersionPropertiesResponse): ModelVersionPropertiesResponse; interface MonitorDefinitionResponse { /** * The monitor's notification settings. */ alertNotificationSettings?: outputs.machinelearningservices.MonitorNotificationSettingsResponse; /** * [Required] The ARM resource ID of the compute resource to run the monitoring job on. */ computeConfiguration: outputs.machinelearningservices.MonitorServerlessSparkComputeResponse; /** * The entities targeted by the monitor. */ monitoringTarget?: outputs.machinelearningservices.MonitoringTargetResponse; /** * [Required] The signals to monitor. */ signals: { [key: string]: outputs.machinelearningservices.CustomMonitoringSignalResponse | outputs.machinelearningservices.DataDriftMonitoringSignalResponse | outputs.machinelearningservices.DataQualityMonitoringSignalResponse | outputs.machinelearningservices.FeatureAttributionDriftMonitoringSignalResponse | outputs.machinelearningservices.PredictionDriftMonitoringSignalResponse; }; } interface MonitorEmailNotificationSettingsResponse { /** * The email recipient list which has a limitation of 499 characters in total. */ emails?: string[]; } interface MonitorNotificationSettingsResponse { /** * The AML notification email settings. */ emailNotificationSettings?: outputs.machinelearningservices.MonitorEmailNotificationSettingsResponse; } /** * Monitor serverless spark compute definition. */ interface MonitorServerlessSparkComputeResponse { /** * [Required] The identity scheme leveraged to by the spark jobs running on serverless Spark. */ computeIdentity: outputs.machinelearningservices.AmlTokenComputeIdentityResponse | outputs.machinelearningservices.ManagedComputeIdentityResponse; /** * Monitor compute type enum. * Expected value is 'ServerlessSpark'. */ computeType: "ServerlessSpark"; /** * [Required] The instance type running the Spark job. */ instanceType: string; /** * [Required] The Spark runtime version. */ runtimeVersion: string; } /** * Monitoring target definition. */ interface MonitoringTargetResponse { /** * Reference to the deployment asset targeted by this monitor. */ deploymentId?: string; /** * Reference to the model asset targeted by this monitor. */ modelId?: string; /** * [Required] The machine learning task type of the monitored model. */ taskType: string; } interface MonitoringThresholdResponse { /** * The threshold value. If null, the set default is dependent on the metric type. */ value?: number; } /** * MPI distribution configuration. */ interface MpiResponse { /** * Enum to determine the job distribution type. * Expected value is 'Mpi'. */ distributionType: "Mpi"; /** * Number of processes per MPI node. */ processCountPerInstance?: number; } interface NlpVerticalFeaturizationSettingsResponse { /** * Dataset language, useful for the text data. */ datasetLanguage?: string; } /** * Job execution constraints. */ interface NlpVerticalLimitSettingsResponse { /** * Maximum Concurrent AutoML iterations. */ maxConcurrentTrials?: number; /** * Number of AutoML iterations. */ maxTrials?: number; /** * AutoML job timeout. */ timeout?: string; } /** * nlpVerticalLimitSettingsResponseProvideDefaults sets the appropriate defaults for NlpVerticalLimitSettingsResponse */ function nlpVerticalLimitSettingsResponseProvideDefaults(val: NlpVerticalLimitSettingsResponse): NlpVerticalLimitSettingsResponse; /** * Counts of various compute node states on the amlCompute. */ interface NodeStateCountsResponse { /** * Number of compute nodes in idle state. */ idleNodeCount: number; /** * Number of compute nodes which are leaving the amlCompute. */ leavingNodeCount: number; /** * Number of compute nodes which are in preempted state. */ preemptedNodeCount: number; /** * Number of compute nodes which are being prepared. */ preparingNodeCount: number; /** * Number of compute nodes which are running jobs. */ runningNodeCount: number; /** * Number of compute nodes which are in unusable state. */ unusableNodeCount: number; } interface NoneAuthTypeWorkspaceConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'None'. */ authType: "None"; /** * Category of the connection */ category?: string; /** * A type definition that refers the id to an Azure Resource Manager resource. */ createdByWorkspaceArmId: string; error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; peRequirement?: string; peStatus?: string; sharedUserList?: string[]; target?: string; useWorkspaceManagedIdentity?: boolean; } /** * Empty/none datastore credentials. */ interface NoneDatastoreCredentialsResponse { /** * Enum to determine the datastore credentials type. * Expected value is 'None'. */ credentialsType: "None"; } interface NotebookPreparationErrorResponse { errorMessage?: string; statusCode?: number; } interface NotebookResourceInfoResponse { fqdn?: string; isPrivateLinkEnabled?: boolean; /** * The error that occurs when preparing notebook. */ notebookPreparationError?: outputs.machinelearningservices.NotebookPreparationErrorResponse; /** * the data plane resourceId that used to initialize notebook component */ resourceId?: string; } /** * Configuration for notification. */ interface NotificationSettingResponse { /** * Send email notification to user on specified notification type */ emailOn?: string[]; /** * This is the email recipient list which has a limitation of 499 characters in total concat with comma separator */ emails?: string[]; /** * Send webhook callback to a service. Key is a user-provided name for the webhook. */ webhooks?: { [key: string]: outputs.machinelearningservices.AzureDevOpsWebhookResponse; }; } interface NumericalDataDriftMetricThresholdResponse { /** * Expected value is 'Numerical'. */ dataType: "Numerical"; /** * [Required] The numerical data drift metric to calculate. */ metric: string; /** * The threshold value. If null, a default value will be set depending on the selected metric. */ threshold?: outputs.machinelearningservices.MonitoringThresholdResponse; } interface NumericalDataQualityMetricThresholdResponse { /** * Expected value is 'Numerical'. */ dataType: "Numerical"; /** * [Required] The numerical data quality metric to calculate. */ metric: string; /** * The threshold value. If null, a default value will be set depending on the selected metric. */ threshold?: outputs.machinelearningservices.MonitoringThresholdResponse; } interface NumericalPredictionDriftMetricThresholdResponse { /** * Expected value is 'Numerical'. */ dataType: "Numerical"; /** * [Required] The numerical prediction drift metric to calculate. */ metric: string; /** * The threshold value. If null, a default value will be set depending on the selected metric. */ threshold?: outputs.machinelearningservices.MonitoringThresholdResponse; } interface OAuth2AuthTypeWorkspaceConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'OAuth2'. */ authType: "OAuth2"; /** * Category of the connection */ category?: string; /** * A type definition that refers the id to an Azure Resource Manager resource. */ createdByWorkspaceArmId: string; /** * ClientId and ClientSecret are required. Other properties are optional * depending on each OAuth2 provider's implementation. */ credentials?: outputs.machinelearningservices.WorkspaceConnectionOAuth2Response; error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; peRequirement?: string; peStatus?: string; sharedUserList?: string[]; target?: string; useWorkspaceManagedIdentity?: boolean; } /** * Optimization objective. */ interface ObjectiveResponse { /** * [Required] Defines supported metric goals for hyperparameter tuning */ goal: string; /** * [Required] Name of the metric to optimize. */ primaryMetric: string; } /** * OneLake (Trident) datastore configuration. */ interface OneLakeDatastoreResponse { /** * [Required] OneLake artifact backing the datastore. */ artifact: outputs.machinelearningservices.LakeHouseArtifactResponse; /** * [Required] Account credentials. */ credentials: outputs.machinelearningservices.AccountKeyDatastoreCredentialsResponse | outputs.machinelearningservices.CertificateDatastoreCredentialsResponse | outputs.machinelearningservices.NoneDatastoreCredentialsResponse | outputs.machinelearningservices.SasDatastoreCredentialsResponse | outputs.machinelearningservices.ServicePrincipalDatastoreCredentialsResponse; /** * Enum to determine the datastore contents type. * Expected value is 'OneLake'. */ datastoreType: "OneLake"; /** * The asset description text. */ description?: string; /** * OneLake endpoint to use for the datastore. */ endpoint?: string; /** * Readonly property to indicate if datastore is the workspace default datastore */ isDefault: boolean; /** * [Required] OneLake workspace name. */ oneLakeWorkspaceName: string; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Indicates which identity to use to authenticate service data access to customer's storage. */ serviceDataAccessAuthIdentity?: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * oneLakeDatastoreResponseProvideDefaults sets the appropriate defaults for OneLakeDatastoreResponse */ function oneLakeDatastoreResponseProvideDefaults(val: OneLakeDatastoreResponse): OneLakeDatastoreResponse; /** * Online endpoint configuration */ interface OnlineEndpointPropertiesResponse { /** * [Required] The authentication method for invoking the endpoint (data plane operation). Use 'Key' for key-based authentication. Use 'AMLToken' for Azure Machine Learning token-based authentication. Use 'AADToken' for Microsoft Entra token-based authentication. */ authMode: string; /** * ARM resource ID of the compute if it exists. * optional */ compute?: string; /** * Description of the inference endpoint. */ description?: string; /** * Percentage of traffic to be mirrored to each deployment without using returned scoring. Traffic values need to sum to utmost 50. */ mirrorTraffic?: { [key: string]: number; }; /** * Property dictionary. Properties can be added, but not removed or altered. */ properties?: { [key: string]: string; }; /** * Provisioning state for the endpoint. */ provisioningState: string; /** * Enum to determine whether PublicNetworkAccess is Enabled or Disabled. */ publicNetworkAccess?: string; /** * Endpoint URI. */ scoringUri: string; /** * Endpoint Swagger URI. */ swaggerUri: string; /** * Percentage of traffic from endpoint to divert to each deployment. Traffic values need to sum to 100. */ traffic?: { [key: string]: number; }; } /** * onlineEndpointPropertiesResponseProvideDefaults sets the appropriate defaults for OnlineEndpointPropertiesResponse */ function onlineEndpointPropertiesResponseProvideDefaults(val: OnlineEndpointPropertiesResponse): OnlineEndpointPropertiesResponse; /** * Online deployment scoring requests configuration. */ interface OnlineRequestSettingsResponse { /** * The number of maximum concurrent requests per node allowed per deployment. Defaults to 1. */ maxConcurrentRequestsPerInstance?: number; /** * (Deprecated for Managed Online Endpoints) The maximum amount of time a request will stay in the queue in ISO 8601 format. * Defaults to 500ms. * (Now increase `request_timeout_ms` to account for any networking/queue delays) */ maxQueueWait?: string; /** * The scoring timeout in ISO 8601 format. * Defaults to 5000ms. */ requestTimeout?: string; } /** * onlineRequestSettingsResponseProvideDefaults sets the appropriate defaults for OnlineRequestSettingsResponse */ function onlineRequestSettingsResponseProvideDefaults(val: OnlineRequestSettingsResponse): OnlineRequestSettingsResponse; interface OpenAIEndpointDeploymentResourcePropertiesResponse { /** * The failure reason if the creation failed. */ failureReason?: string; /** * Model used for the endpoint deployment. */ model: outputs.machinelearningservices.EndpointDeploymentModelResponse; /** * Read-only provision state status property. */ provisioningState: string; /** * The name of RAI policy. */ raiPolicyName?: string; sku?: outputs.machinelearningservices.CognitiveServicesSkuResponse; /** * Kind of the deployment. * Expected value is 'Azure.OpenAI'. */ type: "Azure.OpenAI"; /** * Deployment model version upgrade option. */ versionUpgradeOption?: string; } /** * Returns metadata about the os patching. */ interface OsPatchingStatusResponse { /** * Time of the latest os patching. */ latestPatchTime?: string; /** * Collection of errors encountered when doing os patching. */ osPatchingErrors?: outputs.machinelearningservices.ErrorResponseResponse[]; /** * The os patching status. */ patchStatus?: string; /** * Specifies whether this compute instance is pending for reboot to finish os patching. */ rebootPending?: boolean; /** * Time of scheduled reboot. */ scheduledRebootTime?: string; } /** * Reference to an asset via its path in a job output. */ interface OutputPathAssetReferenceResponse { /** * ARM resource ID of the job. */ jobId?: string; /** * The path of the file/directory in the job output. */ path?: string; /** * Enum to determine which reference method to use for an asset. * Expected value is 'OutputPath'. */ referenceType: "OutputPath"; } interface PATAuthTypeWorkspaceConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'PAT'. */ authType: "PAT"; /** * Category of the connection */ category?: string; /** * A type definition that refers the id to an Azure Resource Manager resource. */ createdByWorkspaceArmId: string; credentials?: outputs.machinelearningservices.WorkspaceConnectionPersonalAccessTokenResponse; error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; peRequirement?: string; peStatus?: string; sharedUserList?: string[]; target?: string; useWorkspaceManagedIdentity?: boolean; } interface PasswordResponse { name: string; value: string; } /** * Settings for a personal compute instance. */ interface PersonalComputeInstanceSettingsResponse { /** * A user explicitly assigned to a personal compute instance. */ assignedUser?: outputs.machinelearningservices.AssignedUserResponse; } /** * Pipeline Job definition: defines generic to MFE attributes. */ interface PipelineJobResponse { /** * ARM resource ID of the component resource. */ componentId?: string; /** * ARM resource ID of the compute resource. */ computeId?: string; /** * The asset description text. */ description?: string; /** * Display name of job. */ displayName?: string; /** * The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment. */ experimentName?: string; /** * Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. * Defaults to AmlToken if null. */ identity?: outputs.machinelearningservices.AmlTokenResponse | outputs.machinelearningservices.ManagedIdentityResponse | outputs.machinelearningservices.UserIdentityResponse; /** * Inputs for the pipeline job. */ inputs?: { [key: string]: outputs.machinelearningservices.CustomModelJobInputResponse | outputs.machinelearningservices.LiteralJobInputResponse | outputs.machinelearningservices.MLFlowModelJobInputResponse | outputs.machinelearningservices.MLTableJobInputResponse | outputs.machinelearningservices.TritonModelJobInputResponse | outputs.machinelearningservices.UriFileJobInputResponse | outputs.machinelearningservices.UriFolderJobInputResponse; }; /** * Is the asset archived? */ isArchived?: boolean; /** * Enum to determine the type of job. * Expected value is 'Pipeline'. */ jobType: "Pipeline"; /** * Jobs construct the Pipeline Job. */ jobs?: { [key: string]: any; }; /** * Notification setting for the job */ notificationSetting?: outputs.machinelearningservices.NotificationSettingResponse; /** * Outputs for the pipeline job */ outputs?: { [key: string]: outputs.machinelearningservices.CustomModelJobOutputResponse | outputs.machinelearningservices.MLFlowModelJobOutputResponse | outputs.machinelearningservices.MLTableJobOutputResponse | outputs.machinelearningservices.TritonModelJobOutputResponse | outputs.machinelearningservices.UriFileJobOutputResponse | outputs.machinelearningservices.UriFolderJobOutputResponse; }; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * List of JobEndpoints. * For local jobs, a job endpoint will have an endpoint value of FileStreamObject. */ services?: { [key: string]: outputs.machinelearningservices.JobServiceResponse; }; /** * Pipeline settings, for things like ContinueRunOnStepFailure etc. */ settings?: any; /** * ARM resource ID of source job. */ sourceJobId?: string; /** * Status of the job. */ status: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * pipelineJobResponseProvideDefaults sets the appropriate defaults for PipelineJobResponse */ function pipelineJobResponseProvideDefaults(val: PipelineJobResponse): PipelineJobResponse; interface PredictionDriftMonitoringSignalResponse { /** * A dictionary that maps feature names to their respective data types. */ featureDataTypeOverride?: { [key: string]: string; }; /** * [Required] A list of metrics to calculate and their associated thresholds. */ metricThresholds: (outputs.machinelearningservices.CategoricalPredictionDriftMetricThresholdResponse | outputs.machinelearningservices.NumericalPredictionDriftMetricThresholdResponse)[]; /** * The current notification mode for this signal. */ notificationTypes?: string[]; /** * [Required] The data which drift will be calculated for. */ productionData: outputs.machinelearningservices.FixedInputDataResponse | outputs.machinelearningservices.RollingInputDataResponse | outputs.machinelearningservices.StaticInputDataResponse; /** * Property dictionary. Properties can be added, but not removed or altered. */ properties?: { [key: string]: string; }; /** * [Required] The data to calculate drift against. */ referenceData: outputs.machinelearningservices.FixedInputDataResponse | outputs.machinelearningservices.RollingInputDataResponse | outputs.machinelearningservices.StaticInputDataResponse; /** * Expected value is 'PredictionDrift'. */ signalType: "PredictionDrift"; } /** * The Private Endpoint Connection resource. */ interface PrivateEndpointConnectionResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The managed service identities assigned to this resource. */ identity?: outputs.machinelearningservices.ManagedServiceIdentityResponse; /** * *Same as workspace location. */ location?: string; /** * The name of the resource */ name: string; /** * The Private Endpoint resource. */ privateEndpoint?: outputs.machinelearningservices.WorkspacePrivateEndpointResourceResponse; /** * The connection state. */ privateLinkServiceConnectionState?: outputs.machinelearningservices.PrivateLinkServiceConnectionStateResponse; /** * The current provisioning state. */ provisioningState: string; /** * Optional. This field is required to be implemented by the RP because AML is supporting more than one tier */ sku?: outputs.machinelearningservices.SkuResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.machinelearningservices.SystemDataResponse; tags?: { [key: string]: string; }; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace. */ interface PrivateEndpointDestinationResponse { /** * A type definition that refers the id to an Azure Resource Manager resource. */ serviceResourceId?: string; sparkEnabled?: boolean; /** * Type of a managed network Outbound Rule of a machine learning workspace. */ sparkStatus?: string; subresourceTarget?: string; } /** * Private Endpoint Outbound Rule for the managed network of a machine learning workspace. */ interface PrivateEndpointOutboundRuleResponse { /** * Category of a managed network Outbound Rule of a machine learning workspace. */ category?: string; /** * Private Endpoint destination for a Private Endpoint Outbound Rule for the managed network of a machine learning workspace. */ destination?: outputs.machinelearningservices.PrivateEndpointDestinationResponse; /** * Error information about an outbound rule of a machine learning workspace if RuleStatus is failed. */ errorInformation: string; fqdns?: string[]; parentRuleNames: string[]; /** * Type of a managed network Outbound Rule of a machine learning workspace. */ status?: string; /** * Type of a managed network Outbound Rule of a machine learning workspace. * Expected value is 'PrivateEndpoint'. */ type: "PrivateEndpoint"; } /** * The PE network resource that is linked to this PE connection. */ interface PrivateEndpointResourceResponse { /** * The ARM identifier for Private Endpoint */ id: string; /** * The subnetId that the private endpoint is connected to. */ subnetArmId?: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * Some RP chose "None". Other RPs use this for region expansion. */ actionsRequired?: string; /** * User-defined message that, per NRP doc, may be used for approval-related message. */ description?: string; /** * Connection status of the service consumer with the service provider\r\nPossible state transitions\r\nPending -> Approved (Service provider approves the connection request)\r\nPending -> Rejected (Service provider rejects the connection request)\r\nPending -> Disconnected (Service provider deletes the connection)\r\nApproved -> Rejected (Service provider rejects the approved connection)\r\nApproved -> Disconnected (Service provider deletes the connection)\r\nRejected -> Pending (Service consumer re-initiates the connection request that was rejected)\r\nRejected -> Disconnected (Service provider deletes the connection) */ status?: string; } /** * Deployment container liveness/readiness probe configuration. */ interface ProbeSettingsResponse { /** * The number of failures to allow before returning an unhealthy status. */ failureThreshold?: number; /** * The delay before the first probe in ISO 8601 format. */ initialDelay?: string; /** * The length of time between probes in ISO 8601 format. */ period?: string; /** * The number of successful probes before returning a healthy status. */ successThreshold?: number; /** * The probe timeout in ISO 8601 format. */ timeout?: string; } /** * probeSettingsResponseProvideDefaults sets the appropriate defaults for ProbeSettingsResponse */ function probeSettingsResponseProvideDefaults(val: ProbeSettingsResponse): ProbeSettingsResponse; /** * Progress metrics definition */ interface ProgressMetricsResponse { /** * The completed datapoint count. */ completedDatapointCount: number; /** * The time of last successful incremental data refresh in UTC. */ incrementalDataLastRefreshDateTime: string; /** * The skipped datapoint count. */ skippedDatapointCount: number; /** * The total datapoint count. */ totalDatapointCount: number; } /** * PyTorch distribution configuration. */ interface PyTorchResponse { /** * Enum to determine the job distribution type. * Expected value is 'PyTorch'. */ distributionType: "PyTorch"; /** * Number of processes per node. */ processCountPerInstance?: number; } interface QueueSettingsResponse { /** * Enum to determine the job tier. */ jobTier?: string; } /** * queueSettingsResponseProvideDefaults sets the appropriate defaults for QueueSettingsResponse */ function queueSettingsResponseProvideDefaults(val: QueueSettingsResponse): QueueSettingsResponse; /** * Azure OpenAI blocklist config. */ interface RaiBlocklistConfigResponse { /** * If blocking would occur. */ blocking?: boolean; /** * Name of ContentFilter. */ blocklistName?: string; } /** * RAI Custom Blocklist Item properties. */ interface RaiBlocklistItemPropertiesResponse { /** * If the pattern is a regex pattern. */ isRegex?: boolean; /** * Pattern to match against. */ pattern?: string; } /** * RAI Custom Blocklist properties. */ interface RaiBlocklistPropertiesResponse { /** * Description of the block list. */ description?: string; } /** * Azure OpenAI Content Filter. */ interface RaiPolicyContentFilterResponse { /** * Level at which content is filtered. */ allowedContentLevel?: string; /** * If blocking would occur. */ blocking?: boolean; /** * If the ContentFilter is enabled. */ enabled?: boolean; /** * Name of ContentFilter. */ name?: string; /** * Content source to apply the Content Filters. */ source?: string; } /** * Azure OpenAI Content Filters properties. */ interface RaiPolicyPropertiesResponse { /** * Name of the base Content Filters. */ basePolicyName?: string; completionBlocklists?: outputs.machinelearningservices.RaiBlocklistConfigResponse[]; contentFilters?: outputs.machinelearningservices.RaiPolicyContentFilterResponse[]; /** * Content Filters mode. */ mode?: string; promptBlocklists?: outputs.machinelearningservices.RaiBlocklistConfigResponse[]; /** * Content Filters policy type. */ type?: string; } /** * Defines a Sampling Algorithm that generates values randomly */ interface RandomSamplingAlgorithmResponse { /** * The specific type of random algorithm */ rule?: string; /** * Expected value is 'Random'. */ samplingAlgorithmType: "Random"; /** * An optional integer to use as the seed for random number generation */ seed?: number; } /** * randomSamplingAlgorithmResponseProvideDefaults sets the appropriate defaults for RandomSamplingAlgorithmResponse */ function randomSamplingAlgorithmResponseProvideDefaults(val: RandomSamplingAlgorithmResponse): RandomSamplingAlgorithmResponse; /** * The workflow trigger recurrence for ComputeStartStop schedule type. */ interface RecurrenceResponse { /** * [Required] The frequency to trigger schedule. */ frequency?: string; /** * [Required] Specifies schedule interval in conjunction with frequency */ interval?: number; /** * [Required] The recurrence schedule. */ schedule?: outputs.machinelearningservices.ComputeRecurrenceScheduleResponse; /** * The start time in yyyy-MM-ddTHH:mm:ss format. */ startTime?: string; /** * Specifies time zone in which the schedule runs. * TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 */ timeZone?: string; } /** * recurrenceResponseProvideDefaults sets the appropriate defaults for RecurrenceResponse */ function recurrenceResponseProvideDefaults(val: RecurrenceResponse): RecurrenceResponse; interface RecurrenceScheduleResponse { /** * [Required] List of hours for the schedule. */ hours: number[]; /** * [Required] List of minutes for the schedule. */ minutes: number[]; /** * List of month days for the schedule */ monthDays?: number[]; /** * List of days for the schedule. */ weekDays?: string[]; } interface RecurrenceTriggerResponse { /** * Specifies end time of schedule in ISO 8601, but without a UTC offset. Refer https://en.wikipedia.org/wiki/ISO_8601. * Recommented format would be "2022-06-01T00:00:01" * If not present, the schedule will run indefinitely */ endTime?: string; /** * [Required] The frequency to trigger schedule. */ frequency: string; /** * [Required] Specifies schedule interval in conjunction with frequency */ interval: number; /** * The recurrence schedule. */ schedule?: outputs.machinelearningservices.RecurrenceScheduleResponse; /** * Specifies start time of schedule in ISO 8601 format, but without a UTC offset. */ startTime?: string; /** * Specifies time zone in which the schedule runs. * TimeZone should follow Windows time zone format. Refer: https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11 */ timeZone?: string; /** * Expected value is 'Recurrence'. */ triggerType: "Recurrence"; } /** * recurrenceTriggerResponseProvideDefaults sets the appropriate defaults for RecurrenceTriggerResponse */ function recurrenceTriggerResponseProvideDefaults(val: RecurrenceTriggerResponse): RecurrenceTriggerResponse; interface RegistryListCredentialsResultResponse { /** * The location of the workspace ACR */ location: string; passwords?: outputs.machinelearningservices.PasswordResponse[]; /** * The username of the workspace ACR */ username: string; } /** * Private endpoint connection definition. */ interface RegistryPrivateEndpointConnectionResponse { /** * The group ids */ groupIds?: string[]; /** * This is the private endpoint connection name created on SRP * Full resource id: /subscriptions/{subId}/resourceGroups/{rgName}/providers/Microsoft.MachineLearningServices/{resourceType}/{resourceName}/registryPrivateEndpointConnections/{peConnectionName} */ id?: string; /** * Same as workspace location. */ location?: string; /** * The PE network resource that is linked to this PE connection. */ privateEndpoint?: outputs.machinelearningservices.PrivateEndpointResourceResponse; /** * One of null, "Succeeded", "Provisioning", "Failed". While not approved, it's null. */ provisioningState?: string; /** * The connection state. */ registryPrivateLinkServiceConnectionState?: outputs.machinelearningservices.RegistryPrivateLinkServiceConnectionStateResponse; } /** * The connection state. */ interface RegistryPrivateLinkServiceConnectionStateResponse { /** * Some RP chose "None". Other RPs use this for region expansion. */ actionsRequired?: string; /** * User-defined message that, per NRP doc, may be used for approval-related message. */ description?: string; /** * Connection status of the service consumer with the service provider */ status?: string; } /** * Details for each region the registry is in */ interface RegistryRegionArmDetailsResponse { /** * List of ACR accounts */ acrDetails?: outputs.machinelearningservices.AcrDetailsResponse[]; /** * The location where the registry exists */ location?: string; /** * List of storage accounts */ storageAccountDetails?: outputs.machinelearningservices.StorageAccountDetailsResponse[]; } /** * Regression task in AutoML Table vertical. */ interface RegressionResponse { /** * Columns to use for CVSplit data. */ cvSplitColumnNames?: string[]; /** * Featurization inputs needed for AutoML job. */ featurizationSettings?: outputs.machinelearningservices.TableVerticalFeaturizationSettingsResponse; /** * Execution constraints for AutoMLJob. */ limitSettings?: outputs.machinelearningservices.TableVerticalLimitSettingsResponse; /** * Enum for setting log verbosity. */ logVerbosity?: string; /** * Number of cross validation folds to be applied on training dataset * when validation dataset is not provided. */ nCrossValidations?: outputs.machinelearningservices.AutoNCrossValidationsResponse | outputs.machinelearningservices.CustomNCrossValidationsResponse; /** * Primary metrics for Regression task. */ primaryMetric?: string; /** * Target column name: This is prediction values column. * Also known as label column name in context of classification tasks. */ targetColumnName?: string; /** * AutoMLJob Task type. * Expected value is 'Regression'. */ taskType: "Regression"; /** * Test data input. */ testData?: outputs.machinelearningservices.MLTableJobInputResponse; /** * The fraction of test dataset that needs to be set aside for validation purpose. * Values between (0.0 , 1.0) * Applied when validation dataset is not provided. */ testDataSize?: number; /** * [Required] Training data input. */ trainingData: outputs.machinelearningservices.MLTableJobInputResponse; /** * Inputs for training phase for an AutoML Job. */ trainingSettings?: outputs.machinelearningservices.RegressionTrainingSettingsResponse; /** * Validation data inputs. */ validationData?: outputs.machinelearningservices.MLTableJobInputResponse; /** * The fraction of training dataset that needs to be set aside for validation purpose. * Values between (0.0 , 1.0) * Applied when validation dataset is not provided. */ validationDataSize?: number; /** * The name of the sample weight column. Automated ML supports a weighted column as an input, causing rows in the data to be weighted up or down. */ weightColumnName?: string; } /** * regressionResponseProvideDefaults sets the appropriate defaults for RegressionResponse */ function regressionResponseProvideDefaults(val: RegressionResponse): RegressionResponse; /** * Regression Training related configuration. */ interface RegressionTrainingSettingsResponse { /** * Allowed models for regression task. */ allowedTrainingAlgorithms?: string[]; /** * Blocked models for regression task. */ blockedTrainingAlgorithms?: string[]; /** * Enable recommendation of DNN models. */ enableDnnTraining?: boolean; /** * Flag to turn on explainability on best model. */ enableModelExplainability?: boolean; /** * Flag for enabling onnx compatible models. */ enableOnnxCompatibleModels?: boolean; /** * Enable stack ensemble run. */ enableStackEnsemble?: boolean; /** * Enable voting ensemble run. */ enableVoteEnsemble?: boolean; /** * During VotingEnsemble and StackEnsemble model generation, multiple fitted models from the previous child runs are downloaded. * Configure this parameter with a higher value than 300 secs, if more time is needed. */ ensembleModelDownloadTimeout?: string; /** * Stack ensemble settings for stack ensemble run. */ stackEnsembleSettings?: outputs.machinelearningservices.StackEnsembleSettingsResponse; } /** * regressionTrainingSettingsResponseProvideDefaults sets the appropriate defaults for RegressionTrainingSettingsResponse */ function regressionTrainingSettingsResponseProvideDefaults(val: RegressionTrainingSettingsResponse): RegressionTrainingSettingsResponse; /** * Scoring requests configuration. */ interface RequestConfigurationResponse { /** * The number of maximum concurrent requests per node allowed per deployment. Defaults to 1. */ maxConcurrentRequestsPerInstance?: number; /** * The scoring timeout in ISO 8601 format. * Defaults to 5000ms. */ requestTimeout?: string; } /** * requestConfigurationResponseProvideDefaults sets the appropriate defaults for RequestConfigurationResponse */ function requestConfigurationResponseProvideDefaults(val: RequestConfigurationResponse): RequestConfigurationResponse; interface RequestLoggingResponse { /** * For payload logging, we only collect payload by default. If customers also want to collect the specified headers, they can set them in captureHeaders so that backend will collect those headers along with payload. */ captureHeaders?: string[]; } /** * Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet. */ interface ResourceIdResponse { /** * The ID of the resource */ id: string; } /** * Rolling input data definition. */ interface RollingInputDataResponse { /** * Mapping of column names to special uses. */ columns?: { [key: string]: string; }; /** * The context metadata of the data source. */ dataContext?: string; /** * Monitoring input data type enum. * Expected value is 'Rolling'. */ inputDataType: "Rolling"; /** * [Required] Specifies the type of job. */ jobInputType: string; /** * Reference to the component asset used to preprocess the data. */ preprocessingComponentId?: string; /** * [Required] Input Asset URI. */ uri: string; /** * [Required] The time offset between the end of the data window and the monitor's current run time. */ windowOffset: string; /** * [Required] The size of the rolling data window. */ windowSize: string; } interface RouteResponse { /** * [Required] The path for the route. */ path: string; /** * [Required] The port for the route. */ port: number; } interface SASAuthTypeWorkspaceConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'SAS'. */ authType: "SAS"; /** * Category of the connection */ category?: string; /** * A type definition that refers the id to an Azure Resource Manager resource. */ createdByWorkspaceArmId: string; credentials?: outputs.machinelearningservices.WorkspaceConnectionSharedAccessSignatureResponse; error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; peRequirement?: string; peStatus?: string; sharedUserList?: string[]; target?: string; useWorkspaceManagedIdentity?: boolean; } /** * SAS datastore credentials configuration. */ interface SasDatastoreCredentialsResponse { /** * Enum to determine the datastore credentials type. * Expected value is 'Sas'. */ credentialsType: "Sas"; } /** * scale settings for AML Compute */ interface ScaleSettingsResponse { /** * Max number of nodes to use */ maxNodeCount: number; /** * Min number of nodes to use */ minNodeCount?: number; /** * Node Idle Time before scaling down amlCompute. This string needs to be in the RFC Format. */ nodeIdleTimeBeforeScaleDown?: string; } /** * scaleSettingsResponseProvideDefaults sets the appropriate defaults for ScaleSettingsResponse */ function scaleSettingsResponseProvideDefaults(val: ScaleSettingsResponse): ScaleSettingsResponse; /** * Configuration for ScaleUnit pool. */ interface ScaleUnitConfigurationResponse { /** * Gets or sets a value indicating whether PublicEgress is disabled. */ disablePublicEgress?: boolean; /** * Gets or sets a list of Registry sources that will be used to confirm identity, storage, ACR. */ registries?: string[]; } /** * scaleUnitConfigurationResponseProvideDefaults sets the appropriate defaults for ScaleUnitConfigurationResponse */ function scaleUnitConfigurationResponseProvideDefaults(val: ScaleUnitConfigurationResponse): ScaleUnitConfigurationResponse; interface ScheduleBaseResponse { /** * A system assigned id for the schedule. */ id?: string; /** * The current deployment state of schedule. */ provisioningStatus?: string; /** * Is the schedule enabled or disabled? */ status?: string; } /** * Base definition of a schedule */ interface SchedulePropertiesResponse { /** * [Required] Specifies the action of the schedule */ action: outputs.machinelearningservices.CreateMonitorActionResponse | outputs.machinelearningservices.EndpointScheduleActionResponse | outputs.machinelearningservices.JobScheduleActionResponse; /** * The asset description text. */ description?: string; /** * Display name of schedule. */ displayName?: string; /** * Is the schedule enabled? */ isEnabled?: boolean; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Provisioning state for the schedule. */ provisioningState: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; /** * [Required] Specifies the trigger details */ trigger: outputs.machinelearningservices.CronTriggerResponse | outputs.machinelearningservices.RecurrenceTriggerResponse; } /** * schedulePropertiesResponseProvideDefaults sets the appropriate defaults for SchedulePropertiesResponse */ function schedulePropertiesResponseProvideDefaults(val: SchedulePropertiesResponse): SchedulePropertiesResponse; /** * Script reference */ interface ScriptReferenceResponse { /** * Optional command line arguments passed to the script to run. */ scriptArguments?: string; /** * The location of scripts in the mounted volume. */ scriptData?: string; /** * The storage source of the script: inline, workspace. */ scriptSource?: string; /** * Optional time period passed to timeout command. */ timeout?: string; } /** * Customized setup scripts */ interface ScriptsToExecuteResponse { /** * Script that's run only once during provision of the compute. */ creationScript?: outputs.machinelearningservices.ScriptReferenceResponse; /** * Script that's run every time the machine starts. */ startupScript?: outputs.machinelearningservices.ScriptReferenceResponse; } /** * Secret Configuration definition. */ interface SecretConfigurationResponse { /** * Secret Uri. * Sample Uri : https://myvault.vault.azure.net/secrets/mysecretname/secretversion */ uri?: string; /** * Name of secret in workspace key vault. */ workspaceSecretName?: string; } interface ServerlessComputeSettingsResponse { /** * The resource ID of an existing virtual network subnet in which serverless compute nodes should be deployed */ serverlessComputeCustomSubnet?: string; /** * The flag to signal if serverless compute nodes deployed in custom vNet would have no public IP addresses for a workspace with private endpoint */ serverlessComputeNoPublicIP?: boolean; } interface ServerlessEndpointPropertiesResponse { /** * [Required] Specifies the authentication mode for the Serverless endpoint. */ authMode: string; /** * Specifies the content safety options. If omitted, the default content safety settings will be configured */ contentSafety?: outputs.machinelearningservices.ContentSafetyResponse; /** * The current state of the ServerlessEndpoint. */ endpointState: string; /** * The inference uri to target when making requests against the serverless endpoint */ inferenceEndpoint: outputs.machinelearningservices.ServerlessInferenceEndpointResponse; /** * The MarketplaceSubscription Azure ID associated to this ServerlessEndpoint. */ marketplaceSubscriptionId: string; /** * The model settings (model id) for the model being serviced on the ServerlessEndpoint. */ modelSettings?: outputs.machinelearningservices.ModelSettingsResponse; /** * State of endpoint provisioning. */ provisioningState: string; } interface ServerlessInferenceEndpointResponse { /** * Specifies any required headers to target this serverless endpoint. */ headers: { [key: string]: string; }; /** * [Required] The inference uri to target when making requests against the Serverless Endpoint. */ uri: string; } interface ServerlessOfferResponse { /** * [Required] The name of the Serverless Offer */ offerName: string; /** * [Required] Publisher name of the Serverless Offer */ publisher: string; } interface ServiceManagedResourcesSettingsResponse { cosmosDb?: outputs.machinelearningservices.CosmosDbSettingsResponse; } interface ServicePrincipalAuthTypeWorkspaceConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'ServicePrincipal'. */ authType: "ServicePrincipal"; /** * Category of the connection */ category?: string; /** * A type definition that refers the id to an Azure Resource Manager resource. */ createdByWorkspaceArmId: string; credentials?: outputs.machinelearningservices.WorkspaceConnectionServicePrincipalResponse; error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; peRequirement?: string; peStatus?: string; sharedUserList?: string[]; target?: string; useWorkspaceManagedIdentity?: boolean; } /** * Service Principal datastore credentials configuration. */ interface ServicePrincipalDatastoreCredentialsResponse { /** * Authority URL used for authentication. */ authorityUrl?: string; /** * [Required] Service principal client ID. */ clientId: string; /** * Enum to determine the datastore credentials type. * Expected value is 'ServicePrincipal'. */ credentialsType: "ServicePrincipal"; /** * Resource the service principal has access to. */ resourceUrl?: string; /** * [Required] ID of the tenant to which the service principal belongs. */ tenantId: string; } /** * Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace. */ interface ServiceTagDestinationResponse { /** * The action enum for networking rule. */ action?: string; /** * Optional, if provided, the ServiceTag property will be ignored. */ addressPrefixes?: string[]; portRanges?: string; protocol?: string; serviceTag?: string; } /** * Service Tag Outbound Rule for the managed network of a machine learning workspace. */ interface ServiceTagOutboundRuleResponse { /** * Category of a managed network Outbound Rule of a machine learning workspace. */ category?: string; /** * Service Tag destination for a Service Tag Outbound Rule for the managed network of a machine learning workspace. */ destination?: outputs.machinelearningservices.ServiceTagDestinationResponse; /** * Error information about an outbound rule of a machine learning workspace if RuleStatus is failed. */ errorInformation: string; parentRuleNames: string[]; /** * Type of a managed network Outbound Rule of a machine learning workspace. */ status?: string; /** * Type of a managed network Outbound Rule of a machine learning workspace. * Expected value is 'ServiceTag'. */ type: "ServiceTag"; } /** * Details of customized scripts to execute for setting up the cluster. */ interface SetupScriptsResponse { /** * Customized setup scripts */ scripts?: outputs.machinelearningservices.ScriptsToExecuteResponse; } interface SharedPrivateLinkResourceResponse { /** * group id of the private link */ groupId?: string; /** * Unique name of the private link */ name?: string; /** * the resource id that private link links to */ privateLinkResourceId?: string; /** * Request message */ requestMessage?: string; /** * Connection status of the service consumer with the service provider\r\nPossible state transitions\r\nPending -> Approved (Service provider approves the connection request)\r\nPending -> Rejected (Service provider rejects the connection request)\r\nPending -> Disconnected (Service provider deletes the connection)\r\nApproved -> Rejected (Service provider rejects the approved connection)\r\nApproved -> Disconnected (Service provider deletes the connection)\r\nRejected -> Pending (Service consumer re-initiates the connection request that was rejected)\r\nRejected -> Disconnected (Service provider deletes the connection) */ status?: string; } /** * Sku of the resource */ interface SkuMachineLearningDatasetResponse { /** * Name of the sku */ name?: string; /** * Tier of the sku like Basic or Enterprise */ tier?: string; } /** * Sku of the resource */ interface SkuMachineLearningDatastoreResponse { /** * Name of the sku */ name?: string; /** * Tier of the sku like Basic or Enterprise */ tier?: string; } /** * The resource model definition representing SKU */ interface SkuResponse { /** * If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. */ capacity?: number; /** * If the service has different generations of hardware, for the same SKU, then that can be captured here. */ family?: string; /** * The name of the SKU. Ex - P3. It is typically a letter+number code */ name: string; /** * The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. */ size?: string; /** * This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. */ tier?: string; } interface SparkJobPythonEntryResponse { /** * [Required] Relative python file path for job entry point. */ file: string; /** * Expected value is 'SparkJobPythonEntry'. */ sparkJobEntryType: "SparkJobPythonEntry"; } /** * Spark job definition. */ interface SparkJobResponse { /** * Archive files used in the job. */ archives?: string[]; /** * Arguments for the job. */ args?: string; /** * [Required] arm-id of the code asset. */ codeId: string; /** * ARM resource ID of the component resource. */ componentId?: string; /** * ARM resource ID of the compute resource. */ computeId?: string; /** * Spark configured properties. */ conf?: { [key: string]: string; }; /** * The asset description text. */ description?: string; /** * Display name of job. */ displayName?: string; /** * [Required] The entry to execute on startup of the job. */ entry: outputs.machinelearningservices.SparkJobPythonEntryResponse | outputs.machinelearningservices.SparkJobScalaEntryResponse; /** * The ARM resource ID of the Environment specification for the job. */ environmentId?: string; /** * Environment variables included in the job. */ environmentVariables?: { [key: string]: string; }; /** * The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment. */ experimentName?: string; /** * Files used in the job. */ files?: string[]; /** * Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. * Defaults to AmlToken if null. */ identity?: outputs.machinelearningservices.AmlTokenResponse | outputs.machinelearningservices.ManagedIdentityResponse | outputs.machinelearningservices.UserIdentityResponse; /** * Mapping of input data bindings used in the job. */ inputs?: { [key: string]: outputs.machinelearningservices.CustomModelJobInputResponse | outputs.machinelearningservices.LiteralJobInputResponse | outputs.machinelearningservices.MLFlowModelJobInputResponse | outputs.machinelearningservices.MLTableJobInputResponse | outputs.machinelearningservices.TritonModelJobInputResponse | outputs.machinelearningservices.UriFileJobInputResponse | outputs.machinelearningservices.UriFolderJobInputResponse; }; /** * Is the asset archived? */ isArchived?: boolean; /** * Jar files used in the job. */ jars?: string[]; /** * Enum to determine the type of job. * Expected value is 'Spark'. */ jobType: "Spark"; /** * Notification setting for the job */ notificationSetting?: outputs.machinelearningservices.NotificationSettingResponse; /** * Mapping of output data bindings used in the job. */ outputs?: { [key: string]: outputs.machinelearningservices.CustomModelJobOutputResponse | outputs.machinelearningservices.MLFlowModelJobOutputResponse | outputs.machinelearningservices.MLTableJobOutputResponse | outputs.machinelearningservices.TritonModelJobOutputResponse | outputs.machinelearningservices.UriFileJobOutputResponse | outputs.machinelearningservices.UriFolderJobOutputResponse; }; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Python files used in the job. */ pyFiles?: string[]; /** * Queue settings for the job */ queueSettings?: outputs.machinelearningservices.QueueSettingsResponse; /** * Compute Resource configuration for the job. */ resources?: outputs.machinelearningservices.SparkResourceConfigurationResponse; /** * List of JobEndpoints. * For local jobs, a job endpoint will have an endpoint value of FileStreamObject. */ services?: { [key: string]: outputs.machinelearningservices.JobServiceResponse; }; /** * Status of the job. */ status: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * sparkJobResponseProvideDefaults sets the appropriate defaults for SparkJobResponse */ function sparkJobResponseProvideDefaults(val: SparkJobResponse): SparkJobResponse; interface SparkJobScalaEntryResponse { /** * [Required] Scala class name used as entry point. */ className: string; /** * Expected value is 'SparkJobScalaEntry'. */ sparkJobEntryType: "SparkJobScalaEntry"; } interface SparkResourceConfigurationResponse { /** * Optional type of VM used as supported by the compute target. */ instanceType?: string; /** * Version of spark runtime used for the job. */ runtimeVersion?: string; } /** * sparkResourceConfigurationResponseProvideDefaults sets the appropriate defaults for SparkResourceConfigurationResponse */ function sparkResourceConfigurationResponseProvideDefaults(val: SparkResourceConfigurationResponse): SparkResourceConfigurationResponse; interface SpeechEndpointDeploymentResourcePropertiesResponse { /** * The failure reason if the creation failed. */ failureReason?: string; /** * Model used for the endpoint deployment. */ model: outputs.machinelearningservices.EndpointDeploymentModelResponse; /** * Read-only provision state status property. */ provisioningState: string; /** * The name of RAI policy. */ raiPolicyName?: string; sku?: outputs.machinelearningservices.CognitiveServicesSkuResponse; /** * Kind of the deployment. * Expected value is 'Azure.Speech'. */ type: "Azure.Speech"; /** * Deployment model version upgrade option. */ versionUpgradeOption?: string; } /** * The ssl configuration for scoring */ interface SslConfigurationResponse { /** * Cert data */ cert?: string; /** * CNAME of the cert */ cname?: string; /** * Key data */ key?: string; /** * Leaf domain label of public endpoint */ leafDomainLabel?: string; /** * Indicates whether to overwrite existing domain label. */ overwriteExistingDomain?: boolean; /** * Enable or disable ssl for scoring */ status?: string; } /** * Advances setting to customize StackEnsemble run. */ interface StackEnsembleSettingsResponse { /** * Optional parameters to pass to the initializer of the meta-learner. */ stackMetaLearnerKWargs?: any; /** * Specifies the proportion of the training set (when choosing train and validation type of training) to be reserved for training the meta-learner. Default value is 0.2. */ stackMetaLearnerTrainPercentage?: number; /** * The meta-learner is a model trained on the output of the individual heterogeneous models.\r\nDefault meta-learners are LogisticRegression for classification tasks (or LogisticRegressionCV if cross-validation is enabled) and ElasticNet for regression/forecasting tasks (or ElasticNetCV if cross-validation is enabled).\r\nThis parameter can be one of the following strings: LogisticRegression, LogisticRegressionCV, LightGBMClassifier, ElasticNet, ElasticNetCV, LightGBMRegressor, or LinearRegression */ stackMetaLearnerType?: string; } /** * stackEnsembleSettingsResponseProvideDefaults sets the appropriate defaults for StackEnsembleSettingsResponse */ function stackEnsembleSettingsResponseProvideDefaults(val: StackEnsembleSettingsResponse): StackEnsembleSettingsResponse; /** * Static input data definition. */ interface StaticInputDataResponse { /** * Mapping of column names to special uses. */ columns?: { [key: string]: string; }; /** * The context metadata of the data source. */ dataContext?: string; /** * Monitoring input data type enum. * Expected value is 'Static'. */ inputDataType: "Static"; /** * [Required] Specifies the type of job. */ jobInputType: string; /** * Reference to the component asset used to preprocess the data. */ preprocessingComponentId?: string; /** * [Required] Input Asset URI. */ uri: string; /** * [Required] The end date of the data window. */ windowEnd: string; /** * [Required] The start date of the data window. */ windowStart: string; } /** * Active message associated with project */ interface StatusMessageResponse { /** * Service-defined message code. */ code: string; /** * Time in UTC at which the message was created. */ createdDateTime: string; /** * Severity level of message. */ level: string; /** * A human-readable representation of the message code. */ message: string; } /** * Details of storage account to be used for the Registry */ interface StorageAccountDetailsResponse { /** * Details of system created storage account to be used for the registry */ systemCreatedStorageAccount?: outputs.machinelearningservices.SystemCreatedStorageAccountResponse; } interface StringStringKeyValuePairResponse { key?: string; value?: string; } /** * Sweep Job limit class. */ interface SweepJobLimitsResponse { /** * Expected value is 'Sweep'. */ jobLimitsType: "Sweep"; /** * Sweep Job max concurrent trials. */ maxConcurrentTrials?: number; /** * Sweep Job max total trials. */ maxTotalTrials?: number; /** * The max run duration in ISO 8601 format, after which the job will be cancelled. Only supports duration with precision as low as Seconds. */ timeout?: string; /** * Sweep Job Trial timeout value. */ trialTimeout?: string; } /** * Sweep job definition. */ interface SweepJobResponse { /** * ARM resource ID of the component resource. */ componentId?: string; /** * ARM resource ID of the compute resource. */ computeId?: string; /** * The asset description text. */ description?: string; /** * Display name of job. */ displayName?: string; /** * Early termination policies enable canceling poor-performing runs before they complete */ earlyTermination?: outputs.machinelearningservices.BanditPolicyResponse | outputs.machinelearningservices.MedianStoppingPolicyResponse | outputs.machinelearningservices.TruncationSelectionPolicyResponse; /** * The name of the experiment the job belongs to. If not set, the job is placed in the "Default" experiment. */ experimentName?: string; /** * Identity configuration. If set, this should be one of AmlToken, ManagedIdentity, UserIdentity or null. * Defaults to AmlToken if null. */ identity?: outputs.machinelearningservices.AmlTokenResponse | outputs.machinelearningservices.ManagedIdentityResponse | outputs.machinelearningservices.UserIdentityResponse; /** * Mapping of input data bindings used in the job. */ inputs?: { [key: string]: outputs.machinelearningservices.CustomModelJobInputResponse | outputs.machinelearningservices.LiteralJobInputResponse | outputs.machinelearningservices.MLFlowModelJobInputResponse | outputs.machinelearningservices.MLTableJobInputResponse | outputs.machinelearningservices.TritonModelJobInputResponse | outputs.machinelearningservices.UriFileJobInputResponse | outputs.machinelearningservices.UriFolderJobInputResponse; }; /** * Is the asset archived? */ isArchived?: boolean; /** * Enum to determine the type of job. * Expected value is 'Sweep'. */ jobType: "Sweep"; /** * Sweep Job limit. */ limits?: outputs.machinelearningservices.SweepJobLimitsResponse; /** * Notification setting for the job */ notificationSetting?: outputs.machinelearningservices.NotificationSettingResponse; /** * [Required] Optimization objective. */ objective: outputs.machinelearningservices.ObjectiveResponse; /** * Mapping of output data bindings used in the job. */ outputs?: { [key: string]: outputs.machinelearningservices.CustomModelJobOutputResponse | outputs.machinelearningservices.MLFlowModelJobOutputResponse | outputs.machinelearningservices.MLTableJobOutputResponse | outputs.machinelearningservices.TritonModelJobOutputResponse | outputs.machinelearningservices.UriFileJobOutputResponse | outputs.machinelearningservices.UriFolderJobOutputResponse; }; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Queue settings for the job */ queueSettings?: outputs.machinelearningservices.QueueSettingsResponse; /** * [Required] The hyperparameter sampling algorithm */ samplingAlgorithm: outputs.machinelearningservices.BayesianSamplingAlgorithmResponse | outputs.machinelearningservices.GridSamplingAlgorithmResponse | outputs.machinelearningservices.RandomSamplingAlgorithmResponse; /** * [Required] A dictionary containing each parameter and its distribution. The dictionary key is the name of the parameter */ searchSpace: any; /** * List of JobEndpoints. * For local jobs, a job endpoint will have an endpoint value of FileStreamObject. */ services?: { [key: string]: outputs.machinelearningservices.JobServiceResponse; }; /** * Status of the job. */ status: string; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; /** * [Required] Trial component definition. */ trial: outputs.machinelearningservices.TrialComponentResponse; } /** * sweepJobResponseProvideDefaults sets the appropriate defaults for SweepJobResponse */ function sweepJobResponseProvideDefaults(val: SweepJobResponse): SweepJobResponse; interface SynapseSparkPropertiesResponse { /** * Auto pause properties. */ autoPauseProperties?: outputs.machinelearningservices.AutoPausePropertiesResponse; /** * Auto scale properties. */ autoScaleProperties?: outputs.machinelearningservices.AutoScalePropertiesResponse; /** * The number of compute nodes currently assigned to the compute. */ nodeCount?: number; /** * Node size. */ nodeSize?: string; /** * Node size family. */ nodeSizeFamily?: string; /** * Pool name. */ poolName?: string; /** * Name of the resource group in which workspace is located. */ resourceGroup?: string; /** * Spark version. */ sparkVersion?: string; /** * Azure subscription identifier. */ subscriptionId?: string; /** * Name of Azure Machine Learning workspace. */ workspaceName?: string; } /** * A SynapseSpark compute. */ interface SynapseSparkResponse { /** * Location for the underlying compute */ computeLocation?: string; /** * The type of compute * Expected value is 'SynapseSpark'. */ computeType: "SynapseSpark"; /** * The time at which the compute was created. */ createdOn: string; /** * The description of the Machine Learning compute. */ description?: string; /** * Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. */ disableLocalAuth?: boolean; /** * Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. */ isAttachedCompute: boolean; /** * The time at which the compute was last modified. */ modifiedOn: string; properties?: outputs.machinelearningservices.SynapseSparkPropertiesResponse; /** * Errors during provisioning */ provisioningErrors: outputs.machinelearningservices.ErrorResponseResponse[]; /** * The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. */ provisioningState: string; /** * ARM resource id of the underlying compute */ resourceId?: string; } interface SystemCreatedAcrAccountResponse { /** * Name of the ACR account */ acrAccountName?: string; /** * SKU of the ACR account */ acrAccountSku?: string; /** * This is populated once the ACR account is created. */ armResourceId?: outputs.machinelearningservices.ArmResourceIdResponse; } interface SystemCreatedStorageAccountResponse { /** * Public blob access allowed */ allowBlobPublicAccess?: boolean; /** * This is populated once the storage account is created. */ armResourceId?: outputs.machinelearningservices.ArmResourceIdResponse; /** * HNS enabled for storage account */ storageAccountHnsEnabled?: boolean; /** * Name of the storage account */ storageAccountName?: string; /** * Allowed values: * "Standard_LRS", * "Standard_GRS", * "Standard_RAGRS", * "Standard_ZRS", * "Standard_GZRS", * "Standard_RAGZRS", * "Premium_LRS", * "Premium_ZRS" */ storageAccountType?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * A system service running on a compute. */ interface SystemServiceResponse { /** * Public IP address */ publicIpAddress: string; /** * The type of this system service. */ systemServiceType: string; /** * The version for this type. */ version: string; } /** * Featurization Configuration. */ interface TableVerticalFeaturizationSettingsResponse { /** * These transformers shall not be used in featurization. */ blockedTransformers?: string[]; /** * Dictionary of column name and its type (int, float, string, datetime etc). */ columnNameAndTypes?: { [key: string]: string; }; /** * Dataset language, useful for the text data. */ datasetLanguage?: string; /** * Determines whether to use Dnn based featurizers for data featurization. */ enableDnnFeaturization?: boolean; /** * Featurization mode - User can keep the default 'Auto' mode and AutoML will take care of necessary transformation of the data in featurization phase. * If 'Off' is selected then no featurization is done. * If 'Custom' is selected then user can specify additional inputs to customize how featurization is done. */ mode?: string; /** * User can specify additional transformers to be used along with the columns to which it would be applied and parameters for the transformer constructor. */ transformerParams?: { [key: string]: outputs.machinelearningservices.ColumnTransformerResponse[]; }; } /** * tableVerticalFeaturizationSettingsResponseProvideDefaults sets the appropriate defaults for TableVerticalFeaturizationSettingsResponse */ function tableVerticalFeaturizationSettingsResponseProvideDefaults(val: TableVerticalFeaturizationSettingsResponse): TableVerticalFeaturizationSettingsResponse; /** * Job execution constraints. */ interface TableVerticalLimitSettingsResponse { /** * Enable early termination, determines whether or not if AutoMLJob will terminate early if there is no score improvement in last 20 iterations. */ enableEarlyTermination?: boolean; /** * Exit score for the AutoML job. */ exitScore?: number; /** * Maximum Concurrent iterations. */ maxConcurrentTrials?: number; /** * Max cores per iteration. */ maxCoresPerTrial?: number; /** * Number of iterations. */ maxTrials?: number; /** * AutoML job timeout. */ timeout?: string; /** * Iteration timeout. */ trialTimeout?: string; } /** * tableVerticalLimitSettingsResponseProvideDefaults sets the appropriate defaults for TableVerticalLimitSettingsResponse */ function tableVerticalLimitSettingsResponseProvideDefaults(val: TableVerticalLimitSettingsResponse): TableVerticalLimitSettingsResponse; interface TargetUtilizationScaleSettingsResponse { /** * The maximum number of instances that the deployment can scale to. The quota will be reserved for max_instances. */ maxInstances?: number; /** * The minimum number of instances to always be present. */ minInstances?: number; /** * The polling interval in ISO 8691 format. Only supports duration with precision as low as Seconds. */ pollingInterval?: string; /** * Expected value is 'TargetUtilization'. */ scaleType: "TargetUtilization"; /** * Target CPU usage for the autoscaler. */ targetUtilizationPercentage?: number; } /** * targetUtilizationScaleSettingsResponseProvideDefaults sets the appropriate defaults for TargetUtilizationScaleSettingsResponse */ function targetUtilizationScaleSettingsResponseProvideDefaults(val: TargetUtilizationScaleSettingsResponse): TargetUtilizationScaleSettingsResponse; /** * TensorFlow distribution configuration. */ interface TensorFlowResponse { /** * Enum to determine the job distribution type. * Expected value is 'TensorFlow'. */ distributionType: "TensorFlow"; /** * Number of parameter server tasks. */ parameterServerCount?: number; /** * Number of workers. If not specified, will default to the instance count. */ workerCount?: number; } /** * tensorFlowResponseProvideDefaults sets the appropriate defaults for TensorFlowResponse */ function tensorFlowResponseProvideDefaults(val: TensorFlowResponse): TensorFlowResponse; /** * Text Classification Multilabel task in AutoML NLP vertical. * NLP - Natural Language Processing. */ interface TextClassificationMultilabelResponse { /** * Featurization inputs needed for AutoML job. */ featurizationSettings?: outputs.machinelearningservices.NlpVerticalFeaturizationSettingsResponse; /** * Execution constraints for AutoMLJob. */ limitSettings?: outputs.machinelearningservices.NlpVerticalLimitSettingsResponse; /** * Enum for setting log verbosity. */ logVerbosity?: string; /** * Primary metric for Text-Classification-Multilabel task. * Currently only Accuracy is supported as primary metric, hence user need not set it explicitly. */ primaryMetric: string; /** * Target column name: This is prediction values column. * Also known as label column name in context of classification tasks. */ targetColumnName?: string; /** * AutoMLJob Task type. * Expected value is 'TextClassificationMultilabel'. */ taskType: "TextClassificationMultilabel"; /** * [Required] Training data input. */ trainingData: outputs.machinelearningservices.MLTableJobInputResponse; /** * Validation data inputs. */ validationData?: outputs.machinelearningservices.MLTableJobInputResponse; } /** * textClassificationMultilabelResponseProvideDefaults sets the appropriate defaults for TextClassificationMultilabelResponse */ function textClassificationMultilabelResponseProvideDefaults(val: TextClassificationMultilabelResponse): TextClassificationMultilabelResponse; /** * Text Classification task in AutoML NLP vertical. * NLP - Natural Language Processing. */ interface TextClassificationResponse { /** * Featurization inputs needed for AutoML job. */ featurizationSettings?: outputs.machinelearningservices.NlpVerticalFeaturizationSettingsResponse; /** * Execution constraints for AutoMLJob. */ limitSettings?: outputs.machinelearningservices.NlpVerticalLimitSettingsResponse; /** * Enum for setting log verbosity. */ logVerbosity?: string; /** * Primary metrics for classification tasks. */ primaryMetric?: string; /** * Target column name: This is prediction values column. * Also known as label column name in context of classification tasks. */ targetColumnName?: string; /** * AutoMLJob Task type. * Expected value is 'TextClassification'. */ taskType: "TextClassification"; /** * [Required] Training data input. */ trainingData: outputs.machinelearningservices.MLTableJobInputResponse; /** * Validation data inputs. */ validationData?: outputs.machinelearningservices.MLTableJobInputResponse; } /** * textClassificationResponseProvideDefaults sets the appropriate defaults for TextClassificationResponse */ function textClassificationResponseProvideDefaults(val: TextClassificationResponse): TextClassificationResponse; /** * Text-NER task in AutoML NLP vertical. * NER - Named Entity Recognition. * NLP - Natural Language Processing. */ interface TextNerResponse { /** * Featurization inputs needed for AutoML job. */ featurizationSettings?: outputs.machinelearningservices.NlpVerticalFeaturizationSettingsResponse; /** * Execution constraints for AutoMLJob. */ limitSettings?: outputs.machinelearningservices.NlpVerticalLimitSettingsResponse; /** * Enum for setting log verbosity. */ logVerbosity?: string; /** * Primary metric for Text-NER task. * Only 'Accuracy' is supported for Text-NER, so user need not set this explicitly. */ primaryMetric: string; /** * Target column name: This is prediction values column. * Also known as label column name in context of classification tasks. */ targetColumnName?: string; /** * AutoMLJob Task type. * Expected value is 'TextNER'. */ taskType: "TextNER"; /** * [Required] Training data input. */ trainingData: outputs.machinelearningservices.MLTableJobInputResponse; /** * Validation data inputs. */ validationData?: outputs.machinelearningservices.MLTableJobInputResponse; } /** * textNerResponseProvideDefaults sets the appropriate defaults for TextNerResponse */ function textNerResponseProvideDefaults(val: TextNerResponse): TextNerResponse; interface TmpfsOptionsResponse { /** * Mention the Tmpfs size */ size?: number; } interface TopNFeaturesByAttributionResponse { /** * Expected value is 'TopNByAttribution'. */ filterType: "TopNByAttribution"; /** * The number of top features to include. */ top?: number; } /** * topNFeaturesByAttributionResponseProvideDefaults sets the appropriate defaults for TopNFeaturesByAttributionResponse */ function topNFeaturesByAttributionResponseProvideDefaults(val: TopNFeaturesByAttributionResponse): TopNFeaturesByAttributionResponse; /** * Trial component definition. */ interface TrialComponentResponse { /** * ARM resource ID of the code asset. */ codeId?: string; /** * [Required] The command to execute on startup of the job. eg. "python train.py" */ command: string; /** * Distribution configuration of the job. If set, this should be one of Mpi, Tensorflow, PyTorch, or null. */ distribution?: outputs.machinelearningservices.MpiResponse | outputs.machinelearningservices.PyTorchResponse | outputs.machinelearningservices.TensorFlowResponse; /** * [Required] The ARM resource ID of the Environment specification for the job. */ environmentId: string; /** * Environment variables included in the job. */ environmentVariables?: { [key: string]: string; }; /** * Compute Resource configuration for the job. */ resources?: outputs.machinelearningservices.JobResourceConfigurationResponse; } /** * trialComponentResponseProvideDefaults sets the appropriate defaults for TrialComponentResponse */ function trialComponentResponseProvideDefaults(val: TrialComponentResponse): TrialComponentResponse; interface TritonModelJobInputResponse { /** * Description for the input. */ description?: string; /** * Enum to determine the Job Input Type. * Expected value is 'triton_model'. */ jobInputType: "triton_model"; /** * Enum to determine the input data delivery mode. */ mode?: string; /** * [Required] Input Asset URI. */ uri: string; } /** * tritonModelJobInputResponseProvideDefaults sets the appropriate defaults for TritonModelJobInputResponse */ function tritonModelJobInputResponseProvideDefaults(val: TritonModelJobInputResponse): TritonModelJobInputResponse; interface TritonModelJobOutputResponse { /** * Output Asset Name. */ assetName?: string; /** * Description for the output. */ description?: string; /** * Enum to determine the Job Output Type. * Expected value is 'triton_model'. */ jobOutputType: "triton_model"; /** * Output data delivery mode enums. */ mode?: string; /** * Output Asset URI. */ uri?: string; } /** * tritonModelJobOutputResponseProvideDefaults sets the appropriate defaults for TritonModelJobOutputResponse */ function tritonModelJobOutputResponseProvideDefaults(val: TritonModelJobOutputResponse): TritonModelJobOutputResponse; /** * Defines an early termination policy that cancels a given percentage of runs at each evaluation interval. */ interface TruncationSelectionPolicyResponse { /** * Number of intervals by which to delay the first evaluation. */ delayEvaluation?: number; /** * Interval (number of runs) between policy evaluations. */ evaluationInterval?: number; /** * Expected value is 'TruncationSelection'. */ policyType: "TruncationSelection"; /** * The percentage of runs to cancel at each evaluation interval. */ truncationPercentage?: number; } /** * truncationSelectionPolicyResponseProvideDefaults sets the appropriate defaults for TruncationSelectionPolicyResponse */ function truncationSelectionPolicyResponseProvideDefaults(val: TruncationSelectionPolicyResponse): TruncationSelectionPolicyResponse; /** * uri-file data version entity */ interface UriFileDataVersionResponse { /** * Enum to determine the type of data. * Expected value is 'uri_file'. */ dataType: "uri_file"; /** * [Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 */ dataUri: string; /** * The asset description text. */ description?: string; /** * If the name version are system generated (anonymous registration). */ isAnonymous?: boolean; /** * Is the asset archived? */ isArchived?: boolean; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * uriFileDataVersionResponseProvideDefaults sets the appropriate defaults for UriFileDataVersionResponse */ function uriFileDataVersionResponseProvideDefaults(val: UriFileDataVersionResponse): UriFileDataVersionResponse; interface UriFileJobInputResponse { /** * Description for the input. */ description?: string; /** * Enum to determine the Job Input Type. * Expected value is 'uri_file'. */ jobInputType: "uri_file"; /** * Enum to determine the input data delivery mode. */ mode?: string; /** * [Required] Input Asset URI. */ uri: string; } /** * uriFileJobInputResponseProvideDefaults sets the appropriate defaults for UriFileJobInputResponse */ function uriFileJobInputResponseProvideDefaults(val: UriFileJobInputResponse): UriFileJobInputResponse; interface UriFileJobOutputResponse { /** * Output Asset Name. */ assetName?: string; /** * Description for the output. */ description?: string; /** * Enum to determine the Job Output Type. * Expected value is 'uri_file'. */ jobOutputType: "uri_file"; /** * Output data delivery mode enums. */ mode?: string; /** * Output Asset URI. */ uri?: string; } /** * uriFileJobOutputResponseProvideDefaults sets the appropriate defaults for UriFileJobOutputResponse */ function uriFileJobOutputResponseProvideDefaults(val: UriFileJobOutputResponse): UriFileJobOutputResponse; /** * uri-folder data version entity */ interface UriFolderDataVersionResponse { /** * Enum to determine the type of data. * Expected value is 'uri_folder'. */ dataType: "uri_folder"; /** * [Required] Uri of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 */ dataUri: string; /** * The asset description text. */ description?: string; /** * If the name version are system generated (anonymous registration). */ isAnonymous?: boolean; /** * Is the asset archived? */ isArchived?: boolean; /** * The asset property dictionary. */ properties?: { [key: string]: string; }; /** * Tag dictionary. Tags can be added, removed, and updated. */ tags?: { [key: string]: string; }; } /** * uriFolderDataVersionResponseProvideDefaults sets the appropriate defaults for UriFolderDataVersionResponse */ function uriFolderDataVersionResponseProvideDefaults(val: UriFolderDataVersionResponse): UriFolderDataVersionResponse; interface UriFolderJobInputResponse { /** * Description for the input. */ description?: string; /** * Enum to determine the Job Input Type. * Expected value is 'uri_folder'. */ jobInputType: "uri_folder"; /** * Enum to determine the input data delivery mode. */ mode?: string; /** * [Required] Input Asset URI. */ uri: string; } /** * uriFolderJobInputResponseProvideDefaults sets the appropriate defaults for UriFolderJobInputResponse */ function uriFolderJobInputResponseProvideDefaults(val: UriFolderJobInputResponse): UriFolderJobInputResponse; interface UriFolderJobOutputResponse { /** * Output Asset Name. */ assetName?: string; /** * Description for the output. */ description?: string; /** * Enum to determine the Job Output Type. * Expected value is 'uri_folder'. */ jobOutputType: "uri_folder"; /** * Output data delivery mode enums. */ mode?: string; /** * Output Asset URI. */ uri?: string; } /** * uriFolderJobOutputResponseProvideDefaults sets the appropriate defaults for UriFolderJobOutputResponse */ function uriFolderJobOutputResponseProvideDefaults(val: UriFolderJobOutputResponse): UriFolderJobOutputResponse; /** * Settings for user account that gets created on each on the nodes of a compute. */ interface UserAccountCredentialsResponse { /** * Name of the administrator user account which can be used to SSH to nodes. */ adminUserName: string; /** * Password of the administrator user account. */ adminUserPassword?: string; /** * SSH public key of the administrator user account. */ adminUserSshPublicKey?: string; } /** * User Assigned Identity */ interface UserAssignedIdentityLinkedServiceResponse { /** * The clientId(aka appId) of the user assigned identity. */ clientId: string; /** * The principal ID of the user assigned identity. */ principalId: string; /** * The tenant ID of the user assigned identity. */ tenantId: string; } /** * User Assigned Identity */ interface UserAssignedIdentityMachineLearningDatasetResponse { /** * The clientId(aka appId) of the user assigned identity. */ clientId: string; /** * The principal ID of the user assigned identity. */ principalId: string; /** * The tenant ID of the user assigned identity. */ tenantId: string; } /** * User Assigned Identity */ interface UserAssignedIdentityMachineLearningDatastoreResponse { /** * The clientId(aka appId) of the user assigned identity. */ clientId: string; /** * The principal ID of the user assigned identity. */ principalId: string; /** * The tenant ID of the user assigned identity. */ tenantId: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * User identity configuration. */ interface UserIdentityResponse { /** * Enum to determine identity framework. * Expected value is 'UserIdentity'. */ identityType: "UserIdentity"; } /** * User who created. */ interface UserInfoResponse { /** * A user alternate sec id. This represents the user in a different identity provider system Eg.1:live.com:puid */ userAltSecId?: string; /** * A user identity provider. Eg live.com */ userIdp?: string; /** * The issuer which issued the token for this user. */ userIss?: string; /** * A user's full name or a service principal's app ID. */ userName?: string; /** * A user or service principal's object ID.. */ userObjectId?: string; /** * A user or service principal's PuID. */ userPuId?: string; /** * A user or service principal's tenant ID. */ userTenantId?: string; } interface UsernamePasswordAuthTypeWorkspaceConnectionPropertiesResponse { /** * Authentication type of the connection target * Expected value is 'UsernamePassword'. */ authType: "UsernamePassword"; /** * Category of the connection */ category?: string; /** * A type definition that refers the id to an Azure Resource Manager resource. */ createdByWorkspaceArmId: string; credentials?: outputs.machinelearningservices.WorkspaceConnectionUsernamePasswordResponse; error?: string; expiryTime?: string; /** * Group based on connection category */ group: string; isSharedToAll?: boolean; /** * Store user metadata for this connection */ metadata?: { [key: string]: string; }; peRequirement?: string; peStatus?: string; sharedUserList?: string[]; target?: string; useWorkspaceManagedIdentity?: boolean; } /** * Virtual Machine image for Windows AML Compute */ interface VirtualMachineImageResponse { /** * Virtual Machine image path */ id: string; } /** * A Machine Learning compute based on Azure Virtual Machines. */ interface VirtualMachineResponse { /** * Location for the underlying compute */ computeLocation?: string; /** * The type of compute * Expected value is 'VirtualMachine'. */ computeType: "VirtualMachine"; /** * The time at which the compute was created. */ createdOn: string; /** * The description of the Machine Learning compute. */ description?: string; /** * Opt-out of local authentication and ensure customers can use only MSI and AAD exclusively for authentication. */ disableLocalAuth?: boolean; /** * Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false. */ isAttachedCompute: boolean; /** * The time at which the compute was last modified. */ modifiedOn: string; properties?: outputs.machinelearningservices.VirtualMachineSchemaPropertiesResponse; /** * Errors during provisioning */ provisioningErrors: outputs.machinelearningservices.ErrorResponseResponse[]; /** * The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed. */ provisioningState: string; /** * ARM resource id of the underlying compute */ resourceId?: string; } interface VirtualMachineSchemaPropertiesResponse { /** * Public IP address of the virtual machine. */ address?: string; /** * Admin credentials for virtual machine */ administratorAccount?: outputs.machinelearningservices.VirtualMachineSshCredentialsResponse; /** * Indicates whether this compute will be used for running notebooks. */ isNotebookInstanceCompute?: boolean; /** * Notebook server port open for ssh connections. */ notebookServerPort?: number; /** * Port open for ssh connections. */ sshPort?: number; /** * Virtual Machine size */ virtualMachineSize?: string; } /** * Describes the properties of a VM size. */ interface VirtualMachineSizeResponse { /** * The estimated price information for using a VM. */ estimatedVMPrices?: outputs.machinelearningservices.EstimatedVMPricesResponse; /** * The family name of the virtual machine size. */ family: string; /** * The number of gPUs supported by the virtual machine size. */ gpus: number; /** * Specifies if the virtual machine size supports low priority VMs. */ lowPriorityCapable: boolean; /** * The resource volume size, in MB, allowed by the virtual machine size. */ maxResourceVolumeMB: number; /** * The amount of memory, in GB, supported by the virtual machine size. */ memoryGB: number; /** * The name of the virtual machine size. */ name: string; /** * The OS VHD disk size, in MB, allowed by the virtual machine size. */ osVhdSizeMB: number; /** * Specifies if the virtual machine size supports premium IO. */ premiumIO: boolean; /** * Specifies the compute types supported by the virtual machine size. */ supportedComputeTypes?: string[]; /** * The number of vCPUs supported by the virtual machine size. */ vCPUs: number; } /** * Admin credentials for virtual machine */ interface VirtualMachineSshCredentialsResponse { /** * Password of admin account */ password?: string; /** * Private key data */ privateKeyData?: string; /** * Public key data */ publicKeyData?: string; /** * Username of admin account */ username?: string; } interface VolumeDefinitionResponse { /** * Bind Options of the mount */ bind?: outputs.machinelearningservices.BindOptionsResponse; /** * Consistency of the volume */ consistency?: string; /** * Indicate whether to mount volume as readOnly. Default value for this is false. */ readOnly?: boolean; /** * Source of the mount. For bind mounts this is the host path. */ source?: string; /** * Target of the mount. For bind mounts this is the path in the container. */ target?: string; /** * tmpfs option of the mount */ tmpfs?: outputs.machinelearningservices.TmpfsOptionsResponse; /** * Type of Volume Definition. Possible Values: bind,volume,tmpfs,npipe */ type?: string; /** * Volume Options of the mount */ volume?: outputs.machinelearningservices.VolumeOptionsResponse; } /** * volumeDefinitionResponseProvideDefaults sets the appropriate defaults for VolumeDefinitionResponse */ function volumeDefinitionResponseProvideDefaults(val: VolumeDefinitionResponse): VolumeDefinitionResponse; interface VolumeOptionsResponse { /** * Indicate whether volume is nocopy */ nocopy?: boolean; } interface WorkspaceConnectionAccessKeyResponse { accessKeyId?: string; secretAccessKey?: string; } /** * Account key object for workspace connection credential. */ interface WorkspaceConnectionAccountKeyResponse { key?: string; } /** * Api key object for workspace connection credential. */ interface WorkspaceConnectionApiKeyResponse { key?: string; } interface WorkspaceConnectionManagedIdentityResponse { clientId?: string; resourceId?: string; } /** * ClientId and ClientSecret are required. Other properties are optional * depending on each OAuth2 provider's implementation. */ interface WorkspaceConnectionOAuth2Response { /** * Required by Concur connection category */ authUrl?: string; /** * Client id in the format of UUID */ clientId?: string; clientSecret?: string; /** * Required by GoogleAdWords connection category */ developerToken?: string; password?: string; /** * Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho * where user needs to get RefreshToken offline */ refreshToken?: string; /** * Required by QuickBooks and Xero connection categories */ tenantId?: string; /** * Concur, ServiceNow auth server AccessToken grant type is 'Password' * which requires UsernamePassword */ username?: string; } interface WorkspaceConnectionPersonalAccessTokenResponse { pat?: string; } interface WorkspaceConnectionServicePrincipalResponse { clientId?: string; clientSecret?: string; tenantId?: string; } interface WorkspaceConnectionSharedAccessSignatureResponse { sas?: string; } interface WorkspaceConnectionUsernamePasswordResponse { password?: string; /** * Optional, required by connections like SalesForce for extra security in addition to UsernamePassword */ securityToken?: string; username?: string; } /** * WorkspaceHub's configuration object. */ interface WorkspaceHubConfigResponse { additionalWorkspaceStorageAccounts?: string[]; defaultWorkspaceResourceGroup?: string; } /** * The Private Endpoint resource. */ interface WorkspacePrivateEndpointResourceResponse { /** * e.g. /subscriptions/{networkSubscriptionId}/resourceGroups/{rgName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName} */ id: string; /** * The subnetId that the private endpoint is connected to. */ subnetArmId: string; } } export declare namespace maintenance { /** * Azure query for the update configuration. */ interface ConfigurationAssignmentFilterPropertiesResponse { /** * List of locations to scope the query to. */ locations?: string[]; /** * List of allowed operating systems. */ osTypes?: string[]; /** * List of allowed resource groups. */ resourceGroups?: string[]; /** * List of allowed resources. */ resourceTypes?: string[]; /** * Tag settings for the VM. */ tagSettings?: outputs.maintenance.TagSettingsPropertiesResponse; } /** * Input properties for patching a Linux machine. */ interface InputLinuxParametersResponse { /** * Classification category of patches to be patched. Allowed values are 'Critical', 'Security', and 'Other'. */ classificationsToInclude?: string[]; /** * Package names to be excluded for patching. */ packageNameMasksToExclude?: string[]; /** * Package names to be included for patching. */ packageNameMasksToInclude?: string[]; } /** * Input configuration for a patch run */ interface InputPatchConfigurationResponse { /** * Input parameters specific to patching Linux machine. For Windows machines, do not pass this property. */ linuxParameters?: outputs.maintenance.InputLinuxParametersResponse; /** * Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed. */ rebootSetting?: string; /** * Input parameters specific to patching a Windows machine. For Linux machines, do not pass this property. */ windowsParameters?: outputs.maintenance.InputWindowsParametersResponse; } /** * inputPatchConfigurationResponseProvideDefaults sets the appropriate defaults for InputPatchConfigurationResponse */ function inputPatchConfigurationResponseProvideDefaults(val: InputPatchConfigurationResponse): InputPatchConfigurationResponse; /** * Input properties for patching a Windows machine. */ interface InputWindowsParametersResponse { /** * Classification category of patches to be patched. Allowed values are 'Critical', 'Security', 'UpdateRollup', 'FeaturePack', 'ServicePack', 'Definition', 'Tools', and 'Updates'. */ classificationsToInclude?: string[]; /** * Exclude patches which need reboot */ excludeKbsRequiringReboot?: boolean; /** * Windows KBID to be excluded for patching. */ kbNumbersToExclude?: string[]; /** * Windows KBID to be included for patching. */ kbNumbersToInclude?: string[]; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Tag filter information for the VM. */ interface TagSettingsPropertiesResponse { /** * Filter VMs by Any or All specified tags. */ filterOperator?: string; /** * Dictionary of tags with its list of values. */ tags?: { [key: string]: string[]; }; } } export declare namespace managedidentity { /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace managednetwork { /** * The collection of Connectivity related groups and policies within the Managed Network */ interface ConnectivityCollectionResponse { /** * The collection of connectivity related Managed Network Groups within the Managed Network */ groups: outputs.managednetwork.ManagedNetworkGroupResponse[]; /** * The collection of Managed Network Peering Policies within the Managed Network */ peerings: outputs.managednetwork.ManagedNetworkPeeringPolicyResponse[]; } /** * The Managed Network Group resource */ interface ManagedNetworkGroupResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * Responsibility role under which this Managed Network Group will be created */ kind?: string; /** * The geo-location where the resource lives */ location?: string; /** * The collection of management groups covered by the Managed Network */ managementGroups?: outputs.managednetwork.ResourceIdResponse[]; /** * The name of the resource */ name: string; /** * Provisioning state of the ManagedNetwork resource. */ provisioningState: string; /** * The collection of subnets covered by the Managed Network */ subnets?: outputs.managednetwork.ResourceIdResponse[]; /** * The collection of subscriptions covered by the Managed Network */ subscriptions?: outputs.managednetwork.ResourceIdResponse[]; /** * The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. */ type: string; /** * The collection of virtual nets covered by the Managed Network */ virtualNetworks?: outputs.managednetwork.ResourceIdResponse[]; } /** * Properties of a Managed Network Peering Policy */ interface ManagedNetworkPeeringPolicyPropertiesResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Gets or sets the hub virtual network ID */ hub?: outputs.managednetwork.ResourceIdResponse; /** * Gets or sets the mesh group IDs */ mesh?: outputs.managednetwork.ResourceIdResponse[]; /** * Provisioning state of the ManagedNetwork resource. */ provisioningState: string; /** * Gets or sets the spokes group IDs */ spokes?: outputs.managednetwork.ResourceIdResponse[]; /** * Gets or sets the connectivity type of a network structure policy */ type: string; } /** * The Managed Network Peering Policy resource */ interface ManagedNetworkPeeringPolicyResponse { /** * Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The geo-location where the resource lives */ location?: string; /** * The name of the resource */ name: string; /** * Gets or sets the properties of a Managed Network Policy */ properties?: outputs.managednetwork.ManagedNetworkPeeringPolicyPropertiesResponse; /** * The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. */ type: string; } /** * Generic pointer to a resource */ interface ResourceIdResponse { /** * Resource Id */ id?: string; } /** * Scope of a Managed Network */ interface ScopeResponse { /** * The collection of management groups covered by the Managed Network */ managementGroups?: outputs.managednetwork.ResourceIdResponse[]; /** * The collection of subnets covered by the Managed Network */ subnets?: outputs.managednetwork.ResourceIdResponse[]; /** * The collection of subscriptions covered by the Managed Network */ subscriptions?: outputs.managednetwork.ResourceIdResponse[]; /** * The collection of virtual nets covered by the Managed Network */ virtualNetworks?: outputs.managednetwork.ResourceIdResponse[]; } } export declare namespace managednetworkfabric { /** * Action that need to performed. */ interface AccessControlListActionResponse { /** * Name of the counter block to get match count information. */ counterName?: string; /** * Type of actions that can be performed. */ type?: string; } /** * Defines the match condition that is supported to filter the traffic. */ interface AccessControlListMatchConditionResponse { /** * List of DSCP Markings that need to be matched. */ dscpMarkings?: string[]; /** * List of ether type values that need to be matched. */ etherTypes?: string[]; /** * List of IP fragment packets that need to be matched. */ fragments?: string[]; /** * IP condition that needs to be matched. */ ipCondition?: outputs.managednetworkfabric.IpMatchConditionResponse; /** * List of IP Lengths that need to be matched. */ ipLengths?: string[]; /** * Defines the port condition that needs to be matched. */ portCondition?: outputs.managednetworkfabric.AccessControlListPortConditionResponse; /** * List of the protocols that need to be matched. */ protocolTypes?: string[]; /** * List of TTL [Time To Live] values that need to be matched. */ ttlValues?: string[]; /** * Vlan match condition that needs to be matched. */ vlanMatchCondition?: outputs.managednetworkfabric.VlanMatchConditionResponse; } /** * Defines the match configuration that are supported to filter the traffic. */ interface AccessControlListMatchConfigurationResponse { /** * List of actions that need to be performed for the matched conditions. */ actions?: outputs.managednetworkfabric.AccessControlListActionResponse[]; /** * Type of IP Address. IPv4 or IPv6 */ ipAddressType?: string; /** * List of the match conditions. */ matchConditions?: outputs.managednetworkfabric.AccessControlListMatchConditionResponse[]; /** * The name of the match configuration. */ matchConfigurationName?: string; /** * Sequence Number of the match configuration. */ sequenceNumber?: number; } /** * Defines the port condition that needs to be matched. */ interface AccessControlListPortConditionResponse { /** * List of protocol flags that need to be matched. Example: established | initial | . List of eligible TCP Flags are ack, fin, not-ack, not-fin, not-psh, not-rst, not-syn, not-urg, psh, rst, syn, urg */ flags?: string[]; /** * Layer4 protocol type that needs to be matched. */ layer4Protocol: string; /** * List of the port Group Names that need to be matched. */ portGroupNames?: string[]; /** * Port type that needs to be matched. */ portType?: string; /** * List of the Ports that need to be matched. */ ports?: string[]; } /** * IP Community Properties. */ interface ActionIpCommunityPropertiesResponse { /** * List of IP Community IDs. */ add?: outputs.managednetworkfabric.IpCommunityIdListResponse; /** * List of IP Community IDs. */ delete?: outputs.managednetworkfabric.IpCommunityIdListResponse; /** * List of IP Community IDs. */ set?: outputs.managednetworkfabric.IpCommunityIdListResponse; } /** * IP Extended Community Properties. */ interface ActionIpExtendedCommunityPropertiesResponse { /** * List of IP Extended Community IDs. */ add?: outputs.managednetworkfabric.IpExtendedCommunityIdListResponse; /** * List of IP Extended Community IDs. */ delete?: outputs.managednetworkfabric.IpExtendedCommunityIdListResponse; /** * List of IP Extended Community IDs. */ set?: outputs.managednetworkfabric.IpExtendedCommunityIdListResponse; } /** * List of IPv4 and IPv6 aggregate routes. */ interface AggregateRouteConfigurationResponse { /** * List of IPv4 Route prefixes. */ ipv4Routes?: outputs.managednetworkfabric.AggregateRouteResponse[]; /** * List of Ipv6Routes prefixes. */ ipv6Routes?: outputs.managednetworkfabric.AggregateRouteResponse[]; } /** * aggregateIpv4Route model. */ interface AggregateRouteResponse { /** * IPv4 Prefix of the aggregate Ipv4Route. */ prefix: string; } /** * BFD configuration properties */ interface BfdConfigurationResponse { /** * Administrative state of the BfdConfiguration. Example: Enabled | Disabled. */ administrativeState: string; /** * Interval in milliseconds. Example: 300. */ intervalInMilliSeconds?: number; /** * Multiplier for the Bfd Configuration. Example: 5. */ multiplier?: number; } /** * bfdConfigurationResponseProvideDefaults sets the appropriate defaults for BfdConfigurationResponse */ function bfdConfigurationResponseProvideDefaults(val: BfdConfigurationResponse): BfdConfigurationResponse; /** * BGP Monitoring Protocol (BMP) Configuration properties. */ interface BmpConfigurationPropertiesResponse { /** * Export Policy for the BMP Configuration. */ exportPolicy?: string; /** * Monitored Address Families for the BMP Configuration. */ monitoredAddressFamilies?: string[]; /** * The List of Network ID's that need to be monitored. */ monitoredNetworks?: string[]; /** * Scope resource ARM Identifier. */ scopeResourceId?: string; /** * Enabling a station. Either True/False. */ stationConfigurationState?: string; /** * Station Connection Mode. */ stationConnectionMode?: string; /** * Station Connection Properties. */ stationConnectionProperties?: outputs.managednetworkfabric.StationConnectionPropertiesResponse; /** * IP Address of the station. */ stationIp?: string; /** * Name of the station. */ stationName?: string; /** * Network of the station */ stationNetwork?: string; /** * Port of the station. Default value is 5000. */ stationPort?: number; } /** * bmpConfigurationPropertiesResponseProvideDefaults sets the appropriate defaults for BmpConfigurationPropertiesResponse */ function bmpConfigurationPropertiesResponseProvideDefaults(val: BmpConfigurationPropertiesResponse): BmpConfigurationPropertiesResponse; /** * Dynamic match configuration object. */ interface CommonDynamicMatchConfigurationResponse { /** * List of IP Groups. */ ipGroups?: outputs.managednetworkfabric.IpGroupPropertiesResponse[]; /** * List of the port groups. */ portGroups?: outputs.managednetworkfabric.PortGroupPropertiesResponse[]; /** * List of vlan groups. */ vlanGroups?: outputs.managednetworkfabric.VlanGroupPropertiesResponse[]; } /** * Connected Subnet properties. */ interface ConnectedSubnetResponse { /** * Switch configuration description. */ annotation?: string; /** * Prefix of the Connected Subnet. */ prefix: string; } /** * Connected Subnet Route Policy properties. */ interface ConnectedSubnetRoutePolicyResponse { /** * Array of ARM Resource ID of the RoutePolicies. */ exportRoutePolicy?: outputs.managednetworkfabric.L3ExportRoutePolicyResponse; /** * ARM Resource ID of the Route Policy. This is used for the backward compatibility. */ exportRoutePolicyId?: string; } /** * Network Fabric Controller services. */ interface ControllerServicesResponse { /** * The IPv4 Address space is optional, if the value is not defined at the time of NFC creation, then the default value 10.0.0.0/19 is considered. The IPV4 address subnet is an optional attribute. */ ipv4AddressSpaces?: string[]; /** * The IPv6 is not supported right now. */ ipv6AddressSpaces?: string[]; } /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.managednetworkfabric.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.managednetworkfabric.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * Export Route Policy Configuration. */ interface ExportRoutePolicyInformationResponse { /** * Export IPv4 Route Policy Id. */ exportIpv4RoutePolicyId?: string; /** * Export IPv6 Route Policy Id. */ exportIpv6RoutePolicyId?: string; } /** * Export Route Policy either IPv4 or IPv6. */ interface ExportRoutePolicyResponse { /** * ARM resource ID of RoutePolicy. */ exportIpv4RoutePolicyId?: string; /** * ARM resource ID of RoutePolicy. */ exportIpv6RoutePolicyId?: string; } /** * The ExpressRoute circuit ID and the Auth Key are required for you to successfully deploy NFC service. */ interface ExpressRouteConnectionInformationResponse { /** * Authorization key for the circuit, must be of type Microsoft.Network/expressRouteCircuits/authorizations. The Auth Key is a mandatory attribute. */ expressRouteAuthorizationKey: string; /** * The express route circuit Azure resource ID, must be of type Microsoft.Network/expressRouteCircuits/circuitName. The ExpressRoute Circuit is a mandatory attribute. */ expressRouteCircuitId: string; } /** * option A properties object */ interface ExternalNetworkPropertiesResponseOptionAProperties { /** * BFD configuration properties */ bfdConfiguration?: outputs.managednetworkfabric.BfdConfigurationResponse; /** * Egress Acl. ARM resource ID of Access Control Lists. */ egressAclId?: string; /** * Fabric ASN number. Example 65001 */ fabricASN: number; /** * Ingress Acl. ARM resource ID of Access Control Lists. */ ingressAclId?: string; /** * MTU to use for option A peering. */ mtu?: number; /** * Peer ASN number.Example : 28 */ peerASN: number; /** * IPv4 Address Prefix. */ primaryIpv4Prefix?: string; /** * IPv6 Address Prefix. */ primaryIpv6Prefix?: string; /** * Secondary IPv4 Address Prefix. */ secondaryIpv4Prefix?: string; /** * Secondary IPv6 Address Prefix. */ secondaryIpv6Prefix?: string; /** * Vlan identifier. Example : 501 */ vlanId: number; } /** * externalNetworkPropertiesResponseOptionAPropertiesProvideDefaults sets the appropriate defaults for ExternalNetworkPropertiesResponseOptionAProperties */ function externalNetworkPropertiesResponseOptionAPropertiesProvideDefaults(val: ExternalNetworkPropertiesResponseOptionAProperties): ExternalNetworkPropertiesResponseOptionAProperties; /** * Option B configuration to be used for Management VPN. */ interface FabricOptionBPropertiesResponse { /** * Route Targets to be applied for outgoing routes from CE. This is for backward compatibility. */ exportRouteTargets?: string[]; /** * Route Targets to be applied for incoming routes into CE. This is for backward compatibility. */ importRouteTargets?: string[]; /** * Route Targets to be applied. */ routeTargets?: outputs.managednetworkfabric.RouteTargetInformationResponse; } /** * Import Route Policy Configuration. */ interface ImportRoutePolicyInformationResponse { /** * Import IPv4 Route Policy Id. */ importIpv4RoutePolicyId?: string; /** * Import IPv6 Route Policy Id. */ importIpv6RoutePolicyId?: string; } /** * Import Route Policy either IPv4 or IPv6. */ interface ImportRoutePolicyResponse { /** * ARM resource ID of RoutePolicy. */ importIpv4RoutePolicyId?: string; /** * ARM resource ID of RoutePolicy. */ importIpv6RoutePolicyId?: string; } /** * BGP configuration properties. */ interface InternalNetworkPropertiesResponseBgpConfiguration { /** * Allows for routes to be received and processed even if the router detects its own ASN in the AS-Path. 0 is disable, Possible values are 1-10, default is 2. */ allowAS?: number; /** * Enable Or Disable state. */ allowASOverride?: string; /** * Switch configuration description. */ annotation?: string; /** * BFD configuration properties */ bfdConfiguration?: outputs.managednetworkfabric.BfdConfigurationResponse; /** * Originate a defaultRoute. Ex: "True" | "False". */ defaultRouteOriginate?: string; /** * ASN of Network Fabric. Example: 65048. */ fabricASN: number; /** * List of BGP IPv4 Listen Range prefixes. */ ipv4ListenRangePrefixes?: string[]; /** * List with stringified IPv4 Neighbor Addresses. */ ipv4NeighborAddress?: outputs.managednetworkfabric.NeighborAddressResponse[]; /** * List of BGP IPv6 Listen Ranges prefixes. */ ipv6ListenRangePrefixes?: string[]; /** * List with stringified IPv6 Neighbor Address. */ ipv6NeighborAddress?: outputs.managednetworkfabric.NeighborAddressResponse[]; /** * Peer ASN. Example: 65047. */ peerASN: number; } /** * internalNetworkPropertiesResponseBgpConfigurationProvideDefaults sets the appropriate defaults for InternalNetworkPropertiesResponseBgpConfiguration */ function internalNetworkPropertiesResponseBgpConfigurationProvideDefaults(val: InternalNetworkPropertiesResponseBgpConfiguration): InternalNetworkPropertiesResponseBgpConfiguration; /** * Static Route Configuration properties. */ interface InternalNetworkPropertiesResponseStaticRouteConfiguration { /** * BFD configuration properties */ bfdConfiguration?: outputs.managednetworkfabric.BfdConfigurationResponse; /** * Extension. Example: NoExtension | NPB. */ extension?: string; /** * List of IPv4 Routes. */ ipv4Routes?: outputs.managednetworkfabric.StaticRoutePropertiesResponse[]; /** * List of IPv6 Routes. */ ipv6Routes?: outputs.managednetworkfabric.StaticRoutePropertiesResponse[]; } /** * internalNetworkPropertiesResponseStaticRouteConfigurationProvideDefaults sets the appropriate defaults for InternalNetworkPropertiesResponseStaticRouteConfiguration */ function internalNetworkPropertiesResponseStaticRouteConfigurationProvideDefaults(val: InternalNetworkPropertiesResponseStaticRouteConfiguration): InternalNetworkPropertiesResponseStaticRouteConfiguration; /** * IP Community ID list properties. */ interface IpCommunityIdListResponse { /** * List of IP Community resource IDs. */ ipCommunityIds?: string[]; } /** * IP Community patchable properties. */ interface IpCommunityRuleResponse { /** * Action to be taken on the configuration. Example: Permit | Deny. */ action: string; /** * List the community members of IP Community. */ communityMembers: string[]; /** * Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. */ sequenceNumber: number; /** * Supported well known Community List. */ wellKnownCommunities?: string[]; } /** * IP Extended Community Id list properties. */ interface IpExtendedCommunityIdListResponse { /** * List of IP Extended Community resource IDs. */ ipExtendedCommunityIds?: string[]; } /** * List of IP Extended Community Rules. */ interface IpExtendedCommunityRuleResponse { /** * Action to be taken on the configuration. Example: Permit | Deny. */ action: string; /** * Route Target List.The expected formats are ASN(plain):NN >> example 4294967294:50, ASN.ASN:NN >> example 65533.65333:40, IP-address:NN >> example 10.10.10.10:65535. The possible values of ASN,NN are in range of 0-65535, ASN(plain) is in range of 0-4294967295. */ routeTargets: string[]; /** * Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. */ sequenceNumber: number; } /** * IP Group properties. */ interface IpGroupPropertiesResponse { /** * IP Address type. */ ipAddressType?: string; /** * List of IP Prefixes. */ ipPrefixes?: string[]; /** * IP Group name. */ name?: string; } /** * Defines the condition that can be filtered using the selected IPs. */ interface IpMatchConditionResponse { /** * The List of IP Group Names that need to be matched. */ ipGroupNames?: string[]; /** * The list of IP Prefixes that need to be matched. */ ipPrefixValues?: string[]; /** * IP Prefix Type that needs to be matched. */ prefixType?: string; /** * IP Address type that needs to be matched. */ type?: string; } /** * IP Prefix Rule properties. */ interface IpPrefixRuleResponse { /** * Action to be taken on the configuration. Example: Permit | Deny. */ action: string; /** * Specify prefix-list bounds. */ condition?: string; /** * Network Prefix specifying IPv4/IPv6 packets to be permitted or denied. Example: 1.1.1.0/24 | 3FFE:FFFF:0:CD30::/126 */ networkPrefix: string; /** * Sequence to insert to/delete from existing route. Prefix lists are evaluated starting with the lowest sequence number and continue down the list until a match is made. Once a match is made, the permit or deny statement is applied to that network and the rest of the list is ignored. */ sequenceNumber: number; /** * SubnetMaskLength gives the minimum NetworkPrefix length to be matched. Possible values for IPv4 are 1 - 32 . Possible values of IPv6 are 1 - 128. */ subnetMaskLength?: string; } /** * Isolation Domain Properties. */ interface IsolationDomainPropertiesResponse { /** * Type of encapsulation. */ encapsulation?: string; /** * List of Neighbor Group IDs. */ neighborGroupIds?: string[]; } /** * Array of ARM Resource ID of the RoutePolicies. */ interface L3ExportRoutePolicyResponse { /** * ARM Resource ID of the RoutePolicy. */ exportIpv4RoutePolicyId?: string; /** * ARM Resource ID of the RoutePolicy. */ exportIpv6RoutePolicyId?: string; } /** * Option B configuration. */ interface L3OptionBPropertiesResponse { /** * RouteTargets to be applied. This is used for the backward compatibility. */ exportRouteTargets?: string[]; /** * RouteTargets to be applied. This is used for the backward compatibility. */ importRouteTargets?: string[]; /** * RouteTargets to be applied. */ routeTargets?: outputs.managednetworkfabric.RouteTargetInformationResponse; } /** * Details of the last operations performed on the resource */ interface LastOperationPropertiesResponse { /** * Details status of the last operation performed on the resource. */ details: string; } /** * Common properties for Layer2 Configuration. */ interface Layer2ConfigurationResponse { /** * List of network device interfaces resource IDs. */ interfaces?: string[]; /** * MTU of the packets between PE & CE. */ mtu?: number; } /** * layer2ConfigurationResponseProvideDefaults sets the appropriate defaults for Layer2ConfigurationResponse */ function layer2ConfigurationResponseProvideDefaults(val: Layer2ConfigurationResponse): Layer2ConfigurationResponse; /** * Managed Resource Group configuration properties. */ interface ManagedResourceGroupConfigurationResponse { /** * Managed resource group location. */ location?: string; /** * The NFC service will be hosted in a Managed resource group. */ name?: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.managednetworkfabric.UserAssignedIdentityResponse; }; } /** * Configuration to be used to setup the management network. */ interface ManagementNetworkConfigurationPropertiesResponse { /** * VPN Configuration properties. */ infrastructureVpnConfiguration: outputs.managednetworkfabric.VpnConfigurationPropertiesResponse; /** * VPN Configuration properties. */ workloadVpnConfiguration: outputs.managednetworkfabric.VpnConfigurationPropertiesResponse; } /** * managementNetworkConfigurationPropertiesResponseProvideDefaults sets the appropriate defaults for ManagementNetworkConfigurationPropertiesResponse */ function managementNetworkConfigurationPropertiesResponseProvideDefaults(val: ManagementNetworkConfigurationPropertiesResponse): ManagementNetworkConfigurationPropertiesResponse; /** * Neighbor Address properties. */ interface NeighborAddressResponse { /** * IP Address. */ address?: string; /** * Configuration state of the resource. */ configurationState: string; } /** * An array of destination IPv4 Addresses or IPv6 Addresses. */ interface NeighborGroupDestinationResponse { /** * Array of IPv4 Addresses. */ ipv4Addresses?: string[]; /** * Array of IPv6 Addresses. */ ipv6Addresses?: string[]; } /** * Destination. */ interface NetworkTapPropertiesResponseDestinations { /** * The destination Id. ARM Resource ID of either NNI or Internal Networks. */ destinationId: string; /** * ARM Resource ID of destination Tap Rule that contains match configurations. */ destinationTapRuleId?: string; /** * Type of destination. Input can be IsolationDomain or Direct. */ destinationType: string; /** * Isolation Domain Properties. */ isolationDomainProperties?: outputs.managednetworkfabric.IsolationDomainPropertiesResponse; /** * Destination name. */ name: string; } /** * Action that need to performed. */ interface NetworkTapRuleActionResponse { /** * Destination Id. The ARM resource Id may be either Network To Network Interconnect or NeighborGroup. */ destinationId?: string; /** * The parameter to enable or disable the timestamp. */ isTimestampEnabled?: string; /** * The name of the match configuration. This is used when Goto type is provided. If Goto type is selected and no match configuration name is provided. It goes to next configuration. */ matchConfigurationName?: string; /** * Truncate. 0 indicates do not truncate. */ truncate?: string; /** * Type of actions that can be performed. */ type?: string; } /** * Defines the match condition that is supported to filter the traffic. */ interface NetworkTapRuleMatchConditionResponse { /** * Encapsulation Type that needs to be matched. */ encapsulationType?: string; /** * IP condition that needs to be matched. */ ipCondition?: outputs.managednetworkfabric.IpMatchConditionResponse; /** * Defines the port condition that needs to be matched. */ portCondition?: outputs.managednetworkfabric.PortConditionResponse; /** * List of the protocols that need to be matched. */ protocolTypes?: string[]; /** * Vlan match condition that needs to be matched. */ vlanMatchCondition?: outputs.managednetworkfabric.VlanMatchConditionResponse; } /** * networkTapRuleMatchConditionResponseProvideDefaults sets the appropriate defaults for NetworkTapRuleMatchConditionResponse */ function networkTapRuleMatchConditionResponseProvideDefaults(val: NetworkTapRuleMatchConditionResponse): NetworkTapRuleMatchConditionResponse; /** * Defines the match configuration that are supported to filter the traffic. */ interface NetworkTapRuleMatchConfigurationResponse { /** * List of actions that need to be performed for the matched conditions. */ actions?: outputs.managednetworkfabric.NetworkTapRuleActionResponse[]; /** * Type of IP Address. IPv4 or IPv6 */ ipAddressType?: string; /** * List of the match conditions. */ matchConditions?: outputs.managednetworkfabric.NetworkTapRuleMatchConditionResponse[]; /** * The name of the match configuration. */ matchConfigurationName?: string; /** * Sequence Number of the match configuration.. */ sequenceNumber?: number; } /** * Common properties for Layer3Configuration. */ interface NetworkToNetworkInterconnectPropertiesResponseOptionBLayer3Configuration { /** * ASN of CE devices for CE/PE connectivity. */ fabricASN: number; /** * ASN of PE devices for CE/PE connectivity.Example : 28 */ peerASN: number; /** * IPv4 Address Prefix. */ primaryIpv4Prefix?: string; /** * IPv6 Address Prefix. */ primaryIpv6Prefix?: string; /** * Secondary IPv4 Address Prefix. */ secondaryIpv4Prefix?: string; /** * Secondary IPv6 Address Prefix. */ secondaryIpv6Prefix?: string; /** * VLAN for CE/PE Layer 3 connectivity.Example : 501 */ vlanId: number; } /** * NPB Static Route Configuration properties. */ interface NpbStaticRouteConfigurationResponse { /** * BFD Configuration properties. */ bfdConfiguration?: outputs.managednetworkfabric.BfdConfigurationResponse; /** * List of IPv4 Routes. */ ipv4Routes?: outputs.managednetworkfabric.StaticRoutePropertiesResponse[]; /** * List of IPv6 Routes. */ ipv6Routes?: outputs.managednetworkfabric.StaticRoutePropertiesResponse[]; } /** * npbStaticRouteConfigurationResponseProvideDefaults sets the appropriate defaults for NpbStaticRouteConfigurationResponse */ function npbStaticRouteConfigurationResponseProvideDefaults(val: NpbStaticRouteConfigurationResponse): NpbStaticRouteConfigurationResponse; /** * Port condition that needs to be matched. */ interface PortConditionResponse { /** * Layer4 protocol type that needs to be matched. */ layer4Protocol: string; /** * List of the port Group Names that need to be matched. */ portGroupNames?: string[]; /** * Port type that needs to be matched. */ portType?: string; /** * List of the Ports that need to be matched. */ ports?: string[]; } /** * Port Group properties. */ interface PortGroupPropertiesResponse { /** * The name of the port group. */ name?: string; /** * List of the ports that need to be matched. */ ports?: string[]; } /** * Route Policy Statement properties. */ interface RoutePolicyStatementPropertiesResponse { /** * Route policy action properties. */ action: outputs.managednetworkfabric.StatementActionPropertiesResponse; /** * Switch configuration description. */ annotation?: string; /** * Route policy condition properties. */ condition: outputs.managednetworkfabric.StatementConditionPropertiesResponse; /** * Sequence to insert to/delete from existing route. */ sequenceNumber: number; } /** * routePolicyStatementPropertiesResponseProvideDefaults sets the appropriate defaults for RoutePolicyStatementPropertiesResponse */ function routePolicyStatementPropertiesResponseProvideDefaults(val: RoutePolicyStatementPropertiesResponse): RoutePolicyStatementPropertiesResponse; /** * Route Target Configuration. */ interface RouteTargetInformationResponse { /** * Route Targets to be applied for outgoing routes into CE. */ exportIpv4RouteTargets?: string[]; /** * Route Targets to be applied for outgoing routes from CE. */ exportIpv6RouteTargets?: string[]; /** * Route Targets to be applied for incoming routes into CE. */ importIpv4RouteTargets?: string[]; /** * Route Targets to be applied for incoming routes from CE. */ importIpv6RouteTargets?: string[]; } /** * Rules for the InternetGateways */ interface RulePropertiesResponse { /** * Specify action. */ action: string; /** * List of Addresses to be allowed or denied. */ addressList: string[]; } /** * Route policy action properties. */ interface StatementActionPropertiesResponse { /** * Action type. Example: Permit | Deny | Continue. */ actionType: string; /** * IP Community Properties. */ ipCommunityProperties?: outputs.managednetworkfabric.ActionIpCommunityPropertiesResponse; /** * IP Extended Community Properties. */ ipExtendedCommunityProperties?: outputs.managednetworkfabric.ActionIpExtendedCommunityPropertiesResponse; /** * Local Preference of the route policy. */ localPreference?: number; } /** * Route policy statement condition properties. */ interface StatementConditionPropertiesResponse { /** * List of IP Community resource IDs. */ ipCommunityIds?: string[]; /** * List of IP Extended Community resource IDs. */ ipExtendedCommunityIds?: string[]; /** * Arm Resource Id of IpPrefix. */ ipPrefixId?: string; /** * Type of the condition used. */ type?: string; } /** * statementConditionPropertiesResponseProvideDefaults sets the appropriate defaults for StatementConditionPropertiesResponse */ function statementConditionPropertiesResponseProvideDefaults(val: StatementConditionPropertiesResponse): StatementConditionPropertiesResponse; /** * Route Properties. */ interface StaticRoutePropertiesResponse { /** * List of next hop addresses. */ nextHop: string[]; /** * Prefix of the route. */ prefix: string; } /** * Station Connection Properties. */ interface StationConnectionPropertiesResponse { /** * Connection keepalive idle time in seconds */ keepaliveIdleTime?: number; /** * Probe count, default value is 10 */ probeCount?: number; /** * Probe interval in seconds, default value is 60 */ probeInterval?: number; } /** * stationConnectionPropertiesResponseProvideDefaults sets the appropriate defaults for StationConnectionPropertiesResponse */ function stationConnectionPropertiesResponseProvideDefaults(val: StationConnectionPropertiesResponse): StationConnectionPropertiesResponse; /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Network and credentials configuration currently applied to terminal server. */ interface TerminalServerConfigurationResponse { /** * ARM Resource ID used for the NetworkDevice. */ networkDeviceId: string; /** * Password for the terminal server connection. */ password: string; /** * IPv4 Address Prefix. */ primaryIpv4Prefix: string; /** * IPv6 Address Prefix. */ primaryIpv6Prefix?: string; /** * Secondary IPv4 Address Prefix. */ secondaryIpv4Prefix: string; /** * Secondary IPv6 Address Prefix. */ secondaryIpv6Prefix?: string; /** * Serial Number of Terminal server. */ serialNumber?: string; /** * Username for the terminal server connection. */ username: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Vlan group properties. */ interface VlanGroupPropertiesResponse { /** * Vlan group name. */ name?: string; /** * List of vlans. */ vlans?: string[]; } /** * The vlan match conditions that need to be matched. */ interface VlanMatchConditionResponse { /** * List of inner vlans that need to be matched. */ innerVlans?: string[]; /** * List of vlan group names that need to be matched. */ vlanGroupNames?: string[]; /** * List of vlans that need to be matched. */ vlans?: string[]; } /** * Network and credential configuration currently applied on terminal server. */ interface VpnConfigurationPropertiesResponse { /** * Administrative state of the resource. */ administrativeState: string; /** * ARM Resource ID of the Network To Network Interconnect. */ networkToNetworkInterconnectId?: string; /** * option A properties */ optionAProperties?: outputs.managednetworkfabric.VpnConfigurationPropertiesResponseOptionAProperties; /** * option B properties */ optionBProperties?: outputs.managednetworkfabric.FabricOptionBPropertiesResponse; /** * Peering option list. */ peeringOption: string; } /** * vpnConfigurationPropertiesResponseProvideDefaults sets the appropriate defaults for VpnConfigurationPropertiesResponse */ function vpnConfigurationPropertiesResponseProvideDefaults(val: VpnConfigurationPropertiesResponse): VpnConfigurationPropertiesResponse; /** * option A properties */ interface VpnConfigurationPropertiesResponseOptionAProperties { /** * BFD Configuration properties. */ bfdConfiguration?: outputs.managednetworkfabric.BfdConfigurationResponse; /** * MTU to use for option A peering. */ mtu?: number; /** * Peer ASN number.Example : 28 */ peerASN: number; /** * IPv4 Address Prefix. */ primaryIpv4Prefix?: string; /** * IPv6 Address Prefix. */ primaryIpv6Prefix?: string; /** * Secondary IPv4 Address Prefix. */ secondaryIpv4Prefix?: string; /** * Secondary IPv6 Address Prefix. */ secondaryIpv6Prefix?: string; /** * Vlan Id.Example : 501 */ vlanId: number; } /** * vpnConfigurationPropertiesResponseOptionAPropertiesProvideDefaults sets the appropriate defaults for VpnConfigurationPropertiesResponseOptionAProperties */ function vpnConfigurationPropertiesResponseOptionAPropertiesProvideDefaults(val: VpnConfigurationPropertiesResponseOptionAProperties): VpnConfigurationPropertiesResponseOptionAProperties; } export declare namespace managedops { /** * Configuration for the Azure Monitor Insights service. */ interface AzureMonitorConfigurationResponse { /** * Azure monitor workspace resource ID used by the service. */ azureMonitorWorkspaceId: string; } /** * Azure Monitor Insights service information. */ interface AzureMonitorInformationResponse { /** * ID of Data Collection Rule (DCR) associated with this service. */ dcrId: string; /** * Indicates whether the service is enabled. */ enablementStatus: string; } /** * Configuration for the Change Tracking and Inventory service. */ interface ChangeTrackingConfigurationResponse { /** * Log analytics workspace resource ID used by the service. */ logAnalyticsWorkspaceId: string; } /** * Change Tracking and Inventory service information. */ interface ChangeTrackingInformationResponse { /** * ID of Data Collection Rule (DCR) associated with this service. */ dcrId: string; /** * Indicates whether the service is enabled. */ enablementStatus: string; } /** * Defender Cloud Security Posture Management (CSPM) service information. */ interface DefenderCspmInformationResponse { /** * Indicates whether the service is enabled. */ enablementStatus: string; } /** * Defender for Servers service information. */ interface DefenderForServersInformationResponse { /** * Indicates whether the service is enabled. */ enablementStatus: string; } /** * Desired configuration input by the user. */ interface DesiredConfigurationResponse { /** * Configuration for the Azure Monitor Insights service. */ azureMonitorInsights: outputs.managedops.AzureMonitorConfigurationResponse; /** * Configuration for the Change Tracking and Inventory service. */ changeTrackingAndInventory: outputs.managedops.ChangeTrackingConfigurationResponse; /** * Desired enablement state of the Defender Cloud Security Posture Management (CSPM) service. */ defenderCspm?: string; /** * Desired enablement state of the Defender For Servers service. */ defenderForServers?: string; /** * User assigned Managed Identity used to perform operations on machines managed by Ops360. */ userAssignedManagedIdentityId: string; } /** * Azure Policy and Machine Configuration service information. */ interface GuestConfigurationInformationResponse { /** * Indicates whether the service is enabled. */ enablementStatus: string; } /** * Properties of the ManagedOps resource. */ interface ManagedOpsPropertiesResponse { /** * Desired configuration input by the user. */ desiredConfiguration: outputs.managedops.DesiredConfigurationResponse; /** * Policy assignments created for managing services. */ policyAssignmentProperties: outputs.managedops.PolicyAssignmentPropertiesResponse; /** * Provisioning state of the resource. */ provisioningState: string; /** * Services provisioned by this resource. */ services: outputs.managedops.ServiceInformationResponse; /** * Product plan details of this resource. */ sku: outputs.managedops.SkuResponse; } /** * Policy assignments created for managing services. */ interface PolicyAssignmentPropertiesResponse { /** * Policy initiative assignment ID. */ policyInitiativeAssignmentId: string; } /** * Services provisioned by this resource. */ interface ServiceInformationResponse { /** * Azure Monitor Insights service information. */ azureMonitorInsights: outputs.managedops.AzureMonitorInformationResponse; /** * Azure Policy and Machine Configuration service information. */ azurePolicyAndMachineConfiguration: outputs.managedops.GuestConfigurationInformationResponse; /** * Azure Update Manager service information. */ azureUpdateManager: outputs.managedops.UpdateManagerInformationResponse; /** * Change Tracking and Inventory service information. */ changeTrackingAndInventory: outputs.managedops.ChangeTrackingInformationResponse; /** * Defender for Cloud's Cloud security posture management (CSPM) service information. */ defenderCspm: outputs.managedops.DefenderCspmInformationResponse; /** * Defender for Servers service information. */ defenderForServers: outputs.managedops.DefenderForServersInformationResponse; } /** * Specifies the service plan for this resource. */ interface SkuResponse { /** * Name of the SKU. */ name: string; /** * Pricing tier of the SKU. */ tier: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Azure Update Manager service information. */ interface UpdateManagerInformationResponse { /** * Indicates whether the service is enabled. */ enablementStatus: string; } } export declare namespace managedservices { /** * The Azure Active Directory principal identifier and Azure built-in role that describes the access the principal will receive on the delegated resource in the managed tenant. */ interface AuthorizationResponse { /** * The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other principals. */ delegatedRoleDefinitionIds?: string[]; /** * The identifier of the Azure Active Directory principal. */ principalId: string; /** * The display name of the Azure Active Directory principal. */ principalIdDisplayName?: string; /** * The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. */ roleDefinitionId: string; } /** * Defines the Azure Active Directory principal that can approve any just-in-time access requests by the principal defined in the EligibleAuthorization. */ interface EligibleApproverResponse { /** * The identifier of the Azure Active Directory principal. */ principalId: string; /** * The display name of the Azure Active Directory principal. */ principalIdDisplayName?: string; } /** * The Azure Active Directory principal identifier, Azure built-in role, and just-in-time access policy that describes the just-in-time access the principal will receive on the delegated resource in the managed tenant. */ interface EligibleAuthorizationResponse { /** * The just-in-time access policy setting. */ justInTimeAccessPolicy?: outputs.managedservices.JustInTimeAccessPolicyResponse; /** * The identifier of the Azure Active Directory principal. */ principalId: string; /** * The display name of the Azure Active Directory principal. */ principalIdDisplayName?: string; /** * The identifier of the Azure built-in role that defines the permissions that the Azure Active Directory principal will have on the projected scope. */ roleDefinitionId: string; } /** * eligibleAuthorizationResponseProvideDefaults sets the appropriate defaults for EligibleAuthorizationResponse */ function eligibleAuthorizationResponseProvideDefaults(val: EligibleAuthorizationResponse): EligibleAuthorizationResponse; /** * Just-in-time access policy setting. */ interface JustInTimeAccessPolicyResponse { /** * The list of managedByTenant approvers for the eligible authorization. */ managedByTenantApprovers?: outputs.managedservices.EligibleApproverResponse[]; /** * The maximum access duration in ISO 8601 format for just-in-time access requests. */ maximumActivationDuration?: string; /** * The multi-factor authorization provider to be used for just-in-time access requests. */ multiFactorAuthProvider: string; } /** * justInTimeAccessPolicyResponseProvideDefaults sets the appropriate defaults for JustInTimeAccessPolicyResponse */ function justInTimeAccessPolicyResponseProvideDefaults(val: JustInTimeAccessPolicyResponse): JustInTimeAccessPolicyResponse; /** * The details for the Managed Services offer’s plan in Azure Marketplace. */ interface PlanResponse { /** * Azure Marketplace plan name. */ name: string; /** * Azure Marketplace product code. */ product: string; /** * Azure Marketplace publisher ID. */ publisher: string; /** * Azure Marketplace plan's version. */ version: string; } /** * The properties of the registration assignment. */ interface RegistrationAssignmentPropertiesResponse { /** * The current provisioning state of the registration assignment. */ provisioningState: string; /** * The registration definition associated with the registration assignment. */ registrationDefinition: outputs.managedservices.RegistrationAssignmentPropertiesResponseRegistrationDefinition; /** * The fully qualified path of the registration definition. */ registrationDefinitionId: string; } /** * The properties of the registration definition associated with the registration assignment. */ interface RegistrationAssignmentPropertiesResponseProperties { /** * The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. */ authorizations?: outputs.managedservices.AuthorizationResponse[]; /** * The description of the registration definition. */ description?: string; /** * The collection of eligible authorization objects describing the just-in-time access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. */ eligibleAuthorizations?: outputs.managedservices.EligibleAuthorizationResponse[]; /** * The identifier of the managedBy tenant. */ managedByTenantId?: string; /** * The name of the managedBy tenant. */ managedByTenantName?: string; /** * The identifier of the managed tenant. */ manageeTenantId?: string; /** * The name of the managed tenant. */ manageeTenantName?: string; /** * The current provisioning state of the registration definition. */ provisioningState?: string; /** * The name of the registration definition. */ registrationDefinitionName?: string; } /** * The registration definition associated with the registration assignment. */ interface RegistrationAssignmentPropertiesResponseRegistrationDefinition { /** * The fully qualified path of the registration definition. */ id: string; /** * The name of the registration definition. */ name: string; /** * The details for the Managed Services offer’s plan in Azure Marketplace. */ plan?: outputs.managedservices.PlanResponse; /** * The properties of the registration definition associated with the registration assignment. */ properties?: outputs.managedservices.RegistrationAssignmentPropertiesResponseProperties; /** * The metadata for the registration definition resource. */ systemData: outputs.managedservices.SystemDataResponse; /** * The type of the Azure resource (Microsoft.ManagedServices/registrationDefinitions). */ type: string; } /** * The properties of a registration definition. */ interface RegistrationDefinitionPropertiesResponse { /** * The collection of authorization objects describing the access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. */ authorizations: outputs.managedservices.AuthorizationResponse[]; /** * The description of the registration definition. */ description?: string; /** * The collection of eligible authorization objects describing the just-in-time access Azure Active Directory principals in the managedBy tenant will receive on the delegated resource in the managed tenant. */ eligibleAuthorizations?: outputs.managedservices.EligibleAuthorizationResponse[]; /** * The identifier of the managedBy tenant. */ managedByTenantId: string; /** * The name of the managedBy tenant. */ managedByTenantName: string; /** * The identifier of the managed tenant. */ manageeTenantId: string; /** * The name of the managed tenant. */ manageeTenantName: string; /** * The current provisioning state of the registration definition. */ provisioningState: string; /** * The name of the registration definition. */ registrationDefinitionName?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace management { /** * The ID of the parent management group. */ interface DescendantParentGroupInfoResponse { /** * The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 */ id?: string; } /** * The entity. */ interface EntityInfoResponse { /** * The friendly name of the management group. */ displayName?: string; /** * The fully qualified ID for the entity. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 */ id: string; /** * The users specific permissions to this item. */ inheritedPermissions?: string; /** * The name of the entity. For example, 00000000-0000-0000-0000-000000000000 */ name: string; /** * Number of children is the number of Groups that are exactly one level underneath the current Group. */ numberOfChildGroups?: number; /** * Number of children is the number of Groups and Subscriptions that are exactly one level underneath the current Group. */ numberOfChildren?: number; /** * Number of Descendants */ numberOfDescendants?: number; /** * (Optional) The ID of the parent management group. */ parent?: outputs.management.EntityParentGroupInfoResponse; /** * The parent display name chain from the root group to the immediate parent */ parentDisplayNameChain?: string[]; /** * The parent name chain from the root group to the immediate parent */ parentNameChain?: string[]; /** * The users specific permissions to this item. */ permissions?: string; /** * The AAD Tenant ID associated with the entity. For example, 00000000-0000-0000-0000-000000000000 */ tenantId?: string; /** * The type of the resource. For example, Microsoft.Management/managementGroups */ type: string; } /** * (Optional) The ID of the parent management group. */ interface EntityParentGroupInfoResponse { /** * The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 */ id?: string; } /** * The child information of a management group. */ interface ManagementGroupChildInfoResponse { /** * The list of children. */ children?: outputs.management.ManagementGroupChildInfoResponse[]; /** * The friendly name of the child resource. */ displayName?: string; /** * The fully qualified ID for the child resource (management group or subscription). For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 */ id?: string; /** * The name of the child entity. */ name?: string; /** * The fully qualified resource type which includes provider namespace (e.g. Microsoft.Management/managementGroups) */ type?: string; } /** * The details of a management group. */ interface ManagementGroupDetailsResponse { /** * The ancestors of the management group. */ managementGroupAncestors?: string[]; /** * The ancestors of the management group displayed in reversed order, from immediate parent to the root. */ managementGroupAncestorsChain?: outputs.management.ManagementGroupPathElementResponse[]; /** * (Optional) The ID of the parent management group. */ parent?: outputs.management.ParentGroupInfoResponse; /** * The path from the root to the current group. */ path?: outputs.management.ManagementGroupPathElementResponse[]; /** * The identity of the principal or process that updated the object. */ updatedBy?: string; /** * The date and time when this object was last updated. */ updatedTime?: string; /** * The version number of the object. */ version?: number; } /** * A path element of a management group ancestors. */ interface ManagementGroupPathElementResponse { /** * The friendly name of the group. */ displayName?: string; /** * The name of the group. */ name?: string; } /** * (Optional) The ID of the parent management group. */ interface ParentGroupInfoResponse { /** * The friendly name of the parent management group. */ displayName?: string; /** * The fully qualified ID for the parent management group. For example, /providers/Microsoft.Management/managementGroups/0000000-0000-0000-0000-000000000000 */ id?: string; /** * The name of the parent management group */ name?: string; } /** * The details of the parent serviceGroup. */ interface ParentServiceGroupPropertiesResponse { /** * The fully qualified ID of the parent serviceGroup. For example, '/providers/Microsoft.Management/serviceGroups/TestServiceGroup' */ resourceId?: string; } /** * ServiceGroup creation request body parameters. */ interface ServiceGroupPropertiesResponse { /** * The display name of the serviceGroup. For example, ServiceGroupTest1 */ displayName?: string; /** * The details of the parent serviceGroup. */ parent?: outputs.management.ParentServiceGroupPropertiesResponse; /** * The provisioning state of the serviceGroup. For example, Running */ provisioningState: string; } /** * The serviceGroup details. */ interface ServiceGroupResponse { /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The kind of the serviceGroup. */ kind?: string; /** * The name of the resource */ name: string; /** * ServiceGroup creation request body parameters. */ properties?: outputs.management.ServiceGroupPropertiesResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.management.SystemDataResponse; /** * The serviceGroup tags. */ tags?: { [key: string]: string; }; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace manufacturingplatform { /** * The properties related to Azure Data Explorer (Adx) Resource */ interface AdxProfileResponse { /** * Data Ingestion Uri of Adx Resource */ dataIngestionUri: string; /** * Resource Id of Adx Resource */ id: string; /** * Uri of Adx Resource */ uri: string; } /** * The properties related to Aks Resource */ interface AksProfileResponse { /** * Resource Id of AKS Resource */ id: string; } /** * Information about application versions */ interface ApplicationVersionResponse { /** * Is Deprecated */ isDeprecated: boolean; /** * Is Latest */ isLatest: boolean; /** * Is Preview */ isPreview: boolean; /** * Application Version */ version: string; } /** * The properties related to CMK */ interface CmkProfileResponse { /** * URI of Key in AKV */ keyUri: string; } /** * The properties related to Database Resource */ interface DatabaseProfileResponse { /** * Resource Id of Cosmos Resource */ cosmosId: string; } /** * The properties related to Deny Assignment Exclusions */ interface DenyAssignmentExclusionResponse { /** * Object Id of Identity */ id: string; /** * Type of Identity */ type: string; } /** * The properties related to EventHub Resource */ interface EventHubProfileResponse { /** * Resource Id of Adx Instance */ adxInstanceId: string; /** * Host Name */ hostName: string; } /** * The properties related to Fabric */ interface FabricProfileResponse { /** * Azure Key Vault Uri */ keyUri: string; /** * One Lake Path */ oneLakePath: string; /** * URI of One Lake */ oneLakeUri: string; } /** * The properties related to Azure Function App Resource */ interface FunctionAppProfileResponse { /** * Resource Id of Azure Function App Resource */ id: string; } /** * Configuration of the managed on behalf of resource. */ interface ManagedOnBehalfOfConfigurationResponse { /** * Associated MoboBrokerResources. */ moboBrokerResources: outputs.manufacturingplatform.MoboBrokerResourceResponse[]; } /** * Configuration of the managed resource group associated with the resource. */ interface ManagedResourceGroupConfigurationResponse { /** * The resource group location. */ location: string; /** * The resource group name. */ name: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.manufacturingplatform.UserAssignedIdentityResponse; }; } /** * Details of the ManufacturingPlatform MdsResource. */ interface MdsResourcePropertiesResponse { /** * AAD Application Id. */ aadApplicationId: string; /** * Profile of Adx Created. */ adxProfile: outputs.manufacturingplatform.AdxProfileResponse; /** * AKS Admin Group Id. */ aksAdminGroupId?: string; /** * Profile of AKS Created. */ aksProfile: outputs.manufacturingplatform.AksProfileResponse; /** * Profile of CMK Settings. */ cmkProfile?: outputs.manufacturingplatform.CmkProfileResponse; /** * Profile of Database Created. */ databaseProfile: outputs.manufacturingplatform.DatabaseProfileResponse; /** * Deny Assignments exclusion list. */ denyAssignmentExclusions?: outputs.manufacturingplatform.DenyAssignmentExclusionResponse[]; /** * Enable Copilot. */ enableCopilot?: boolean; /** * Enable Diagnostic Settings. */ enableDiagnosticSettings?: boolean; /** * Profile of EventHub Resource. */ eventHubProfile: outputs.manufacturingplatform.EventHubProfileResponse; /** * Profile of Fabric resources. */ fabricProfile?: outputs.manufacturingplatform.FabricProfileResponse; /** * Profile of Function App Resource. */ functionAppProfile: outputs.manufacturingplatform.FunctionAppProfileResponse; /** * Managed On Behalf Of Configuration. */ managedOnBehalfOfConfiguration: outputs.manufacturingplatform.ManagedOnBehalfOfConfigurationResponse; /** * Configuration of the managed resource group associated with the resource. */ managedResourceGroupConfiguration: outputs.manufacturingplatform.ManagedResourceGroupConfigurationResponse; /** * Profile of Monitoring Resource Created. */ monitoringProfile: outputs.manufacturingplatform.MonitoringProfileResponse; /** * Profile of OpenAI Resource. */ openAIProfile?: outputs.manufacturingplatform.OpenAIProfileResponse; /** * The status of the last operation. */ provisioningState: string; /** * Profile of Azure Redis Created. */ redisProfile: outputs.manufacturingplatform.RedisProfileResponse; /** * Zone redundancy state for resources */ redundancyState?: string; /** * State of the resource */ resourceState?: string; /** * Service Url */ serviceUrl: string; /** * Profile of Storage Created. */ storageProfile: outputs.manufacturingplatform.StorageProfileResponse; /** * Profile of User Managed OpenAI Resource. */ userManagedOpenAIProfile?: outputs.manufacturingplatform.UserManagedOpenAIProfileResponse; /** * Mds Resource Version. */ version?: string; } /** * mdsResourcePropertiesResponseProvideDefaults sets the appropriate defaults for MdsResourcePropertiesResponse */ function mdsResourcePropertiesResponseProvideDefaults(val: MdsResourcePropertiesResponse): MdsResourcePropertiesResponse; /** * MoboBroker resource. */ interface MoboBrokerResourceResponse { /** * Resource Id of MoboBrokerResource */ id: string; } /** * The properties related to Monitoring Resource */ interface MonitoringProfileResponse { /** * Resource Id of Application Insights Resource */ id: string; } /** * The properties related to OpenAI Resource */ interface OpenAIProfileResponse { /** * Embedding Model Capacity */ embeddingModelCapacity?: number; /** * Embedding Model Name */ embeddingModelName?: string; /** * Embedding Model SKU Name */ embeddingModelSkuName?: string; /** * Embedding Model Version */ embeddingModelVersion?: string; /** * GPT Model Capacity */ gptModelCapacity?: number; /** * GPT Model Name */ gptModelName?: string; /** * GPT Model SKU Name */ gptModelSkuName?: string; /** * GPT Model Version */ gptModelVersion?: string; /** * Resource Id of OpenAI Resource */ id: string; } /** * The properties related to Azure Redis Cache Resource */ interface RedisProfileResponse { /** * Resource Id of Azure Redis Cache Resource */ id: string; } /** * The resource model definition representing SKU */ interface SkuResponse { /** * If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. */ capacity?: number; /** * If the service has different generations of hardware, for the same SKU, then that can be captured here. */ family?: string; /** * The name of the SKU. E.g. P3. It is typically a letter+number code */ name: string; /** * The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. */ size?: string; /** * This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT. */ tier?: string; } /** * The properties related to Storage Resource */ interface StorageProfileResponse { /** * Resource Id of Storage Resource */ id: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * The properties related to User Managed OpenAI Resource */ interface UserManagedOpenAIProfileResponse { /** * Embedding Model Deployment Name */ embeddingModelDeploymentName: string; /** * Embedding Model Type */ embeddingModelType: string; /** * GPT Model Deployment Name */ gptModelDeploymentName: string; /** * Resource Id of OpenAI Resource */ id: string; } } export declare namespace maps { /** * Specifies a CORS rule for the Map Account. */ interface CorsRuleResponse { /** * Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains */ allowedOrigins: string[]; } /** * Sets the CORS rules. You can include up to five CorsRule elements in the request. */ interface CorsRulesResponse { /** * The list of CORS rules. You can include up to five CorsRule elements in the request. */ corsRules?: outputs.maps.CorsRuleResponse[]; } /** * Creator resource properties */ interface CreatorPropertiesResponse { /** * The consumed storage unit size in bytes for the creator resource. */ consumedStorageUnitSizeInBytes?: number; /** * The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled */ provisioningState: string; /** * The storage units to be allocated. Integer values from 1 to 100, inclusive. */ storageUnits: number; /** * The total allocated storage unit size in bytes for the creator resource. */ totalStorageUnitSizeInBytes?: number; } /** * All encryption configuration for a resource. */ interface EncryptionResponse { /** * All Customer-managed key encryption properties for the resource. */ customerManagedKeyEncryption?: outputs.maps.EncryptionResponseCustomerManagedKeyEncryption; /** * (Optional) Discouraged to include in resource definition. Only needed where it is possible to disable platform (AKA infrastructure) encryption. Azure SQL TDE is an example of this. Values are enabled and disabled. */ infrastructureEncryption?: string; } /** * All Customer-managed key encryption properties for the resource. */ interface EncryptionResponseCustomerManagedKeyEncryption { /** * All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. */ keyEncryptionKeyIdentity?: outputs.maps.EncryptionResponseKeyEncryptionKeyIdentity; /** * key encryption key Url, versioned or unversioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. */ keyEncryptionKeyUrl?: string; } /** * All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. */ interface EncryptionResponseKeyEncryptionKeyIdentity { /** * delegated identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity and userAssignedIdentity - internal use only. */ delegatedIdentityClientId?: string; /** * application client identity to use for accessing key encryption key Url in a different tenant. Ex: f83c6b1b-4d34-47e4-bb34-9d83df58b540 */ federatedClientId?: string; /** * The type of identity to use. Values can be systemAssignedIdentity, userAssignedIdentity, or delegatedResourceIdentity. */ identityType?: string; /** * User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity. */ userAssignedIdentityResourceId?: string; } /** * Linked resource is reference to a resource deployed in an Azure subscription, add the linked resource `uniqueName` value as an optional parameter for operations on Azure Maps Geospatial REST APIs. */ interface LinkedResourceResponse { /** * ARM resource id in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/accounts/{storageName}'. */ id: string; /** * A provided name which uniquely identifies the linked resource. */ uniqueName: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.maps.UserAssignedIdentityResponse; }; } /** * Additional Maps account properties */ interface MapsAccountPropertiesResponse { /** * Specifies CORS rules for the Blob service. You can include up to five CorsRule elements in the request. If no CorsRule elements are included in the request body, all CORS rules will be deleted, and CORS will be disabled for the Blob service. */ cors?: outputs.maps.CorsRulesResponse; /** * Allows toggle functionality on Azure Policy to disable Azure Maps local authentication support. This will disable Shared Keys and Shared Access Signature Token authentication from any usage. */ disableLocalAuth?: boolean; /** * All encryption configuration for a resource. */ encryption?: outputs.maps.EncryptionResponse; /** * The array of associated resources to the Maps account. Linked resource in the array cannot individually update, you must update all linked resources in the array together. These resources may be used on operations on the Azure Maps REST API. Access is controlled by the Maps Account Managed Identity(s) permissions to those resource(s). */ linkedResources?: outputs.maps.LinkedResourceResponse[]; /** * List of additional data processing regions for the Maps Account, which may result in requests being processed in another geography. Some features or results may be restricted to specific regions. By default, Maps REST APIs process requests according to the account location or the [geographic scope](https://learn.microsoft.com/azure/azure-maps/geographic-scope). */ locations?: outputs.maps.MapsAccountPropertiesResponseLocations[]; /** * The provisioning state of the Maps account resource, Account updates can only be performed on terminal states. Terminal states: `Succeeded` and `Failed` */ provisioningState: string; /** * A unique identifier for the Maps Account */ uniqueId: string; } /** * mapsAccountPropertiesResponseProvideDefaults sets the appropriate defaults for MapsAccountPropertiesResponse */ function mapsAccountPropertiesResponseProvideDefaults(val: MapsAccountPropertiesResponse): MapsAccountPropertiesResponse; /** * Data processing location. */ interface MapsAccountPropertiesResponseLocations { /** * The location name. */ locationName: string; } /** * Private Atlas resource properties */ interface PrivateAtlasPropertiesResponse { /** * The state of the resource provisioning, terminal states: Succeeded, Failed, Canceled */ provisioningState?: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * The SKU of the Maps Account. */ interface SkuResponse { /** * The name of the SKU, in standard format (such as G2). */ name: string; /** * Gets the sku tier. This is based on the SKU name. */ tier: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace marketplace { /** * New plans notification details */ interface NewNotificationsResponse { /** * Gets offer display name */ displayName?: string; /** * Gets or sets the icon url */ icon?: string; /** * Gets a value indicating whether future plans is enabled. */ isFuturePlansEnabled?: boolean; /** * Gets or sets the notification message id */ messageCode?: number; /** * Gets offer id */ offerId?: string; /** * Gets or sets removed plans notifications */ plans?: outputs.marketplace.PlanNotificationDetailsResponse[]; } /** * Plan notification details */ interface PlanNotificationDetailsResponse { /** * Gets or sets the plan display name */ planDisplayName?: string; /** * Gets or sets the plan id */ planId?: string; } interface PlanResponse { /** * Plan accessibility */ accessibility?: string; /** * Alternative stack type */ altStackReference: string; /** * Friendly name for the plan for display in the marketplace */ planDisplayName: string; /** * Text identifier for this plan */ planId: string; /** * Identifier for this plan */ skuId: string; /** * Stack type (classic or arm) */ stackType: string; } interface ProductResponse { description?: string; displayName?: string; pricingTypes?: string[]; productType?: string; publisherDisplayName?: string; ratingAverage?: number; smallIconUri?: string; storeFronts?: string[]; summary?: string; uniqueProductId?: string; } interface RuleResponse { /** * Rule type */ type?: string; value?: string[]; } /** * List of stop sell offers and plans notifications. */ interface StopSellOffersPlansNotificationsListPropertiesResponse { /** * The offer display name */ displayName: string; /** * The icon url */ icon: string; /** * A value indicating whether entire offer is in stop sell or only few of its plans */ isEntire: boolean; /** * The notification message code */ messageCode: number; /** * The offer id */ offerId: string; /** * The list of removed plans notifications */ plans: outputs.marketplace.PlanNotificationDetailsResponse[]; /** * True if the offer has public plans */ publicContext: boolean; /** * The subscriptions related to private plans */ subscriptionsIds: string[]; } /** * Read only system data */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC) */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource */ lastModifiedByType?: string; } } export declare namespace migrate { /** * Class for ACR Properties. */ interface ACRPropertiesResponse { /** * Gets or sets the azure container registry name. */ registryName?: string; /** * Gets or sets the resource group of the resource. */ resourceGroup?: string; /** * Gets or sets the subscription id of the resource. */ subscriptionId?: string; /** * Gets or sets the tenant id. */ tenantId?: string; } /** * Data model of AKS Assessment Details. */ interface AKSAssessmentDetailsResponse { /** * Gets Confidence score. */ confidenceRatingInPercentage: number; /** * Gets date and time when assessment was created. */ createdTimestamp: string; /** * Gets the number of machines. */ machineCount: number; /** * Gets last time when rates were queried. */ pricesTimestamp: string; /** * Gets assessment status. */ status: string; /** * Gets the total monthly cost. */ totalMonthlyCost: number; /** * Gets date and time when assessment was last updated. */ updatedTimestamp: string; /** * Gets the number of web apps. */ webAppCount: number; /** * Gets the number of web servers. */ webServerCount: number; } /** * Data model of AKS Assessment Settings. */ interface AKSAssessmentSettingsResponse { /** * Gets or sets azure location. */ azureLocation: string; /** * Gets or sets azure VM category. */ category: string; /** * Gets or sets consolidation type. */ consolidation: string; /** * Gets or sets currency. */ currency: string; /** * Gets or sets discount percentage. */ discountPercentage?: number; /** * Gets or sets environment type. */ environmentType: string; /** * Gets or sets licensing program. */ licensingProgram: string; /** * Gets or sets performance data settings. */ performanceData?: outputs.migrate.PerfDataSettingsResponse; /** * Gets or sets pricing tier. */ pricingTier: string; /** * Gets or sets savings options. */ savingsOptions: string; /** * Gets or sets scaling factor. */ scalingFactor?: number; /** * Gets or sets sizing criteria. */ sizingCriteria: string; } /** * Class for AKSDeployment Properties. */ interface AKSDeploymentPropertiesResponse { /** * Gets or sets the AKS cluster name. */ aksClusterName?: string; /** * Gets or sets the resource group of the resource. */ resourceGroup?: string; /** * Gets or sets the subscription id of the resource. */ subscriptionId?: string; /** * Gets or sets the tenant id. */ tenantId?: string; } /** * AKS Deployment Specification. */ interface AKSDeploymentSpecificationResponse { /** * Gets or sets the Merged Deployment and service Yaml. */ kubernetesObjectsYaml?: string; /** * Gets or sets the load balancer type. */ loadBalancerType?: string; /** * Gets or sets the replica count to be created in AKS. */ replicaCount?: string; } /** * ApacheTomcat workload instance model custom properties. */ interface ApacheTomcatAKSWorkloadDeploymentModelCustomPropertiesResponse { /** * ApacheTomcat web application. */ apacheTomcatAksWorkloadDeploymentProperties?: outputs.migrate.ApacheTomcatAKSWorkloadDeploymentResponse; /** * Gets or sets the instance type. * Expected value is 'ApacheTomcatAKSWorkloadDeploymentModelCustomProperties'. */ instanceType: "ApacheTomcatAKSWorkloadDeploymentModelCustomProperties"; } /** * ApacheTomcat web application. */ interface ApacheTomcatAKSWorkloadDeploymentResponse { /** * Class for automation artifact. */ automationArtifactProperties?: outputs.migrate.AutomationArtifactResponse; /** * Gets or sets the bindings for the application. */ bindings?: outputs.migrate.BindingResponse[]; /** * Gets or sets the build container images. */ buildContainerImages?: outputs.migrate.ContainerImagePropertiesResponse[]; /** * Class for AKSDeployment Properties. */ clusterProperties?: outputs.migrate.AKSDeploymentPropertiesResponse; /** * Gets or sets application configuration. */ configurations?: outputs.migrate.WebApplicationConfigurationResponse[]; /** * Class for container image properties. */ containerImageProperties?: outputs.migrate.ContainerImagePropertiesResponse; /** * Gets or sets the deployment history. */ deploymentHistory: outputs.migrate.DeployedResourcesPropertiesResponse[]; /** * Gets or sets the deployment name prefix. */ deploymentNamePrefix?: string; /** * AKS Deployment Specification. */ deploymentSpec?: outputs.migrate.AKSDeploymentSpecificationResponse; /** * Gets or sets application directories. */ directories?: outputs.migrate.WebApplicationDirectoryResponse[]; /** * Resource Requirements. */ limits?: outputs.migrate.ResourceRequirementsResponse; /** * Class for app insight monitoring properties. */ monitoringProperties?: outputs.migrate.AppInsightMonitoringPropertiesResponse; /** * Resource Requirements. */ requests?: outputs.migrate.ResourceRequirementsResponse; /** * Gets or sets the target platform managed identity. */ targetPlatformIdentity?: string; } /** * ApacheTomcat web application. */ interface ApacheTomcatWebApplicationResponse { /** * Gets or sets the web application id. */ applicationId?: string; /** * Gets or sets the web application name. */ applicationName?: string; /** * Gets or sets application scratch path. */ applicationScratchPath?: string; /** * Gets or sets the bindings for the application. */ bindings?: outputs.migrate.BindingResponse[]; /** * Gets or sets application configuration. */ configurations?: outputs.migrate.WebApplicationConfigurationResponse[]; /** * Gets or sets application directories. */ directories?: outputs.migrate.WebApplicationDirectoryResponse[]; /** * Gets or sets the discovered frameworks of application. */ discoveredFrameworks?: outputs.migrate.WebApplicationFrameworkResponse[]; /** * Gets or sets the display name. */ displayName?: string; /** * Resource Requirements. */ limits?: outputs.migrate.ResourceRequirementsResponse; /** * Second level entity for virtual directories. */ path?: outputs.migrate.DirectoryPathResponse; /** * Framework specific data for a web application. */ primaryFramework?: outputs.migrate.WebApplicationFrameworkResponse; /** * Resource Requirements. */ requests?: outputs.migrate.ResourceRequirementsResponse; /** * Gets or sets the web server id. */ webServerId?: string; /** * Gets or sets the web server name. */ webServerName?: string; } /** * ApacheTomcat workload instance model custom properties. */ interface ApacheTomcatWorkloadInstanceModelCustomPropertiesResponse { /** * ApacheTomcat web application. */ apacheTomcatWebApplication?: outputs.migrate.ApacheTomcatWebApplicationResponse; /** * Gets or sets the instance type. * Expected value is 'ApacheTomcatWorkloadInstanceModelCustomProperties'. */ instanceType: "ApacheTomcatWorkloadInstanceModelCustomProperties"; /** * Gets or sets the Web application ARM id. */ webAppArmId?: string; /** * Gets or sets the Web application site name. */ webAppSiteName?: string; } /** * Class for app insight monitoring properties. */ interface AppInsightMonitoringPropertiesResponse { /** * Gets or sets the app insights name. */ appInsightsName?: string; /** * Gets or sets a value indicating whether monitoring is enabled. */ isEnabled?: boolean; /** * Gets or sets the region. */ region?: string; /** * Gets or sets the resource group of the resource. */ resourceGroup?: string; secretStoreDetails?: outputs.migrate.SecretStoreDetailsResponse; /** * Gets or sets the subscription id of the resource. */ subscriptionId?: string; } /** * App service container settings. */ interface AppSvcContainerSettingsResponse { /** * Gets or sets the isolation required. */ isolationRequired: boolean; } /** * App service native settings. */ interface AppSvcNativeSettingsResponse { /** * Gets or sets the isolation required. */ isolationRequired: boolean; } /** * ARG query and other details to create workloads within a wave. */ interface ArgResponse { /** * The query to create workloads within the wave. */ query: string; } /** * Assessment details class. */ interface AssessmentDetailsResponse { /** * Confidence Rating in Percentage. */ confidenceRatingInPercentage: number; /** * Date and Time when assessment was created. */ createdTimestamp: string; /** * Last time when rates were queried. */ pricesTimestamp: string; /** * Whether assessment is in valid state and all machines have been assessed. */ status: string; /** * Date and Time when assessment was last updated. */ updatedTimestamp: string; } /** * Properties of an assessment. */ interface AssessmentPropertiesResponse { /** * Storage type selected for this disk. */ azureDiskType: string; /** * AHUB discount on windows virtual machines. */ azureHybridUseBenefit: string; /** * Target Azure location for which the machines should be assessed. These enums are the same as used by Compute API. */ azureLocation: string; /** * Offer code according to which cost estimation is done. */ azureOfferCode: string; /** * Pricing tier for Size evaluation. */ azurePricingTier: string; /** * Storage Redundancy type offered by Azure. */ azureStorageRedundancy: string; /** * List of azure VM families. */ azureVmFamilies: string[]; /** * Confidence rating percentage for assessment. Can be in the range [0, 100]. */ confidenceRatingInPercentage: number; /** * Time when this project was created. Date-Time represented in ISO-8601 format. */ createdTimestamp: string; /** * Currency to report prices in. */ currency: string; /** * Custom discount percentage to be applied on final costs. Can be in the range [0, 100]. */ discountPercentage: number; /** * Enterprise agreement subscription arm id. */ eaSubscriptionId: string; /** * Monthly network cost estimate for the machines that are part of this assessment as a group, for a 31-day month. */ monthlyBandwidthCost: number; /** * Monthly compute cost estimate for the machines that are part of this assessment as a group, for a 31-day month. */ monthlyComputeCost: number; /** * Monthly premium storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month. */ monthlyPremiumStorageCost: number; /** * Monthly standard SSD storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month. */ monthlyStandardSSDStorageCost: number; /** * Monthly storage cost estimate for the machines that are part of this assessment as a group, for a 31-day month. */ monthlyStorageCost: number; /** * Number of assessed machines part of this assessment. */ numberOfMachines: number; /** * Percentile of performance data used to recommend Azure size. */ percentile: string; /** * End time to consider performance data for assessment */ perfDataEndTime: string; /** * Start time to consider performance data for assessment */ perfDataStartTime: string; /** * Time when the Azure Prices were queried. Date-Time represented in ISO-8601 format. */ pricesTimestamp: string; /** * Azure reserved instance. */ reservedInstance: string; /** * Scaling factor used over utilization data to add a performance buffer for new machines to be created in Azure. Min Value = 1.0, Max value = 1.9, Default = 1.3. */ scalingFactor: number; /** * Assessment sizing criterion. */ sizingCriterion: string; /** * User configurable setting that describes the status of the assessment. */ stage: string; /** * Whether the assessment has been created and is valid. */ status: string; /** * Time range of performance data used to recommend a size. */ timeRange: string; /** * Time when this project was last updated. Date-Time represented in ISO-8601 format. */ updatedTimestamp: string; /** * Specify the duration for which the VMs are up in the on-premises environment. */ vmUptime: outputs.migrate.VmUptimeResponse; } /** * Data model of Assessment Scope Parameters. */ interface AssessmentScopeParametersResponse { /** * Gets or sets the server group id. */ serverGroupId?: string; } /** * Defines the properties for automatic resolution. */ interface AutomaticResolutionPropertiesResponse { /** * Gets the MoveResource ARM ID of * the dependent resource if the resolution type is Automatic. */ moveResourceId?: string; } /** * Class for automation artifact. */ interface AutomationArtifactResponse { /** * Gets or sets the artifacts. */ artifacts?: { [key: string]: string; }; /** * Azure file share profile for hydration of application folders not mounted on * the container file system. */ azureFileShareProfile?: outputs.migrate.AzureFileShareHydrationProfileResponse; /** * Gets or sets the status of automation artifacts. */ status?: string; } /** * Gets or sets the availability set resource settings. */ interface AvailabilitySetResourceSettingsResponse { /** * Gets or sets the target fault domain. */ faultDomain?: number; /** * The resource type. For example, the value can be Microsoft.Compute/virtualMachines. * Expected value is 'Microsoft.Compute/availabilitySets'. */ resourceType: "Microsoft.Compute/availabilitySets"; /** * Gets or sets the Resource tags. */ tags?: { [key: string]: string; }; /** * Gets or sets the target resource group name. */ targetResourceGroupName?: string; /** * Gets or sets the target Resource name. */ targetResourceName?: string; /** * Gets or sets the target update domain. */ updateDomain?: number; } /** * Assessment properties class. */ interface AvsAssessmentPropertiesV2Response { /** * Gets or sets the details of the assessment. */ details?: outputs.migrate.AssessmentDetailsResponse; /** * Gets or sets the machine assessment ARM ID for VM fallback. */ fallbackMachineAssessmentArmId?: string; /** * The status of the last operation. */ provisioningState: string; /** * Gets or sets the scope of assessment. */ scope?: outputs.migrate.ScopeResponse; /** * Gets or sets the settings for the assessment. */ settings?: outputs.migrate.AvsAssessmentSettingsResponse; } /** * Properties of the AVS assessment. */ interface AvsAssessmentSettingsResponse { /** * AVS Assessment Scenario. */ avsAssessmentScenario?: string; /** * Azure Location or Azure region where to which the machines will be migrated. */ azureLocation?: string; /** * Gets or sets the billing settings. */ billingSettings?: outputs.migrate.BillingSettingsResponse; /** * Gets or sets the CPU headroom. */ cpuHeadroom?: number; /** * Currency in which prices should be reported. */ currency?: string; /** * De-duplication compression. */ dedupeCompression?: number; /** * Custom discount percentage. */ discountPercentage?: number; /** * Gets or sets user configurable setting to display the environment type. */ environmentType?: string; /** * List of AVS external storage types. */ externalStorageTypes?: string[]; /** * List of Failures to tolerate and RAID levels in a common property. */ failuresToTolerateAndRaidLevelList?: string[]; /** * Is Stretch Cluster Enabled. */ isStretchClusterEnabled?: boolean; /** * Is VCF license applied */ isVcfByolEnabled?: boolean; /** * Memory overcommit. */ memOvercommit?: number; /** * AVS node types. */ nodeTypes?: string[]; /** * Gets or sets the performance data. */ performanceData?: outputs.migrate.PerformanceDataResponse; /** * Gets or sets the savings settings. */ savingsSettings?: outputs.migrate.SavingsSettingsResponse; /** * Percentage of buffer that user wants on performance metrics when recommending * Azure sizes. */ scalingFactor?: number; /** * Assessment sizing criterion. */ sizingCriterion?: string; /** * VCPU over subscription. */ vcpuOversubscription?: number; } /** * Details on the Estimated External Storage for AVS Assessment. */ interface AvsEstimatedExternalStorageResponse { /** * Total monthly cost for type of storage. */ monthlyPrice?: number; /** * Recommended External Storage. */ storageType?: string; /** * Predicted storage utilization. */ storageUtilization?: number; /** * Predicted total Storage used in GB. */ totalStorageInGB?: number; } /** * Details on the Estimated Network Costs for AVS Assessment. */ interface AvsEstimatedNetworkResponse { /** * Monthly cost for network type. */ monthlyPrice?: number; /** * Recommended Network Sku. */ networkType?: string; } /** * Details on the Estimated nodes for AVS Assessment. */ interface AvsEstimatedNodeResponse { /** * Predicted CPU utilization. */ cpuUtilization?: number; /** * FttRaidLevel recommended for Node. */ fttRaidLevel?: string; /** * Total monthly cost for type and number of nodes. */ monthlyPrice?: number; /** * Number of nodes that will be needed. */ nodeNumber?: number; /** * Recommended SKU. */ nodeType?: string; /** * Pricing model indicates what hour multiplier to use while estimating the Nodes cost. */ pricingModel?: string; /** * Predicted RAM utilization. */ ramUtilization?: number; /** * Predicted storage utilization. */ storageUtilization?: number; /** * Predicted total CPU cores across the set of nodes. */ totalCpu?: number; /** * Predicted total RAM used in GB. */ totalRam?: number; /** * Predicted total Storage used in GB. */ totalStorage?: number; } /** * Azure Arc Management settings. */ interface AzureArcManagementSettingsResponse { /** * Gets the azure arc monitoring settings. */ monitoringSettings: outputs.migrate.AzureArcMonitoringSettingsResponse; } /** * Azure Arc Monitoring settings. */ interface AzureArcMonitoringSettingsResponse { /** * Number of alert rules settings. */ alertRulesCount: number; /** * Logs volume settings. */ logsVolumeInGB: number; } /** * Azure arc settings for a business case. */ interface AzureArcSettingsResponse { /** * AzureArc state indicates whether to include azure arc related costs in on-premises or not. */ azureArcState: string; /** * Gets Azure arc labour cost percentage. */ laborCostPercentage?: number; /** * Management settings. */ managementSettings?: outputs.migrate.AzureArcManagementSettingsResponse; } /** * Azure file share profile for hydration of application folders not mounted on * the container file system. */ interface AzureFileShareHydrationProfileResponse { /** * Gets or sets the cloud directory path of the directory on azure file share. */ azureFileShareDirPath?: string; /** * Gets or sets the name of the azure file share. */ azureFileShareName?: string; /** * Gets or sets the name of the azure file share resource group. */ azureFileShareResourceGroup?: string; /** * Gets or sets the name of the azure file share storage account. */ azureFileShareStorageAccount?: string; /** * Gets or sets the subscription id of the azure file share. */ azureFileShareSubscriptionId?: string; } /** * Azure settings for a business case. */ interface AzureSettingsResponse { /** * Gets Avs labour cost percentage. */ avsLaborCostPercentage?: number; /** * Migration Strategy. */ businessCaseType?: string; /** * Gets comfort factor. */ comfortFactor?: number; /** * Business case Currency. */ currency: string; /** * Gets azure Discount percentage. */ discountPercentage?: number; /** * Gets IaaS labour cost percentage. */ iaasLaborCostPercentage?: number; /** * Gets infrastructure growth rate. */ infrastructureGrowthRate?: number; /** * Gets network cost percentage. */ networkCostPercentage?: number; /** * Gets PaaS labour cost percentage. */ paasLaborCostPercentage?: number; /** * Gets migration completion percentage per year. */ perYearMigrationCompletionPercentage?: { [key: string]: number; }; /** * Gets end time to use for performance. */ performanceDataEndTime?: string; /** * Gets start time to use for performance. */ performanceDataStartTime?: string; /** * Gets utilization percentile for performance. */ performanceUtilizationPercentile?: number; /** * Gets the business case savings option type. */ savingsOption?: string; /** * Gets or sets azure location. */ targetLocation: string; /** * Gets wACC percentage. */ wacc?: number; /** * Workload discovery source. */ workloadDiscoverySource?: string; } /** * azureSettingsResponseProvideDefaults sets the appropriate defaults for AzureSettingsResponse */ function azureSettingsResponseProvideDefaults(val: AzureSettingsResponse): AzureSettingsResponse; /** * Billing settings class. */ interface BillingSettingsResponse { /** * Gets or sets the licensing program. */ licensingProgram?: string; /** * Gets or sets the subscription ID for licensing program selected. */ subscriptionId?: string; } /** * Binding for a web application. */ interface BindingResponse { /** * WebApplication certificate. */ cert?: outputs.migrate.CertResponse; /** * Gets or sets the binding host name. */ hostName?: string; /** * Gets the ID. */ id: string; /** * Gets or sets the IP Address. */ ipAddress?: string; /** * Gets or sets the application port. */ port?: string; /** * WebApplication port mapping. */ portMapping?: outputs.migrate.PortMappingResponse; /** * Gets or sets the protocol. */ protocol?: string; } /** * WebApplication certificate. */ interface CertResponse { /** * Gets or sets the Certificate data. */ certData?: string; /** * Gets or sets a value indicating whether certificate is needed or not. */ certNeeded?: boolean; /** * Gets or sets a value indicating whether certificate is provided or not. */ certProvided?: boolean; /** * Gets or sets the type of secret store for the certificate. */ secretStore?: string; } /** * Collector agent property class. */ interface CollectorAgentPropertiesBaseResponse { /** * Gets the collector agent id. */ id?: string; /** * Gets the collector last heartbeat time. */ lastHeartbeatUtc?: string; /** * Gets or sets the SPN details. */ spnDetails?: outputs.migrate.CollectorAgentSpnPropertiesBaseResponse; /** * Gets the collector agent version. */ version?: string; } interface CollectorAgentPropertiesResponse { id: string; lastHeartbeatUtc: string; spnDetails?: outputs.migrate.CollectorBodyAgentSpnPropertiesResponse; version: string; } /** * Collector agent SPN details class. */ interface CollectorAgentSpnPropertiesBaseResponse { /** * Gets the AAD application id. */ applicationId?: string; /** * Gets the AAD audience url. */ audience?: string; /** * Gets the AAD authority endpoint. */ authority?: string; /** * Gets the object id of the AAD application. */ objectId?: string; /** * Gets the tenant id of the AAD application. */ tenantId?: string; } interface CollectorBodyAgentSpnPropertiesResponse { /** * Application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. */ applicationId?: string; /** * Intended audience for the service principal. */ audience?: string; /** * AAD Authority URL which was used to request the token for the service principal. */ authority?: string; /** * Object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. */ objectId?: string; /** * Tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. */ tenantId?: string; } interface CollectorPropertiesResponse { agentProperties?: outputs.migrate.CollectorAgentPropertiesResponse; /** * Time when this collector was created. Date-Time represented in ISO-8601 format. */ createdTimestamp: string; /** * The ARM id of the discovery service site. */ discoverySiteId?: string; /** * Time when this collector was updated. Date-Time represented in ISO-8601 format. */ updatedTimestamp: string; } /** * Details of the compound assessment. */ interface CompoundAssessmentDetailsResponse { /** * Timestamp when the assessment was created. */ createdTimestamp?: string; /** * Status of the assessment. */ status: string; /** * Timestamp when the assessment was last updated. */ updatedTimestamp?: string; } /** * Properties of a compound assessment. */ interface CompoundAssessmentPropertiesResponse { /** * Details of the compound assessment. */ details: outputs.migrate.CompoundAssessmentDetailsResponse; /** * Fallback machine assessment ARM ID. */ fallbackMachineAssessmentArmId?: string; /** * The status of the last operation. */ provisioningState: string; /** * ARM IDs of the target assessments. */ targetAssessmentArmIds: outputs.migrate.TargetAssessmentArmIdsResponse; } /** * Compute settings. */ interface ComputeSettingsResponse { /** * Hyperthread core to memory ratio. */ hyperthreadCoreToMemoryRatio: number; /** * Compute Price. */ price: number; /** * Linux Rhel Server licensing settings. */ rhelLinuxServerLicensing: outputs.migrate.LinuxServerLicensingSettingsResponse; /** * SQL Server licensing settings. */ sqlServerLicensing: outputs.migrate.SqlServerLicensingSettingsResponse[]; /** * Linux Suse Server licensing settings. */ suseLinuxServerLicensing: outputs.migrate.LinuxServerLicensingSettingsResponse; /** * Virtualization software settings. */ virtualizationSoftwareSettings: outputs.migrate.VirtualizationSoftwareSettingsResponse; /** * Windows Server licensing settings. */ windowsServerLicensing: outputs.migrate.WindowsServerLicensingSettingsResponse; } /** * Class for container image properties. */ interface ContainerImagePropertiesResponse { /** * Gets or sets the dockerfile for the container image. */ dockerfile?: string; /** * Gets the ID. */ id: string; /** * Gets or sets the container image name. */ imageName?: string; /** * Gets or sets the container image tag. */ imageTag?: string; /** * Class for ACR Properties. */ registryProperties?: outputs.migrate.ACRPropertiesResponse; /** * Gets or sets the RunId. */ runId?: string; /** * Gets or sets the RunStatus. */ runStatus?: string; } /** * Class to represent the component of the cost. */ interface CostComponentResponse { /** * The textual description of the component. */ description?: string; /** * Gets the name of the component. */ name: string; /** * The value of the component. */ value?: number; } /** * The database project summary class. */ interface DatabaseProjectSummaryResponse { /** * Gets or sets the extended summary. */ extendedSummary?: { [key: string]: string; }; /** * Gets the Instance type. * Expected value is 'Databases'. */ instanceType: "Databases"; /** * Gets or sets the time when summary was last refreshed. */ lastSummaryRefreshedTime?: string; /** * Gets or sets the state of refresh summary. */ refreshSummaryState?: string; } /** * Class representing the databases solution summary. */ interface DatabasesSolutionSummaryResponse { /** * Gets or sets the count of database instances assessed. */ databaseInstancesAssessedCount?: number; /** * Gets or sets the count of databases assessed. */ databasesAssessedCount?: number; /** * Gets the Instance type. * Expected value is 'Databases'. */ instanceType: "Databases"; /** * Gets or sets the count of databases ready for migration. */ migrationReadyCount?: number; } /** * Class for deployed resource properties. */ interface DeployedResourcesPropertiesResponse { /** * Gets or sets the context of deployed resources. */ context: string; /** * Gets or sets the deployed resource id. */ deployedResourceId: string; /** * Gets or sets the deployment timestamp. */ deploymentTimestamp: string; /** * Gets or sets the name of deployed resources. */ displayName: string; /** * Gets or sets the ID. */ id: string; /** * Gets or sets a value indicating whether resources are cleaned up from target. */ isCleanUpDone: boolean; /** * Gets or sets a value indicating whether scenario is test migration. */ isTestMigration: boolean; /** * Gets or sets the status of deployed resources. */ status: string; /** * Gets or sets the type of deployed resources. */ type: string; } /** * Second level entity for virtual directories. */ interface DirectoryPathResponse { /** * Gets the ID. */ id: string; /** * Gets or sets the physical path of the directory on the web server. */ physical?: string; /** * Gets or sets the virtual path for the directory. */ virtual?: string; } /** * Discovered entity light summary. */ interface DiscoveredEntityLightSummaryResponse { /** * Gets or sets the number of machines. */ numberOfMachines: number; /** * Gets or sets the number of servers. */ numberOfServers: number; /** * Gets or sets the number of web apps. */ numberOfWebApps: number; } /** * Defines the disk encryption set resource settings. */ interface DiskEncryptionSetResourceSettingsResponse { /** * The resource type. For example, the value can be Microsoft.Compute/virtualMachines. * Expected value is 'Microsoft.Compute/diskEncryptionSets'. */ resourceType: "Microsoft.Compute/diskEncryptionSets"; /** * Gets or sets the target resource group name. */ targetResourceGroupName?: string; /** * Gets or sets the target Resource name. */ targetResourceName?: string; } /** * Entity Uptime. */ interface EntityUptimeResponse { /** * Gets the days per month. */ daysPerMonth?: number; /** * Gets the hours per day. */ hoursPerDay?: number; } /** * Facility settings. */ interface FacilitySettingsResponse { /** * The facilities cost. */ facilitiesCostPerKwh?: number; } /** * Class for GMSA authentication details to configure Active Directory connectivity. */ interface GmsaAuthenticationPropertiesResponse { /** * Gets or sets the list of dns server that can resolve the Active Directory Domain Name/Address. */ adDomainControllerDns?: string; /** * Gets or sets the FQDN of the Active Directory Domain. For e.g. 'contoso.local', 'fareast.corp.microsoft.com' etc. */ adDomainFqdn?: string; akvProperties?: outputs.migrate.KeyVaultSecretStorePropertiesResponse; /** * Gets or sets the current state of GMSA configuration. */ configurationState: string; /** * Gets or sets the password of the user specified by RestApi.Controllers.V2022_05_01_preview.Models.WorkloadDeployment.Gmsa.GmsaAuthenticationProperties.DomainAdminUsername. */ domainAdminPassword?: string; /** * Gets or sets the name of the user having admin rights on the Active Directory Domain Controller. */ domainAdminUsername?: string; /** * Gets or sets the address of the Active Directory Domain Controller running Domain Services. */ domainControllerAddress?: string; /** * Gets or sets the name to be used for GMSA. */ gmsaAccountName?: string; /** * Gets Cred Spec Name to be used. */ gmsaCredSpecName: string; /** * Gets name of the secret where GMSA secret is stored in the KeyVault. */ gmsaSecretName: string; /** * Gets or sets the password of the user specified by RestApi.Controllers.V2022_05_01_preview.Models.WorkloadDeployment.Gmsa.GmsaAuthenticationProperties.GmsaUsername. */ gmsaUserPassword?: string; /** * Gets or sets username of the user having authorization to access GMSA on Active Directory. */ gmsaUsername?: string; } /** * Properties of group resource. */ interface GroupPropertiesResponse { /** * If the assessments are in running state. */ areAssessmentsRunning: boolean; /** * List of References to Assessments created on this group. */ assessments: string[]; /** * Time when this group was created. Date-Time represented in ISO-8601 format. */ createdTimestamp: string; /** * Whether the group has been created and is valid. */ groupStatus: string; /** * The type of group. */ groupType?: string; /** * Number of machines part of this group. */ machineCount: number; /** * Time when this group was last updated. Date-Time represented in ISO-8601 format. */ updatedTimestamp: string; } /** * Health error model. */ interface HealthErrorModelResponse { /** * Gets or sets the list of affected resource correlation Ids. This can be used to * uniquely identify the count of items affected by a specific category and severity * as well as count of item affected by an specific issue. */ affectedResourceCorrelationIds?: string[]; /** * Gets or sets the type of affected resource type. */ affectedResourceType?: string; /** * Gets or sets the error category. */ category: string; /** * Gets or sets possible causes of the error. */ causes: string; /** * Gets or sets a list of child health errors associated with this error. */ childErrors?: outputs.migrate.InnerHealthErrorModelResponse[]; /** * Gets or sets the error code. */ code: string; /** * Gets or sets the error creation time. */ creationTime: string; /** * Gets or sets the health category. */ healthCategory: string; /** * Gets the ID. */ id: string; /** * Gets or sets a value indicating whether the error is customer resolvable. */ isCustomerResolvable: boolean; /** * Gets or sets the error message. */ message: string; /** * Gets or sets recommended action to resolve the error. */ recommendation: string; /** * Gets or sets the error severity. */ severity: string; /** * Gets or sets the error source. */ source: string; /** * Gets or sets the error summary. */ summary: string; } /** * Properties of an assessment. */ interface HeterogeneousAssessmentPropertiesResponse { /** * Arm id of partner assessments. */ assessmentArmIds?: string[]; /** * Azure location for assessment. */ azureLocation: string; /** * Confidence rating in percentage. */ confidenceRatingInPercentage: number; /** * Timestamp for the last successfully calculated summary for the assessment. */ lastCalculatedOn: string; /** * The status of the last operation. */ provisioningState: string; /** * Schema version. */ schemaVersion: string; /** * Sizing criterion for assessment. */ sizingCriterion: string; /** * Whether assessment is in valid state and all machines have been assessed. */ status: string; } /** * Representation of a licence. */ interface HypervLicenseResponse { /** * Cost of a licence. */ licenseCost: number; /** * HyperV licence type. */ licenseType: string; } /** * HyperV Virtualization Management Settings. */ interface HypervVirtualizationManagementSettingsResponse { /** * Licence and support list. */ licenseAndSupportList: outputs.migrate.HypervLicenseResponse[]; /** * Number of physical cores per licence. */ numberOfPhysicalCoresPerLicense: number; /** * Software Assurance Cost. */ softwareAssuranceCost: number; } /** * IIS workload instance model custom properties. */ interface IISAKSWorkloadDeploymentModelCustomPropertiesResponse { /** * IIS AKS workload deployment. */ iisAksWorkloadDeploymentProperties?: outputs.migrate.IISAKSWorkloadDeploymentResponse; /** * Gets or sets the instance type. * Expected value is 'IISAKSWorkloadDeploymentModelCustomProperties'. */ instanceType: "IISAKSWorkloadDeploymentModelCustomProperties"; } /** * IIS AKS workload deployment. */ interface IISAKSWorkloadDeploymentResponse { /** * Class for GMSA authentication details to configure Active Directory connectivity. */ authenticationProperties?: outputs.migrate.GmsaAuthenticationPropertiesResponse; /** * Class for automation artifact. */ automationArtifactProperties?: outputs.migrate.AutomationArtifactResponse; /** * Gets or sets the bindings for the application. */ bindings?: outputs.migrate.BindingResponse[]; /** * Gets or sets the build container images. */ buildContainerImages?: outputs.migrate.ContainerImagePropertiesResponse[]; /** * Class for AKSDeployment Properties. */ clusterProperties?: outputs.migrate.AKSDeploymentPropertiesResponse; /** * Gets or sets application configuration. */ configurations?: outputs.migrate.WebApplicationConfigurationResponse[]; /** * Class for container image properties. */ containerImageProperties?: outputs.migrate.ContainerImagePropertiesResponse; /** * Gets or sets the deployment history. */ deploymentHistory: outputs.migrate.DeployedResourcesPropertiesResponse[]; /** * Gets or sets the deployment name prefix. */ deploymentNamePrefix?: string; /** * AKS Deployment Specification. */ deploymentSpec?: outputs.migrate.AKSDeploymentSpecificationResponse; /** * Gets or sets application directories. */ directories?: outputs.migrate.WebApplicationDirectoryResponse[]; /** * Resource Requirements. */ limits?: outputs.migrate.ResourceRequirementsResponse; /** * Class for app insight monitoring properties. */ monitoringProperties?: outputs.migrate.AppInsightMonitoringPropertiesResponse; /** * Resource Requirements. */ requests?: outputs.migrate.ResourceRequirementsResponse; /** * Gets or sets the target platform managed identity. */ targetPlatformIdentity?: string; } /** * IISApplication details. */ interface IISApplicationDetailsResponse { /** * Gets or sets the application pool name. */ applicationPoolName?: string; /** * Gets or sets the list of directories. */ directories?: outputs.migrate.DirectoryPathResponse[]; /** * Gets or sets a value indicating whether 32 bit applications are allowed to run on 64 bit. */ enable32BitApiOnWin64?: boolean; /** * Gets the ID. */ id: string; /** * Gets or sets the managed pipeline mode. */ managedPipelineMode?: string; /** * Second level entity for virtual directories. */ path?: outputs.migrate.DirectoryPathResponse; /** * Gets or sets the runtime version. */ runtimeVersion?: string; } /** * IIS virtual application details. */ interface IISVirtualApplicationDetailsResponse { /** * Gets or sets the list of directories. */ directories?: outputs.migrate.DirectoryPathResponse[]; /** * Gets the ID. */ id: string; /** * Gets a value indicating whether the application corresponds to a directory. */ isVirtualDirectory: boolean; /** * Second level entity for virtual directories. */ path?: outputs.migrate.DirectoryPathResponse; } /** * IISWeb application. */ interface IISWebApplicationResponse { /** * Gets or sets the web application id. */ applicationId?: string; /** * Gets or sets the web application name. */ applicationName?: string; /** * Gets or sets application scratch path. */ applicationScratchPath?: string; /** * Gets or sets the list of applications for the IIS web site. */ applications?: outputs.migrate.IISApplicationDetailsResponse[]; /** * Gets or sets the bindings for the application. */ bindings?: outputs.migrate.BindingResponse[]; /** * Gets or sets application configuration. */ configurations?: outputs.migrate.WebApplicationConfigurationResponse[]; /** * Gets or sets application directories. */ directories?: outputs.migrate.WebApplicationDirectoryResponse[]; /** * Gets or sets the discovered frameworks of application. */ discoveredFrameworks?: outputs.migrate.WebApplicationFrameworkResponse[]; /** * Gets or sets the display name. */ displayName?: string; /** * IISWeb server. */ iisWebServer?: outputs.migrate.IISWebServerResponse; /** * Resource Requirements. */ limits?: outputs.migrate.ResourceRequirementsResponse; /** * Second level entity for virtual directories. */ path?: outputs.migrate.DirectoryPathResponse; /** * Framework specific data for a web application. */ primaryFramework?: outputs.migrate.WebApplicationFrameworkResponse; /** * Resource Requirements. */ requests?: outputs.migrate.ResourceRequirementsResponse; /** * Gets or sets the list of application units for the web site. */ virtualApplications?: outputs.migrate.IISVirtualApplicationDetailsResponse[]; /** * Gets or sets the web server id. */ webServerId?: string; /** * Gets or sets the web server name. */ webServerName?: string; } /** * IISWeb server. */ interface IISWebServerResponse { /** * Gets or sets the display name. */ displayName?: string; /** * Gets or sets list of ip addresses. */ ipAddresses?: string[]; /** * Gets or sets the list of machines. */ machines?: string[]; operatingSystemDetails?: outputs.migrate.OperatingSystemDetailsResponse; /** * Gets or sets the server root configuration location. */ rootConfigurationLocation?: string; /** * Gets or sets the run as account id. */ runAsAccountId?: string; /** * Gets or sets the server FQDN. */ serverFqdn?: string; /** * Gets or sets the web server id. */ serverId?: string; /** * Gets or sets the web server name. */ serverName?: string; /** * Gets or sets the server version. */ version?: string; /** * Gets or sets the list of web applications. */ webApplications?: string[]; } /** * IIS workload instance model custom properties. */ interface IISWorkloadInstanceModelCustomPropertiesResponse { /** * Gets or sets the container Id. */ containerName?: string; /** * Gets or sets the fileshare name. */ fileshareName?: string; /** * IISWeb application. */ iisWebApplication?: outputs.migrate.IISWebApplicationResponse; /** * Gets or sets the instance type. * Expected value is 'IISWorkloadInstanceModelCustomProperties'. */ instanceType: "IISWorkloadInstanceModelCustomProperties"; /** * Gets or sets the Web application ARM id. */ webAppArmId?: string; /** * Gets or sets the Web application site name. */ webAppSiteName?: string; } /** * Identity model. */ interface IdentityModelResponse { /** * Gets or sets the authority of the SPN with which MigrateAgent communicates to service. */ aadAuthority?: string; /** * Gets or sets the client/application Id of the SPN with which MigrateAgent communicates to * service. */ applicationId?: string; /** * Gets or sets the audience of the SPN with which MigrateAgent communicates to service. */ audience?: string; /** * Gets or sets the object Id of the SPN with which MigrateAgent communicates to service. */ objectId?: string; /** * Gets or sets the tenant Id of the SPN with which MigrateAgent communicates to service. */ tenantId?: string; } /** * Defines the MSI properties of the Move Collection. */ interface IdentityResponse { /** * Gets or sets the principal id. */ principalId?: string; /** * Gets or sets the tenant id. */ tenantId?: string; /** * The type of identity used for the resource mover service. */ type?: string; } interface ImportCollectorPropertiesResponse { createdTimestamp: string; discoverySiteId?: string; updatedTimestamp: string; } /** * Import SQL Collector properties class. */ interface ImportSqlCollectorPropertiesResponse { /** * When was import SQL collector first created. */ createdTimestamp: string; /** * The sql db extended details. */ discoverySiteId?: string; /** * The status of the last operation. */ provisioningState: string; /** * When was import SQL collector last updated. */ updatedTimestamp: string; } /** * Inner health error model. */ interface InnerHealthErrorModelResponse { /** * Gets or sets the error category. */ category: string; /** * Gets or sets possible causes of the error. */ causes: string; /** * Gets or sets the error code. */ code: string; /** * Gets or sets the error creation time. */ creationTime: string; /** * Gets or sets the health category. */ healthCategory: string; /** * Gets the ID. */ id: string; /** * Gets or sets a value indicating whether the error is customer resolvable. */ isCustomerResolvable: boolean; /** * Gets or sets the error message. */ message: string; /** * Gets or sets recommended action to resolve the error. */ recommendation: string; /** * Gets or sets the error severity. */ severity: string; /** * Gets or sets the error source. */ source: string; /** * Gets or sets the error summary. */ summary: string; } /** * Defines the job status. */ interface JobStatusResponse { /** * Defines the job name. */ jobName: string; /** * Gets or sets the monitoring job percentage. */ jobProgress: string; } /** * Defines the key vault resource settings. */ interface KeyVaultResourceSettingsResponse { /** * The resource type. For example, the value can be Microsoft.Compute/virtualMachines. * Expected value is 'Microsoft.KeyVault/vaults'. */ resourceType: "Microsoft.KeyVault/vaults"; /** * Gets or sets the target resource group name. */ targetResourceGroupName?: string; /** * Gets or sets the target Resource name. */ targetResourceName?: string; } interface KeyVaultSecretStorePropertiesResponse { inputType: string; keyvaultName?: string; managedIdentityProperties?: outputs.migrate.ManagedIdentityPropertiesResponse; resourceGroup?: string; secretStoreId?: string; subscriptionId?: string; tenantId?: string; } /** * Defines load balancer backend address pool properties. */ interface LBBackendAddressPoolResourceSettingsResponse { /** * Gets or sets the backend address pool name. */ name?: string; } /** * Defines load balancer frontend IP configuration properties. */ interface LBFrontendIPConfigurationResourceSettingsResponse { /** * Gets or sets the frontend IP configuration name. */ name?: string; /** * Gets or sets the IP address of the Load Balancer.This is only specified if a specific * private IP address shall be allocated from the subnet specified in subnetRef. */ privateIpAddress?: string; /** * Gets or sets PrivateIP allocation method (Static/Dynamic). */ privateIpAllocationMethod?: string; /** * Defines reference to subnet. */ subnet?: outputs.migrate.SubnetReferenceResponse; /** * Gets or sets the csv list of zones. */ zones?: string; } /** * Labour settings. */ interface LaborSettingsResponse { /** * Hourly administrator cost. */ hourlyAdminCost: number; /** * Physical servers per administrator. */ physicalServersPerAdmin: number; /** * Virtual machines per administrator. */ virtualMachinesPerAdmin: number; } /** * Linux Server licensing settings. */ interface LinuxServerLicensingSettingsResponse { /** * Licence Cost. */ licenseCost: number; } /** * Defines reference to load balancer backend address pools. */ interface LoadBalancerBackendAddressPoolReferenceResponse { /** * Gets the name of the proxy resource on the target side. */ name?: string; /** * Gets the ARM resource ID of the tracked resource being referenced. */ sourceArmResourceId: string; } /** * Defines reference to load balancer NAT rules. */ interface LoadBalancerNatRuleReferenceResponse { /** * Gets the name of the proxy resource on the target side. */ name?: string; /** * Gets the ARM resource ID of the tracked resource being referenced. */ sourceArmResourceId: string; } /** * Defines the load balancer resource settings. */ interface LoadBalancerResourceSettingsResponse { /** * Gets or sets the backend address pools of the load balancer. */ backendAddressPools?: outputs.migrate.LBBackendAddressPoolResourceSettingsResponse[]; /** * Gets or sets the frontend IP configurations of the load balancer. */ frontendIPConfigurations?: outputs.migrate.LBFrontendIPConfigurationResourceSettingsResponse[]; /** * The resource type. For example, the value can be Microsoft.Compute/virtualMachines. * Expected value is 'Microsoft.Network/loadBalancers'. */ resourceType: "Microsoft.Network/loadBalancers"; /** * Gets or sets load balancer sku (Basic/Standard). */ sku?: string; /** * Gets or sets the Resource tags. */ tags?: { [key: string]: string; }; /** * Gets or sets the target resource group name. */ targetResourceGroupName?: string; /** * Gets or sets the target Resource name. */ targetResourceName?: string; /** * Gets or sets the csv list of zones common for all frontend IP configurations. Note this is given * precedence only if frontend IP configurations settings are not present. */ zones?: string; } /** * Properties of an assessment. */ interface MachineAssessmentSettingsResponse { /** * The disk type for the assessment. */ azureDiskTypes?: string[]; /** * Gets or sets the user configurable setting to display the azure hybrid use * benefit. */ azureHybridUseBenefit?: string; /** * Azure Location or Azure region where to which the machines will be migrated. */ azureLocation?: string; /** * Gets or sets Azure Pricing Tier - Free, Basic, etc. */ azurePricingTier?: string; /** * The azure security offering type. */ azureSecurityOfferingType?: string; /** * Gets or sets the Azure Storage Redundancy. Example: Locally Redundant Storage. */ azureStorageRedundancy?: string; /** * Gets or sets the Azure VM families. */ azureVmFamilies?: string[]; /** * Gets or sets the Azure VM security options. */ azureVmSecurityOptions?: string[]; /** * Gets or sets the billing settings. */ billingSettings?: outputs.migrate.BillingSettingsResponse; /** * Currency in which prices should be reported. */ currency?: string; /** * Custom discount percentage. */ discountPercentage?: number; /** * Gets or sets user configurable setting to display the environment type. */ environmentType?: string; /** * Gets or sets the user configurable setting to display the linux azure hybrid use * benefit. */ linuxAzureHybridUseBenefit?: string; /** * Gets or sets the performance data. */ performanceData?: outputs.migrate.PerformanceDataResponse; /** * Gets or sets the savings settings. */ savingsSettings?: outputs.migrate.SavingsSettingsResponse; /** * Percentage of buffer that user wants on performance metrics when recommending * Azure sizes. */ scalingFactor?: number; /** * Assessment sizing criterion. */ sizingCriterion?: string; /** * Gets or sets the duration for which the VMs are up in the on-premises * environment. */ vmUptime?: outputs.migrate.VmUptimeMachineAssessmentsV2OperationResponse; } /** * Assessment properties class. */ interface MachineAssessmentV2PropertiesResponse { /** * Gets or sets the details of the assessment. */ details?: outputs.migrate.AssessmentDetailsResponse; /** * The status of the last operation. */ provisioningState: string; /** * Gets or sets the scope of assessment. */ scope?: outputs.migrate.ScopeResponse; /** * Gets or sets the settings for the assessment. */ settings?: outputs.migrate.MachineAssessmentSettingsResponse; } interface ManagedIdentityPropertiesResponse { clientId?: string; managedIdentityName?: string; principalId?: string; resourceGroup?: string; subscriptionId?: string; tenantId?: string; } /** * Management settings. */ interface ManagementSettingsResponse { /** * HyperV Virtualization Management Settings. */ hypervVirtualizationManagementSettings: outputs.migrate.HypervVirtualizationManagementSettingsResponse; /** * Other Management Costs Settings. */ otherManagementCostsSettings: outputs.migrate.OtherManagementCostsSettingsResponse; /** * Third Party Management Settings. */ thirdPartyManagementSettings: outputs.migrate.ThirdPartyManagementSettingsResponse; } /** * Defines the properties for manual resolution. */ interface ManualResolutionPropertiesResponse { /** * Gets or sets the target resource ARM ID of the dependent resource if the resource type is Manual. */ targetId?: string; } /** * MigrateAgent model properties. */ interface MigrateAgentModelPropertiesResponse { /** * Identity model. */ authenticationIdentity?: outputs.migrate.IdentityModelResponse; /** * Gets or sets the MigrateAgent correlation Id. */ correlationId: string; /** * MigrateAgent model custom properties. */ customProperties?: outputs.migrate.VMwareMigrateAgentModelCustomPropertiesResponse; /** * Gets or sets the list of health errors. */ healthErrors: outputs.migrate.HealthErrorModelResponse[]; /** * Gets or sets a value indicating whether MigrateAgent is responsive. */ isResponsive: boolean; /** * Gets or sets the time when last heartbeat was sent by the MigrateAgent. */ lastHeartbeat: string; /** * Gets or sets the machine Id where MigrateAgent is running. */ machineId?: string; /** * Gets or sets the machine name where MigrateAgent is running. */ machineName?: string; /** * Gets or sets the provisioning state of the MigrateAgent. */ provisioningState: string; /** * Gets or sets the MigrateAgent version. */ versionNumber: string; } interface MigrateAgentModelResponseSystemData { /** * Gets or sets the timestamp of resource creation (UTC). */ createdAt?: string; /** * Gets or sets identity that created the resource. */ createdBy?: string; /** * Gets or sets the type of identity that created the resource: user, application, * managedIdentity. */ createdByType?: string; /** * Gets or sets the timestamp of resource last modification (UTC). */ lastModifiedAt?: string; /** * Gets or sets the identity that last modified the resource. */ lastModifiedBy?: string; /** * Gets or sets the type of identity that last modified the resource: user, application, * managedIdentity. */ lastModifiedByType?: string; } /** * Properties of a migrate project. */ interface MigrateProjectPropertiesMigrateProjectsControllerMigrateProjectResponse { /** * Last summary refresh time. */ lastSummaryRefreshedTime: string; /** * Gets the private endpoint connections. */ privateEndpointConnections: outputs.migrate.PrivateEndpointConnectionMigrateProjectsControllerMigrateProjectResponse[]; /** * Gets or sets the state of public network access. */ publicNetworkAccess?: string; /** * Refresh summary state. */ refreshSummaryState: string; /** * Register tools inside project. */ registeredTools: string[]; /** * Service endpoint. */ serviceEndpoint?: string; /** * Project summary. */ summary: { [key: string]: outputs.migrate.ProjectSummaryResponse; }; /** * Utility storage account id. */ utilityStorageAccountId?: string; } /** * Class for migrate project properties. */ interface MigrateProjectPropertiesResponse { /** * Gets the last time the project summary was refreshed. */ lastSummaryRefreshedTime: string; /** * Provisioning state of the migrate project. */ provisioningState?: string; /** * Gets the refresh summary state. */ refreshSummaryState: string; /** * Gets or sets the list of tools registered with the migrate project. */ registeredTools?: string[]; /** * Gets the summary of the migrate project. */ summary: { [key: string]: outputs.migrate.DatabaseProjectSummaryResponse | outputs.migrate.ServersProjectSummaryResponse; }; } /** * Gets or sets the tags. */ interface MigrateProjectResponseTags { additionalProperties?: string; } /** * MigrationConfiguration properties. */ interface MigrationConfigurationResponse { /** * Gets or sets the key vault resource Id. */ keyVaultResourceId?: string; /** * Gets or sets the migration solution resource Id. */ migrationSolutionResourceId?: string; /** * Gets or sets the storage account resource Id. */ storageAccountResourceId?: string; } /** * Migration Entity Group Properties class. */ interface MigrationEntityGroupPropertiesResponse { /** * Display Name of the Workload. */ applicationDisplayName: string; /** * Application id */ applicationId: string; /** * Associated Assessment Id */ associatedAssessmentId?: string; /** * associated Wave Id */ associatedWaveIds?: string[]; /** * Execution Start Date */ executionStartDate: string; /** * Migration Entity Group Status */ executionStatus: string; /** * Migration path */ migrationPath?: string; /** * The status of the last operation. */ provisioningState: string; } /** * Migration Entity Properties class. */ interface MigrationEntityPropertiesResponse { /** * Assessed Entity ARM Id */ assessedEntityArmId?: string; /** * Associated Assessment Id */ associatedAssessmentId?: string; /** * inventory resource id */ associatedInventoryResourceId: string; /** * associated Migration Entity Group Id */ associatedMigrationEntityGroupIds?: string[]; /** * associated Wave Id */ associatedWaveId?: string; /** * Execution Readiness of Migration Entity. */ executionReadiness: string; /** * Execution Stage of Migration Entity. */ executionStage: string; /** * Execution start date for Migration Entity. */ executionStartDate: string; /** * Execution Status of Migration Entity. */ executionStatus: string; /** * Display Name of the Workload. */ inventoryDisplayName: string; /** * Migration path */ migrationPath?: string; /** * Migration specific properties for the entity. */ migrationSpecificProperties?: outputs.migrate.ServerMigrationSpecificPropertiesResponse; /** * Strategy of Migration Entity. */ migrationStrategy: string; /** * Migration Tool of the Migration Entity. */ migrationTool?: string; /** * ARM Resource Identifier for the partner resource. */ partnerResourceArmId?: string; /** * The status of the last operation. */ provisioningState: string; /** * Target of the Migration Entity. */ target?: string; /** * target Azure Resource ARM Id. */ targetAzureResourceArmId?: string; } /** * ModernizeProject properties. */ interface ModernizeProjectModelPropertiesResponse { /** * MigrationConfiguration properties. */ migrationConfiguration?: outputs.migrate.MigrationConfigurationResponse; /** * Gets or sets the provisioning state of the ModernizeProject. */ provisioningState: string; /** * Gets or sets the service endpoint. */ serviceEndpoint: string; /** * Gets or sets the service resource Id. */ serviceResourceId: string; } interface ModernizeProjectModelResponseSystemData { /** * Gets or sets the timestamp of resource creation (UTC). */ createdAt?: string; /** * Gets or sets identity that created the resource. */ createdBy?: string; /** * Gets or sets the type of identity that created the resource: user, application, * managedIdentity. */ createdByType?: string; /** * Gets or sets the timestamp of resource last modification (UTC). */ lastModifiedAt?: string; /** * Gets or sets the identity that last modified the resource. */ lastModifiedBy?: string; /** * Gets or sets the type of identity that last modified the resource: user, application, * managedIdentity. */ lastModifiedByType?: string; } /** * Defines the move collection properties. */ interface MoveCollectionPropertiesResponse { /** * Defines the move collection errors. */ errors: outputs.migrate.MoveCollectionPropertiesResponseErrors; /** * Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted. */ moveRegion?: string; /** * Defines the MoveType. */ moveType?: string; /** * Defines the provisioning states. */ provisioningState: string; /** * Gets or sets the source region. */ sourceRegion?: string; /** * Gets or sets the target region. */ targetRegion?: string; /** * Gets or sets the version of move collection. */ version?: string; } /** * Defines the move collection errors. */ interface MoveCollectionPropertiesResponseErrors { /** * The move resource error body. */ properties?: outputs.migrate.MoveResourceErrorBodyResponse; } /** * Defines the dependency override of the move resource. */ interface MoveResourceDependencyOverrideResponse { /** * Gets or sets the ARM ID of the dependent resource. */ id?: string; /** * Gets or sets the resource ARM id of either the MoveResource or the resource ARM ID of * the dependent resource. */ targetId?: string; } /** * Defines the dependency of the move resource. */ interface MoveResourceDependencyResponse { /** * Defines the properties for automatic resolution. */ automaticResolution?: outputs.migrate.AutomaticResolutionPropertiesResponse; /** * Defines the dependency type. */ dependencyType?: string; /** * Gets the source ARM ID of the dependent resource. */ id?: string; /** * Gets or sets a value indicating whether the dependency is optional. */ isOptional?: string; /** * Defines the properties for manual resolution. */ manualResolution?: outputs.migrate.ManualResolutionPropertiesResponse; /** * Gets the dependency resolution status. */ resolutionStatus?: string; /** * Defines the resolution type. */ resolutionType?: string; } /** * An error response from the Azure Migrate service. */ interface MoveResourceErrorBodyResponse { /** * An identifier for the error. Codes are invariant and are intended to be consumed programmatically. */ code: string; /** * A list of additional details about the error. */ details: outputs.migrate.MoveResourceErrorBodyResponse[]; /** * A message describing the error, intended to be suitable for display in a user interface. */ message: string; /** * The target of the particular error. For example, the name of the property in error. */ target: string; } /** * An error response from the azure resource mover service. */ interface MoveResourceErrorResponse { /** * The move resource error body. */ properties?: outputs.migrate.MoveResourceErrorBodyResponse; } /** * Defines the move resource properties. */ interface MoveResourcePropertiesResponse { /** * Gets or sets the move resource dependencies. */ dependsOn: outputs.migrate.MoveResourceDependencyResponse[]; /** * Gets or sets the move resource dependencies overrides. */ dependsOnOverrides?: outputs.migrate.MoveResourceDependencyOverrideResponse[]; /** * Defines the move resource errors. */ errors: outputs.migrate.MoveResourcePropertiesResponseErrors; /** * Gets or sets the existing target ARM Id of the resource. */ existingTargetId?: string; /** * Gets a value indicating whether the resolve action is required over the move collection. */ isResolveRequired: boolean; /** * Defines the move resource status. */ moveStatus: outputs.migrate.MoveResourcePropertiesResponseMoveStatus; /** * Defines the provisioning states. */ provisioningState: string; /** * Gets or sets the resource settings. */ resourceSettings?: outputs.migrate.AvailabilitySetResourceSettingsResponse | outputs.migrate.DiskEncryptionSetResourceSettingsResponse | outputs.migrate.KeyVaultResourceSettingsResponse | outputs.migrate.LoadBalancerResourceSettingsResponse | outputs.migrate.NetworkInterfaceResourceSettingsResponse | outputs.migrate.NetworkSecurityGroupResourceSettingsResponse | outputs.migrate.PublicIPAddressResourceSettingsResponse | outputs.migrate.ResourceGroupResourceSettingsResponse | outputs.migrate.SqlDatabaseResourceSettingsResponse | outputs.migrate.SqlElasticPoolResourceSettingsResponse | outputs.migrate.SqlServerResourceSettingsResponse | outputs.migrate.VirtualMachineResourceSettingsResponse | outputs.migrate.VirtualNetworkResourceSettingsResponse; /** * Gets or sets the Source ARM Id of the resource. */ sourceId: string; /** * Gets or sets the source resource settings. */ sourceResourceSettings: outputs.migrate.AvailabilitySetResourceSettingsResponse | outputs.migrate.DiskEncryptionSetResourceSettingsResponse | outputs.migrate.KeyVaultResourceSettingsResponse | outputs.migrate.LoadBalancerResourceSettingsResponse | outputs.migrate.NetworkInterfaceResourceSettingsResponse | outputs.migrate.NetworkSecurityGroupResourceSettingsResponse | outputs.migrate.PublicIPAddressResourceSettingsResponse | outputs.migrate.ResourceGroupResourceSettingsResponse | outputs.migrate.SqlDatabaseResourceSettingsResponse | outputs.migrate.SqlElasticPoolResourceSettingsResponse | outputs.migrate.SqlServerResourceSettingsResponse | outputs.migrate.VirtualMachineResourceSettingsResponse | outputs.migrate.VirtualNetworkResourceSettingsResponse; /** * Gets or sets the Target ARM Id of the resource. */ targetId: string; } /** * Defines the move resource errors. */ interface MoveResourcePropertiesResponseErrors { /** * The move resource error body. */ properties?: outputs.migrate.MoveResourceErrorBodyResponse; } /** * Defines the move resource status. */ interface MoveResourcePropertiesResponseMoveStatus { /** * An error response from the azure resource mover service. */ errors?: outputs.migrate.MoveResourceErrorResponse; /** * Defines the job status. */ jobStatus?: outputs.migrate.JobStatusResponse; /** * Defines the MoveResource states. */ moveState: string; } /** * Defines the network interface resource settings. */ interface NetworkInterfaceResourceSettingsResponse { /** * Gets or sets a value indicating whether accelerated networking is enabled. */ enableAcceleratedNetworking?: boolean; /** * Gets or sets the IP configurations of the NIC. */ ipConfigurations?: outputs.migrate.NicIpConfigurationResourceSettingsResponse[]; /** * The resource type. For example, the value can be Microsoft.Compute/virtualMachines. * Expected value is 'Microsoft.Network/networkInterfaces'. */ resourceType: "Microsoft.Network/networkInterfaces"; /** * Gets or sets the Resource tags. */ tags?: { [key: string]: string; }; /** * Gets or sets the target resource group name. */ targetResourceGroupName?: string; /** * Gets or sets the target Resource name. */ targetResourceName?: string; } /** * Defines the NSG resource settings. */ interface NetworkSecurityGroupResourceSettingsResponse { /** * The resource type. For example, the value can be Microsoft.Compute/virtualMachines. * Expected value is 'Microsoft.Network/networkSecurityGroups'. */ resourceType: "Microsoft.Network/networkSecurityGroups"; /** * Gets or sets Security rules of network security group. */ securityRules?: outputs.migrate.NsgSecurityRuleResponse[]; /** * Gets or sets the Resource tags. */ tags?: { [key: string]: string; }; /** * Gets or sets the target resource group name. */ targetResourceGroupName?: string; /** * Gets or sets the target Resource name. */ targetResourceName?: string; } /** * Network settings. */ interface NetworkSettingsResponse { /** * Network hardware and software cost percentage. */ hardwareSoftwareCostPercentage: number; /** * Network maintenance cost percentage. */ maintenanceCostPercentage: number; } /** * Defines NIC IP configuration properties. */ interface NicIpConfigurationResourceSettingsResponse { /** * Gets or sets the references of the load balancer backend address pools. */ loadBalancerBackendAddressPools?: outputs.migrate.LoadBalancerBackendAddressPoolReferenceResponse[]; /** * Gets or sets the references of the load balancer NAT rules. */ loadBalancerNatRules?: outputs.migrate.LoadBalancerNatRuleReferenceResponse[]; /** * Gets or sets the IP configuration name. */ name?: string; /** * Gets or sets a value indicating whether this IP configuration is the primary. */ primary?: boolean; /** * Gets or sets the private IP address of the network interface IP Configuration. */ privateIpAddress?: string; /** * Gets or sets the private IP address allocation method. */ privateIpAllocationMethod?: string; /** * Defines reference to a public IP. */ publicIp?: outputs.migrate.PublicIpReferenceResponse; /** * Defines reference to subnet. */ subnet?: outputs.migrate.SubnetReferenceResponse; } /** * Defines reference to NSG. */ interface NsgReferenceResponse { /** * Gets the ARM resource ID of the tracked resource being referenced. */ sourceArmResourceId: string; } /** * Security Rule data model for Network Security Groups. */ interface NsgSecurityRuleResponse { /** * Gets or sets whether network traffic is allowed or denied. * Possible values are “Allow” and “Deny”. */ access?: string; /** * Gets or sets a description for this rule. Restricted to 140 chars. */ description?: string; /** * Gets or sets destination address prefix. CIDR or source IP range. * A “*” can also be used to match all source IPs. Default tags such * as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. */ destinationAddressPrefix?: string; /** * Gets or sets Destination Port or Range. Integer or range between * 0 and 65535. A “*” can also be used to match all ports. */ destinationPortRange?: string; /** * Gets or sets the direction of the rule.InBound or Outbound. The * direction specifies if rule will be evaluated on incoming or outgoing traffic. */ direction?: string; /** * Gets or sets the Security rule name. */ name?: string; /** * Gets or sets the priority of the rule. The value can be between * 100 and 4096. The priority number must be unique for each rule in the collection. * The lower the priority number, the higher the priority of the rule. */ priority?: number; /** * Gets or sets Network protocol this rule applies to. Can be Tcp, Udp or All(*). */ protocol?: string; /** * Gets or sets source address prefix. CIDR or source IP range. A * “*” can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, * ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress * rule, specifies where network traffic originates from. */ sourceAddressPrefix?: string; /** * Gets or sets Source Port or Range. Integer or range between 0 and * 65535. A “*” can also be used to match all ports. */ sourcePortRange?: string; } /** * On-premise settings. */ interface OnPremiseSettingsResponse { /** * Compute settings. */ computeSettings: outputs.migrate.ComputeSettingsResponse; /** * Facility settings. */ facilitySettings: outputs.migrate.FacilitySettingsResponse; /** * Labour settings. */ laborSettings: outputs.migrate.LaborSettingsResponse; /** * Management settings. */ managementSettings?: outputs.migrate.ManagementSettingsResponse; /** * Network settings. */ networkSettings: outputs.migrate.NetworkSettingsResponse; /** * Security settings. */ securitySettings: outputs.migrate.SecuritySettingsResponse; /** * Storage settings. */ storageSettings: outputs.migrate.StorageSettingsResponse; } interface OperatingSystemDetailsResponse { os?: string; osArchitecture?: string; osName?: string; osVersion?: string; } /** * Other Management Costs Settings. */ interface OtherManagementCostsSettingsResponse { /** * Data Protection Cost Per Server Per Year. */ dataProtectionCostPerServerPerYear: number; /** * Monitoring Cost Per Server Per Year. */ monitoringCostPerServerPerYear: number; /** * Patching Cost Per Server Per Year. */ patchingCostPerServerPerYear: number; } /** * Data model of Performance Data Settings. */ interface PerfDataSettingsResponse { /** * Gets percentile utilization for performance data. */ percentile: string; /** * Gets or sets perf data end time. */ perfDataEndTime?: string; /** * Gets or sets perf data start time. */ perfDataStartTime?: string; /** * Gets perf data time range. */ timeRange: string; } /** * Performance data class. */ interface PerformanceDataResponse { /** * Percentile of the utilization data values to be considered while assessing * machines. */ percentile?: string; /** * Gets or sets the end time to consider performance data for assessment. */ perfDataEndTime?: string; /** * Gets or sets the start time to consider performance data for assessment. */ perfDataStartTime?: string; /** * Time Range for which the historic utilization data should be considered for * assessment. */ timeRange?: string; } /** * WebApplication port mapping. */ interface PortMappingResponse { /** * Gets or sets the External Port. */ externalPort?: number; /** * Gets or sets the Internal Port. */ internalPort?: number; } /** * REST model used to encapsulate the user visible state of a PrivateEndpoint. */ interface PrivateEndpointConnectionMigrateProjectsControllerMigrateProjectResponse { /** * Gets the tag for optimistic concurrency control. */ eTag: string; /** * Relative URL to get this Sites. */ id: string; /** * Gets the name of the resource. */ name: string; /** * Gets the properties of the object. */ properties: outputs.migrate.PrivateEndpointConnectionPropertiesResponse; /** * Metadata pertaining to creation and last modification of the resource. */ systemData: outputs.migrate.SystemDataResponse; /** * Gets the resource type. */ type: string; } /** * A private endpoint connection for a project. */ interface PrivateEndpointConnectionProjectResponse { /** * For optimistic concurrency control. */ eTag?: string; /** * Path reference to this private endpoint endpoint connection. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/assessmentProjects/{projectName}/privateEndpointConnections/{privateEndpointConnectionName} */ id: string; /** * Name of the private endpoint endpoint connection. */ name: string; /** * Properties of the private endpoint endpoint connection. */ properties: outputs.migrate.PrivateEndpointConnectionPropertiesResponse; /** * Type of the object = [Microsoft.Migrate/assessmentProjects/privateEndpointConnections]. */ type: string; } /** * Private endpoint connection properties. */ interface PrivateEndpointConnectionPropertiesResponse { /** * ARM id for the private endpoint resource corresponding to the connection. */ privateEndpoint: outputs.migrate.ResourceIdResponse; /** * State of the private endpoint connection. */ privateLinkServiceConnectionState?: outputs.migrate.PrivateLinkServiceConnectionStateResponse; /** * Indicates whether there is an ongoing operation on the private endpoint. */ provisioningState: string; } /** * Private endpoint connection resource. */ interface PrivateEndpointConnectionResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint resource. */ privateEndpoint?: outputs.migrate.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.migrate.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.migrate.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * State of a private endpoint connection. */ interface PrivateLinkServiceConnectionStateResponse { /** * Actions required on the private endpoint connection. */ actionsRequired?: string; /** * Description of the private endpoint connection. */ description?: string; /** * Connection status of the private endpoint connection. */ status?: string; } /** * Properties of a project. */ interface ProjectPropertiesResponse { /** * Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects. */ assessmentSolutionId?: string; /** * Time when this project was created. Date-Time represented in ISO-8601 format. */ createdTimestamp: string; /** * The ARM id of the storage account used for interactions when public access is disabled. */ customerStorageAccountArmId?: string; /** * The ARM id of service map workspace created by customer. */ customerWorkspaceId?: string; /** * Location of service map workspace created by customer. */ customerWorkspaceLocation?: string; /** * Time when last assessment was created. Date-Time represented in ISO-8601 format. This value will be null until assessment is created. */ lastAssessmentTimestamp: string; /** * Number of assessments created in the project. */ numberOfAssessments: number; /** * Number of groups created in the project. */ numberOfGroups: number; /** * Number of machines in the project. */ numberOfMachines: number; /** * The list of private endpoint connections to the project. */ privateEndpointConnections: outputs.migrate.PrivateEndpointConnectionProjectResponse[]; /** * Assessment project status. */ projectStatus?: string; /** * Provisioning state of the project. */ provisioningState: string; /** * This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method. */ publicNetworkAccess?: string; /** * Endpoint at which the collector agent can call agent REST API. */ serviceEndpoint: string; /** * Time when this project was last updated. Date-Time represented in ISO-8601 format. */ updatedTimestamp: string; } /** * Project summary. */ interface ProjectSummaryResponse { /** * Extended summary. */ extendedSummary?: { [key: string]: string; }; /** * Instance type. */ instanceType: string; /** * Last summary refresh time. */ lastSummaryRefreshedTime?: string; /** * Refresh summary state. */ refreshSummaryState?: string; } /** * Defines the public IP address resource settings. */ interface PublicIPAddressResourceSettingsResponse { /** * Gets or sets the domain name label. */ domainNameLabel?: string; /** * Gets or sets the fully qualified domain name. */ fqdn?: string; /** * Gets or sets public IP allocation method. */ publicIpAllocationMethod?: string; /** * The resource type. For example, the value can be Microsoft.Compute/virtualMachines. * Expected value is 'Microsoft.Network/publicIPAddresses'. */ resourceType: "Microsoft.Network/publicIPAddresses"; /** * Gets or sets public IP sku. */ sku?: string; /** * Gets or sets the Resource tags. */ tags?: { [key: string]: string; }; /** * Gets or sets the target resource group name. */ targetResourceGroupName?: string; /** * Gets or sets the target Resource name. */ targetResourceName?: string; /** * Gets or sets public IP zones. */ zones?: string; } /** * Defines reference to a public IP. */ interface PublicIpReferenceResponse { /** * Gets the ARM resource ID of the tracked resource being referenced. */ sourceArmResourceId: string; } /** * Business case report details. */ interface ReportDetailsResponse { /** * Report status. */ reportStatus: string; /** * Report type. */ reportType: string; } /** * Defines the resource group resource settings. */ interface ResourceGroupResourceSettingsResponse { /** * The resource type. For example, the value can be Microsoft.Compute/virtualMachines. * Expected value is 'resourceGroups'. */ resourceType: "resourceGroups"; /** * Gets or sets the target resource group name. */ targetResourceGroupName?: string; /** * Gets or sets the target Resource name. */ targetResourceName?: string; } /** * ARM id for a resource. */ interface ResourceIdResponse { id: string; } interface ResourceIdentityResponse { principalId?: string; tenantId?: string; type?: string; userAssignedIdentities?: { [key: string]: outputs.migrate.UserAssignedIdentityResponse; }; } /** * Resource Requirements. */ interface ResourceRequirementsResponse { /** * Gets or sets the Cpu requirement. */ cpu?: string; /** * Gets or sets the Memory requirement. */ memory?: string; } /** * Savings settings class. */ interface SavingsSettingsResponse { /** * Gets or sets the Azure offer code. */ azureOfferCode?: string; /** * Gets or sets the savings options. */ savingsOptions?: string; } /** * Scope of the assessment. */ interface ScopeResponse { /** * The ARG query. */ azureResourceGraphQuery?: string; /** * The scope type */ scopeType?: string; /** * The server group arm id. */ serverGroupId?: string; } interface SecretStoreDetailsResponse { secretStore?: string; secretStoreProperties?: outputs.migrate.SecretStorePropertiesResponse; } interface SecretStorePropertiesResponse { inputType: string; secretStoreId?: string; } /** * Security settings. */ interface SecuritySettingsResponse { /** * Physical servers per administrator. */ serverSecurityCostPerServerPerYear: number; /** * Virtual machines per administrator. */ sqlServerSecurityCostPerServerPerYear: number; } /** * Represents a Server Migration Specific properties base model. */ interface ServerMigrationSpecificPropertiesResponse { /** * A type definition that refers the id to an Azure Resource Manager resource. */ currentJobId?: string; /** * A type definition that refers the id to an Azure Resource Manager resource. */ drApplianceInventoryId?: string; /** * Migration Specific Properties Instance Types. * Expected value is 'ServerMigration'. */ instanceType: "ServerMigration"; } /** * Class representing the servers project summary. */ interface ServersProjectSummaryResponse { /** * Gets or sets the count of entities assessed. */ assessedCount?: number; /** * Gets or sets the count of entities discovered. */ discoveredCount?: number; /** * Gets or sets the extended summary. */ extendedSummary?: { [key: string]: string; }; /** * Gets the Instance type. * Expected value is 'Servers'. */ instanceType: "Servers"; /** * Gets or sets the time when summary was last refreshed. */ lastSummaryRefreshedTime?: string; /** * Gets or sets the count of entities migrated. */ migratedCount?: number; /** * Gets or sets the state of refresh summary. */ refreshSummaryState?: string; /** * Gets or sets the count of entities being replicated. */ replicatingCount?: number; /** * Gets or sets the count of entities test migrated. */ testMigratedCount?: number; } /** * Class representing the servers solution summary. */ interface ServersSolutionSummaryResponse { /** * Gets or sets the count of servers assessed. */ assessedCount?: number; /** * Gets or sets the count of servers discovered. */ discoveredCount?: number; /** * Gets the Instance type. * Expected value is 'Servers'. */ instanceType: "Servers"; /** * Gets or sets the count of servers migrated. */ migratedCount?: number; /** * Gets or sets the count of servers being replicated. */ replicatingCount?: number; /** * Gets or sets the count of servers test migrated. */ testMigratedCount?: number; } /** * Business case settings. */ interface SettingsResponse { /** * Azure arc settings. */ azureArcSettings?: outputs.migrate.AzureArcSettingsResponse; /** * Azure settings for a business case. */ azureSettings: outputs.migrate.AzureSettingsResponse; /** * On-premise settings. */ onPremiseSettings?: outputs.migrate.OnPremiseSettingsResponse; } /** * settingsResponseProvideDefaults sets the appropriate defaults for SettingsResponse */ function settingsResponseProvideDefaults(val: SettingsResponse): SettingsResponse; /** * Class representing the details of the solution. */ interface SolutionDetailsResponse { /** * Gets or sets the count of assessments reported by the solution. */ assessmentCount?: number; /** * Gets or sets the extended details reported by the solution. */ extendedDetails?: { [key: string]: string; }; /** * Gets or sets the count of groups reported by the solution. */ groupCount?: number; } /** * Class for solution properties. */ interface SolutionPropertiesResponse { /** * Gets or sets the cleanup state of the solution. */ cleanupState?: string; /** * Gets or sets the details of the solution. */ details?: outputs.migrate.SolutionDetailsResponse; /** * Gets or sets the goal of the solution. */ goal?: string; /** * Gets or sets the purpose of the solution. */ purpose?: string; /** * Gets or sets the current status of the solution. */ status?: string; /** * Gets or sets the summary of the solution. */ summary?: outputs.migrate.DatabasesSolutionSummaryResponse | outputs.migrate.ServersSolutionSummaryResponse; /** * Gets or sets the tool being used in the solution. */ tool?: string; } /** * SQL assessment settings class. */ interface SqlAssessmentSettingsResponse { /** * Gets or sets user preference indicating intent of async commit mode. */ asyncCommitModeIntent?: string; /** * Azure Location or Azure region where to which the machines will be migrated. */ azureLocation?: string; /** * Gets or sets a value indicating azure security offering type. */ azureSecurityOfferingType?: string; /** * Gets or sets user configurable SQL database settings. */ azureSqlDatabaseSettings?: outputs.migrate.SqlDbSettingsV3Response; /** * Gets or sets user configurable SQL managed instance settings. */ azureSqlManagedInstanceSettings?: outputs.migrate.SqlMiSettingsV3Response; /** * Gets or sets user configurable SQL VM settings. */ azureSqlVmSettings?: outputs.migrate.SqlVmSettingsResponse; /** * Gets or sets the billing settings. */ billingSettings?: outputs.migrate.BillingSettingsResponse; /** * Currency in which prices should be reported. */ currency?: string; /** * Gets or sets the Azure Location or Azure region where to which the machines * will be migrated. */ disasterRecoveryLocation?: string; /** * Custom discount percentage. */ discountPercentage?: number; /** * Gets or sets a value indicating whether HADR assessments needs to be created. */ enableHadrAssessment?: boolean; /** * Gets or sets the duration for which the entity (SQL, VMs) are up in the * on-premises environment. */ entityUptime?: outputs.migrate.EntityUptimeResponse; /** * Gets or sets user configurable setting to display the environment type. */ environmentType?: string; /** * Gets or sets a value indicating whether internet access is available. */ isInternetAccessAvailable?: boolean; /** * Gets or sets user preference indicating intent of multi-subnet configuration. */ multiSubnetIntent?: string; /** * Gets or sets user configurable setting to display the azure hybrid use benefit. */ osLicense?: string; /** * Gets or sets the performance data. */ performanceData?: outputs.migrate.PerformanceDataResponse; /** * Gets or sets SQL the preferred azure targets. */ preferredTargets?: string[]; /** * Gets or sets the savings settings. */ savingsSettings?: outputs.migrate.SavingsSettingsResponse; /** * Percentage of buffer that user wants on performance metrics when recommending * Azure sizes. */ scalingFactor?: number; /** * Assessment sizing criterion. */ sizingCriterion?: string; /** * SQL server license. */ sqlServerLicense?: string; } /** * SQL assessment properties class. */ interface SqlAssessmentV3PropertiesResponse { /** * Gets or sets the details of the assessment. */ details?: outputs.migrate.AssessmentDetailsResponse; /** * Gets or sets the machine assessment ARM ID for VM fallback. */ fallbackMachineAssessmentArmId?: string; /** * The status of the last operation. */ provisioningState: string; /** * Gets or sets the scope of assessment. */ scope?: outputs.migrate.ScopeResponse; /** * Gets or sets the settings for the assessment. */ settings?: outputs.migrate.SqlAssessmentSettingsResponse; } /** * Defines the Sql Database resource settings. */ interface SqlDatabaseResourceSettingsResponse { /** * The resource type. For example, the value can be Microsoft.Compute/virtualMachines. * Expected value is 'Microsoft.Sql/servers/databases'. */ resourceType: "Microsoft.Sql/servers/databases"; /** * Gets or sets the Resource tags. */ tags?: { [key: string]: string; }; /** * Gets or sets the target resource group name. */ targetResourceGroupName?: string; /** * Gets or sets the target Resource name. */ targetResourceName?: string; /** * Defines the zone redundant resource setting. */ zoneRedundant?: string; } /** * SQL database assessment settings. */ interface SqlDbSettingsResponse { /** * Gets or sets the azure SQL compute tier. */ azureSqlComputeTier?: string; /** * Gets or sets the azure PAAS SQL instance type. */ azureSqlDataBaseType?: string; /** * Gets or sets the azure SQL purchase model. */ azureSqlPurchaseModel?: string; /** * Gets or sets the azure SQL service tier. */ azureSqlServiceTier?: string; } /** * SQL database assessment settings V3. */ interface SqlDbSettingsV3Response { /** * Gets or sets the azure SQL compute tier. */ azureSqlComputeTier?: string; /** * Gets or sets the azure PAAS SQL instance type. */ azureSqlDataBaseType?: string; /** * Gets or sets the azure SQL purchase model. */ azureSqlPurchaseModel?: string; /** * Gets or sets the azure SQL service tier. */ azureSqlServiceTier?: string; } /** * Defines the Sql ElasticPool resource settings. */ interface SqlElasticPoolResourceSettingsResponse { /** * The resource type. For example, the value can be Microsoft.Compute/virtualMachines. * Expected value is 'Microsoft.Sql/servers/elasticPools'. */ resourceType: "Microsoft.Sql/servers/elasticPools"; /** * Gets or sets the Resource tags. */ tags?: { [key: string]: string; }; /** * Gets or sets the target resource group name. */ targetResourceGroupName?: string; /** * Gets or sets the target Resource name. */ targetResourceName?: string; /** * Defines the zone redundant resource setting. */ zoneRedundant?: string; } /** * SQL managed instance assessment settings. */ interface SqlMiSettingsResponse { /** * Gets or sets the azure PAAS SQL instance type. */ azureSqlInstanceType?: string; /** * Gets or sets the azure SQL service tier. */ azureSqlServiceTier?: string; } /** * SQL managed instance assessment settings V3. */ interface SqlMiSettingsV3Response { /** * Gets or sets the azure PAAS SQL instance type. */ azureSqlInstanceType?: string; /** * Gets or sets the azure SQL service tier. */ azureSqlServiceTier?: string; } /** * SQL Server licensing settings. */ interface SqlServerLicensingSettingsResponse { /** * Licence cost. */ licenseCost: number; /** * Software assurance (SA) cost. */ softwareAssuranceCost: number; /** * SQL Server version. */ version: string; } /** * Defines the SQL Server resource settings. */ interface SqlServerResourceSettingsResponse { /** * The resource type. For example, the value can be Microsoft.Compute/virtualMachines. * Expected value is 'Microsoft.Sql/servers'. */ resourceType: "Microsoft.Sql/servers"; /** * Gets or sets the target resource group name. */ targetResourceGroupName?: string; /** * Gets or sets the target Resource name. */ targetResourceName?: string; } /** * SQL VM assessment settings. */ interface SqlVmSettingsResponse { /** * Gets or sets the Azure VM families (calling instance series to keep it * consistent with other targets). */ instanceSeries?: string[]; } /** * Storage settings. */ interface StorageSettingsResponse { /** * Cost per gigabyte per month. */ costPerGbPerMonth: number; /** * Maintenance cost percentage. */ maintainanceCostPercentageToAcquisitionCost: number; } /** * Defines reference to subnet. */ interface SubnetReferenceResponse { /** * Gets the name of the proxy resource on the target side. */ name?: string; /** * Gets the ARM resource ID of the tracked resource being referenced. */ sourceArmResourceId: string; } /** * Defines the virtual network subnets resource settings. */ interface SubnetResourceSettingsResponse { /** * Gets or sets address prefix for the subnet. */ addressPrefix?: string; /** * Gets or sets the Subnet name. */ name?: string; /** * Defines reference to NSG. */ networkSecurityGroup?: outputs.migrate.NsgReferenceResponse; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * ARM IDs of the target assessments. */ interface TargetAssessmentArmIdsResponse { /** * ARM ID for Azure Kubernetes Service assessment. */ aks?: string; /** * ARM ID for Azure App Service assessment. */ azureAppService?: string; /** * ARM ID for Azure App Service Container assessment. */ azureAppServiceContainer?: string; } /** * Storage profile for the directory on the target container. */ interface TargetStorageProfileResponse { /** * Azure file share profile for hydration of application folders not mounted on * the container file system. */ azureFileShareProfile?: outputs.migrate.AzureFileShareHydrationProfileResponse; /** * Gets or sets the storage provider type on the target. * Applicable when StorageProjectionType is not ContainerFileSystem. */ hydrationStorageProviderType?: string; /** * Gets or sets the target persistent volume id. * Applicable when StorageProjectionType is PersistentVolume and on using an * existing PersistentVolume. */ persistentVolumeId?: string; /** * Gets or sets the target storage access type. */ storageAccessType?: string; /** * Gets or sets the target projection type. */ storageProjectionType?: string; /** * Gets or sets the name of the projected volume on the target environment. */ targetName?: string; /** * Gets or sets the storage size on the target. * Applicable when StorageProjectionType is PersistentVolume and on creating a new * PersistentVolume. */ targetSize?: string; } /** * Task Properties class. */ interface TaskPropertiesResponse { /** * Task completion Date */ completionDate: string; /** * Task Description */ description?: string; /** * Task Dislay Name */ displayName: string; /** * Indicates whether the task is editable. */ isEditable: boolean; /** * The status of the last operation. */ provisioningState: string; /** * Task Scope */ scope: string; /** * associated Wave Id */ scopeId: string; /** * Task Stage */ stage?: string; /** * Task Status */ status: string; /** * Task Type */ taskType: string; } /** * Third Party Management settings. */ interface ThirdPartyManagementSettingsResponse { /** * License Cost. */ licenseCost: number; /** * Support Cost. */ supportCost: number; } interface UserAssignedIdentityResponse { clientId?: string; principalId?: string; } /** * VMware MigrateAgent model custom properties. */ interface VMwareMigrateAgentModelCustomPropertiesResponse { /** * Gets or sets the friendly name of the,of the MigrateAgent fabric. */ fabricFriendlyName?: string; /** * Gets or sets the instance type. * Expected value is 'VMwareMigrateAgentModelCustomProperties'. */ instanceType: "VMwareMigrateAgentModelCustomProperties"; /** * Gets or sets the master Site Id of the Migrate Agent. */ vmwareSiteId?: string; } /** * Gets or sets the virtual machine resource settings. */ interface VirtualMachineResourceSettingsResponse { /** * The resource type. For example, the value can be Microsoft.Compute/virtualMachines. * Expected value is 'Microsoft.Compute/virtualMachines'. */ resourceType: "Microsoft.Compute/virtualMachines"; /** * Gets or sets the Resource tags. */ tags?: { [key: string]: string; }; /** * Gets or sets the target availability set id for virtual machines not in an availability set at source. */ targetAvailabilitySetId?: string; /** * Gets or sets the target availability zone. */ targetAvailabilityZone?: string; /** * Gets or sets the target resource group name. */ targetResourceGroupName?: string; /** * Gets or sets the target Resource name. */ targetResourceName?: string; /** * Gets or sets the target virtual machine size. */ targetVmSize?: string; /** * Gets or sets user-managed identities */ userManagedIdentities?: string[]; } /** * Defines the virtual network resource settings. */ interface VirtualNetworkResourceSettingsResponse { /** * Gets or sets the address prefixes for the virtual network. */ addressSpace?: string[]; /** * Gets or sets DHCPOptions that contains an array of DNS servers available to VMs * deployed in the virtual network. */ dnsServers?: string[]; /** * Gets or sets a value indicating whether gets or sets whether the * DDOS protection should be switched on. */ enableDdosProtection?: boolean; /** * The resource type. For example, the value can be Microsoft.Compute/virtualMachines. * Expected value is 'Microsoft.Network/virtualNetworks'. */ resourceType: "Microsoft.Network/virtualNetworks"; /** * Gets or sets List of subnets in a VirtualNetwork. */ subnets?: outputs.migrate.SubnetResourceSettingsResponse[]; /** * Gets or sets the Resource tags. */ tags?: { [key: string]: string; }; /** * Gets or sets the target resource group name. */ targetResourceGroupName?: string; /** * Gets or sets the target Resource name. */ targetResourceName?: string; } /** * Virtualization software settings. */ interface VirtualizationSoftwareSettingsResponse { /** * VMware cloud foundation license cost. */ vMwareCloudFoundationLicenseCost: number; } /** * Details on the total up-time for the VM. */ interface VmUptimeAssessmentsOperationResponse { /** * Number of days in a month for VM uptime. */ daysPerMonth?: number; /** * Number of hours per day for VM uptime. */ hoursPerDay?: number; } /** * Details on the total up-time for the VM. */ interface VmUptimeMachineAssessmentsV2OperationResponse { /** * Number of days in a month for VM uptime. */ daysPerMonth?: number; /** * Number of hours per day for VM uptime. */ hoursPerDay?: number; } interface VmUptimeResponse { /** * Number of days in a month for VM uptime. */ daysPerMonth?: number; /** * Number of hours per day for VM uptime. */ hoursPerDay?: number; } /** * Migration Wave Properties class. */ interface WavePropertiesResponse { /** * Actual start date of the wave. */ actualStartDate: string; /** * ARG query and other details to create workloads within a wave */ arg: outputs.migrate.ArgResponse; /** * Description of the wave. */ description?: string; /** * Display Name of the wave. */ displayName: string; /** * Planned completion date of the wave. */ plannedCompletionDate?: string; /** * Planned start date of the wave. */ plannedStartDate: string; /** * The status of the last operation. */ provisioningState: string; /** * The current stage of the wave. */ stage: string; /** * The status of the wave. */ status: string; } /** * Web app assessment settings class. */ interface WebAppAssessmentSettingsResponse { /** * App Service container settings. */ appSvcContainerSettings: outputs.migrate.AppSvcContainerSettingsResponse; /** * App Service native settings. */ appSvcNativeSettings: outputs.migrate.AppSvcNativeSettingsResponse; /** * Azure Location or Azure region where to which the machines will be migrated. */ azureLocation?: string; /** * Azure security offering type. */ azureSecurityOfferingType: string; /** * Gets or sets the billing settings. */ billingSettings?: outputs.migrate.BillingSettingsResponse; /** * Currency in which prices should be reported. */ currency?: string; /** * Custom discount percentage. */ discountPercentage?: number; /** * Gets or sets user configurable setting to display the environment type. */ environmentType?: string; /** * Gets or sets the performance data. */ performanceData?: outputs.migrate.PerformanceDataResponse; /** * Gets or sets the savings settings. */ savingsSettings?: outputs.migrate.SavingsSettingsResponse; /** * Percentage of buffer that user wants on performance metrics when recommending * Azure sizes. */ scalingFactor?: number; /** * Assessment sizing criterion. */ sizingCriterion?: string; } /** * WebApp assessment resource properties. */ interface WebAppAssessmentV3PropertiesResponse { /** * Gets or sets the details of the assessment. */ details?: outputs.migrate.AssessmentDetailsResponse; /** * Gets or sets the machine assessment ARM ID for VM fallback. */ fallbackMachineAssessmentArmId?: string; /** * The status of the last operation. */ provisioningState: string; /** * Gets or sets the scope of assessment. */ scope?: outputs.migrate.ScopeResponse; /** * Gets or sets the settings for the assessment. */ settings?: outputs.migrate.WebAppAssessmentSettingsResponse; } /** * Class for web application configurations. */ interface WebApplicationConfigurationResponse { /** * Gets or sets the configuration file path. */ filePath?: string; /** * Gets the ID. */ id: string; /** * Gets or sets the identifier for the configuration. */ identifier?: string; /** * Gets or sets a value indicating whether the configuration is edited or not by the user. */ isDeploymentTimeEditable?: boolean; /** * Gets or sets the configuration local file path. */ localFilePath?: string; /** * Gets or sets the configuration name. */ name?: string; secretStoreDetails?: outputs.migrate.SecretStoreDetailsResponse; /** * Gets or sets the configuration section in the file. */ section?: string; /** * Gets or sets the configuration target file path. */ targetFilePath?: string; /** * Gets or sets the configuration type. */ type?: string; /** * Gets or sets the configuration value. */ value?: string; } /** * WebApplication directory structure. */ interface WebApplicationDirectoryResponse { /** * Gets the unique id corresponding to the application directory. */ id: string; /** * Gets or sets a value indicating whether the directory object is editable. * True when the directory is added as an optional directory, false when discovery is done * manually. */ isEditable?: boolean; /** * Gets or sets the paths of the directory on the source machine. */ sourcePaths?: string[]; /** * Gets or sets the size of the directory on the source machine. */ sourceSize?: string; /** * Storage profile for the directory on the target container. */ storageProfile?: outputs.migrate.TargetStorageProfileResponse; } /** * Framework specific data for a web application. */ interface WebApplicationFrameworkResponse { /** * Gets the ID. */ id: string; /** * Gets or sets Name of the framework. */ name?: string; /** * Gets or sets Version of the framework. */ version?: string; } /** * Windows Server licensing settings. */ interface WindowsServerLicensingSettingsResponse { /** * Licence Cost. */ licenseCost: number; /** * Licenses per core. */ licensesPerCore: number; /** * Software assurance (SA) cost. */ softwareAssuranceCost: number; } /** * Workload deployment model properties. */ interface WorkloadDeploymentModelPropertiesResponse { /** * Gets or sets the allowed scenarios on the workload deployment. */ allowedOperations: string[]; /** * Gets or sets the workload deployment correlation Id. */ correlationId: string; currentJob: outputs.migrate.WorkloadDeploymentModelPropertiesResponseCurrentJob; /** * Workload deployment model custom properties. */ customProperties?: outputs.migrate.ApacheTomcatAKSWorkloadDeploymentModelCustomPropertiesResponse | outputs.migrate.IISAKSWorkloadDeploymentModelCustomPropertiesResponse; /** * Gets or sets the display name. */ displayName?: string; /** * Gets or sets the list of health errors. */ healthErrors: outputs.migrate.HealthErrorModelResponse[]; /** * Gets or sets the Last successful unplanned migrate time. */ lastSuccessfulMigrateTime: string; /** * Gets or sets the Last successful test migrate time. */ lastSuccessfulTestMigrateTime: string; /** * Gets or sets the migrate state. */ migrationStatus: string; /** * Gets or sets the migrate state description. */ migrationStatusDescription: string; /** * Gets or sets the provisioning state of the workload deployment. */ provisioningState: string; /** * Gets or sets the workload deployment status. */ status: string; /** * Gets or sets the workload deployment status description. */ statusDescription: string; /** * Gets or sets the deployment target platform. */ targetPlatform?: string; /** * Gets or sets the test migrate state. */ testMigrationStatus: string; /** * Gets or sets the Test migrate state description. */ testMigrationStatusDescription: string; /** * Workload instance model properties. */ workloadInstanceProperties?: outputs.migrate.WorkloadInstanceModelPropertiesResponse; } interface WorkloadDeploymentModelPropertiesResponseCurrentJob { /** * Gets or sets the workflow friendly display name. */ displayName: string; /** * Gets or sets end time of the workflow. */ endTime: string; /** * Gets or sets workflow Id. */ id: string; /** * Gets or sets workflow name. */ name: string; /** * Gets or sets workload scenario name. */ scenarioName: string; /** * Gets or sets start time of the workflow. */ startTime: string; /** * Gets or sets workflow state. */ state: string; } interface WorkloadDeploymentModelResponseSystemData { /** * Gets or sets the timestamp of resource creation (UTC). */ createdAt?: string; /** * Gets or sets identity that created the resource. */ createdBy?: string; /** * Gets or sets the type of identity that created the resource: user, application, * managedIdentity. */ createdByType?: string; /** * Gets or sets the timestamp of resource last modification (UTC). */ lastModifiedAt?: string; /** * Gets or sets the identity that last modified the resource. */ lastModifiedBy?: string; /** * Gets or sets the type of identity that last modified the resource: user, application, * managedIdentity. */ lastModifiedByType?: string; } /** * Workload instance model properties. */ interface WorkloadInstanceModelPropertiesResponse { /** * Gets or sets the allowed scenarios on the workload instance. */ allowedOperations: string[]; currentJob: outputs.migrate.WorkloadInstanceModelPropertiesResponseCurrentJob; /** * Workload instance model custom properties. */ customProperties?: outputs.migrate.ApacheTomcatWorkloadInstanceModelCustomPropertiesResponse | outputs.migrate.IISWorkloadInstanceModelCustomPropertiesResponse; /** * Gets or sets the display name. */ displayName?: string; /** * Gets or sets the list of health errors. */ healthErrors: outputs.migrate.HealthErrorModelResponse[]; /** * Gets or sets the Last successful replication cycle time. */ lastSuccessfulReplicationCycleTime: string; /** * Gets or Sets the master site name. */ masterSiteName?: string; /** * Gets or sets the migrate agent id associated with the workload instance. */ migrateAgentId?: string; /** * Gets or sets the workload instance name. */ name?: string; /** * Gets or sets the provisioning state of the workload instance. */ provisioningState: string; /** * Gets or sets the replication health of the workload instance. */ replicationHealth: string; /** * Gets or sets the replication state of the workload instance. */ replicationStatus: string; /** * Gets or sets the workload replication state description. */ replicationStatusDescription: string; /** * Gets or sets the source name. */ sourceName?: string; /** * Gets or sets the source platform. */ sourcePlatform?: string; } interface WorkloadInstanceModelPropertiesResponseCurrentJob { /** * Gets or sets the workflow friendly display name. */ displayName: string; /** * Gets or sets end time of the workflow. */ endTime: string; /** * Gets or sets workflow Id. */ id: string; /** * Gets or sets workflow name. */ name: string; /** * Gets or sets workload scenario name. */ scenarioName: string; /** * Gets or sets start time of the workflow. */ startTime: string; /** * Gets or sets workflow state. */ state: string; } interface WorkloadInstanceModelResponseSystemData { /** * Gets or sets the timestamp of resource creation (UTC). */ createdAt?: string; /** * Gets or sets identity that created the resource. */ createdBy?: string; /** * Gets or sets the type of identity that created the resource: user, application, * managedIdentity. */ createdByType?: string; /** * Gets or sets the timestamp of resource last modification (UTC). */ lastModifiedAt?: string; /** * Gets or sets the identity that last modified the resource. */ lastModifiedBy?: string; /** * Gets or sets the type of identity that last modified the resource: user, application, * managedIdentity. */ lastModifiedByType?: string; } } export declare namespace mission { /** * ApprovalSettings Properties */ interface ApprovalSettingsResponse { /** * Approval required for enclave connection creation (Required or NotRequired). */ connectionCreation?: string; /** * Approval required for enclave connection deletion (Required or NotRequired). */ connectionDeletion?: string; /** * Approval required for enclave connection update (Required or NotRequired). */ connectionUpdate?: string; /** * Approval required for virtual enclave creation (Required or NotRequired). */ enclaveCreation?: string; /** * Approval required for virtual enclave deletion (Required or NotRequired). */ enclaveDeletion?: string; /** * Approval required for endpoint creation (Required or NotRequired). */ endpointCreation?: string; /** * Approval required for endpoint deletion (Required or NotRequired). */ endpointDeletion?: string; /** * Approval required for endpoint update (Required or NotRequired). */ endpointUpdate?: string; /** * Approval required for toggling maintenance mode (Required or NotRequired). */ maintenanceMode?: string; /** * List of mandatory approvers for the approval request */ mandatoryApprovers?: outputs.mission.MandatoryApproverResponse[]; /** * Minimum number of approvers required for the approval request */ minimumApproversRequired?: number; /** * Notification will be sent on any action taken (Approve/Reject) on an Approval Request */ notificationOnApprovalAction?: string; /** * Notification will be sent on creation of an Approval Request */ notificationOnApprovalCreation?: string; /** * Notification will be sent on deletion of an Approval Request */ notificationOnApprovalDeletion?: string; /** * Approval required for deploying service catalog templates (Required or NotRequired). */ serviceCatalogDeployment?: string; } /** * Approver Metadata for approvals request. */ interface ApproverResponse { /** * Action Performed by approver */ actionPerformed?: string; /** * Entra ObjectID of the approver */ approverEntraId: string; /** * approval request last updated at */ lastUpdatedAt: string; } /** * Base type for destination rules. */ interface CommunityEndpointDestinationRuleResponse { /** * Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. */ destination?: string; /** * Destination Type. */ destinationType?: string; /** * Endpoint Rule Name. */ endpointRuleName?: string; /** * Port. Can include multiple ports separated by commas or a range indicated by a hyphen. */ ports?: string; /** * Protocols. Options specified by Endpoint Protocol Enum. */ protocols?: string[]; /** * Transit Hub Resource Id. */ transitHubResourceId?: string; } /** * Enclave Address Spaces */ interface EnclaveAddressSpacesModelResponse { /** * Enclave Address Space */ enclaveAddressSpace?: string; /** * Managed Address Space */ managedAddressSpace?: string; } /** * Virtual Enclave Default Settings */ interface EnclaveDefaultSettingsModelResponse { /** * Diagnostic Destination. */ diagnosticDestination?: string; /** * Key Vault Resource Id. */ keyVaultResourceId: string; /** * Log Analytics Resource Ids. */ logAnalyticsResourceIdCollection: string[]; /** * Storage Account Resource Id. */ storageAccountResourceId: string; } /** * enclaveDefaultSettingsModelResponseProvideDefaults sets the appropriate defaults for EnclaveDefaultSettingsModelResponse */ function enclaveDefaultSettingsModelResponseProvideDefaults(val: EnclaveDefaultSettingsModelResponse): EnclaveDefaultSettingsModelResponse; /** * Enclave Endpoint Rule Properties */ interface EnclaveEndpointDestinationRuleResponse { /** * Destination address. Can include multiple CIDR/IP Addresses or fqdn tags or fqdns (for community endpoint) separated by commas. */ destination?: string; /** * Endpoint Rule Name. */ endpointRuleName?: string; /** * Port. Can include multiple ports separated by commas or a range indicated by a hyphen. */ ports?: string; /** * Protocols. Options specified by Endpoint Protocol Enum. */ protocols?: string[]; } /** * Enclave Virtual Network Properties */ interface EnclaveVirtualNetworkModelResponse { /** * Allow Subnet Communication. */ allowSubnetCommunication?: boolean; /** * Custom CIDR Range. */ customCidrRange?: string; /** * Network Name. */ networkName?: string; /** * Network Size. */ networkSize?: string; /** * Subnet Configurations. */ subnetConfigurations?: outputs.mission.SubnetConfigurationResponse[]; } /** * enclaveVirtualNetworkModelResponseProvideDefaults sets the appropriate defaults for EnclaveVirtualNetworkModelResponse */ function enclaveVirtualNetworkModelResponseProvideDefaults(val: EnclaveVirtualNetworkModelResponse): EnclaveVirtualNetworkModelResponse; /** * GovernedServiceItem Properties */ interface GovernedServiceItemResponse { /** * Initiative enforcement (Enabled or Disabled). */ enforcement?: string; /** * Initiatives associated with this service. */ initiatives: string[]; /** * Governance option for this service (Allow, Deny, ExceptionOnly, or NotApplicable). */ option?: string; /** * Enforcement mode for policy. AuditOnly, Enforce, or None. */ policyAction?: string; /** * Service ID */ serviceId: string; /** * Service name. */ serviceName: string; } /** * Maintenance Mode */ interface MaintenanceModeConfigurationModelResponse { /** * Justification for entering or exiting Maintenance Mode */ justification?: string; /** * Current mode of Maintenance Mode Configuration */ mode: string; /** * The user, group or service principal object affected by Maintenance Mode */ principals?: outputs.mission.PrincipalResponse[]; } /** * maintenanceModeConfigurationModelResponseProvideDefaults sets the appropriate defaults for MaintenanceModeConfigurationModelResponse */ function maintenanceModeConfigurationModelResponseProvideDefaults(val: MaintenanceModeConfigurationModelResponse): MaintenanceModeConfigurationModelResponse; /** * Managed-On-Behalf-Of configuration properties. This configuration exists for the resources where a resource provider manages those resources on behalf of the resource owner. */ interface ManagedOnBehalfOfConfigurationResponse { /** * Managed-On-Behalf-Of broker resources */ moboBrokerResources?: outputs.mission.MoboBrokerResourceResponse[]; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.mission.UserAssignedIdentityResponse; }; } /** * Approver Metadata for approvals request. */ interface MandatoryApproverResponse { /** * EntraId of the approver */ approverEntraId: string; } /** * Managed-On-Behalf-Of broker resource. This resource is created by the Resource Provider to manage some resources on behalf of the user. */ interface MoboBrokerResourceResponse { /** * Resource identifier of a Managed-On-Behalf-Of broker resource */ id?: string; } /** * Principal for maintenance mode or role assignments */ interface PrincipalResponse { /** * The object id associated with the principal */ id: string; /** * The type of the object id. We currently allow users, groups, and service principals */ type: string; } /** * Request Metadata for approvals request. */ interface RequestMetadataResponse { /** * Payload to be sent upon any action on approval request */ approvalCallbackPayload?: string; /** * Route name for the approval callback */ approvalCallbackRoute?: string; /** * Status of the approval. Uses ApprovalStatus enum. */ approvalStatus?: string; /** * Resource Action of the item being approved or declined. */ resourceAction: string; } /** * requestMetadataResponseProvideDefaults sets the appropriate defaults for RequestMetadataResponse */ function requestMetadataResponseProvideDefaults(val: RequestMetadataResponse): RequestMetadataResponse; /** * Role assignment item that indicates which principals should be assigned this role definition */ interface RoleAssignmentItemResponse { /** * List of principal IDs to which to assign this role definition */ principals?: outputs.mission.PrincipalResponse[]; /** * Role definition identifier */ roleDefinitionId: string; } /** * Subnet Configuration */ interface SubnetConfigurationResponse { /** * Address prefix. */ addressPrefix: string; /** * Network prefix size. */ networkPrefixSize: number; /** * Network security group ID. */ networkSecurityGroupResourceId: string; /** * Subnet delegation. */ subnetDelegation?: string; /** * Subnet name. */ subnetName: string; /** * Subnet Resource ID. */ subnetResourceId: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * TransitOptionParams Properties */ interface TransitOptionParamsResponse { /** * Transit Option Params remoteVirtualNetworkId. */ remoteVirtualNetworkId?: string; /** * Transit Option Params scaleUnits. */ scaleUnits?: number; } /** * TransitOption Properties */ interface TransitOptionResponse { /** * Transit Option Params */ params?: outputs.mission.TransitOptionParamsResponse; /** * Transit Option Type. */ type?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace mongocluster { /** * The local administrator login properties. */ interface AdministratorPropertiesResponse { /** * The administrator user name. */ userName?: string; } /** * The backup properties of the cluster. This includes the earliest restore time and retention settings. */ interface BackupPropertiesResponse { /** * Earliest restore timestamp in UTC ISO8601 format. */ earliestRestoreTime: string; } /** * The compute properties of the cluster. This includes the virtual-cores/memory and scaling options applied to servers in the cluster. */ interface ComputePropertiesResponse { /** * The compute tier to assign to the cluster, where each tier maps to a virtual-core and memory size. Example values: 'M30', 'M40'. */ tier?: string; } /** * Connection string for the mongo cluster */ interface ConnectionStringResponse { /** * Value of the connection string */ connectionString: string; /** * Description of the connection string */ description: string; /** * Name of the connection string. */ name: string; } /** * Database role definition that is assigned to a user. */ interface DatabaseRoleResponse { /** * Database scope that the role is assigned to. */ db: string; /** * The role that is assigned to the user on the database scope. */ role: string; } /** * Microsoft Entra ID provider properties. */ interface EntraIdentityProviderPropertiesResponse { /** * The principal type of the user. */ principalType: string; } /** * Defines a Microsoft Entra ID Mongo user. */ interface EntraIdentityProviderResponse { /** * The Entra identity properties for the user. */ properties: outputs.mongocluster.EntraIdentityProviderPropertiesResponse; /** * Identity provider types that a a user identity can belong to. * Expected value is 'MicrosoftEntraID'. */ type: "MicrosoftEntraID"; } /** * The properties of a mongo cluster firewall rule. */ interface FirewallRulePropertiesResponse { /** * The end IP address of the mongo cluster firewall rule. Must be IPv4 format. */ endIpAddress: string; /** * The provisioning state of the firewall rule. */ provisioningState: string; /** * The start IP address of the mongo cluster firewall rule. Must be IPv4 format. */ startIpAddress: string; } /** * The high availability properties of the cluster. */ interface HighAvailabilityPropertiesResponse { /** * The target high availability mode requested for the cluster. */ targetMode?: string; } /** * The properties of a mongo cluster. */ interface MongoClusterPropertiesResponse { /** * The local administrator properties for the mongo cluster. */ administrator?: outputs.mongocluster.AdministratorPropertiesResponse; /** * The backup properties of the mongo cluster. */ backup?: outputs.mongocluster.BackupPropertiesResponse; /** * The status of the mongo cluster. */ clusterStatus: string; /** * The compute properties of the mongo cluster. */ compute?: outputs.mongocluster.ComputePropertiesResponse; /** * The default mongo connection string for the cluster. */ connectionString: string; /** * The high availability properties of the mongo cluster. */ highAvailability?: outputs.mongocluster.HighAvailabilityPropertiesResponse; /** * The infrastructure version the cluster is provisioned on. */ infrastructureVersion: string; /** * List of private endpoint connections. */ previewFeatures?: string[]; /** * List of private endpoint connections. */ privateEndpointConnections: outputs.mongocluster.PrivateEndpointConnectionResponse[]; /** * The provisioning state of the mongo cluster. */ provisioningState: string; /** * Whether or not public endpoint access is allowed for this mongo cluster. */ publicNetworkAccess?: string; /** * The replication properties for the mongo cluster */ replica: outputs.mongocluster.ReplicationPropertiesResponse; /** * The Mongo DB server version. Defaults to the latest available version if not specified. */ serverVersion?: string; /** * The sharding properties of the mongo cluster. */ sharding?: outputs.mongocluster.ShardingPropertiesResponse; /** * The storage properties of the mongo cluster. */ storage?: outputs.mongocluster.StoragePropertiesResponse; } /** * Properties of the private endpoint connection. */ interface PrivateEndpointConnectionPropertiesResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * The private endpoint resource. */ privateEndpoint?: outputs.mongocluster.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.mongocluster.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; } /** * The private endpoint connection resource. */ interface PrivateEndpointConnectionResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint resource. */ privateEndpoint?: outputs.mongocluster.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.mongocluster.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.mongocluster.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Replica properties of the mongo cluster. */ interface ReplicationPropertiesResponse { /** * The replication link state of the replica cluster. */ replicationState: string; /** * The replication role of the cluster */ role: string; /** * The resource id the source cluster for the replica cluster. */ sourceResourceId: string; } /** * The sharding properties of the cluster. This includes the shard count and scaling options for the cluster. */ interface ShardingPropertiesResponse { /** * Number of shards to provision on the cluster. */ shardCount?: number; } /** * The storage properties of the cluster. This includes the data storage size and scaling applied to servers in the cluster. */ interface StoragePropertiesResponse { /** * The size of the data disk assigned to each server. */ sizeGb?: number; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Definition of Mongo user resource on a cluster. */ interface UserPropertiesResponse { /** * The user's identity provider definition. */ identityProvider?: outputs.mongocluster.EntraIdentityProviderResponse; /** * The provisioning state of the user. */ provisioningState: string; /** * Database roles that are assigned to the user. */ roles?: outputs.mongocluster.DatabaseRoleResponse[]; } } export declare namespace monitor { /** * Properties that define the scope private link mode settings exclusion item. This setting applies to a specific private endpoint connection and overrides the default settings for that private endpoint connection. */ interface AccessModeSettingsExclusionResponse { /** * Specifies the access mode of ingestion through the specified private endpoint connection in the exclusion. */ ingestionAccessMode?: string; /** * The private endpoint connection name associated to the private endpoint on which we want to apply the specific access mode settings. */ privateEndpointConnectionName?: string; /** * Specifies the access mode of queries through the specified private endpoint connection in the exclusion. */ queryAccessMode?: string; } /** * Properties that define the scope private link mode settings. */ interface AccessModeSettingsResponse { /** * List of exclusions that override the default access mode settings for specific private endpoint connections. */ exclusions?: outputs.monitor.AccessModeSettingsExclusionResponse[]; /** * Specifies the default access mode of ingestion through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array. */ ingestionAccessMode: string; /** * Specifies the default access mode of queries through associated private endpoints in scope. If not specified default value is 'Open'. You can override this default setting for a specific private endpoint connection by adding an exclusion in the 'exclusions' array. */ queryAccessMode: string; } /** * A pointer to an Azure Action Group. */ interface ActionGroupResponse { /** * The resource ID of the Action Group. This cannot be null or empty. */ actionGroupId: string; /** * the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload. */ webhookProperties?: { [key: string]: string; }; } /** * A list of Activity Log Alert rule actions. */ interface ActionListResponse { /** * The list of the Action Groups. */ actionGroups?: outputs.monitor.ActionGroupResponse[]; } /** * Actions to invoke when the alert fires. */ interface ActionsResponse { /** * Action Group resource Ids to invoke when the alert fires. */ actionGroups?: string[]; /** * The properties of an action properties. */ actionProperties?: { [key: string]: string; }; /** * The properties of an alert payload. */ customProperties?: { [key: string]: string; }; } /** * Alert configuration details */ interface AlertConfigurationResponse { /** * Optional list of action group resource IDs to be notified when the alert is triggered. */ actionGroupIds?: string[]; /** * The alert rule description. */ description?: string; /** * The severity of triggered alert. */ severity: string; } /** * An Activity Log Alert rule condition that is met when all its member conditions are met. */ interface AlertRuleAllOfConditionResponse { /** * The list of Activity Log Alert rule conditions. */ allOf: outputs.monitor.AlertRuleAnyOfOrLeafConditionResponse[]; } /** * An Activity Log Alert rule condition that is met when all its member conditions are met. * Each condition can be of one of the following types: * __Important__: Each type has its unique subset of properties. Properties from different types CANNOT exist in one condition. * * __Leaf Condition -__ must contain 'field' and either 'equals' or 'containsAny'. * _Please note, 'anyOf' should __not__ be set in a Leaf Condition._ * * __AnyOf Condition -__ must contain __only__ 'anyOf' (which is an array of Leaf Conditions). * _Please note, 'field', 'equals' and 'containsAny' should __not__ be set in an AnyOf Condition._ */ interface AlertRuleAnyOfOrLeafConditionResponse { /** * An Activity Log Alert rule condition that is met when at least one of its member leaf conditions are met. */ anyOf?: outputs.monitor.AlertRuleLeafConditionResponse[]; /** * The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met. */ containsAny?: string[]; /** * The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met. */ equals?: string; /** * The name of the Activity Log event's field that this condition will examine. * The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'. */ field?: string; } /** * An Activity Log Alert rule condition that is met by comparing the field and value of an Activity Log event. * This condition must contain 'field' and either 'equals' or 'containsAny'. */ interface AlertRuleLeafConditionResponse { /** * The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met. */ containsAny?: string[]; /** * The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met. */ equals?: string; /** * The name of the Activity Log event's field that this condition will examine. * The possible values for this field are (case-insensitive): 'resourceId', 'category', 'caller', 'level', 'operationName', 'resourceGroup', 'resourceProvider', 'status', 'subStatus', 'resourceType', or anything beginning with 'properties'. */ field?: string; } /** * Represents an Azure Monitor Workspace (AMW) account used for emitting metrics. */ interface AmwAccountResponse { /** * The ARM resource ID of the managed identity with access to the source account. */ identity: string; /** * The ARM resource ID of the account where metrics are emitted. */ resourceId: string; } /** * Discovery rule properties for an Application Insights topology query */ interface ApplicationInsightsTopologyDiscoveryRulePropertiesResponse { /** * Whether to add all recommended signals to the discovered entities. */ addRecommendedSignals: string; /** * Application Insights resource ID */ applicationInsightsResourceId: string; /** * Reference to the name of the authentication setting which is used for querying Azure Resource Graph. The same authentication setting will also be assigned to any discovered entities. */ authenticationSetting: string; /** * Date when the discovery rule was (soft-)deleted. */ deletionDate: string; /** * Whether to create relationships between the discovered entities based on a set of built-in rules. These relationships cannot be manually deleted. */ discoverRelationships: string; /** * Discovery rule relationship discovery behavior * Expected value is 'ApplicationInsightsTopology'. */ discoveryRuleKind: "ApplicationInsightsTopology"; /** * Display name */ displayName?: string; /** * Name of the entity which represents the discovery rule. Note: It might take a few minutes after creating the discovery rule until the entity is created. */ entityName: string; /** * Error details if the last discovery operation failed. */ error: outputs.monitor.DiscoveryErrorResponse; /** * The status of the last operation. */ provisioningState: string; } /** * An arm role receiver. */ interface ArmRoleReceiverResponse { /** * The name of the arm role receiver. Names must be unique across all receivers within an action group. */ name: string; /** * The arm role id. */ roleId: string; /** * Indicates whether to use common alert schema. */ useCommonAlertSchema?: boolean; } /** * armRoleReceiverResponseProvideDefaults sets the appropriate defaults for ArmRoleReceiverResponse */ function armRoleReceiverResponseProvideDefaults(val: ArmRoleReceiverResponse): ArmRoleReceiverResponse; /** * The Azure Automation Runbook notification receiver. */ interface AutomationRunbookReceiverResponse { /** * The Azure automation account Id which holds this runbook and authenticate to Azure resource. */ automationAccountId: string; /** * Indicates whether this instance is global runbook. */ isGlobalRunbook: boolean; /** * The principal id of the managed identity. The value can be "None", "SystemAssigned" */ managedIdentity?: string; /** * Indicates name of the webhook. */ name?: string; /** * The name for this runbook. */ runbookName: string; /** * The URI where webhooks should be sent. */ serviceUri?: string; /** * Indicates whether to use common alert schema. */ useCommonAlertSchema?: boolean; /** * The resource id for webhook linked to this runbook. */ webhookResourceId: string; } /** * automationRunbookReceiverResponseProvideDefaults sets the appropriate defaults for AutomationRunbookReceiverResponse */ function automationRunbookReceiverResponseProvideDefaults(val: AutomationRunbookReceiverResponse): AutomationRunbookReceiverResponse; /** * Autoscale notification. */ interface AutoscaleNotificationResponse { /** * the email notification. */ email?: outputs.monitor.EmailNotificationResponse; /** * the operation associated with the notification and its value must be "scale" */ operation: string; /** * the collection of webhook notifications. */ webhooks?: outputs.monitor.WebhookNotificationResponse[]; } /** * autoscaleNotificationResponseProvideDefaults sets the appropriate defaults for AutoscaleNotificationResponse */ function autoscaleNotificationResponseProvideDefaults(val: AutoscaleNotificationResponse): AutoscaleNotificationResponse; /** * Autoscale profile. */ interface AutoscaleProfileResponse { /** * the number of instances that can be used during this profile. */ capacity: outputs.monitor.ScaleCapacityResponse; /** * the specific date-time for the profile. This element is not used if the Recurrence element is used. */ fixedDate?: outputs.monitor.TimeWindowResponse; /** * the name of the profile. */ name: string; /** * the repeating times at which this profile begins. This element is not used if the FixedDate element is used. */ recurrence?: outputs.monitor.RecurrenceResponse; /** * the collection of rules that provide the triggers and parameters for the scaling action. A maximum of 10 rules can be specified. */ rules: outputs.monitor.ScaleRuleResponse[]; } /** * A setting that contains all of the configuration for the automatic scaling of a resource. */ interface AutoscaleSettingResponse { /** * the enabled flag. Specifies whether automatic scaling is enabled for the resource. The default value is 'false'. */ enabled?: boolean; /** * the name of the autoscale setting. */ name?: string; /** * the collection of notifications. */ notifications?: outputs.monitor.AutoscaleNotificationResponse[]; /** * the predictive autoscale policy mode. */ predictiveAutoscalePolicy?: outputs.monitor.PredictiveAutoscalePolicyResponse; /** * the collection of automatic scaling profiles that specify different scaling parameters for different time periods. A maximum of 20 profiles can be specified. */ profiles: outputs.monitor.AutoscaleProfileResponse[]; /** * the location of the resource that the autoscale setting should be added to. */ targetResourceLocation?: string; /** * the resource identifier of the resource that the autoscale setting should be added to. */ targetResourceUri?: string; } /** * autoscaleSettingResponseProvideDefaults sets the appropriate defaults for AutoscaleSettingResponse */ function autoscaleSettingResponseProvideDefaults(val: AutoscaleSettingResponse): AutoscaleSettingResponse; /** * The Azure mobile App push notification receiver. */ interface AzureAppPushReceiverResponse { /** * The email address registered for the Azure mobile app. */ emailAddress: string; /** * The name of the Azure mobile app push receiver. Names must be unique across all receivers within an action group. */ name: string; } /** * An azure function receiver. */ interface AzureFunctionReceiverResponse { /** * The azure resource id of the function app. */ functionAppResourceId: string; /** * The function name in the function app. */ functionName: string; /** * The http trigger url where http request sent to. */ httpTriggerUrl: string; /** * The principal id of the managed identity. The value can be "None", "SystemAssigned" */ managedIdentity?: string; /** * The name of the azure function receiver. Names must be unique across all receivers within an action group. */ name: string; /** * Indicates whether to use common alert schema. */ useCommonAlertSchema?: boolean; } /** * azureFunctionReceiverResponseProvideDefaults sets the appropriate defaults for AzureFunctionReceiverResponse */ function azureFunctionReceiverResponseProvideDefaults(val: AzureFunctionReceiverResponse): AzureFunctionReceiverResponse; /** * Azure Monitor Workspace Logs Api configurations. */ interface AzureMonitorWorkspaceLogsApiConfigResponse { /** * Data collection endpoint ingestion url. */ dataCollectionEndpointUrl: string; /** * Data Collection Rule (DCR) immutable id. */ dataCollectionRule: string; /** * The schema mapping for incoming data. */ schema: outputs.monitor.SchemaMapResponse; /** * Stream name in destination. Azure Monitor stream is related to the destination table. */ stream: string; } /** * Azure Monitor Workspace Logs specific configurations. */ interface AzureMonitorWorkspaceLogsExporterResponse { /** * API configurations for Azure Monitor workspace exporter. */ api: outputs.monitor.AzureMonitorWorkspaceLogsApiConfigResponse; /** * Cache configurations. */ cache?: outputs.monitor.CacheConfigurationResponse; /** * Concurrency configuration for the exporter. */ concurrency?: outputs.monitor.ConcurrencyConfigurationResponse; } /** * azureMonitorWorkspaceLogsExporterResponseProvideDefaults sets the appropriate defaults for AzureMonitorWorkspaceLogsExporterResponse */ function azureMonitorWorkspaceLogsExporterResponseProvideDefaults(val: AzureMonitorWorkspaceLogsExporterResponse): AzureMonitorWorkspaceLogsExporterResponse; /** * The Data Collection Rule and Endpoint used for ingestion by default. */ interface AzureMonitorWorkspaceResponseDefaultIngestionSettings { /** * The Azure resource Id of the default data collection endpoint for this Azure Monitor Workspace. */ dataCollectionEndpointResourceId: string; /** * The Azure resource Id of the default data collection rule for this Azure Monitor Workspace. */ dataCollectionRuleResourceId: string; } /** * Properties related to the metrics container in the Azure Monitor Workspace */ interface AzureMonitorWorkspaceResponseMetrics { /** * An internal identifier for the metrics container. Only to be used by the system */ internalId: string; /** * The Prometheus query endpoint for the Azure Monitor Workspace */ prometheusQueryEndpoint: string; } /** * A grouping of signal assignments for a Azure Monitor Workspace */ interface AzureMonitorWorkspaceSignalGroupResponse { /** * Reference to the name of the authentication setting which is used for querying the data source */ authenticationSetting: string; /** * Azure Monitor workspace resource ID */ azureMonitorWorkspaceResourceId: string; /** * Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. */ signalAssignments?: outputs.monitor.SignalAssignmentResponse[]; } /** * A grouping of signal assignments for an Azure resource */ interface AzureResourceSignalGroupResponse { /** * Reference to the name of the authentication setting which is used for querying the data source */ authenticationSetting: string; /** * Azure resource ID */ azureResourceId: string; /** * Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. */ signalAssignments?: outputs.monitor.SignalAssignmentResponse[]; } /** * Defines the properties of a baseline. */ interface BaselinePropertiesResponse { /** * Defines the baseline target, which is compared against the SLI value to determine compliance. */ baseline: outputs.monitor.BaselineResponse; } /** * Defines the target parameters for a Slo baseline. */ interface BaselineResponse { /** * Specifies how evaluation is calculated, either based on calendar days or a rolling window. */ evaluationCalculationType: string; /** * The time frame (in days) used for SLI evaluation. */ evaluationPeriodDays: number; /** * The user-defined or Azure-defined target value used for comparison against the SLI value. */ value: number; } /** * Batch processor. */ interface BatchProcessorResponse { /** * Size of the batch. */ batchSize?: number; /** * Timeout in milliseconds. */ timeout?: number; } /** * batchProcessorResponseProvideDefaults sets the appropriate defaults for BatchProcessorResponse */ function batchProcessorResponseProvideDefaults(val: BatchProcessorResponse): BatchProcessorResponse; /** * Cache configurations. */ interface CacheConfigurationResponse { /** * Max storage usage in megabytes. */ maxStorageUsage?: number; /** * Retention period in minutes. */ retentionPeriod?: number; } /** * Definition of custom data column. */ interface ColumnDefinitionResponse { /** * The name of the column. */ name?: string; /** * The type of the column data. */ type?: string; } /** * Concurrent publishing configuration. */ interface ConcurrencyConfigurationResponse { /** * Size of the queue for log batches. */ batchQueueSize?: number; /** * Number of parallel workers processing the log queues. */ workerCount?: number; } /** * concurrencyConfigurationResponseProvideDefaults sets the appropriate defaults for ConcurrencyConfigurationResponse */ function concurrencyConfigurationResponseProvideDefaults(val: ConcurrencyConfigurationResponse): ConcurrencyConfigurationResponse; /** * A condition of the scheduled query rule. */ interface ConditionResponse { /** * The extent of deviation required to trigger an alert. Allowed values are 'Low', 'Medium' and 'High'. This will affect how tight the threshold is to the metric series pattern. Relevant only for dynamic threshold rules of the kind LogAlert. */ alertSensitivity?: string; /** * Specifies the type of threshold criteria */ criterionType?: string; /** * List of Dimensions conditions. Relevant only for rules of the kind LogAlert and LogToMetric. */ dimensions?: outputs.monitor.DimensionResponse[]; /** * The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert. */ failingPeriods?: outputs.monitor.ConditionResponseFailingPeriods; /** * Use this option to set the date from which to start learning the metric historical data and calculate the dynamic thresholds (in ISO8601 format). Relevant only for dynamic threshold rules of the kind LogAlert. */ ignoreDataBefore?: string; /** * The column containing the metric measure number. Relevant only for rules of the kind LogAlert. */ metricMeasureColumn?: string; /** * The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric. */ metricName?: string; /** * The minimum results count that should be found for triggering an alert. Relevant only for rules of the kind SimpleLogAlert. */ minRecurrenceCount?: number; /** * The criteria operator. Relevant and required only for rules of the kind LogAlert. */ operator?: string; /** * Log query alert */ query?: string; /** * The column containing the resource id. The content of the column must be a uri formatted as resource id. Relevant only for rules of the kind LogAlert. */ resourceIdColumn?: string; /** * the criteria threshold value that activates the alert. Relevant and required only for static threshold rules of the kind LogAlert. */ threshold?: number; /** * Aggregation type. Relevant and required only for rules of the kind LogAlert. */ timeAggregation?: string; } /** * conditionResponseProvideDefaults sets the appropriate defaults for ConditionResponse */ function conditionResponseProvideDefaults(val: ConditionResponse): ConditionResponse; /** * The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert. */ interface ConditionResponseFailingPeriods { /** * The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1 */ minFailingPeriodsToAlert?: number; /** * The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1 */ numberOfEvaluationPeriods?: number; } /** * conditionResponseFailingPeriodsProvideDefaults sets the appropriate defaults for ConditionResponseFailingPeriods */ function conditionResponseFailingPeriodsProvideDefaults(val: ConditionResponseFailingPeriods): ConditionResponseFailingPeriods; /** * Represents a filtering condition. */ interface ConditionSliResponse { /** * Dimension name used in filtering. */ dimensionName?: string; /** * Operator used in the filtering condition. */ operator: string; /** * Defines the sampling type. */ samplingType?: string; /** * Scalar function applied for filtering. */ scalarFunction?: string; /** * Value used in filtering. For most operators (eq, ne, lt, lte, gt, gte, startswith, notstartswith, contains, notcontains) this is a single value (for example "GetContosoUsers"). For the `in` and `notin` operators, multiple values must be joined by the delimiter `^^` (for example "east^^west^^north"). */ value: string; } /** * Managed service identity of the resource. */ interface DataCollectionEndpointResourceResponseIdentity { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.monitor.UserAssignedIdentityResponse; }; } /** * Metadata pertaining to creation and last modification of the resource. */ interface DataCollectionEndpointResourceResponseSystemData { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The endpoint used by clients to access their configuration. */ interface DataCollectionEndpointResponseConfigurationAccess { /** * The endpoint. This property is READ-ONLY. */ endpoint: string; } /** * Failover configuration on this endpoint. This property is READ-ONLY. */ interface DataCollectionEndpointResponseFailoverConfiguration { /** * Active location where data flow will occur. */ activeLocation?: string; /** * Locations that are configured for failover. */ locations?: outputs.monitor.LocationSpecResponse[]; } /** * The endpoint used by clients to ingest logs. */ interface DataCollectionEndpointResponseLogsIngestion { /** * The endpoint. This property is READ-ONLY. */ endpoint: string; } /** * Metadata for the resource. This property is READ-ONLY. */ interface DataCollectionEndpointResponseMetadata { /** * Azure offering managing this resource on-behalf-of customer. */ provisionedBy: string; /** * Resource Id of azure offering managing this resource on-behalf-of customer. */ provisionedByResourceId: string; } /** * The endpoint used by clients to ingest metrics. */ interface DataCollectionEndpointResponseMetricsIngestion { /** * The endpoint. This property is READ-ONLY. */ endpoint: string; } /** * Network access control rules for the endpoints. */ interface DataCollectionEndpointResponseNetworkAcls { /** * The configuration to set whether network access from public internet to the endpoints are allowed. */ publicNetworkAccess?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface DataCollectionRuleAssociationProxyOnlyResourceResponseSystemData { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Metadata about the resource */ interface DataCollectionRuleAssociationResponseMetadata { /** * Azure offering managing this resource on-behalf-of customer. */ provisionedBy: string; /** * Resource Id of azure offering managing this resource on-behalf-of customer. */ provisionedByResourceId: string; } /** * Managed service identity of the resource. */ interface DataCollectionRuleResourceResponseIdentity { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.monitor.UserAssignedIdentityResponse; }; } /** * Metadata pertaining to creation and last modification of the resource. */ interface DataCollectionRuleResourceResponseSystemData { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The specification of data sources. * This property is optional and can be omitted if the rule is meant to be used via direct calls to the provisioned endpoint. */ interface DataCollectionRuleResponseDataSources { /** * Specifications of pull based data sources */ dataImports?: outputs.monitor.DataSourcesSpecResponseDataImports; /** * The list of Azure VM extension data source configurations. */ extensions?: outputs.monitor.ExtensionDataSourceResponse[]; /** * The list of IIS logs source configurations. */ iisLogs?: outputs.monitor.IisLogsDataSourceResponse[]; /** * The list of Log files source configurations. */ logFiles?: outputs.monitor.LogFilesDataSourceResponse[]; /** * The list of performance counter data source configurations. */ performanceCounters?: outputs.monitor.PerfCounterDataSourceResponse[]; /** * The list of platform telemetry configurations */ platformTelemetry?: outputs.monitor.PlatformTelemetryDataSourceResponse[]; /** * The list of Prometheus forwarder data source configurations. */ prometheusForwarder?: outputs.monitor.PrometheusForwarderDataSourceResponse[]; /** * The list of Syslog data source configurations. */ syslog?: outputs.monitor.SyslogDataSourceResponse[]; /** * The list of Windows Event Log data source configurations. */ windowsEventLogs?: outputs.monitor.WindowsEventLogDataSourceResponse[]; /** * The list of Windows Firewall logs source configurations. */ windowsFirewallLogs?: outputs.monitor.WindowsFirewallLogsDataSourceResponse[]; } /** * The specification of destinations. */ interface DataCollectionRuleResponseDestinations { /** * Azure Monitor Metrics destination. */ azureMonitorMetrics?: outputs.monitor.DestinationsSpecResponseAzureMonitorMetrics; /** * List of Event Hubs destinations. */ eventHubs?: outputs.monitor.EventHubDestinationResponse[]; /** * List of Event Hubs Direct destinations. */ eventHubsDirect?: outputs.monitor.EventHubDirectDestinationResponse[]; /** * List of Log Analytics destinations. */ logAnalytics?: outputs.monitor.LogAnalyticsDestinationResponse[]; /** * List of monitoring account destinations. */ monitoringAccounts?: outputs.monitor.MonitoringAccountDestinationResponse[]; /** * List of storage accounts destinations. */ storageAccounts?: outputs.monitor.StorageBlobDestinationResponse[]; /** * List of Storage Blob Direct destinations. To be used only for sending data directly to store from the agent. */ storageBlobsDirect?: outputs.monitor.StorageBlobDestinationResponse[]; /** * List of Storage Table Direct destinations. */ storageTablesDirect?: outputs.monitor.StorageTableDestinationResponse[]; } /** * Metadata about the resource */ interface DataCollectionRuleResponseMetadata { /** * Azure offering managing this resource on-behalf-of customer. */ provisionedBy: string; /** * Resource Id of azure offering managing this resource on-behalf-of customer. */ provisionedByResourceId: string; } /** * Definition of which streams are sent to which destinations. */ interface DataFlowResponse { /** * The builtIn transform to transform stream data */ builtInTransform?: string; /** * List of destinations for this data flow. */ destinations?: string[]; /** * The output stream of the transform. Only required if the transform changes data to a different stream. */ outputStream?: string; /** * List of streams for this data flow. */ streams?: string[]; /** * The KQL query to transform stream data. */ transformKql?: string; } /** * Definition of Event Hub configuration. */ interface DataImportSourcesResponseEventHub { /** * Event Hub consumer group name */ consumerGroup?: string; /** * A friendly name for the data source. * This name should be unique across all data sources (regardless of type) within the data collection rule. */ name?: string; /** * The stream to collect from EventHub */ stream?: string; } /** * Specifications of pull based data sources */ interface DataSourcesSpecResponseDataImports { /** * Definition of Event Hub configuration. */ eventHub?: outputs.monitor.DataImportSourcesResponseEventHub; } /** * Properties for dependent entities, i.e. child entities */ interface DependenciesSignalGroupResponse { /** * Aggregation type for child dependencies. */ aggregationType: string; /** * Degraded threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered degraded when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is 'Thresholds'. */ degradedThreshold?: string; /** * Unhealthy threshold for aggregating the propagated health state of child dependencies. Can be either an absolute number that is greater than 0, or a percentage between 1-100%. The entity will be considered unhealthy when the number of not healthy child dependents (unhealthy, degraded, unknown) is equal to or above the threshold value. Must only be set when AggregationType is 'Thresholds'. */ unhealthyThreshold?: string; } /** * dependenciesSignalGroupResponseProvideDefaults sets the appropriate defaults for DependenciesSignalGroupResponse */ function dependenciesSignalGroupResponseProvideDefaults(val: DependenciesSignalGroupResponse): DependenciesSignalGroupResponse; /** * Azure Monitor Metrics destination. */ interface DestinationsSpecResponseAzureMonitorMetrics { /** * A friendly name for the destination. * This name should be unique across all destinations (regardless of type) within the data collection rule. */ name?: string; } /** * The diagnostic settings category resource. */ interface DiagnosticSettingsCategoryResourceResponse { /** * the collection of what category groups are supported. */ categoryGroups?: string[]; /** * The type of the diagnostic settings category. */ categoryType?: string; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.monitor.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular log. */ interface DiagnosticsLogSettingsResponse { /** * Name of a Diagnostic Log category for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. */ category?: string; /** * Name of a Diagnostic Log category group for a resource type this setting is applied to. To obtain the list of Diagnostic Log categories for a resource, first perform a GET diagnostic settings operation. */ categoryGroup?: string; /** * a value indicating whether this log is enabled. */ enabled: boolean; /** * the retention policy for this log. */ retentionPolicy?: outputs.monitor.RetentionPolicyResponse; } /** * Part of MultiTenantDiagnosticSettings. Specifies the settings for a particular metric. */ interface DiagnosticsMetricSettingsResponse { /** * Name of a Diagnostic Metric category for a resource type this setting is applied to. To obtain the list of Diagnostic metric categories for a resource, first perform a GET diagnostic settings operation. */ category?: string; /** * a value indicating whether this category is enabled. */ enabled: boolean; /** * the retention policy for this category. */ retentionPolicy?: outputs.monitor.RetentionPolicyResponse; /** * the timegrain of the metric in ISO8601 format. */ timeGrain?: string; } /** * Dimension splitting and filtering definition */ interface DimensionResponse { /** * Name of the dimension */ name: string; /** * Operator for dimension values */ operator: string; /** * List of dimension values */ values: string[]; } /** * Error details for a failed discovery operation */ interface DiscoveryErrorResponse { /** * Additional context information, like resource IDs or query details */ context: string[]; /** * Error message */ message: string; } /** * ML-based evaluation rule for a signal definition */ interface DynamicDetectionRuleResponse { /** * Threshold direction */ dynamicThresholdDirection: string; /** * ML model to use for dynamic thresholds */ dynamicThresholdModel: string; /** * ML model sensitivity. Lowest value = high sensitivity. Supported step size = 0.5 */ modelSensitivity: number; /** * Start time of the training in UTC. */ trainingStartTime?: string; } /** * Criterion for dynamic threshold. */ interface DynamicMetricCriteriaResponse { /** * The extent of deviation required to trigger an alert. This will affect how tight the threshold is to the metric series pattern. */ alertSensitivity: string; /** * Specifies the type of threshold criteria * Expected value is 'DynamicThresholdCriterion'. */ criterionType: "DynamicThresholdCriterion"; /** * List of dimension conditions. */ dimensions?: outputs.monitor.MetricDimensionResponse[]; /** * The minimum number of violations required within the selected lookback time window required to raise an alert. */ failingPeriods: outputs.monitor.DynamicThresholdFailingPeriodsResponse; /** * Use this option to set the date from which to start learning the metric historical data and calculate the dynamic thresholds (in ISO8601 format) */ ignoreDataBefore?: string; /** * Name of the metric. */ metricName: string; /** * Namespace of the metric. */ metricNamespace?: string; /** * Name of the criteria. */ name: string; /** * The operator used to compare the metric value against the threshold. */ operator: string; /** * Allows creating an alert rule on a custom metric that isn't yet emitted, by causing the metric validation to be skipped. */ skipMetricValidation?: boolean; /** * the criteria time aggregation types. */ timeAggregation: string; } /** * The minimum number of violations required within the selected lookback time window required to raise an alert. */ interface DynamicThresholdFailingPeriodsResponse { /** * The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. */ minFailingPeriodsToAlert: number; /** * The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. */ numberOfEvaluationPeriods: number; } /** * Email notification of an autoscale event. */ interface EmailNotificationResponse { /** * the custom e-mails list. This value can be null or empty, in which case this attribute will be ignored. */ customEmails?: string[]; /** * a value indicating whether to send email to subscription administrator. */ sendToSubscriptionAdministrator?: boolean; /** * a value indicating whether to send email to subscription co-administrators. */ sendToSubscriptionCoAdministrators?: boolean; } /** * emailNotificationResponseProvideDefaults sets the appropriate defaults for EmailNotificationResponse */ function emailNotificationResponseProvideDefaults(val: EmailNotificationResponse): EmailNotificationResponse; /** * An email receiver. */ interface EmailReceiverResponse { /** * The email address of this receiver. */ emailAddress: string; /** * The name of the email receiver. Names must be unique across all receivers within an action group. */ name: string; /** * The receiver status of the e-mail. */ status: string; /** * Indicates whether to use common alert schema. */ useCommonAlertSchema?: boolean; } /** * emailReceiverResponseProvideDefaults sets the appropriate defaults for EmailReceiverResponse */ function emailReceiverResponseProvideDefaults(val: EmailReceiverResponse): EmailReceiverResponse; /** * Alert configuration for an entity */ interface EntityAlertsResponse { /** * Alert to be triggered on state change to degraded */ degraded?: outputs.monitor.AlertConfigurationResponse; /** * Alert to be triggered on state change to unhealthy */ unhealthy?: outputs.monitor.AlertConfigurationResponse; } /** * Visual position of the entity */ interface EntityCoordinatesResponse { /** * X Coordinate */ x: number; /** * Y Coordinate */ y: number; } /** * Properties which are common across all kinds of entities */ interface EntityPropertiesResponse { /** * Alert configuration for this entity */ alerts?: outputs.monitor.EntityAlertsResponse; /** * Positioning of the entity on the model canvas */ canvasPosition?: outputs.monitor.EntityCoordinatesResponse; /** * Date when the entity was (soft-)deleted */ deletionDate: string; /** * Discovered by which discovery rule. If set, the entity cannot be deleted manually. */ discoveredBy: string; /** * Display name */ displayName?: string; /** * Health objective as a percentage of time the entity should be healthy. */ healthObjective?: number; /** * Health state of this entity */ healthState: string; /** * Visual icon definition. If not set, a default icon is used. */ icon?: outputs.monitor.IconDefinitionResponse; /** * Impact of the entity in health state propagation */ impact?: string; /** * Entity kind */ kind?: string; /** * The status of the last operation. */ provisioningState: string; /** * Signal groups which are assigned to this entity */ signals?: outputs.monitor.SignalGroupResponse; /** * Optional set of labels (key-value pairs) */ tags?: { [key: string]: string; }; } /** * entityPropertiesResponseProvideDefaults sets the appropriate defaults for EntityPropertiesResponse */ function entityPropertiesResponseProvideDefaults(val: EntityPropertiesResponse): EntityPropertiesResponse; /** * Evaluation rule for a signal definition */ interface EvaluationRuleResponse { /** * Degraded rule with static threshold. When used, dynamicDetectionRule must not be set. */ degradedRule?: outputs.monitor.ThresholdRuleResponse; /** * Configure to use ML-based dynamic thresholds. When used, degradedRule and unhealthyRule must not be set. */ dynamicDetectionRule?: outputs.monitor.DynamicDetectionRuleResponse; /** * Unhealthy rule with static threshold. When used, dynamicDetectionRule must not be set. */ unhealthyRule?: outputs.monitor.ThresholdRuleResponse; } interface EventHubDestinationResponse { /** * The resource ID of the event hub. */ eventHubResourceId?: string; /** * A friendly name for the destination. * This name should be unique across all destinations (regardless of type) within the data collection rule. */ name?: string; } interface EventHubDirectDestinationResponse { /** * The resource ID of the event hub. */ eventHubResourceId?: string; /** * A friendly name for the destination. * This name should be unique across all destinations (regardless of type) within the data collection rule. */ name?: string; } /** * An Event hub receiver. */ interface EventHubReceiverResponse { /** * The name of the specific Event Hub queue */ eventHubName: string; /** * The Event Hub namespace */ eventHubNameSpace: string; /** * The principal id of the managed identity. The value can be "None", "SystemAssigned" */ managedIdentity?: string; /** * The name of the Event hub receiver. Names must be unique across all receivers within an action group. */ name: string; /** * The Id for the subscription containing this event hub */ subscriptionId: string; /** * The tenant Id for the subscription containing this event hub */ tenantId?: string; /** * Indicates whether to use common alert schema. */ useCommonAlertSchema?: boolean; } /** * eventHubReceiverResponseProvideDefaults sets the appropriate defaults for EventHubReceiverResponse */ function eventHubReceiverResponseProvideDefaults(val: EventHubReceiverResponse): EventHubReceiverResponse; /** * Represents the current execution state of an SLI. */ interface ExecutionStateResponse { /** * A descriptive message related to the execution state. */ message?: string; /** * The execution state value. */ state: string; } /** * Exporter Info. */ interface ExporterResponse { /** * Azure Monitor Workspace Logs specific configurations. */ azureMonitorWorkspaceLogs?: outputs.monitor.AzureMonitorWorkspaceLogsExporterResponse; /** * The name of exporter. */ name: string; /** * TCP based exporter. Used for pipelineGroup exporter. */ tcp?: outputs.monitor.TcpExporterResponse; /** * The type of exporter. */ type: string; } /** * exporterResponseProvideDefaults sets the appropriate defaults for ExporterResponse */ function exporterResponseProvideDefaults(val: ExporterResponse): ExporterResponse; /** * The complex type of the extended location. */ interface ExtendedLocationResponse { /** * The name of the extended location. */ name: string; /** * The type of the extended location. */ type: string; } /** * Definition of which data will be collected from a separate VM extension that integrates with the Azure Monitor Agent. * Collected from either Windows and Linux machines, depending on which extension is defined. */ interface ExtensionDataSourceResponse { /** * The name of the VM extension. */ extensionName: string; /** * The extension settings. The format is specific for particular extension. */ extensionSettings?: any; /** * The list of data sources this extension needs data from. */ inputDataSources?: string[]; /** * A friendly name for the data source. * This name should be unique across all data sources (regardless of type) within the data collection rule. */ name?: string; /** * List of streams that this data source will be sent to. * A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. */ streams?: string[]; } /** * HealthModel properties */ interface HealthModelPropertiesResponse { /** * Configure to automatically discover entities from a given scope, such as a Service Group. The discovered entities will be linked to the root entity of the health model. */ discovery?: outputs.monitor.ModelDiscoverySettingsResponse; /** * The status of the last operation. */ provisioningState: string; /** * The data plane endpoint for querying health data */ queryEndpoint: string; } /** * Visual icon definition of an entity */ interface IconDefinitionResponse { /** * Custom data. Base64-encoded SVG data. If set, this overrides the built-in icon. */ customData?: string; /** * Name of the built-in icon, or 'Custom' to use customData */ iconName: string; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * Type of managed service identity. */ type: string; /** * The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.monitor.UserIdentityPropertiesResponse; }; } /** * Enables IIS logs to be collected by this data collection rule. */ interface IisLogsDataSourceResponse { /** * Absolute paths file location */ logDirectories?: string[]; /** * A friendly name for the data source. * This name should be unique across all data sources (regardless of type) within the data collection rule. */ name?: string; /** * IIS streams */ streams: string[]; } /** * An Incident receiver. */ interface IncidentReceiverResponse { /** * The incident service connection */ connection: outputs.monitor.IncidentServiceConnectionResponse; /** * The incident management service type */ incidentManagementService: string; /** * Field mappings for the incident service */ mappings: { [key: string]: string; }; /** * The name of the Incident receiver. Names must be unique across all receivers within an action group. */ name: string; } /** * The connection info for Incident Receiver. */ interface IncidentServiceConnectionResponse { /** * GUID value representing the connection ID for the incident management service. */ id: string; /** * The name of the connection. */ name: string; } /** * Details about the execution of the investigation */ interface InvestigationExecutionResponse { /** * The time at which the investigation execution completed (in UTC) */ completedAt?: string; /** * The state of the investigation execution */ runState: string; } /** * Properties of the current investigation */ interface InvestigationMetadataResponse { /** * The creation time of the investigation (in UTC) */ createdAt: string; /** * The execution details of the investigation */ execution: outputs.monitor.InvestigationExecutionResponse; /** * The unique identifier of the investigation */ id: string; /** * The parameters that were used to start the investigation */ runParameters: outputs.monitor.RunParametersResponse; } /** * A single scope of the investigation */ interface InvestigationScopeResponse { /** * The ID of the scope of the investigation - either an Azure alert ID or an Azure resource ID */ id: string; /** * The origin of the scope */ origin: outputs.monitor.OriginResponse; /** * The relevance of the scope */ relevance?: string; } /** * The issue properties */ interface IssuePropertiesResponse { /** * The issue impact time (in UTC) */ impactTime: string; /** * The list of investigations in the issue */ investigations: outputs.monitor.InvestigationMetadataResponse[]; /** * The number of investigations in the issue */ investigationsCount: number; /** * The provisioning state of the resource. */ provisioningState: string; /** * The issue severity */ severity: string; /** * The issue status */ status: string; /** * The issue title */ title: string; } /** * An Itsm receiver. */ interface ItsmReceiverResponse { /** * Unique identification of ITSM connection among multiple defined in above workspace. */ connectionId: string; /** * The name of the Itsm receiver. Names must be unique across all receivers within an action group. */ name: string; /** * Region in which workspace resides. Supported values:'centralindia','japaneast','southeastasia','australiasoutheast','uksouth','westcentralus','canadacentral','eastus','westeurope' */ region: string; /** * JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well. */ ticketConfiguration: string; /** * OMS LA instance identifier. */ workspaceId: string; } /** * A component that allows parsing a value from sourceField as a json array, match a key to each parsed value from keys, and output the key-value map to destinationField field. */ interface JsonArrayMapperResponse { /** * Define a destination field to which the parsed output will be written. The output is a map, it's keys is the given keys array and the matching values are the parsed json array elements. */ destinationField?: outputs.monitor.JsonMapperDestinationFieldResponse; /** * Define the names of the keys in the resulting map. The input json array elements are mapped in order, one for every key. */ keys: string[]; /** * Define a source field from which a json array will be read and parsed to it's elements. The number of elements in the json array is expected to be the same as the length of keys. */ sourceField?: outputs.monitor.JsonMapperSourceFieldResponse; } /** * jsonArrayMapperResponseProvideDefaults sets the appropriate defaults for JsonArrayMapperResponse */ function jsonArrayMapperResponseProvideDefaults(val: JsonArrayMapperResponse): JsonArrayMapperResponse; /** * JsonArrayMapper destination field used to describe the field to which the parsed output will be written. */ interface JsonMapperDestinationFieldResponse { /** * Define the destination's element. The element is the body or the attributes of the message, to which the json array mapper will write the output map. */ destination?: string; /** * Define a destination field name under the given element. Leaving this empty, means the root of the element. In case element=attributes and fieldName is empty, the object's attributes themselves will contain the key value output pairs. */ fieldName?: string; } /** * jsonMapperDestinationFieldResponseProvideDefaults sets the appropriate defaults for JsonMapperDestinationFieldResponse */ function jsonMapperDestinationFieldResponseProvideDefaults(val: JsonMapperDestinationFieldResponse): JsonMapperDestinationFieldResponse; /** * JsonArrayMapper source field used to describe the field from which the json array will be read. */ interface JsonMapperSourceFieldResponse { /** * Define a source field name from which the json array mapper will read the json array. Leaving this empty, means reading the body of the message itself. */ fieldName?: string; } interface LocationSpecResponse { /** * Name of location. */ location?: string; /** * The resource provisioning state in this location. */ provisioningStatus?: string; } /** * Log Analytics destination. */ interface LogAnalyticsDestinationResponse { /** * A friendly name for the destination. * This name should be unique across all destinations (regardless of type) within the data collection rule. */ name?: string; /** * The Customer ID of the Log Analytics workspace. */ workspaceId: string; /** * The resource ID of the Log Analytics workspace. */ workspaceResourceId?: string; } /** * Log Analytics Query Signal Definition properties */ interface LogAnalyticsQuerySignalDefinitionPropertiesResponse { /** * Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count)) */ dataUnit?: string; /** * Date when the signal definition was (soft-)deleted */ deletionDate: string; /** * Display name */ displayName?: string; /** * Evaluation rules for the signal definition */ evaluationRules: outputs.monitor.EvaluationRuleResponse; /** * The status of the last operation. */ provisioningState: string; /** * Query text in KQL syntax */ queryText: string; /** * Interval in which the signal is being evaluated. Defaults to PT1M (1 minute). */ refreshInterval?: string; /** * Supported signal kinds as discriminator * Expected value is 'LogAnalyticsQuery'. */ signalKind: "LogAnalyticsQuery"; /** * Optional set of labels (key-value pairs) */ tags?: { [key: string]: string; }; /** * Time range of signal. ISO duration format like PT10M. If not specified, the KQL query must define a time range. */ timeGrain?: string; /** * Name of the column in the result set to evaluate against the thresholds. Defaults to the first column in the result set if not specified. The column must be numeric. */ valueColumnName?: string; } /** * logAnalyticsQuerySignalDefinitionPropertiesResponseProvideDefaults sets the appropriate defaults for LogAnalyticsQuerySignalDefinitionPropertiesResponse */ function logAnalyticsQuerySignalDefinitionPropertiesResponseProvideDefaults(val: LogAnalyticsQuerySignalDefinitionPropertiesResponse): LogAnalyticsQuerySignalDefinitionPropertiesResponse; /** * A grouping of signal assignments for a Log Analytics Workspace */ interface LogAnalyticsSignalGroupResponse { /** * Reference to the name of the authentication setting which is used for querying the data source */ authenticationSetting: string; /** * Log Analytics Workspace resource ID */ logAnalyticsWorkspaceResourceId: string; /** * Signal definitions which are assigned to this signal group. All assignments are combined with an OR operator. */ signalAssignments?: outputs.monitor.SignalAssignmentResponse[]; } /** * Text settings */ interface LogFileSettingsResponseText { /** * One of the supported timestamp formats */ recordStartTimestampFormat: string; } /** * Definition of which custom log files will be collected by this data collection rule */ interface LogFilesDataSourceResponse { /** * File Patterns where the log files are located */ filePatterns: string[]; /** * The data format of the log files */ format: string; /** * A friendly name for the data source. * This name should be unique across all data sources (regardless of type) within the data collection rule. */ name?: string; /** * The log files specific settings. */ settings?: outputs.monitor.LogFilesDataSourceResponseSettings; /** * List of streams that this data source will be sent to. * A stream indicates what schema will be used for this data source */ streams: string[]; } /** * The log files specific settings. */ interface LogFilesDataSourceResponseSettings { /** * Text settings */ text?: outputs.monitor.LogFileSettingsResponseText; } /** * A logic app receiver. */ interface LogicAppReceiverResponse { /** * The callback url where http request sent to. */ callbackUrl: string; /** * The principal id of the managed identity. The value can be "None", "SystemAssigned" */ managedIdentity?: string; /** * The name of the logic app receiver. Names must be unique across all receivers within an action group. */ name: string; /** * The azure resource id of the logic app receiver. */ resourceId: string; /** * Indicates whether to use common alert schema. */ useCommonAlertSchema?: boolean; } /** * logicAppReceiverResponseProvideDefaults sets the appropriate defaults for LogicAppReceiverResponse */ function logicAppReceiverResponseProvideDefaults(val: LogicAppReceiverResponse): LogicAppReceiverResponse; /** * Authentication setting properties for Azure Managed Identity */ interface ManagedIdentityAuthenticationSettingPropertiesResponse { /** * Supported kinds of authentication settings as discriminator * Expected value is 'ManagedIdentity'. */ authenticationKind: "ManagedIdentity"; /** * Display name */ displayName?: string; /** * Name of the managed identity to use. Either 'SystemAssigned' or the resourceId of a user-assigned identity. */ managedIdentityName: string; /** * The status of the last operation. */ provisioningState: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.monitor.UserAssignedIdentityResponse; }; } /** * Part of Management Group diagnostic setting. Specifies the settings for a particular log. */ interface ManagementGroupLogSettingsResponse { /** * Name of a Management Group Diagnostic Log category for a resource type this setting is applied to. */ category?: string; /** * Name of a Management Group Diagnostic Log category group for a resource type this setting is applied to. */ categoryGroup?: string; /** * a value indicating whether this log is enabled. */ enabled: boolean; } /** * An alert action. */ interface MetricAlertActionResponse { /** * the id of the action group to use. */ actionGroupId?: string; /** * This field allows specifying custom properties, which would be appended to the alert payload sent as input to the webhook. */ webHookProperties?: { [key: string]: string; }; } /** * Specifies the metric alert criteria for multiple resource that has multiple metric criteria. */ interface MetricAlertMultipleResourceMultipleMetricCriteriaResponse { /** * the list of multiple metric criteria for this 'all of' operation. */ allOf?: (outputs.monitor.DynamicMetricCriteriaResponse | outputs.monitor.MetricCriteriaResponse)[]; /** * specifies the type of the alert criteria. * Expected value is 'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria'. */ odataType: "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria"; } /** * Specifies the metric alert criteria for a single resource that has multiple metric criteria. */ interface MetricAlertSingleResourceMultipleMetricCriteriaResponse { /** * The list of metric criteria for this 'all of' operation. */ allOf?: outputs.monitor.MetricCriteriaResponse[]; /** * specifies the type of the alert criteria. * Expected value is 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria'. */ odataType: "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria"; } /** * Criterion to filter metrics. */ interface MetricCriteriaResponse { /** * Specifies the type of threshold criteria * Expected value is 'StaticThresholdCriterion'. */ criterionType: "StaticThresholdCriterion"; /** * List of dimension conditions. */ dimensions?: outputs.monitor.MetricDimensionResponse[]; /** * Name of the metric. */ metricName: string; /** * Namespace of the metric. */ metricNamespace?: string; /** * Name of the criteria. */ name: string; /** * the criteria operator. */ operator: string; /** * Allows creating an alert rule on a custom metric that isn't yet emitted, by causing the metric validation to be skipped. */ skipMetricValidation?: boolean; /** * the criteria threshold value that activates the alert. */ threshold: number; /** * the criteria time aggregation types. */ timeAggregation: string; } /** * Specifies a metric dimension. */ interface MetricDimensionResponse { /** * Name of the dimension. */ name: string; /** * the dimension operator. Only 'Include' and 'Exclude' are supported */ operator: string; /** * list of dimension values. */ values: string[]; } /** * Defines a metric in the destination AMW account. */ interface MetricResponse { /** * The name of the metric. */ metricName: string; /** * The namespace of the metric. */ metricNamespace: string; } /** * The trigger that results in a scaling action. */ interface MetricTriggerResponse { /** * List of dimension conditions. For example: [{"DimensionName":"AppName","Operator":"Equals","Values":["App1"]},{"DimensionName":"Deployment","Operator":"Equals","Values":["default"]}]. */ dimensions?: outputs.monitor.ScaleRuleMetricDimensionResponse[]; /** * a value indicating whether metric should divide per instance. */ dividePerInstance?: boolean; /** * the name of the metric that defines what the rule monitors. */ metricName: string; /** * the namespace of the metric that defines what the rule monitors. */ metricNamespace?: string; /** * the location of the resource the rule monitors. */ metricResourceLocation?: string; /** * the resource identifier of the resource the rule monitors. */ metricResourceUri: string; /** * the operator that is used to compare the metric data and the threshold. */ operator: string; /** * the metric statistic type. How the metrics from multiple instances are combined. */ statistic: string; /** * the threshold of the metric that triggers the scale action. */ threshold: number; /** * time aggregation type. How the data that is collected should be combined over time. The default value is Average. */ timeAggregation: string; /** * the granularity of metrics the rule monitors. Must be one of the predefined values returned from metric definitions for the metric. Must be between 12 hours and 1 minute. */ timeGrain: string; /** * the range of time in which instance data is collected. This value must be greater than the delay in metric collection, which can vary from resource-to-resource. Must be between 12 hours and 5 minutes. */ timeWindow: string; } /** * Settings for automatically discovering entities for the health model. */ interface ModelDiscoverySettingsResponse { /** * Whether to add all recommended signals to the discovered entities. */ addRecommendedSignals: string; /** * Which Managed Identity of the health model to use for discovery. Defaults to SystemAssigned, if not set. Can be set to 'SystemAssigned' or to the resource id of a user-assigned managed identity which is linked to the health model. */ identity?: string; /** * The scope from which entities should be automatically discovered. For example, the resource id of a Service Group. */ scope: string; } /** * Monitoring account destination. */ interface MonitoringAccountDestinationResponse { /** * The immutable ID of the account. */ accountId: string; /** * The resource ID of the monitoring account. */ accountResourceId?: string; /** * A friendly name for the destination. * This name should be unique across all destinations (regardless of type) within the data collection rule. */ name?: string; } /** * Networking configuration for the pipeline group instance. */ interface NetworkingConfigurationResponse { /** * External networking mode. */ externalNetworkingMode: string; /** * The address exposed on the cluster. Example: azuremonitorpipeline.contoso.com. */ host?: string; /** * Networking routes configuration. */ routes: outputs.monitor.NetworkingRouteResponse[]; } /** * Networking route configuration. */ interface NetworkingRouteResponse { /** * Route path. */ path?: string; /** * The port that will be configured externally. If not specified, it will use the port from the receiver definition. */ port?: number; /** * The name of the previously defined receiver. */ receiver: string; /** * Route subdomain. */ subdomain?: string; } /** * Details about the origin of the entity - the source that added it to the issue */ interface OriginResponse { /** * The ID of the origin - for example, in case of 'Manual', the user ID/app ID, and in case of 'Automatic', the name of the automatic system */ addedBy: string; /** * The source of the origin - Manual or Automatic */ addedByType: string; } /** * OTLP Receiver. */ interface OtlpReceiverResponse { /** * OTLP GRPC endpoint definition. Example: 0.0.0.0:. */ endpoint: string; } /** * Definition of which performance counters will be collected and how they will be collected by this data collection rule. * Collected from both Windows and Linux machines where the counter is present. */ interface PerfCounterDataSourceResponse { /** * A list of specifier names of the performance counters you want to collect. * Use a wildcard (*) to collect a counter for all instances. * To get a list of performance counters on Windows, run the command 'typeperf'. */ counterSpecifiers?: string[]; /** * A friendly name for the data source. * This name should be unique across all data sources (regardless of type) within the data collection rule. */ name?: string; /** * The number of seconds between consecutive counter measurements (samples). */ samplingFrequencyInSeconds?: number; /** * List of streams that this data source will be sent to. * A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. */ streams?: string[]; } /** * Persistence options to all pipelines in the instance. */ interface PersistenceConfigurationsResponse { /** * The name of the mounted persistent volume. */ persistentVolumeName: string; } /** * Properties that need to be specified to create a new pipeline group instance. */ interface PipelineGroupPropertiesResponse { /** * The exporters specified for a pipeline group instance. */ exporters: outputs.monitor.ExporterResponse[]; /** * Networking configurations for the pipeline group instance. */ networkingConfigurations?: outputs.monitor.NetworkingConfigurationResponse[]; /** * The processors specified for a pipeline group instance. */ processors: outputs.monitor.ProcessorResponse[]; /** * The provisioning state of a pipeline group instance. Set to Succeeded if everything is healthy. */ provisioningState: string; /** * The receivers specified for a pipeline group instance. */ receivers: outputs.monitor.ReceiverResponse[]; /** * Defines the amount of replicas of the pipeline group instance. */ replicas?: number; /** * The service section for a given pipeline group instance. */ service: outputs.monitor.ServiceResponse; } /** * Pipeline Info. */ interface PipelineResponse { /** * Reference to exporters configured for the pipeline. */ exporters: string[]; /** * Name of the pipeline. */ name: string; /** * Reference to processors configured for the pipeline. */ processors?: string[]; /** * Reference to receivers configured for the pipeline. */ receivers: string[]; /** * The type of pipeline */ type: string; } /** * Definition of platform telemetry data source configuration */ interface PlatformTelemetryDataSourceResponse { /** * A friendly name for the data source. * This name should be unique across all data sources (regardless of type) within the data collection rule. */ name?: string; /** * List of platform telemetry streams to collect */ streams: string[]; } /** * The parameters for enabling predictive autoscale. */ interface PredictiveAutoscalePolicyResponse { /** * the amount of time to specify by which instances are launched in advance. It must be between 1 minute and 60 minutes in ISO 8601 format. */ scaleLookAheadTime?: string; /** * the predictive autoscale mode */ scaleMode: string; } /** * The private endpoint connection resource. */ interface PrivateEndpointConnectionResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint resource. */ privateEndpoint?: outputs.monitor.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.monitor.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.monitor.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } interface PrivateLinkScopedResourceResponse { /** * The resourceId of the Azure Monitor Private Link Scope Scoped Resource through which this DCE is associated with a Azure Monitor Private Link Scope. */ resourceId?: string; /** * The immutableId of the Azure Monitor Private Link Scope Resource to which the association is. */ scopeId?: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Processor Info. */ interface ProcessorResponse { /** * Batch processor configurations. */ batch?: outputs.monitor.BatchProcessorResponse; /** * The name of processor. */ name: string; /** * The type of processor. */ type: string; } /** * processorResponseProvideDefaults sets the appropriate defaults for ProcessorResponse */ function processorResponseProvideDefaults(val: ProcessorResponse): ProcessorResponse; /** * Definition of Prometheus metrics forwarding configuration. */ interface PrometheusForwarderDataSourceResponse { /** * The list of label inclusion filters in the form of label "name-value" pairs. * Currently only one label is supported: 'microsoft_metrics_include_label'. * Label values are matched case-insensitively. */ labelIncludeFilter?: { [key: string]: string; }; /** * A friendly name for the data source. * This name should be unique across all data sources (regardless of type) within the data collection rule. */ name?: string; /** * List of streams that this data source will be sent to. */ streams?: string[]; } /** * Prometheus Metrics Signal Definition properties */ interface PrometheusMetricsSignalDefinitionPropertiesResponse { /** * Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count)) */ dataUnit?: string; /** * Date when the signal definition was (soft-)deleted */ deletionDate: string; /** * Display name */ displayName?: string; /** * Evaluation rules for the signal definition */ evaluationRules: outputs.monitor.EvaluationRuleResponse; /** * The status of the last operation. */ provisioningState: string; /** * Query text in PromQL syntax */ queryText: string; /** * Interval in which the signal is being evaluated. Defaults to PT1M (1 minute). */ refreshInterval?: string; /** * Supported signal kinds as discriminator * Expected value is 'PrometheusMetricsQuery'. */ signalKind: "PrometheusMetricsQuery"; /** * Optional set of labels (key-value pairs) */ tags?: { [key: string]: string; }; /** * Time range of signal. ISO duration format like PT10M. */ timeGrain?: string; } /** * prometheusMetricsSignalDefinitionPropertiesResponseProvideDefaults sets the appropriate defaults for PrometheusMetricsSignalDefinitionPropertiesResponse */ function prometheusMetricsSignalDefinitionPropertiesResponseProvideDefaults(val: PrometheusMetricsSignalDefinitionPropertiesResponse): PrometheusMetricsSignalDefinitionPropertiesResponse; /** * Receiver Info. */ interface ReceiverResponse { /** * The name of receiver. */ name: string; /** * OTLP receiver configurations. This field is mandatory for OTLP and pipelineGroup receivers. */ otlp?: outputs.monitor.OtlpReceiverResponse; /** * Syslog configurations. This field is mandatory for syslog type receivers. */ syslog?: outputs.monitor.SyslogReceiverResponse; /** * The type of receiver. */ type: string; /** * UDP receiver configurations. This field is mandatory for UDP receivers. */ udp?: outputs.monitor.UdpReceiverResponse; } /** * receiverResponseProvideDefaults sets the appropriate defaults for ReceiverResponse */ function receiverResponseProvideDefaults(val: ReceiverResponse): ReceiverResponse; /** * Record map for schema in azure monitor. */ interface RecordMapResponse { /** * Record Map Key. */ from: string; /** * Record Map Value. */ to: string; } /** * The repeating times at which this profile begins. This element is not used if the FixedDate element is used. */ interface RecurrenceResponse { /** * the recurrence frequency. How often the schedule profile should take effect. This value must be Week, meaning each week will have the same set of profiles. For example, to set a daily schedule, set **schedule** to every day of the week. The frequency property specifies that the schedule is repeated weekly. */ frequency: string; /** * the scheduling constraints for when the profile begins. */ schedule: outputs.monitor.RecurrentScheduleResponse; } /** * The scheduling constraints for when the profile begins. */ interface RecurrentScheduleResponse { /** * the collection of days that the profile takes effect on. Possible values are Sunday through Saturday. */ days: string[]; /** * A collection of hours that the profile takes effect on. Values supported are 0 to 23 on the 24-hour clock (AM/PM times are not supported). */ hours: number[]; /** * A collection of minutes at which the profile takes effect at. */ minutes: number[]; /** * the timezone for the hours of the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time */ timeZone: string; } /** * Properties of an alert which is related to the issue */ interface RelatedAlertResponse { /** * The time this relation was added to the issue (in UTC) */ addedAt: string; /** * The alert ID */ id: string; /** * The last update time of this relation (in UTC) */ lastModifiedAt: string; /** * The source that related the alert to the issue */ origin: outputs.monitor.OriginResponse; /** * The alerts's relevance status */ relevance: string; } /** * Properties of a resource which is related to the issue */ interface RelatedResourceResponse { /** * The time this relation was added to the issue (in UTC) */ addedAt: string; /** * The resource ID */ id: string; /** * The last update time of this relation (in UTC) */ lastModifiedAt: string; /** * The source that related the resource to the issue */ origin: outputs.monitor.OriginResponse; /** * The resource's relevance status */ relevance: string; } /** * Relationship properties */ interface RelationshipPropertiesResponse { /** * Resource name of the child entity */ childEntityName: string; /** * Date when the relationship was (soft-)deleted */ deletionDate: string; /** * Discovered by which discovery rule. If set, the relationship cannot be deleted manually. */ discoveredBy: string; /** * Display name */ displayName?: string; /** * Resource name of the parent entity */ parentEntityName: string; /** * The status of the last operation. */ provisioningState: string; /** * Optional set of labels (key-value pairs) */ tags?: { [key: string]: string; }; } /** * Discovery rule properties for an Azure Resource Graph query */ interface ResourceGraphQueryDiscoveryRulePropertiesResponse { /** * Whether to add all recommended signals to the discovered entities. */ addRecommendedSignals: string; /** * Reference to the name of the authentication setting which is used for querying Azure Resource Graph. The same authentication setting will also be assigned to any discovered entities. */ authenticationSetting: string; /** * Date when the discovery rule was (soft-)deleted. */ deletionDate: string; /** * Whether to create relationships between the discovered entities based on a set of built-in rules. These relationships cannot be manually deleted. */ discoverRelationships: string; /** * Discovery rule relationship discovery behavior * Expected value is 'ResourceGraphQuery'. */ discoveryRuleKind: "ResourceGraphQuery"; /** * Display name */ displayName?: string; /** * Name of the entity which represents the discovery rule. Note: It might take a few minutes after creating the discovery rule until the entity is created. */ entityName: string; /** * Error details if the last discovery operation failed. */ error: outputs.monitor.DiscoveryErrorResponse; /** * The status of the last operation. */ provisioningState: string; /** * Azure Resource Graph query text in KQL syntax. The query must return at least a column named 'id' which contains the resource ID of the discovered resources. */ resourceGraphQuery: string; } /** * Resource map for schema in azure monitor. */ interface ResourceMapResponse { /** * Resource Map Key. */ from: string; /** * Resource Map Value. */ to: string; } /** * Azure Resource Metric Signal Definition properties */ interface ResourceMetricSignalDefinitionPropertiesResponse { /** * Type of aggregation to apply to the metric */ aggregationType: string; /** * Unit of the signal result (e.g. Bytes, MilliSeconds, Percent, Count)) */ dataUnit?: string; /** * Date when the signal definition was (soft-)deleted */ deletionDate: string; /** * Optional: Dimension to split by */ dimension?: string; /** * Optional: Dimension filter to apply to the dimension. Must only be set if also Dimension is set. */ dimensionFilter?: string; /** * Display name */ displayName?: string; /** * Evaluation rules for the signal definition */ evaluationRules: outputs.monitor.EvaluationRuleResponse; /** * Name of the metric */ metricName: string; /** * Metric namespace */ metricNamespace: string; /** * The status of the last operation. */ provisioningState: string; /** * Interval in which the signal is being evaluated. Defaults to PT1M (1 minute). */ refreshInterval?: string; /** * Supported signal kinds as discriminator * Expected value is 'AzureResourceMetric'. */ signalKind: "AzureResourceMetric"; /** * Optional set of labels (key-value pairs) */ tags?: { [key: string]: string; }; /** * Time range of signal. ISO duration format like PT10M. */ timeGrain: string; } /** * resourceMetricSignalDefinitionPropertiesResponseProvideDefaults sets the appropriate defaults for ResourceMetricSignalDefinitionPropertiesResponse */ function resourceMetricSignalDefinitionPropertiesResponseProvideDefaults(val: ResourceMetricSignalDefinitionPropertiesResponse): ResourceMetricSignalDefinitionPropertiesResponse; /** * Specifies the retention policy for the log. */ interface RetentionPolicyResponse { /** * the number of days for the retention in days. A value of 0 will retain the events indefinitely. */ days: number; /** * a value indicating whether the retention policy is enabled. */ enabled: boolean; } /** * TBD. Relevant only for rules of the kind LogAlert. */ interface RuleResolveConfigurationResponse { /** * The flag that indicates whether or not to auto resolve a fired alert. */ autoResolved?: boolean; /** * The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format. */ timeToResolve?: string; } /** * The parameters used to run the investigation */ interface RunParametersResponse { /** * The alerts used to run the investigation */ alerts: outputs.monitor.InvestigationScopeResponse[]; /** * The impact time to investigate (in UTC) */ impactTime: string; /** * The resources used to run the investigation */ resources: outputs.monitor.InvestigationScopeResponse[]; } /** * The parameters for the scaling action. */ interface ScaleActionResponse { /** * the amount of time to wait since the last scaling action before this action occurs. It must be between 1 week and 1 minute in ISO 8601 format. */ cooldown: string; /** * the scale direction. Whether the scaling action increases or decreases the number of instances. */ direction: string; /** * the type of action that should occur when the scale rule fires. */ type: string; /** * the number of instances that are involved in the scaling action. This value must be 1 or greater. The default value is 1. */ value?: string; } /** * scaleActionResponseProvideDefaults sets the appropriate defaults for ScaleActionResponse */ function scaleActionResponseProvideDefaults(val: ScaleActionResponse): ScaleActionResponse; /** * The number of instances that can be used during this profile. */ interface ScaleCapacityResponse { /** * the number of instances that will be set if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default. */ default: string; /** * the maximum number of instances for the resource. The actual maximum number of instances is limited by the cores that are available in the subscription. */ maximum: string; /** * the minimum number of instances for the resource. */ minimum: string; } /** * Specifies an auto scale rule metric dimension. */ interface ScaleRuleMetricDimensionResponse { /** * Name of the dimension. */ dimensionName: string; /** * the dimension operator. Only 'Equals' and 'NotEquals' are supported. 'Equals' being equal to any of the values. 'NotEquals' being not equal to all of the values */ operator: string; /** * list of dimension values. For example: ["App1","App2"]. */ values: string[]; } /** * A rule that provide the triggers and parameters for the scaling action. */ interface ScaleRuleResponse { /** * the trigger that results in a scaling action. */ metricTrigger: outputs.monitor.MetricTriggerResponse; /** * the parameters for the scaling action. */ scaleAction: outputs.monitor.ScaleActionResponse; } /** * scaleRuleResponseProvideDefaults sets the appropriate defaults for ScaleRuleResponse */ function scaleRuleResponseProvideDefaults(val: ScaleRuleResponse): ScaleRuleResponse; /** * The rule criteria that defines the conditions of the scheduled query rule. */ interface ScheduledQueryRuleCriteriaResponse { /** * A list of conditions to evaluate against the specified scopes */ allOf?: outputs.monitor.ConditionResponse[]; } /** * Schema map for azure monitor for logs. */ interface SchemaMapResponse { /** * Record Map. */ recordMap: outputs.monitor.RecordMapResponse[]; /** * Resource Map captures information about the entity for which telemetry is recorded. For example, metrics exposed by a Kubernetes container can be linked to a resource that specifies the cluster, namespace, pod, and container name.Resource may capture an entire hierarchy of entity identification. It may describe the host in the cloud and specific container or an application running in the process. */ resourceMap?: outputs.monitor.ResourceMapResponse[]; /** * A scope map is a logical unit of the application code with which the emitted telemetry can be associated. */ scopeMap?: outputs.monitor.ScopeMapResponse[]; } /** * Scope map for schema in azure monitor. */ interface ScopeMapResponse { /** * Scope Map Key. */ from: string; /** * Scope Map Value. */ to: string; } /** * Service Info. */ interface ServiceResponse { /** * Persistence options to all pipelines in the instance. */ persistence?: outputs.monitor.PersistenceConfigurationsResponse; /** * Pipelines belonging to a given pipeline group. */ pipelines: outputs.monitor.PipelineResponse[]; } /** * Group of signal definition assignments */ interface SignalAssignmentResponse { /** * Signal definitions referenced by their names. All definitions are combined with an AND operator. */ signalDefinitions: string[]; } /** * Contains various signal groups that can be assigned to an entity */ interface SignalGroupResponse { /** * Log Analytics Signal Group */ azureLogAnalytics?: outputs.monitor.LogAnalyticsSignalGroupResponse; /** * Azure Monitor Workspace Signal Group */ azureMonitorWorkspace?: outputs.monitor.AzureMonitorWorkspaceSignalGroupResponse; /** * Azure Resource Signal Group */ azureResource?: outputs.monitor.AzureResourceSignalGroupResponse; /** * Settings for dependency signals to control how the health state of child entities influences the health state of the parent entity. */ dependencies?: outputs.monitor.DependenciesSignalGroupResponse; } /** * signalGroupResponseProvideDefaults sets the appropriate defaults for SignalGroupResponse */ function signalGroupResponseProvideDefaults(val: SignalGroupResponse): SignalGroupResponse; /** * Represents a signal model used in SLI calculations. */ interface SignalResponse { /** * Mathematical formula used to combine multiple metrics. */ signalFormula: string; /** * Sources of metrics used for SLIs. */ signalSources: outputs.monitor.SignalSourceResponse[]; } /** * Represents a signal source used in SLIs. */ interface SignalSourceResponse { /** * Filters applied to modify signal values. */ filters: outputs.monitor.ConditionSliResponse[]; /** * Name of the metric. */ metricName: string; /** * Namespace of the metric. */ metricNamespace: string; /** * Unique identifier for the signal source. */ signalSourceId: string; /** * Managed identity for authenticating the signal source. */ sourceAmwAccountManagedIdentity: string; /** * Resource ID of the source AMW account. */ sourceAmwAccountResourceId: string; /** * Defines how measurements are aggregated across multiple time series. */ spatialAggregation: outputs.monitor.SpatialAggregationResponse; /** * Defines how measurements are aggregated over a specific time window within the same time series. */ temporalAggregation: outputs.monitor.TemporalAggregationResponse; } /** * Defines the properties of an SLI. */ interface SliPropertiesResponse { /** * Represents good signals used in request-based SLI calculations. */ goodSignals?: outputs.monitor.SignalResponse; /** * Signals used for window-based SLI calculations. */ signals?: outputs.monitor.SignalResponse; /** * Represents total signals used in request-based SLI calculations. */ totalSignals?: outputs.monitor.SignalResponse; /** * Defines the uptime criteria for window-based SLIs. */ windowUptimeCriteria?: outputs.monitor.WindowUptimeCriteriaResponse; } /** * Defines the root level properties of an SLI resource. */ interface SliResourceResponse { /** * Defines the SLO baseline associated with the SLI. */ baselineProperties: outputs.monitor.BaselinePropertiesResponse; /** * Specifies the category of the SLI, used to classify signals such as Availability and Latency. */ category: string; /** * A user-provided description of the SLI, with a maximum length of 1000 characters. */ description: string; /** * Destination AMW accounts. */ destinationAmwAccounts: outputs.monitor.AmwAccountResponse[]; /** * The destination Azure Monitor Workspace (AMW) accounts where the SLI emits metrics. */ destinationMetrics: outputs.monitor.MetricResponse[]; /** * A flag to determine whether alert is enabled. */ enableAlert: boolean; /** * Determines how the SLI is evaluated—either based on request counts or time windows. */ evaluationType: string; /** * Indicates the current execution status of the SLI resource in ARM responses. */ executionState: outputs.monitor.ExecutionStateResponse; /** * Indicates the provisioning status of the last operation. */ provisioningState: any; /** * Defines the SLI properties associated with the SLI. */ sliProperties: outputs.monitor.SliPropertiesResponse; /** * The streaming rule Id associated with the Sli resource. */ streamingRuleId: string; /** * The streaming rule last updated timestamp associated with the Sli resource. */ streamingRuleLastUpdatedTimestamp: string; } /** * An SMS receiver. */ interface SmsReceiverResponse { /** * The country code of the SMS receiver. */ countryCode: string; /** * The name of the SMS receiver. Names must be unique across all receivers within an action group. */ name: string; /** * The phone number of the SMS receiver. */ phoneNumber: string; /** * The status of the receiver. */ status: string; } /** * Represents the spatial aggregation model. */ interface SpatialAggregationResponse { /** * Dimensions considered for spatial aggregation. */ dimensions: string[]; /** * Type of spatial aggregation. */ type: string; } interface StorageBlobDestinationResponse { /** * The container name of the Storage Blob. */ containerName?: string; /** * A friendly name for the destination. * This name should be unique across all destinations (regardless of type) within the data collection rule. */ name?: string; /** * The resource ID of the storage account. */ storageAccountResourceId?: string; } interface StorageTableDestinationResponse { /** * A friendly name for the destination. * This name should be unique across all destinations (regardless of type) within the data collection rule. */ name?: string; /** * The resource ID of the storage account. */ storageAccountResourceId?: string; /** * The name of the Storage Table. */ tableName?: string; } /** * Declaration of a custom stream. */ interface StreamDeclarationResponse { /** * List of columns used by data in this stream. */ columns?: outputs.monitor.ColumnDefinitionResponse[]; } /** * Part of Subscription diagnostic setting. Specifies the settings for a particular log. */ interface SubscriptionLogSettingsResponse { /** * Name of a Subscription Diagnostic Log category for a resource type this setting is applied to. */ category?: string; /** * Name of a Subscription Diagnostic Log category group for a resource type this setting is applied to. */ categoryGroup?: string; /** * a value indicating whether this log is enabled. */ enabled: boolean; } /** * Definition of which syslog data will be collected and how it will be collected. * Only collected from Linux machines. */ interface SyslogDataSourceResponse { /** * The list of facility names. */ facilityNames?: string[]; /** * The log levels to collect. */ logLevels?: string[]; /** * A friendly name for the data source. * This name should be unique across all data sources (regardless of type) within the data collection rule. */ name?: string; /** * List of streams that this data source will be sent to. * A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. */ streams?: string[]; } /** * Base receiver using TCP as transport protocol. */ interface SyslogReceiverResponse { /** * Syslog receiver endpoint definition. Example: 0.0.0.0:. */ endpoint: string; /** * Protocol to parse syslog messages. Default rfc3164 */ protocol?: string; } /** * syslogReceiverResponseProvideDefaults sets the appropriate defaults for SyslogReceiverResponse */ function syslogReceiverResponseProvideDefaults(val: SyslogReceiverResponse): SyslogReceiverResponse; /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Base exporter using TCP as transport protocol. */ interface TcpExporterResponse { /** * TCP url to export. */ url: string; } /** * Represents temporal aggregation settings. */ interface TemporalAggregationResponse { /** * Type of temporal aggregation. */ type: string; /** * Time window size for aggregation, in minutes. */ windowSizeMinutes?: number; } /** * Threshold-based evaluation rule for a signal definition */ interface ThresholdRuleResponse { /** * Operator how to compare the signal value with the threshold */ operator: string; /** * Threshold value */ threshold: string; } /** * A specific date-time for the profile. */ interface TimeWindowResponse { /** * the end time for the profile in ISO 8601 format. */ end: string; /** * the start time for the profile in ISO 8601 format. */ start: string; /** * the timezone of the start and end times for the profile. Some examples of valid time zones are: Dateline Standard Time, UTC-11, Hawaiian Standard Time, Alaskan Standard Time, Pacific Standard Time (Mexico), Pacific Standard Time, US Mountain Standard Time, Mountain Standard Time (Mexico), Mountain Standard Time, Central America Standard Time, Central Standard Time, Central Standard Time (Mexico), Canada Central Standard Time, SA Pacific Standard Time, Eastern Standard Time, US Eastern Standard Time, Venezuela Standard Time, Paraguay Standard Time, Atlantic Standard Time, Central Brazilian Standard Time, SA Western Standard Time, Pacific SA Standard Time, Newfoundland Standard Time, E. South America Standard Time, Argentina Standard Time, SA Eastern Standard Time, Greenland Standard Time, Montevideo Standard Time, Bahia Standard Time, UTC-02, Mid-Atlantic Standard Time, Azores Standard Time, Cape Verde Standard Time, Morocco Standard Time, UTC, GMT Standard Time, Greenwich Standard Time, W. Europe Standard Time, Central Europe Standard Time, Romance Standard Time, Central European Standard Time, W. Central Africa Standard Time, Namibia Standard Time, Jordan Standard Time, GTB Standard Time, Middle East Standard Time, Egypt Standard Time, Syria Standard Time, E. Europe Standard Time, South Africa Standard Time, FLE Standard Time, Turkey Standard Time, Israel Standard Time, Kaliningrad Standard Time, Libya Standard Time, Arabic Standard Time, Arab Standard Time, Belarus Standard Time, Russian Standard Time, E. Africa Standard Time, Iran Standard Time, Arabian Standard Time, Azerbaijan Standard Time, Russia Time Zone 3, Mauritius Standard Time, Georgian Standard Time, Caucasus Standard Time, Afghanistan Standard Time, West Asia Standard Time, Ekaterinburg Standard Time, Pakistan Standard Time, India Standard Time, Sri Lanka Standard Time, Nepal Standard Time, Central Asia Standard Time, Bangladesh Standard Time, N. Central Asia Standard Time, Myanmar Standard Time, SE Asia Standard Time, North Asia Standard Time, China Standard Time, North Asia East Standard Time, Singapore Standard Time, W. Australia Standard Time, Taipei Standard Time, Ulaanbaatar Standard Time, Tokyo Standard Time, Korea Standard Time, Yakutsk Standard Time, Cen. Australia Standard Time, AUS Central Standard Time, E. Australia Standard Time, AUS Eastern Standard Time, West Pacific Standard Time, Tasmania Standard Time, Magadan Standard Time, Vladivostok Standard Time, Russia Time Zone 10, Central Pacific Standard Time, Russia Time Zone 11, New Zealand Standard Time, UTC+12, Fiji Standard Time, Kamchatka Standard Time, Tonga Standard Time, Samoa Standard Time, Line Islands Standard Time */ timeZone?: string; } /** * Receiver using UDP as transport protocol. */ interface UdpReceiverResponse { /** * The encoding of the stream being received. */ encoding?: string; /** * TCP endpoint definition. Example: 0.0.0.0:. */ endpoint: string; /** * Json array mapper - allows this udp receiver to parse a value from a given source field as a json array, match a key to each parsed value and output the key-value map to a given output field. */ jsonArrayMapper?: outputs.monitor.JsonArrayMapperResponse; /** * Max read queue length. */ readQueueLength?: number; } /** * udpReceiverResponseProvideDefaults sets the appropriate defaults for UdpReceiverResponse */ function udpReceiverResponseProvideDefaults(val: UdpReceiverResponse): UdpReceiverResponse; /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * User assigned identity properties. */ interface UserIdentityPropertiesResponse { /** * The client id of user assigned identity. */ clientId: string; /** * The principal id of user assigned identity. */ principalId: string; } /** * A voice receiver. */ interface VoiceReceiverResponse { /** * The country code of the voice receiver. */ countryCode: string; /** * The name of the voice receiver. Names must be unique across all receivers within an action group. */ name: string; /** * The phone number of the voice receiver. */ phoneNumber: string; } /** * Webhook notification of an autoscale event. */ interface WebhookNotificationResponse { /** * a property bag of settings. This value can be empty. */ properties?: { [key: string]: string; }; /** * the service address to receive the notification. */ serviceUri?: string; } /** * A webhook receiver. */ interface WebhookReceiverResponse { /** * Indicates the identifier uri for aad auth. */ identifierUri?: string; /** * The principal id of the managed identity. The value can be "None", "SystemAssigned" */ managedIdentity?: string; /** * The name of the webhook receiver. Names must be unique across all receivers within an action group. */ name: string; /** * Indicates the webhook app object Id for aad auth. */ objectId?: string; /** * The URI where webhooks should be sent. */ serviceUri: string; /** * Indicates the tenant id for aad auth. */ tenantId?: string; /** * Indicates whether or not use AAD authentication. */ useAadAuth?: boolean; /** * Indicates whether to use common alert schema. */ useCommonAlertSchema?: boolean; } /** * webhookReceiverResponseProvideDefaults sets the appropriate defaults for WebhookReceiverResponse */ function webhookReceiverResponseProvideDefaults(val: WebhookReceiverResponse): WebhookReceiverResponse; /** * A webhook receiver. */ interface WebhookReceiverTenantActionGroupResponse { /** * Indicates the identifier uri for aad auth. */ identifierUri?: string; /** * The name of the webhook receiver. Names must be unique across all receivers within a tenant action group. */ name: string; /** * Indicates the webhook app object Id for aad auth. */ objectId?: string; /** * The URI where webhooks should be sent. */ serviceUri: string; /** * Indicates the tenant id for aad auth. */ tenantId?: string; /** * Indicates whether or not use AAD authentication. */ useAadAuth?: boolean; /** * Indicates whether to use common alert schema. */ useCommonAlertSchema?: boolean; } /** * webhookReceiverTenantActionGroupResponseProvideDefaults sets the appropriate defaults for WebhookReceiverTenantActionGroupResponse */ function webhookReceiverTenantActionGroupResponseProvideDefaults(val: WebhookReceiverTenantActionGroupResponse): WebhookReceiverTenantActionGroupResponse; /** * Specifies the metric alert rule criteria for a web test resource. */ interface WebtestLocationAvailabilityCriteriaResponse { /** * The Application Insights resource Id. */ componentId: string; /** * The number of failed locations. */ failedLocationCount: number; /** * specifies the type of the alert criteria. * Expected value is 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria'. */ odataType: "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria"; /** * The Application Insights web test Id. */ webTestId: string; } /** * Represents criteria for determining uptime in window-based SLIs. */ interface WindowUptimeCriteriaResponse { /** * Comparison operator used for uptime evaluation. */ comparator: string; /** * Threshold value used to determine uptime. */ target: number; } /** * Definition of which Windows Event Log events will be collected and how they will be collected. * Only collected from Windows machines. */ interface WindowsEventLogDataSourceResponse { /** * A friendly name for the data source. * This name should be unique across all data sources (regardless of type) within the data collection rule. */ name?: string; /** * List of streams that this data source will be sent to. * A stream indicates what schema will be used for this data and usually what table in Log Analytics the data will be sent to. */ streams?: string[]; /** * A list of Windows Event Log queries in XPATH format. */ xPathQueries?: string[]; } /** * Enables Firewall logs to be collected by this data collection rule. */ interface WindowsFirewallLogsDataSourceResponse { /** * A friendly name for the data source. * This name should be unique across all data sources (regardless of type) within the data collection rule. */ name?: string; /** * Firewall logs streams */ streams: string[]; } } export declare namespace mysqldiscovery { /** * Defines the error. */ interface ErrorResponse { /** * The error code. */ code?: string; /** * The error ID. */ id?: string; /** * The detailed error message. */ message?: string; /** * The error possible cause. */ possibleCause?: string; /** * Gets description of the checkpoint. */ recommendedAction?: string; /** * The account ID used to login. */ runAsAccountId?: string; /** * Gets description of the severity. */ severity?: string; /** * The summarized error message. */ summaryMessage?: string; /** * Time when this error was last updated. */ updatedTimeStamp?: string; } /** * The extended location for off-azure resources. */ interface ExtendedLocationResponse { /** * The extended location name. */ name?: string; /** * The extended location type. */ type?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace netapp { /** * Encryption settings */ interface AccountEncryptionResponse { /** * Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. */ identity?: outputs.netapp.EncryptionIdentityResponse; /** * The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault */ keySource?: string; /** * Properties provided by KeVault. Applicable if keySource is 'Microsoft.KeyVault'. */ keyVaultProperties?: outputs.netapp.KeyVaultPropertiesResponse; } /** * accountEncryptionResponseProvideDefaults sets the appropriate defaults for AccountEncryptionResponse */ function accountEncryptionResponseProvideDefaults(val: AccountEncryptionResponse): AccountEncryptionResponse; /** * Active Directory Configuration properties */ interface ActiveDirectoryConfigPropertiesResponse { /** * Status of the Active Directory */ activeDirectoryStatus: string; /** * Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier */ administrators?: string[]; /** * Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier */ backupOperators?: string[]; /** * An array of DNS server IP addresses(IPv4 only) for the Active Directory */ dns?: string[]; /** * Name of the Active Directory domain */ domain: string; /** * The Organizational Unit (OU) within the Windows Active Directory */ organizationalUnit?: string; /** * Azure lifecycle management. */ provisioningState: string; /** * Access password from Azure KeyVault Secrets to connect Active Directory */ secretPassword: outputs.netapp.SecretPasswordResponse; /** * Domain Users in the Active directory to be given SecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier */ securityOperators?: string[]; /** * The Active Directory site the service will limit Domain Controller discovery to */ site?: string; /** * NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes */ smbServerName?: string; /** * A domain user account with permission to create machine accounts */ userName?: string; } /** * Active Directory */ interface ActiveDirectoryResponse { /** * Id of the Active Directory */ activeDirectoryId?: string; /** * Name of the active directory machine. This optional parameter is used only while creating kerberos volume */ adName?: string; /** * Users to be added to the Built-in Administrators active directory group. A list of unique usernames without domain specifier */ administrators?: string[]; /** * If enabled, AES encryption will be enabled for SMB communication. */ aesEncryption?: boolean; /** * If enabled, NFS client local users can also (in addition to LDAP users) access the NFS volumes. */ allowLocalNfsUsersWithLdap?: boolean; /** * Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier */ backupOperators?: string[]; /** * Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain */ dns?: string; /** * Name of the Active Directory domain */ domain?: string; /** * If enabled, Traffic between the SMB server to Domain Controller (DC) will be encrypted. */ encryptDCConnections?: boolean; /** * kdc server IP address for the active directory machine. This optional parameter is used only while creating kerberos volume. */ kdcIP?: string; /** * Specifies whether or not the LDAP traffic needs to be secured via TLS. */ ldapOverTLS?: boolean; /** * LDAP Search scope options */ ldapSearchScope?: outputs.netapp.LdapSearchScopeOptResponse; /** * Specifies whether or not the LDAP traffic needs to be signed. */ ldapSigning?: boolean; /** * The Organizational Unit (OU) within the Windows Active Directory */ organizationalUnit?: string; /** * Plain text password of Active Directory domain administrator, value is masked in the response */ password?: string; /** * Comma separated list of IPv4 addresses of preferred servers for LDAP client. At most two comma separated IPv4 addresses can be passed. */ preferredServersForLdapClient?: string; /** * Domain Users in the Active directory to be given SeSecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier */ securityOperators?: string[]; /** * When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes. */ serverRootCACertificate?: string; /** * The Active Directory site the service will limit Domain Controller discovery to */ site?: string; /** * NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes */ smbServerName?: string; /** * Status of the Active Directory */ status: string; /** * Any details in regards to the Status of the Active Directory */ statusDetails: string; /** * A domain user account with permission to create machine accounts */ username?: string; } /** * activeDirectoryResponseProvideDefaults sets the appropriate defaults for ActiveDirectoryResponse */ function activeDirectoryResponseProvideDefaults(val: ActiveDirectoryResponse): ActiveDirectoryResponse; /** * Properties of the server managing the lifecycle of volume buckets */ interface BucketServerPropertiesResponse { /** * Certificate Common Name taken from the certificate installed on the bucket server */ certificateCommonName: string; /** * The bucket server's certificate expiry date. */ certificateExpiryDate: string; /** * The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate. */ fqdn?: string; /** * The bucket server's IPv4 address */ ipAddress: string; } /** * Contains all the information needed to mount a cache */ interface CacheMountTargetPropertiesResponse { /** * The mount target's IPv4 address, used to mount the cache. */ ipAddress: string; /** * UUID v4 used to identify the MountTarget */ mountTargetId: string; /** * The SMB server's Fully Qualified Domain Name, FQDN */ smbServerFqdn: string; } /** * Set of export policy rules */ interface CachePropertiesExportPolicyResponse { /** * Export policy rule */ rules?: outputs.netapp.ExportPolicyRuleResponse[]; } /** * Cache resource properties */ interface CachePropertiesResponse { /** * Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel */ actualThroughputMibps: number; /** * Azure NetApp Files Cache lifecycle management */ cacheState: string; /** * The Azure Resource URI for a delegated cache subnet that will be used to allocate data IPs. */ cacheSubnetResourceId: string; /** * Flag indicating whether a CIFS change notification is enabled for the cache. */ cifsChangeNotifications?: string; /** * Specifies if the cache is encryption or not. */ encryption: string; /** * Source of key used to encrypt data in the cache. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' */ encryptionKeySource: string; /** * Set of export policy rules */ exportPolicy?: outputs.netapp.CachePropertiesExportPolicyResponse; /** * The file path of the Cache. */ filepath: string; /** * Flag indicating whether the global file lock is enabled for the cache. */ globalFileLocking?: string; /** * Describe if a cache is Kerberos enabled. */ kerberos?: string; /** * The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. */ keyVaultPrivateEndpointResourceId?: string; /** * Language supported for volume. */ language: string; /** * Specifies whether LDAP is enabled or not for flexcache volume. */ ldap?: string; /** * Specifies the type of LDAP server for flexcache volume. */ ldapServerType?: string; /** * Maximum number of files allowed. */ maximumNumberOfFiles: number; /** * List of mount targets that can be used to mount this cache */ mountTargets: outputs.netapp.CacheMountTargetPropertiesResponse[]; /** * Origin cluster information */ originClusterInformation: outputs.netapp.OriginClusterInformationResponse; /** * The Azure Resource URI for a delegated subnet that will be used for ANF Intercluster Interface IP addresses. */ peeringSubnetResourceId: string; /** * Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol */ protocolTypes?: string[]; /** * Azure lifecycle management */ provisioningState: string; /** * Maximum storage quota allowed for a file system in bytes. Valid values are in the range 50GiB to 1PiB. Values expressed in bytes as multiples of 1GiB. */ size: number; /** * SMB information for the cache */ smbSettings?: outputs.netapp.SmbSettingsResponse; /** * Maximum throughput in MiB/s that can be achieved by this cache volume and this will be accepted as input only for manual qosType cache */ throughputMibps?: number; /** * Flag indicating whether writeback is enabled for the cache. */ writeBack?: string; } /** * The effective CIFS username when accessing the volume data. */ interface CifsUserResponse { /** * The CIFS user's username */ username?: string; } /** * Daily Schedule properties */ interface DailyScheduleResponse { /** * Indicates which hour in UTC timezone a snapshot should be taken */ hour?: number; /** * Indicates which minute snapshot should be taken */ minute?: number; /** * Daily snapshot count to keep */ snapshotsToKeep?: number; /** * Resource size in bytes, current storage usage for the volume in bytes */ usedBytes?: number; } /** * NetApp elastic account properties */ interface ElasticAccountPropertiesResponse { /** * Encryption settings */ encryption?: outputs.netapp.ElasticEncryptionResponse; /** * Azure lifecycle management. */ provisioningState: string; } /** * Elastic Backup Policy properties */ interface ElasticBackupPolicyPropertiesResponse { /** * The number of volumes currently using this Backup Policy. */ assignedVolumesCount: number; /** * Daily backups count to keep */ dailyBackupsToKeep?: number; /** * Monthly backups count to keep */ monthlyBackupsToKeep?: number; /** * The property to identify whether Backup Policy is enabled or not */ policyState?: string; /** * Azure lifecycle management. */ provisioningState: string; /** * Weekly backups count to keep */ weeklyBackupsToKeep?: number; } /** * Elastic Backup properties */ interface ElasticBackupPropertiesResponse { /** * Type of backup Manual or Scheduled */ backupType: string; /** * The completion date of the backup */ completionDate: string; /** * The creation date of the backup */ creationDate: string; /** * ResourceId used to identify the elastic backup policy */ elasticBackupPolicyResourceId: string; /** * ResourceId used to identify the elastic snapshot resource. This is required when an existing snapshot needs to be used for creating a manual backup */ elasticSnapshotResourceId?: string; /** * ResourceId used to identify the Elastic Volume */ elasticVolumeResourceId: string; /** * Failure reason */ failureReason: string; /** * Label for backup */ label?: string; /** * Azure lifecycle management. */ provisioningState: string; /** * Size of backup in bytes */ size: number; /** * The snapshot creation date of the backup */ snapshotCreationDate: string; /** * Manual backup using an already existing snapshot. This will always be CreateNewSnapshot for scheduled backups and UseExistingSnapshot/CreateNewSnapshot for manual backups */ snapshotUsage?: string; /** * Specifies if the backup is for a large volume. */ volumeSize: string; } /** * elasticBackupPropertiesResponseProvideDefaults sets the appropriate defaults for ElasticBackupPropertiesResponse */ function elasticBackupPropertiesResponseProvideDefaults(val: ElasticBackupPropertiesResponse): ElasticBackupPropertiesResponse; /** * Elastic Backup Vault properties */ interface ElasticBackupVaultPropertiesResponse { /** * Azure lifecycle management. */ provisioningState: string; } /** * Elastic capacity pool properties */ interface ElasticCapacityPoolPropertiesResponse { /** * The Azure Resource URI for an Active Directory configuration. This is used by all the SMB volumes within the pool */ activeDirectoryConfigResourceId?: string; /** * Current availability status of the resource. */ availabilityStatus: string; /** * Indicates the current zone of the pool. This can be changed for zoneRedundant service level pool with the changeZone action */ currentZone: string; /** * Encryption settings */ encryption?: outputs.netapp.ElasticEncryptionConfigurationResponse; /** * Azure lifecycle management. */ provisioningState: string; /** * The service level of the elastic capacity pool */ serviceLevel: string; /** * Provisioned size of the pool (in bytes). For zoneRedundant service level pool, value must be in the range 1TiB to 16TiB or 1TiB to 128TiB for supported region. Values expressed in bytes as multiples of 1TiB till 16TiB and in multiples of 8TiB from 24TiB to 128TiB. Pool size can't be shrunk once it is created. */ size: number; /** * The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/elasticVolumes, this is used by all the volumes within the pool */ subnetResourceId: string; /** * Total throughput of the pool in MiB/s */ totalThroughputMibps: number; } /** * CMK Encryption Configuration */ interface ElasticEncryptionConfigurationResponse { /** * Pool Encryption Key Source. */ elasticPoolEncryptionKeySource: string; /** * The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. */ keyVaultPrivateEndpointResourceId: string; } /** * Identity used to authenticate with key vault. */ interface ElasticEncryptionIdentityResponse { /** * The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. */ principalId: string; /** * The ARM resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type has 'UserAssigned'. It should match key of identity.userAssignedIdentities. */ userAssignedIdentity?: string; } /** * Encryption settings */ interface ElasticEncryptionResponse { /** * Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. */ identity?: outputs.netapp.ElasticEncryptionIdentityResponse; /** * The encryption keySource (provider). Possible values (case-insensitive): Microsoft.NetApp, Microsoft.KeyVault */ keySource?: string; /** * Properties provided by KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. */ keyVaultProperties?: outputs.netapp.ElasticKeyVaultPropertiesResponse; } /** * Set of export policy rules */ interface ElasticExportPolicyResponse { /** * Export policy rule */ rules?: outputs.netapp.ElasticExportPolicyRuleResponse[]; } /** * Elastic Volume Export Policy Rule */ interface ElasticExportPolicyRuleResponse { /** * Client ingress specification for the export policy as list of IPv4 CIDRs, IPv4 host addresses and host names. */ allowedClients?: string[]; /** * Allows clients to access the volume with the NFSv3 protocol. Enable only for NFSv3 type volumes */ nfsv3?: string; /** * Allows clients to access the volume with at least NFSv4.1 protocol. */ nfsv4?: string; /** * Indicates whether root access to the volume is granted to clients affected by this rule */ rootAccess?: string; /** * Controls the priority of the export policy rule. When connecting to the volume the rule with the lowest index that applies to the connecting client is used */ ruleIndex?: number; /** * Specifies the Unix file access level for the volume. It encompasses both read-only and read-write permissions. Additionally, NoAccess can be set to block all access to the volume */ unixAccessRule?: string; } /** * elasticExportPolicyRuleResponseProvideDefaults sets the appropriate defaults for ElasticExportPolicyRuleResponse */ function elasticExportPolicyRuleResponseProvideDefaults(val: ElasticExportPolicyRuleResponse): ElasticExportPolicyRuleResponse; /** * Properties of key vault. */ interface ElasticKeyVaultPropertiesResponse { /** * The name of KeyVault key. */ keyName?: string; /** * The resource ID of KeyVault. */ keyVaultResourceId?: string; /** * The Uri of KeyVault. */ keyVaultUri?: string; /** * Status of the KeyVault connection. */ status: string; } /** * Contains all the information needed to mount an elastic volume */ interface ElasticMountTargetPropertiesResponse { /** * The mount target's IPv4 address, used to mount the volume */ ipAddress: string; /** * The SMB server's Fully Qualified Domain Name, FQDN */ smbServerFqdn: string; } /** * SMB Properties */ interface ElasticSmbPropertiesResponse { /** * Used to enable or disable encryption for in-flight SMB data volume. This flag can be modified during Elastic volume update operation as well. Only applicable for SMB protocol Elastic volumes. */ smbEncryption?: string; } /** * elasticSmbPropertiesResponseProvideDefaults sets the appropriate defaults for ElasticSmbPropertiesResponse */ function elasticSmbPropertiesResponseProvideDefaults(val: ElasticSmbPropertiesResponse): ElasticSmbPropertiesResponse; /** * Daily Schedule properties used to create NetApp snapshot policy */ interface ElasticSnapshotPolicyDailyScheduleResponse { /** * Indicates which hour in UTC timezone a snapshot should be taken */ hour?: number; /** * Indicates which minute snapshot should be taken */ minute?: number; /** * Daily snapshot count to keep */ snapshotsToKeep?: number; } /** * Hourly Schedule properties used to create NetApp snapshot policy */ interface ElasticSnapshotPolicyHourlyScheduleResponse { /** * Indicates which minute snapshot should be taken */ minute?: number; /** * Hourly snapshot count to keep */ snapshotsToKeep?: number; } /** * Monthly Schedule properties used to create NetApp snapshot policy */ interface ElasticSnapshotPolicyMonthlyScheduleResponse { /** * Indicates which days of the month snapshot (1-31) should be taken, accepts a list of integers */ daysOfMonth?: number[]; /** * Indicates which hour in UTC timezone a snapshot should be taken */ hour?: number; /** * Indicates which minute snapshot should be taken */ minute?: number; /** * Monthly snapshot count to keep */ snapshotsToKeep?: number; } /** * Elastic Snapshot policy properties */ interface ElasticSnapshotPolicyPropertiesResponse { /** * Schedule for daily snapshots */ dailySchedule?: outputs.netapp.ElasticSnapshotPolicyDailyScheduleResponse; /** * Schedule for hourly snapshots */ hourlySchedule?: outputs.netapp.ElasticSnapshotPolicyHourlyScheduleResponse; /** * Schedule for monthly snapshots */ monthlySchedule?: outputs.netapp.ElasticSnapshotPolicyMonthlyScheduleResponse; /** * Configures if the snapshot policy is enabled on the volumes connected to the policy. */ policyStatus?: string; /** * Azure lifecycle management. */ provisioningState: string; /** * Schedule for weekly snapshots */ weeklySchedule?: outputs.netapp.ElasticSnapshotPolicyWeeklyScheduleResponse; } /** * Weekly Schedule properties used to create NetApp snapshot policy */ interface ElasticSnapshotPolicyWeeklyScheduleResponse { /** * Indicates which weekday(s) snapshot(s) should be taken, accepts a list of week day names in english */ days?: string[]; /** * Indicates which hour in UTC timezone a snapshot should be taken */ hour?: number; /** * Indicates which minute snapshot should be taken */ minute?: number; /** * Weekly snapshot count to keep */ snapshotsToKeep?: number; } /** * Elastic Snapshot properties */ interface ElasticSnapshotPropertiesResponse { /** * Azure lifecycle management. */ provisioningState: string; } /** * Elastic Volume Backup Properties */ interface ElasticVolumeBackupPropertiesResponse { /** * ResourceId used to identify Elastic Backup Policy */ elasticBackupPolicyResourceId?: string; /** * ResourceId used to identify Elastic Backup Vault */ elasticBackupVaultResourceId?: string; /** * The property to decide policy is enforced or not on the volume */ policyEnforcement?: string; } /** * Data protection configuration option for the volume, including snapshot policies and backup. */ interface ElasticVolumeDataProtectionPropertiesResponse { /** * Used to configure backups on an elastic volume. */ backup?: outputs.netapp.ElasticVolumeBackupPropertiesResponse; /** * Used to apply a snapshot policy to a volume. */ snapshot?: outputs.netapp.ElasticVolumeSnapshotPropertiesResponse; } /** * Elastic Volume properties */ interface ElasticVolumePropertiesResponse { /** * Current availability status of the resource. */ availabilityStatus: string; /** * Resource identifier used to identify the Elastic Backup. */ backupResourceId?: string; /** * Data protection configuration option for the volume, including snapshot policies and backup. */ dataProtection?: outputs.netapp.ElasticVolumeDataProtectionPropertiesResponse; /** * Set of export policy rules */ exportPolicy?: outputs.netapp.ElasticExportPolicyResponse; /** * A unique file path for the volume. Used when creating mount targets. This needs to be unique within the elastic capacity pool. */ filePath: string; /** * List of mount targets that can be used to mount this volume */ mountTargets: outputs.netapp.ElasticMountTargetPropertiesResponse[]; /** * Set of support protocol types for the elastic volume */ protocolTypes: string[]; /** * Azure lifecycle management. */ provisioningState: string; /** * The current state of the restoration process. */ restorationState: string; /** * Maximum size allowed for a volume in bytes. Valid values are in the range 1GiB to 16TiB. Values expressed in bytes as multiples of 1 GiB. */ size: number; /** * SMB Properties */ smbProperties?: outputs.netapp.ElasticSmbPropertiesResponse; /** * Controls the visibility of the volume's read-only snapshot directory, which provides access to each of the volume's snapshots. */ snapshotDirectoryVisibility?: string; /** * Resource identifier used to identify the Elastic Snapshot. */ snapshotResourceId?: string; } /** * elasticVolumePropertiesResponseProvideDefaults sets the appropriate defaults for ElasticVolumePropertiesResponse */ function elasticVolumePropertiesResponseProvideDefaults(val: ElasticVolumePropertiesResponse): ElasticVolumePropertiesResponse; /** * Elastic Volume Snapshot Properties */ interface ElasticVolumeSnapshotPropertiesResponse { /** * Snapshot Policy ResourceId */ snapshotPolicyResourceId?: string; } /** * Identity used to authenticate with key vault. */ interface EncryptionIdentityResponse { /** * The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. */ principalId: string; /** * The ARM resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type has 'UserAssigned'. It should match key of identity.userAssignedIdentities. */ userAssignedIdentity?: string; } /** * Volume Export Policy Rule */ interface ExportPolicyRuleCapacityPoolVolumeResponse { /** * Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names */ allowedClients?: string; /** * This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. */ chownMode?: string; /** * Allows CIFS protocol */ cifs?: boolean; /** * Has root access to volume */ hasRootAccess?: boolean; /** * Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later */ kerberos5ReadOnly?: boolean; /** * Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later */ kerberos5ReadWrite?: boolean; /** * Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later */ kerberos5iReadOnly?: boolean; /** * Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later */ kerberos5iReadWrite?: boolean; /** * Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later */ kerberos5pReadOnly?: boolean; /** * Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later */ kerberos5pReadWrite?: boolean; /** * Allows NFSv3 protocol. Enable only for NFSv3 type volumes */ nfsv3?: boolean; /** * Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes */ nfsv41?: boolean; /** * Order index */ ruleIndex?: number; /** * Read only access */ unixReadOnly?: boolean; /** * Read and write access */ unixReadWrite?: boolean; } /** * exportPolicyRuleCapacityPoolVolumeResponseProvideDefaults sets the appropriate defaults for ExportPolicyRuleCapacityPoolVolumeResponse */ function exportPolicyRuleCapacityPoolVolumeResponseProvideDefaults(val: ExportPolicyRuleCapacityPoolVolumeResponse): ExportPolicyRuleCapacityPoolVolumeResponse; /** * Volume Export Policy Rule */ interface ExportPolicyRuleResponse { /** * Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names */ allowedClients?: string; /** * This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. */ chownMode?: string; /** * Allows CIFS protocol */ cifs?: boolean; /** * Has root access to volume */ hasRootAccess?: boolean; /** * Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later */ kerberos5IReadOnly?: boolean; /** * Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later */ kerberos5IReadWrite?: boolean; /** * Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later */ kerberos5PReadOnly?: boolean; /** * Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later */ kerberos5PReadWrite?: boolean; /** * Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later */ kerberos5ReadOnly?: boolean; /** * Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later */ kerberos5ReadWrite?: boolean; /** * Allows NFSv3 protocol. Enable only for NFSv3 type volumes */ nfsv3?: boolean; /** * Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes */ nfsv41?: boolean; /** * Order index */ ruleIndex?: number; /** * Read only access */ unixReadOnly?: boolean; /** * Read and write access */ unixReadWrite?: boolean; } /** * exportPolicyRuleResponseProvideDefaults sets the appropriate defaults for ExportPolicyRuleResponse */ function exportPolicyRuleResponseProvideDefaults(val: ExportPolicyRuleResponse): ExportPolicyRuleResponse; /** * Volume Export Policy Rule */ interface ExportPolicyRuleVolumeGroupResponse { /** * Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names */ allowedClients?: string; /** * This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. */ chownMode?: string; /** * Allows CIFS protocol */ cifs?: boolean; /** * Has root access to volume */ hasRootAccess?: boolean; /** * Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later */ kerberos5ReadOnly?: boolean; /** * Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later */ kerberos5ReadWrite?: boolean; /** * Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later */ kerberos5iReadOnly?: boolean; /** * Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later */ kerberos5iReadWrite?: boolean; /** * Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later */ kerberos5pReadOnly?: boolean; /** * Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later */ kerberos5pReadWrite?: boolean; /** * Allows NFSv3 protocol. Enable only for NFSv3 type volumes */ nfsv3?: boolean; /** * Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes */ nfsv41?: boolean; /** * Order index */ ruleIndex?: number; /** * Read only access */ unixReadOnly?: boolean; /** * Read and write access */ unixReadWrite?: boolean; } /** * exportPolicyRuleVolumeGroupResponseProvideDefaults sets the appropriate defaults for ExportPolicyRuleVolumeGroupResponse */ function exportPolicyRuleVolumeGroupResponseProvideDefaults(val: ExportPolicyRuleVolumeGroupResponse): ExportPolicyRuleVolumeGroupResponse; /** * File System user having access to volume data. For Unix, this is the user's uid and gid. For Windows, this is the user's username. Note that the Unix and Windows user details are mutually exclusive, meaning one or other must be supplied, but not both. */ interface FileSystemUserResponse { /** * The effective CIFS username when accessing the volume data. */ cifsUser?: outputs.netapp.CifsUserResponse; /** * The effective NFS User ID and Group ID when accessing the volume data. */ nfsUser?: outputs.netapp.NfsUserResponse; } /** * Hourly Schedule properties */ interface HourlyScheduleResponse { /** * Indicates which minute snapshot should be taken */ minute?: number; /** * Hourly snapshot count to keep */ snapshotsToKeep?: number; /** * Resource size in bytes, current storage usage for the volume in bytes */ usedBytes?: number; } /** * Pairs of virtual network ID and private endpoint ID. Every virtual network that has volumes encrypted with customer-managed keys needs its own key vault private endpoint. */ interface KeyVaultPrivateEndpointResponse { /** * Identifier of the private endpoint to reach the Azure Key Vault */ privateEndpointId?: string; /** * Identifier for the virtual network id */ virtualNetworkId?: string; } /** * Properties of key vault. */ interface KeyVaultPropertiesResponse { /** * The name of KeyVault key. */ keyName: string; /** * UUID v4 used to identify the Azure Key Vault configuration */ keyVaultId: string; /** * The resource ID of KeyVault. */ keyVaultResourceId?: string; /** * The Uri of KeyVault. */ keyVaultUri: string; /** * Status of the KeyVault connection. */ status: string; } /** * LDAP search scope */ interface LdapSearchScopeOptResponse { /** * This specifies the group DN, which overrides the base DN for group lookups. */ groupDN?: string; /** * This specifies the custom LDAP search filter to be used when looking up group membership from LDAP server. */ groupMembershipFilter?: string; /** * This specifies the user DN, which overrides the base DN for user lookups. */ userDN?: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.netapp.UserAssignedIdentityResponse; }; } /** * Monthly Schedule properties */ interface MonthlyScheduleResponse { /** * Indicates which days of the month snapshot should be taken. A comma delimited string. */ daysOfMonth?: string; /** * Indicates which hour in UTC timezone a snapshot should be taken */ hour?: number; /** * Indicates which minute snapshot should be taken */ minute?: number; /** * Monthly snapshot count to keep */ snapshotsToKeep?: number; /** * Resource size in bytes, current storage usage for the volume in bytes */ usedBytes?: number; } /** * Mount target properties */ interface MountTargetPropertiesResponse { /** * UUID v4 used to identify the MountTarget */ fileSystemId: string; /** * The mount target's IPv4 address */ ipAddress: string; /** * UUID v4 used to identify the MountTarget */ mountTargetId: string; /** * The SMB server's Fully Qualified Domain Name, FQDN */ smbServerFqdn?: string; } /** * The effective NFS User ID and Group ID when accessing the volume data. */ interface NfsUserResponse { /** * The NFS user's GID */ groupId?: number; /** * The NFS user's UID */ userId?: number; } /** * Stores the origin cluster information associated to a cache. */ interface OriginClusterInformationResponse { /** * ONTAP Intercluster LIF IP addresses. One IP address per cluster node is required */ peerAddresses: string[]; /** * ONTAP cluster name of external cluster hosting the origin volume */ peerClusterName: string; /** * External origin volume name associated to this cache */ peerVolumeName: string; /** * External Vserver (SVM) name name of the SVM hosting the origin volume */ peerVserverName: string; } /** * Application specific parameters for the placement of volumes in the volume group */ interface PlacementKeyValuePairsResponse { /** * Key for an application specific parameter for the placement of volumes in the volume group */ key: string; /** * Value for an application specific parameter for the placement of volumes in the volume group */ value: string; } /** * Quota report record properties */ interface QuotaReportResponse { /** * Flag to indicate whether the quota is derived from default quota. */ isDerivedQuota?: boolean; /** * Percentage of used size compared to total size. */ percentageUsed?: number; /** * Specifies the total size limit in kibibytes for the user/group quota. */ quotaLimitTotalInKiBs?: number; /** * Specifies the current usage in kibibytes for the user/group quota. */ quotaLimitUsedInKiBs?: number; /** * UserID/GroupID/SID based on the quota target type. UserID and groupID can be found by running ‘id’ or ‘getent’ command for the user or group and SID can be found by running */ quotaTarget?: string; /** * Type of quota */ quotaType?: string; } /** * The full path to a volume that is to be migrated into ANF. Required for Migration volumes */ interface RemotePathResponse { /** * The Path to a ONTAP Host */ externalHostName: string; /** * The name of a server on the ONTAP Host */ serverName: string; /** * The name of a volume on the server */ volumeName: string; } /** * Replication properties */ interface ReplicationObjectResponse { /** * Indicates whether the local volume is the source or destination for the Volume Replication */ endpointType?: string; /** * The full path to a volume that is to be migrated into ANF. Required for Migration volumes */ remotePath?: outputs.netapp.RemotePathResponse; /** * The remote region for the other end of the Volume Replication. */ remoteVolumeRegion?: string; /** * The resource ID of the remote volume. Required for cross region and cross zone replication */ remoteVolumeResourceId?: string; /** * Id */ replicationId: string; /** * Schedule */ replicationSchedule?: string; } /** * Replication properties */ interface ReplicationResponse { /** * Indicates whether the local volume is the source or destination for the Volume Replication */ endpointType?: string; /** * The remote region for the other end of the Volume Replication. */ remoteVolumeRegion?: string; /** * The resource ID of the remote volume. */ remoteVolumeResourceId: string; /** * UUID v4 used to identify the replication. */ replicationId: string; /** * Schedule */ replicationSchedule?: string; } /** * Identity used to authenticate with key vault. */ interface SecretPasswordIdentityResponse { /** * The principal ID (object ID) of the identity used to authenticate with key vault. Read-only. */ principalId: string; /** * The Azure resource identifier of the user assigned identity used to authenticate with key vault. Applicable if identity.type has 'UserAssigned'. It should match key of identity.userAssignedIdentities. */ userAssignedIdentity?: string; } /** * Properties of key vault to get the secrets for password. */ interface SecretPasswordKeyVaultPropertiesResponse { /** * The Uri of KeyVault. */ keyVaultUri: string; /** * The name of KeyVault password secret. */ secretName: string; } /** * Access password from Azure KeyVault Secrets to connect Active Directory */ interface SecretPasswordResponse { /** * Identity used to authenticate to KeyVault. Applicable if keySource is 'Microsoft.KeyVault'. */ identity?: outputs.netapp.SecretPasswordIdentityResponse; /** * Properties provided by KeyVault. */ keyVaultProperties?: outputs.netapp.SecretPasswordKeyVaultPropertiesResponse; } /** * SMB settings for the cache */ interface SmbSettingsResponse { /** * Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume */ smbAccessBasedEnumeration?: string; /** * Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol cache. */ smbEncryption?: string; /** * Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume */ smbNonBrowsable?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Volume Backup Properties */ interface VolumeBackupPropertiesResponse { /** * Backup Policy Resource ID */ backupPolicyId?: string; /** * Backup Vault Resource ID */ backupVaultId?: string; /** * Policy Enforced */ policyEnforced?: boolean; } /** * Volume details using the backup policy */ interface VolumeBackupsResponse { /** * Total count of backups for volume */ backupsCount?: number; /** * Policy enabled */ policyEnabled?: boolean; /** * Volume name */ volumeName?: string; /** * ResourceId used to identify the Volume */ volumeResourceId?: string; } /** * Volume group properties */ interface VolumeGroupMetaDataResponse { /** * Application specific identifier */ applicationIdentifier?: string; /** * Application Type */ applicationType?: string; /** * Application specific placement rules for the volume group */ globalPlacementRules?: outputs.netapp.PlacementKeyValuePairsResponse[]; /** * Group Description */ groupDescription?: string; /** * Number of volumes in volume group */ volumesCount: number; } /** * Volume resource */ interface VolumeGroupVolumePropertiesResponse { /** * Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel */ actualThroughputMibps: number; /** * Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose */ avsDataStore?: string; /** * Resource identifier used to identify the Backup. */ backupId?: string; /** * Unique Baremetal Tenant Identifier. */ baremetalTenantId: string; /** * Pool Resource Id used in case of creating a volume through volume group */ capacityPoolResourceId?: string; /** * When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning. */ cloneProgress: number; /** * Specifies whether Cool Access(tiering) is enabled for the volume. */ coolAccess?: boolean; /** * coolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are: * Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default. * OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads. * Never - No client-driven data is pulled from cool tier to standard storage. */ coolAccessRetrievalPolicy?: string; /** * coolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are: Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default. SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier. */ coolAccessTieringPolicy?: string; /** * Specifies the number of days after which data that is not accessed by clients will be tiered. */ coolnessPeriod?: number; /** * A unique file path for the volume. Used when creating mount targets */ creationToken: string; /** * DataProtection type volumes include an object containing details of the replication */ dataProtection?: outputs.netapp.VolumePropertiesResponseDataProtection; /** * Data store resource unique identifier */ dataStoreResourceId: string[]; /** * Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies. */ defaultGroupQuotaInKiBs?: number; /** * Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies . */ defaultUserQuotaInKiBs?: number; /** * If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false */ deleteBaseSnapshot?: boolean; /** * The effective value of the network features type available to the volume, or current effective state of update. */ effectiveNetworkFeatures: string; /** * Flag indicating whether subvolume operations are enabled on the volume */ enableSubvolumes?: string; /** * Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01. */ encrypted: boolean; /** * Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault' */ encryptionKeySource?: string; /** * Set of export policy rules */ exportPolicy?: outputs.netapp.VolumePropertiesResponseExportPolicyV1; /** * Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. */ fileAccessLogs: string; /** * Unique FileSystem Identifier. */ fileSystemId: string; /** * Resource Id */ id: string; /** * Specifies if default quota is enabled for the volume. */ isDefaultQuotaEnabled?: boolean; /** * Specifies whether volume is a Large Volume or Regular Volume. */ isLargeVolume?: boolean; /** * Restoring */ isRestoring?: boolean; /** * Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later */ kerberosEnabled?: boolean; /** * The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'. */ keyVaultPrivateEndpointResourceId?: string; /** * Specifies whether LDAP is enabled or not for a given NFS volume. */ ldapEnabled?: boolean; /** * Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB. */ maximumNumberOfFiles: number; /** * List of mount targets */ mountTargets: outputs.netapp.MountTargetPropertiesResponse[]; /** * Resource name */ name?: string; /** * The original value of the network features type available to the volume at the time it was created. */ networkFeatures?: string; /** * Network Sibling Set ID for the the group of volumes sharing networking resources. */ networkSiblingSetId: string; /** * Id of the snapshot or backup that the volume is restored from. */ originatingResourceId: string; /** * Application specific placement rules for the particular volume */ placementRules?: outputs.netapp.PlacementKeyValuePairsResponse[]; /** * Set of protocol types, default NFSv3, CIFS for SMB protocol */ protocolTypes?: string[]; /** * The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides. */ provisionedAvailabilityZone: string; /** * Azure lifecycle management */ provisioningState: string; /** * Proximity placement group associated with the volume */ proximityPlacementGroup?: string; /** * The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol */ securityStyle?: string; /** * The service level of the file system */ serviceLevel?: string; /** * Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume */ smbAccessBasedEnumeration?: string; /** * Enables continuously available share property for smb volume. Only applicable for SMB volume */ smbContinuouslyAvailable?: boolean; /** * Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later */ smbEncryption?: boolean; /** * Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume */ smbNonBrowsable?: string; /** * If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true). */ snapshotDirectoryVisible?: boolean; /** * Resource identifier used to identify the Snapshot. */ snapshotId?: string; /** * Provides storage to network proximity information for the volume. */ storageToNetworkProximity: string; /** * The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes */ subnetId: string; /** * T2 network information */ t2Network: string; /** * Resource tags */ tags?: { [key: string]: string; }; throughputMibps?: number; /** * Resource type */ type: string; /** * UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users. */ unixPermissions?: string; /** * Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB. */ usageThreshold: number; /** * Volume Group Name */ volumeGroupName: string; /** * Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log */ volumeSpecName?: string; /** * What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection */ volumeType?: string; /** * Availability Zone */ zones?: string[]; } /** * volumeGroupVolumePropertiesResponseProvideDefaults sets the appropriate defaults for VolumeGroupVolumePropertiesResponse */ function volumeGroupVolumePropertiesResponseProvideDefaults(val: VolumeGroupVolumePropertiesResponse): VolumeGroupVolumePropertiesResponse; /** * DataProtection type volumes include an object containing details of the replication */ interface VolumePropertiesResponseDataProtection { /** * Backup Properties */ backup?: outputs.netapp.VolumeBackupPropertiesResponse; /** * Replication properties */ replication?: outputs.netapp.ReplicationObjectResponse; /** * Snapshot properties. */ snapshot?: outputs.netapp.VolumeSnapshotPropertiesResponse; /** * VolumeRelocation properties */ volumeRelocation?: outputs.netapp.VolumeRelocationPropertiesResponse; } /** * Set of export policy rules */ interface VolumePropertiesResponseExportPolicy { /** * Export policy rule */ rules?: outputs.netapp.ExportPolicyRuleCapacityPoolVolumeResponse[]; } /** * Set of export policy rules */ interface VolumePropertiesResponseExportPolicyV1 { /** * Export policy rule */ rules?: outputs.netapp.ExportPolicyRuleVolumeGroupResponse[]; } /** * Volume relocation properties */ interface VolumeRelocationPropertiesResponse { /** * Has relocation finished and is ready to be cleaned up */ readyToBeFinalized: boolean; /** * Has relocation been requested for this volume */ relocationRequested?: boolean; } /** * Volume Snapshot Properties */ interface VolumeSnapshotPropertiesResponse { /** * Snapshot Policy ResourceId */ snapshotPolicyId?: string; } /** * Weekly Schedule properties, make a snapshot every week at a specific day or days */ interface WeeklyScheduleResponse { /** * Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english */ day?: string; /** * Indicates which hour in UTC timezone a snapshot should be taken */ hour?: number; /** * Indicates which minute snapshot should be taken */ minute?: number; /** * Weekly snapshot count to keep */ snapshotsToKeep?: number; /** * Resource size in bytes, current storage usage for the volume in bytes */ usedBytes?: number; } } export declare namespace network { /** * AAD Vpn authentication type related parameters. */ interface AadAuthenticationParametersResponse { /** * AAD Vpn authentication parameter AAD audience. */ aadAudience?: string; /** * AAD Vpn authentication parameter AAD issuer. */ aadIssuer?: string; /** * AAD Vpn authentication parameter AAD tenant. */ aadTenant?: string; } /** * Action to be taken on a route matching a RouteMap criterion. */ interface ActionResponse { /** * List of parameters relevant to the action.For instance if type is drop then parameters has list of prefixes to be dropped.If type is add, parameters would have list of ASN numbers to be added */ parameters?: outputs.network.ParameterResponse[]; /** * Type of action to be taken. Supported types are 'Remove', 'Add', 'Replace', and 'Drop.' */ type?: string; } /** * Active connectivity configuration. */ interface ActiveConnectivityConfigurationResponse { /** * Groups for configuration */ appliesToGroups?: outputs.network.ConnectivityGroupItemlistActiveConnectivityConfigurationResponse[]; /** * Deployment time string. */ commitTime?: string; /** * Effective configuration groups. */ configurationGroups?: outputs.network.ConfigurationGroupResponse[]; /** * Connectivity topology type. */ connectivityTopology: string; /** * Flag if need to remove current existing peerings. */ deleteExistingPeering?: string; /** * A description of the connectivity configuration. */ description?: string; /** * A friendly name for the resource. */ displayName?: string; /** * List of hubItems */ hubs?: outputs.network.HubResponse[]; /** * Resource ID. */ id?: string; /** * Flag if global mesh is supported. */ isGlobal?: string; /** * The provisioning state of the connectivity configuration resource. */ provisioningState: string; /** * Deployment region. */ region?: string; } /** * Active connectivity configuration. */ interface ActiveConnectivityConfigurationlistActiveConnectivityConfigurationsResponse { /** * Groups for configuration */ appliesToGroups: outputs.network.ConnectivityGroupItemResponse[]; /** * Deployment time string. */ commitTime?: string; /** * Effective configuration groups. */ configurationGroups?: outputs.network.ConfigurationGrouplistActiveConnectivityConfigurationsResponse[]; /** * Connectivity topology type. */ connectivityTopology: string; /** * Flag if need to remove current existing peerings. */ deleteExistingPeering?: string; /** * A description of the connectivity configuration. */ description?: string; /** * List of hubItems */ hubs?: outputs.network.HubResponse[]; /** * Connectivity configuration ID. */ id?: string; /** * Flag if global mesh is supported. */ isGlobal?: string; /** * The provisioning state of the connectivity configuration resource. */ provisioningState: string; /** * Deployment region. */ region?: string; /** * Unique identifier for this resource. */ resourceGuid: string; } /** * Network default admin rule. */ interface ActiveDefaultSecurityAdminRuleResponse { /** * Indicates the access allowed for this particular rule */ access: string; /** * Deployment time string. */ commitTime?: string; /** * A description of the security admin configuration. */ configurationDescription?: string; /** * A display name of the security admin configuration. */ configurationDisplayName?: string; /** * A description for this rule. Restricted to 140 chars. */ description: string; /** * The destination port ranges. */ destinationPortRanges: string[]; /** * The destination address prefixes. CIDR or destination IP ranges. */ destinations: outputs.network.AddressPrefixItemResponse[]; /** * Indicates if the traffic matched against the rule in inbound or outbound. */ direction: string; /** * A friendly name for the rule. */ displayName: string; /** * Default rule flag. */ flag?: string; /** * Resource ID. */ id?: string; /** * Whether the rule is custom or default. * Expected value is 'Default'. */ kind: "Default"; /** * The priority of the rule. The value can be between 1 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. */ priority: number; /** * Network protocol this rule applies to. */ protocol: string; /** * The provisioning state of the resource. */ provisioningState: string; /** * Deployment region. */ region?: string; /** * Groups for rule collection */ ruleCollectionAppliesToGroups?: outputs.network.NetworkManagerSecurityGroupItemlistActiveSecurityAdminRuleResponse[]; /** * A description of the rule collection. */ ruleCollectionDescription?: string; /** * A display name of the rule collection. */ ruleCollectionDisplayName?: string; /** * Effective configuration groups. */ ruleGroups?: outputs.network.ConfigurationGroupResponse[]; /** * The source port ranges. */ sourcePortRanges: string[]; /** * The CIDR or source IP ranges. */ sources: outputs.network.AddressPrefixItemResponse[]; } /** * Network default admin rule. */ interface ActiveDefaultSecurityAdminRulelistActiveSecurityAdminRulesResponse { /** * Indicates the access allowed for this particular rule */ access: string; /** * Deployment time string. */ commitTime?: string; /** * A description of the security admin configuration. */ configurationDescription?: string; /** * A description for this rule. Restricted to 140 chars. */ description: string; /** * The destination port ranges. */ destinationPortRanges: string[]; /** * The destination address prefixes. CIDR or destination IP ranges. */ destinations: outputs.network.AddressPrefixItemResponse[]; /** * Indicates if the traffic matched against the rule in inbound or outbound. */ direction: string; /** * Default rule flag. */ flag?: string; /** * Resource ID. */ id?: string; /** * Whether the rule is custom or default. * Expected value is 'Default'. */ kind: "Default"; /** * The priority of the rule. The value can be between 1 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. */ priority: number; /** * Network protocol this rule applies to. */ protocol: string; /** * The provisioning state of the resource. */ provisioningState: string; /** * Deployment region. */ region?: string; /** * Unique identifier for this resource. */ resourceGuid: string; /** * Groups for rule collection */ ruleCollectionAppliesToGroups?: outputs.network.NetworkManagerSecurityGroupItemResponse[]; /** * A description of the rule collection. */ ruleCollectionDescription?: string; /** * Effective configuration groups. */ ruleGroups?: outputs.network.ConfigurationGrouplistActiveSecurityAdminRulesResponse[]; /** * The source port ranges. */ sourcePortRanges: string[]; /** * The CIDR or source IP ranges. */ sources: outputs.network.AddressPrefixItemResponse[]; } /** * Network security default user rule. */ interface ActiveDefaultSecurityUserRuleResponse { /** * Deployment time string. */ commitTime?: string; /** * A description of the security user configuration. */ configurationDescription?: string; /** * A display name of the security user configuration. */ configurationDisplayName?: string; /** * A description for this rule. Restricted to 140 chars. */ description: string; /** * The destination port ranges. */ destinationPortRanges: string[]; /** * The destination address prefixes. CIDR or destination IP ranges. */ destinations: outputs.network.AddressPrefixItemResponse[]; /** * Indicates if the traffic matched against the rule in inbound or outbound. */ direction: string; /** * A friendly name for the rule. */ displayName: string; /** * Default rule flag. */ flag?: string; /** * Resource ID. */ id?: string; /** * Whether the rule is custom or default. * Expected value is 'Default'. */ kind: "Default"; /** * Network protocol this rule applies to. */ protocol: string; /** * The provisioning state of the security configuration user rule resource. */ provisioningState: string; /** * Deployment region. */ region?: string; /** * Groups for rule collection */ ruleCollectionAppliesToGroups?: outputs.network.NetworkManagerSecurityGroupItemlistActiveSecurityUserRuleResponse[]; /** * A description of the rule collection. */ ruleCollectionDescription?: string; /** * A display name of the rule collection. */ ruleCollectionDisplayName?: string; /** * Effective configuration groups. */ ruleGroups?: outputs.network.ConfigurationGroupResponse[]; /** * The source port ranges. */ sourcePortRanges: string[]; /** * The CIDR or source IP ranges. */ sources: outputs.network.AddressPrefixItemResponse[]; } /** * Network security default user rule. */ interface ActiveDefaultSecurityUserRulelistActiveSecurityUserRulesResponse { /** * Deployment time string. */ commitTime?: string; /** * A description of the security user configuration. */ configurationDescription?: string; /** * A description for this rule. Restricted to 140 chars. */ description: string; /** * The destination port ranges. */ destinationPortRanges: string[]; /** * The destination address prefixes. CIDR or destination IP ranges. */ destinations: outputs.network.AddressPrefixItemResponse[]; /** * Indicates if the traffic matched against the rule in inbound or outbound. */ direction: string; /** * Default rule flag. */ flag?: string; /** * Resource ID. */ id?: string; /** * Whether the rule is custom or default. * Expected value is 'Default'. */ kind: "Default"; /** * Network protocol this rule applies to. */ protocol: string; /** * The provisioning state of the security configuration user rule resource. */ provisioningState: string; /** * Deployment region. */ region?: string; /** * Groups for rule collection */ ruleCollectionAppliesToGroups?: outputs.network.NetworkManagerSecurityGroupItemResponse[]; /** * A description of the rule collection. */ ruleCollectionDescription?: string; /** * Effective configuration groups. */ ruleGroups?: outputs.network.ConfigurationGrouplistActiveSecurityUserRulesResponse[]; /** * The source port ranges. */ sourcePortRanges: string[]; /** * The CIDR or source IP ranges. */ sources: outputs.network.AddressPrefixItemResponse[]; } /** * Network admin rule. */ interface ActiveSecurityAdminRuleResponse { /** * Indicates the access allowed for this particular rule */ access: string; /** * Deployment time string. */ commitTime?: string; /** * A description of the security admin configuration. */ configurationDescription?: string; /** * A display name of the security admin configuration. */ configurationDisplayName?: string; /** * A description for this rule. Restricted to 140 chars. */ description?: string; /** * The destination port ranges. */ destinationPortRanges?: string[]; /** * The destination address prefixes. CIDR or destination IP ranges. */ destinations?: outputs.network.AddressPrefixItemResponse[]; /** * Indicates if the traffic matched against the rule in inbound or outbound. */ direction: string; /** * A friendly name for the rule. */ displayName?: string; /** * Resource ID. */ id?: string; /** * Whether the rule is custom or default. * Expected value is 'Custom'. */ kind: "Custom"; /** * The priority of the rule. The value can be between 1 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. */ priority?: number; /** * Network protocol this rule applies to. */ protocol: string; /** * The provisioning state of the resource. */ provisioningState: string; /** * Deployment region. */ region?: string; /** * Groups for rule collection */ ruleCollectionAppliesToGroups?: outputs.network.NetworkManagerSecurityGroupItemlistActiveSecurityAdminRuleResponse[]; /** * A description of the rule collection. */ ruleCollectionDescription?: string; /** * A display name of the rule collection. */ ruleCollectionDisplayName?: string; /** * Effective configuration groups. */ ruleGroups?: outputs.network.ConfigurationGroupResponse[]; /** * The source port ranges. */ sourcePortRanges?: string[]; /** * The CIDR or source IP ranges. */ sources?: outputs.network.AddressPrefixItemResponse[]; } /** * Network admin rule. */ interface ActiveSecurityAdminRulelistActiveSecurityAdminRulesResponse { /** * Indicates the access allowed for this particular rule */ access: string; /** * Deployment time string. */ commitTime?: string; /** * A description of the security admin configuration. */ configurationDescription?: string; /** * A description for this rule. Restricted to 140 chars. */ description?: string; /** * The destination port ranges. */ destinationPortRanges?: string[]; /** * The destination address prefixes. CIDR or destination IP ranges. */ destinations?: outputs.network.AddressPrefixItemResponse[]; /** * Indicates if the traffic matched against the rule in inbound or outbound. */ direction: string; /** * Resource ID. */ id?: string; /** * Whether the rule is custom or default. * Expected value is 'Custom'. */ kind: "Custom"; /** * The priority of the rule. The value can be between 1 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. */ priority: number; /** * Network protocol this rule applies to. */ protocol: string; /** * The provisioning state of the resource. */ provisioningState: string; /** * Deployment region. */ region?: string; /** * Unique identifier for this resource. */ resourceGuid: string; /** * Groups for rule collection */ ruleCollectionAppliesToGroups?: outputs.network.NetworkManagerSecurityGroupItemResponse[]; /** * A description of the rule collection. */ ruleCollectionDescription?: string; /** * Effective configuration groups. */ ruleGroups?: outputs.network.ConfigurationGrouplistActiveSecurityAdminRulesResponse[]; /** * The source port ranges. */ sourcePortRanges?: string[]; /** * The CIDR or source IP ranges. */ sources?: outputs.network.AddressPrefixItemResponse[]; } /** * Network security user rule. */ interface ActiveSecurityUserRuleResponse { /** * Deployment time string. */ commitTime?: string; /** * A description of the security user configuration. */ configurationDescription?: string; /** * A display name of the security user configuration. */ configurationDisplayName?: string; /** * A description for this rule. */ description?: string; /** * The destination port ranges. */ destinationPortRanges?: string[]; /** * The destination address prefixes. CIDR or destination IP ranges. */ destinations?: outputs.network.AddressPrefixItemResponse[]; /** * Indicates if the traffic matched against the rule in inbound or outbound. */ direction: string; /** * A friendly name for the rule. */ displayName?: string; /** * Resource ID. */ id?: string; /** * Whether the rule is custom or default. * Expected value is 'Custom'. */ kind: "Custom"; /** * Network protocol this rule applies to. */ protocol: string; /** * The provisioning state of the security configuration user rule resource. */ provisioningState: string; /** * Deployment region. */ region?: string; /** * Groups for rule collection */ ruleCollectionAppliesToGroups?: outputs.network.NetworkManagerSecurityGroupItemlistActiveSecurityUserRuleResponse[]; /** * A description of the rule collection. */ ruleCollectionDescription?: string; /** * A display name of the rule collection. */ ruleCollectionDisplayName?: string; /** * Effective configuration groups. */ ruleGroups?: outputs.network.ConfigurationGroupResponse[]; /** * The source port ranges. */ sourcePortRanges?: string[]; /** * The CIDR or source IP ranges. */ sources?: outputs.network.AddressPrefixItemResponse[]; } /** * Network security user rule. */ interface ActiveSecurityUserRulelistActiveSecurityUserRulesResponse { /** * Deployment time string. */ commitTime?: string; /** * A description of the security user configuration. */ configurationDescription?: string; /** * A description for this rule. */ description?: string; /** * The destination port ranges. */ destinationPortRanges?: string[]; /** * The destination address prefixes. CIDR or destination IP ranges. */ destinations?: outputs.network.AddressPrefixItemResponse[]; /** * Indicates if the traffic matched against the rule in inbound or outbound. */ direction: string; /** * Resource ID. */ id?: string; /** * Whether the rule is custom or default. * Expected value is 'Custom'. */ kind: "Custom"; /** * Network protocol this rule applies to. */ protocol: string; /** * The provisioning state of the security configuration user rule resource. */ provisioningState: string; /** * Deployment region. */ region?: string; /** * Groups for rule collection */ ruleCollectionAppliesToGroups?: outputs.network.NetworkManagerSecurityGroupItemResponse[]; /** * A description of the rule collection. */ ruleCollectionDescription?: string; /** * Effective configuration groups. */ ruleGroups?: outputs.network.ConfigurationGrouplistActiveSecurityUserRulesResponse[]; /** * The source port ranges. */ sourcePortRanges?: string[]; /** * The CIDR or source IP ranges. */ sources?: outputs.network.AddressPrefixItemResponse[]; } /** * Address prefix item. */ interface AddressPrefixItemResponse { /** * Address prefix. */ addressPrefix?: string; /** * Address prefix type. */ addressPrefixType?: string; } /** * AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network. */ interface AddressSpaceResponse { /** * A list of address blocks reserved for this virtual network in CIDR notation. */ addressPrefixes?: string[]; /** * A list of IPAM Pools allocating IP address prefixes. */ ipamPoolPrefixAllocations?: outputs.network.IpamPoolPrefixAllocationResponse[]; } /** * Authentication certificates of an application gateway. */ interface ApplicationGatewayAuthenticationCertificateResponse { /** * Certificate public data. */ data?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the authentication certificate that is unique within an Application Gateway. */ name?: string; /** * The provisioning state of the authentication certificate resource. */ provisioningState: string; /** * Type of the resource. */ type: string; } /** * Application Gateway autoscale configuration. */ interface ApplicationGatewayAutoscaleConfigurationResponse { /** * Upper bound on number of Application Gateway capacity. */ maxCapacity?: number; /** * Lower bound on number of Application Gateway capacity. */ minCapacity: number; } /** * Backend Address Pool of an application gateway. */ interface ApplicationGatewayBackendAddressPoolInterfaceEndpointResponse { /** * Backend addresses */ backendAddresses?: outputs.network.ApplicationGatewayBackendAddressResponse[]; /** * Collection of references to IPs defined in network interfaces. */ backendIPConfigurations?: outputs.network.NetworkInterfaceIPConfigurationInterfaceEndpointResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * Name of the backend address pool that is unique within an Application Gateway. */ name?: string; /** * Provisioning state of the backend address pool resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState?: string; /** * Type of the resource. */ type?: string; } /** * Backend Address Pool of an application gateway. */ interface ApplicationGatewayBackendAddressPoolResponse { /** * Backend addresses. */ backendAddresses?: outputs.network.ApplicationGatewayBackendAddressResponse[]; /** * Collection of references to IPs defined in network interfaces. */ backendIPConfigurations: outputs.network.NetworkInterfaceIPConfigurationResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the backend address pool that is unique within an Application Gateway. */ name?: string; /** * The provisioning state of the backend address pool resource. */ provisioningState: string; /** * Type of the resource. */ type: string; } /** * Backend Address Pool of an application gateway. */ interface ApplicationGatewayBackendAddressPoolServiceGatewayResponse { /** * Backend addresses. */ backendAddresses?: outputs.network.ApplicationGatewayBackendAddressResponse[]; /** * Collection of references to IPs defined in network interfaces. */ backendIPConfigurations: outputs.network.NetworkInterfaceIPConfigurationServiceGatewayResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the backend address pool that is unique within an Application Gateway. */ name?: string; /** * The provisioning state of the backend address pool resource. */ provisioningState: string; /** * Type of the resource. */ type: string; } /** * Backend Address Pool of an application gateway. */ interface ApplicationGatewayBackendAddressPoolVirtualNetworkApplianceResponse { /** * Backend addresses. */ backendAddresses?: outputs.network.ApplicationGatewayBackendAddressResponse[]; /** * Collection of references to IPs defined in network interfaces. */ backendIPConfigurations: outputs.network.NetworkInterfaceIPConfigurationVirtualNetworkApplianceResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the backend address pool that is unique within an Application Gateway. */ name?: string; /** * The provisioning state of the backend address pool resource. */ provisioningState: string; /** * Type of the resource. */ type: string; } /** * Backend address of an application gateway. */ interface ApplicationGatewayBackendAddressResponse { /** * Fully qualified domain name (FQDN). */ fqdn?: string; /** * IP address. */ ipAddress?: string; } /** * Application gateway BackendHealthHttp settings. */ interface ApplicationGatewayBackendHealthHttpSettingsResponse { /** * Reference to an ApplicationGatewayBackendHttpSettings resource. */ backendHttpSettings?: outputs.network.ApplicationGatewayBackendHttpSettingsResponse; /** * List of ApplicationGatewayBackendHealthServer resources. */ servers?: outputs.network.ApplicationGatewayBackendHealthServerResponse[]; } /** * Application gateway backendhealth http settings. */ interface ApplicationGatewayBackendHealthServerResponse { /** * IP address or FQDN of backend server. */ address?: string; /** * Health of backend server. */ health?: string; /** * Health Probe Log. */ healthProbeLog?: string; /** * Reference to IP configuration of backend server. */ ipConfiguration?: outputs.network.NetworkInterfaceIPConfigurationResponse; } /** * applicationGatewayBackendHealthServerResponseProvideDefaults sets the appropriate defaults for ApplicationGatewayBackendHealthServerResponse */ function applicationGatewayBackendHealthServerResponseProvideDefaults(val: ApplicationGatewayBackendHealthServerResponse): ApplicationGatewayBackendHealthServerResponse; /** * Backend address pool settings of an application gateway. */ interface ApplicationGatewayBackendHttpSettingsResponse { /** * Cookie name to use for the affinity cookie. */ affinityCookieName?: string; /** * Array of references to application gateway authentication certificates. */ authenticationCertificates?: outputs.network.SubResourceResponse[]; /** * Connection draining of the backend http settings resource. */ connectionDraining?: outputs.network.ApplicationGatewayConnectionDrainingResponse; /** * Cookie based affinity. */ cookieBasedAffinity?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Host header to be sent to the backend servers. */ hostName?: string; /** * Resource ID. */ id?: string; /** * Name of the backend http settings that is unique within an Application Gateway. */ name?: string; /** * Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null. */ path?: string; /** * Whether to pick host header should be picked from the host name of the backend server. Default value is false. */ pickHostNameFromBackendAddress?: boolean; /** * The destination port on the backend. */ port?: number; /** * Probe resource of an application gateway. */ probe?: outputs.network.SubResourceResponse; /** * Whether the probe is enabled. Default value is false. */ probeEnabled?: boolean; /** * The protocol used to communicate with the backend. */ protocol?: string; /** * The provisioning state of the backend HTTP settings resource. */ provisioningState: string; /** * Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds. */ requestTimeout?: number; /** * Array of references to application gateway trusted root certificates. */ trustedRootCertificates?: outputs.network.SubResourceResponse[]; /** * Type of the resource. */ type: string; } /** * Backend address pool settings of an application gateway. */ interface ApplicationGatewayBackendSettingsResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Server name indication to be sent to the backend servers for Tls protocol. */ hostName?: string; /** * Resource ID. */ id?: string; /** * Name of the backend settings that is unique within an Application Gateway. */ name?: string; /** * Whether to pick server name indication from the host name of the backend server for Tls protocol. Default value is false. */ pickHostNameFromBackendAddress?: boolean; /** * The destination port on the backend. */ port?: number; /** * Probe resource of an application gateway. */ probe?: outputs.network.SubResourceResponse; /** * The protocol used to communicate with the backend. */ protocol?: string; /** * The provisioning state of the backend HTTP settings resource. */ provisioningState: string; /** * Connection timeout in seconds. Application Gateway will fail the request if response is not received within ConnectionTimeout. Acceptable values are from 1 second to 86400 seconds. */ timeout?: number; /** * Array of references to application gateway trusted root certificates. */ trustedRootCertificates?: outputs.network.SubResourceResponse[]; /** * Type of the resource. */ type: string; } /** * Application gateway client authentication configuration. */ interface ApplicationGatewayClientAuthConfigurationResponse { /** * Verify client certificate issuer name on the application gateway. */ verifyClientCertIssuerDN?: boolean; /** * Verify client certificate revocation status. */ verifyClientRevocation?: string; } /** * Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration. */ interface ApplicationGatewayConnectionDrainingResponse { /** * The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds. */ drainTimeoutInSec: number; /** * Whether connection draining is enabled or not. */ enabled: boolean; } /** * Custom error of an application gateway. */ interface ApplicationGatewayCustomErrorResponse { /** * Error page URL of the application gateway custom error. */ customErrorPageUrl?: string; /** * Status code of the application gateway custom error. */ statusCode?: string; } /** * Allows to disable rules within a rule group or an entire rule group. */ interface ApplicationGatewayFirewallDisabledRuleGroupResponse { /** * The name of the rule group that will be disabled. */ ruleGroupName: string; /** * The list of rules that will be disabled. If null, all rules of the rule group will be disabled. */ rules?: number[]; } /** * Allow to exclude some variable satisfy the condition for the WAF check. */ interface ApplicationGatewayFirewallExclusionResponse { /** * The variable to be excluded. */ matchVariable: string; /** * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. */ selector: string; /** * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. */ selectorMatchOperator: string; } /** * Defines an application gateway for containers reference. */ interface ApplicationGatewayForContainersReferenceDefinitionResponse { /** * Resource Id of the application gateway for containers. */ id: string; } /** * Frontend IP configuration of an application gateway. */ interface ApplicationGatewayFrontendIPConfigurationResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the frontend IP configuration that is unique within an Application Gateway. */ name?: string; /** * PrivateIPAddress of the network interface IP Configuration. */ privateIPAddress?: string; /** * The private IP address allocation method. */ privateIPAllocationMethod?: string; /** * Reference to the application gateway private link configuration. */ privateLinkConfiguration?: outputs.network.SubResourceResponse; /** * The provisioning state of the frontend IP configuration resource. */ provisioningState: string; /** * Reference to the PublicIP resource. */ publicIPAddress?: outputs.network.SubResourceResponse; /** * Reference to the subnet resource. */ subnet?: outputs.network.SubResourceResponse; /** * Type of the resource. */ type: string; } /** * Frontend port of an application gateway. */ interface ApplicationGatewayFrontendPortResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the frontend port that is unique within an Application Gateway. */ name?: string; /** * Frontend port. */ port?: number; /** * The provisioning state of the frontend port resource. */ provisioningState: string; /** * Type of the resource. */ type: string; } /** * Application Gateway global configuration. */ interface ApplicationGatewayGlobalConfigurationResponse { /** * Enable request buffering. */ enableRequestBuffering?: boolean; /** * Enable response buffering. */ enableResponseBuffering?: boolean; } /** * Header configuration of the Actions set in Application Gateway. */ interface ApplicationGatewayHeaderConfigurationResponse { /** * Header name of the header configuration. */ headerName?: string; /** * Header value of the header configuration. */ headerValue?: string; /** * An optional field under "Rewrite Action". It lets you capture and modify the value(s) of a specific header when multiple headers with the same name exist. Currently supported for Set-Cookie Response header only. For more details, visit https://aka.ms/appgwheadercrud */ headerValueMatcher?: outputs.network.HeaderValueMatcherResponse; } /** * Http listener of an application gateway. */ interface ApplicationGatewayHttpListenerResponse { /** * Custom error configurations of the HTTP listener. */ customErrorConfigurations?: outputs.network.ApplicationGatewayCustomErrorResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Reference to the FirewallPolicy resource. */ firewallPolicy?: outputs.network.SubResourceResponse; /** * Frontend IP configuration resource of an application gateway. */ frontendIPConfiguration?: outputs.network.SubResourceResponse; /** * Frontend port resource of an application gateway. */ frontendPort?: outputs.network.SubResourceResponse; /** * Host name of HTTP listener. */ hostName?: string; /** * List of Host names for HTTP Listener that allows special wildcard characters as well. */ hostNames?: string[]; /** * Resource ID. */ id?: string; /** * Name of the HTTP listener that is unique within an Application Gateway. */ name?: string; /** * Protocol of the HTTP listener. */ protocol?: string; /** * The provisioning state of the HTTP listener resource. */ provisioningState: string; /** * Applicable only if protocol is https. Enables SNI for multi-hosting. */ requireServerNameIndication?: boolean; /** * SSL certificate resource of an application gateway. */ sslCertificate?: outputs.network.SubResourceResponse; /** * SSL profile resource of the application gateway. */ sslProfile?: outputs.network.SubResourceResponse; /** * Type of the resource. */ type: string; } /** * IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed. */ interface ApplicationGatewayIPConfigurationResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the IP configuration that is unique within an Application Gateway. */ name?: string; /** * The provisioning state of the application gateway IP configuration resource. */ provisioningState: string; /** * Reference to the subnet resource. A subnet from where application gateway gets its private address. */ subnet?: outputs.network.SubResourceResponse; /** * Type of the resource. */ type: string; } /** * Listener of an application gateway. */ interface ApplicationGatewayListenerResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Frontend IP configuration resource of an application gateway. */ frontendIPConfiguration?: outputs.network.SubResourceResponse; /** * Frontend port resource of an application gateway. */ frontendPort?: outputs.network.SubResourceResponse; /** * List of Server Name Indications(SNI) for TLS Multi-site Listener that allows special wildcard characters as well. */ hostNames?: string[]; /** * Resource ID. */ id?: string; /** * Name of the listener that is unique within an Application Gateway. */ name?: string; /** * Protocol of the listener. */ protocol?: string; /** * The provisioning state of the listener resource. */ provisioningState: string; /** * SSL certificate resource of an application gateway. */ sslCertificate?: outputs.network.SubResourceResponse; /** * SSL profile resource of the application gateway. */ sslProfile?: outputs.network.SubResourceResponse; /** * Type of the resource. */ type: string; } /** * Load Distribution Policy of an application gateway. */ interface ApplicationGatewayLoadDistributionPolicyResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Load Distribution Targets resource of an application gateway. */ loadDistributionAlgorithm?: string; /** * Load Distribution Targets resource of an application gateway. */ loadDistributionTargets?: outputs.network.ApplicationGatewayLoadDistributionTargetResponse[]; /** * Name of the load distribution policy that is unique within an Application Gateway. */ name?: string; /** * The provisioning state of the Load Distribution Policy resource. */ provisioningState: string; /** * Type of the resource. */ type: string; } /** * Load Distribution Target of an application gateway. */ interface ApplicationGatewayLoadDistributionTargetResponse { /** * Backend address pool resource of the application gateway. */ backendAddressPool?: outputs.network.SubResourceResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the load distribution policy that is unique within an Application Gateway. */ name?: string; /** * Type of the resource. */ type: string; /** * Weight per server. Range between 1 and 100. */ weightPerServer?: number; } /** * Path rule of URL path map of an application gateway. */ interface ApplicationGatewayPathRuleResponse { /** * Backend address pool resource of URL path map path rule. */ backendAddressPool?: outputs.network.SubResourceResponse; /** * Backend http settings resource of URL path map path rule. */ backendHttpSettings?: outputs.network.SubResourceResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Reference to the FirewallPolicy resource. */ firewallPolicy?: outputs.network.SubResourceResponse; /** * Resource ID. */ id?: string; /** * Load Distribution Policy resource of URL path map path rule. */ loadDistributionPolicy?: outputs.network.SubResourceResponse; /** * Name of the path rule that is unique within an Application Gateway. */ name?: string; /** * Path rules of URL path map. */ paths?: string[]; /** * The provisioning state of the path rule resource. */ provisioningState: string; /** * Redirect configuration resource of URL path map path rule. */ redirectConfiguration?: outputs.network.SubResourceResponse; /** * Rewrite rule set resource of URL path map path rule. */ rewriteRuleSet?: outputs.network.SubResourceResponse; /** * Type of the resource. */ type: string; } /** * Private Endpoint connection on an application gateway. */ interface ApplicationGatewayPrivateEndpointConnectionResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The consumer link id. */ linkIdentifier: string; /** * Name of the private endpoint connection on an application gateway. */ name?: string; /** * The resource of private end point. */ privateEndpoint: outputs.network.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState?: outputs.network.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the application gateway private endpoint connection resource. */ provisioningState: string; /** * Type of the resource. */ type: string; } /** * applicationGatewayPrivateEndpointConnectionResponseProvideDefaults sets the appropriate defaults for ApplicationGatewayPrivateEndpointConnectionResponse */ function applicationGatewayPrivateEndpointConnectionResponseProvideDefaults(val: ApplicationGatewayPrivateEndpointConnectionResponse): ApplicationGatewayPrivateEndpointConnectionResponse; /** * Private Link Configuration on an application gateway. */ interface ApplicationGatewayPrivateLinkConfigurationResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * An array of application gateway private link ip configurations. */ ipConfigurations?: outputs.network.ApplicationGatewayPrivateLinkIpConfigurationResponse[]; /** * Name of the private link configuration that is unique within an Application Gateway. */ name?: string; /** * The provisioning state of the application gateway private link configuration. */ provisioningState: string; /** * Type of the resource. */ type: string; } /** * The application gateway private link ip configuration. */ interface ApplicationGatewayPrivateLinkIpConfigurationResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of application gateway private link ip configuration. */ name?: string; /** * Whether the ip configuration is primary or not. */ primary?: boolean; /** * The private IP address of the IP configuration. */ privateIPAddress?: string; /** * The private IP address allocation method. */ privateIPAllocationMethod?: string; /** * The provisioning state of the application gateway private link IP configuration. */ provisioningState: string; /** * Reference to the subnet resource. */ subnet?: outputs.network.SubResourceResponse; /** * The resource type. */ type: string; } /** * Application gateway probe health response match. */ interface ApplicationGatewayProbeHealthResponseMatchResponse { /** * Body that must be contained in the health response. Default value is empty. */ body?: string; /** * Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399. */ statusCodes?: string[]; } /** * Probe of the application gateway. */ interface ApplicationGatewayProbeResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Host name to send the probe to. */ host?: string; /** * Resource ID. */ id?: string; /** * The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds. */ interval?: number; /** * Criterion for classifying a healthy probe response. */ match?: outputs.network.ApplicationGatewayProbeHealthResponseMatchResponse; /** * Minimum number of servers that are always marked healthy. Default value is 0. */ minServers?: number; /** * Name of the probe that is unique within an Application Gateway. */ name?: string; /** * Relative path of probe. Valid path starts from '/'. Probe is sent to ://:. */ path?: string; /** * Whether the host header should be picked from the backend http settings. Default value is false. */ pickHostNameFromBackendHttpSettings?: boolean; /** * Whether the server name indication should be picked from the backend settings for Tls protocol. Default value is false. */ pickHostNameFromBackendSettings?: boolean; /** * Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Basic, Standard_v2 and WAF_v2 only. */ port?: number; /** * The protocol used for the probe. */ protocol?: string; /** * The provisioning state of the probe resource. */ provisioningState: string; /** * The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds. */ timeout?: number; /** * Type of the resource. */ type: string; /** * The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20. */ unhealthyThreshold?: number; } /** * Redirect configuration of an application gateway. */ interface ApplicationGatewayRedirectConfigurationResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Include path in the redirected url. */ includePath?: boolean; /** * Include query string in the redirected url. */ includeQueryString?: boolean; /** * Name of the redirect configuration that is unique within an Application Gateway. */ name?: string; /** * Path rules specifying redirect configuration. */ pathRules?: outputs.network.SubResourceResponse[]; /** * HTTP redirection type. */ redirectType?: string; /** * Request routing specifying redirect configuration. */ requestRoutingRules?: outputs.network.SubResourceResponse[]; /** * Reference to a listener to redirect the request to. */ targetListener?: outputs.network.SubResourceResponse; /** * Url to redirect the request to. */ targetUrl?: string; /** * Type of the resource. */ type: string; /** * Url path maps specifying default redirect configuration. */ urlPathMaps?: outputs.network.SubResourceResponse[]; } /** * Request routing rule of an application gateway. */ interface ApplicationGatewayRequestRoutingRuleResponse { /** * Backend address pool resource of the application gateway. */ backendAddressPool?: outputs.network.SubResourceResponse; /** * Backend http settings resource of the application gateway. */ backendHttpSettings?: outputs.network.SubResourceResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Http listener resource of the application gateway. */ httpListener?: outputs.network.SubResourceResponse; /** * Resource ID. */ id?: string; /** * Load Distribution Policy resource of the application gateway. */ loadDistributionPolicy?: outputs.network.SubResourceResponse; /** * Name of the request routing rule that is unique within an Application Gateway. */ name?: string; /** * Priority of the request routing rule. */ priority?: number; /** * The provisioning state of the request routing rule resource. */ provisioningState: string; /** * Redirect configuration resource of the application gateway. */ redirectConfiguration?: outputs.network.SubResourceResponse; /** * Rewrite Rule Set resource in Basic rule of the application gateway. */ rewriteRuleSet?: outputs.network.SubResourceResponse; /** * Rule type. */ ruleType?: string; /** * Type of the resource. */ type: string; /** * URL path map resource of the application gateway. */ urlPathMap?: outputs.network.SubResourceResponse; } /** * Application gateway resource. */ interface ApplicationGatewayResponse { /** * Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). */ authenticationCertificates?: outputs.network.ApplicationGatewayAuthenticationCertificateResponse[]; /** * Autoscale Configuration. */ autoscaleConfiguration?: outputs.network.ApplicationGatewayAutoscaleConfigurationResponse; /** * Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). */ backendAddressPools?: outputs.network.ApplicationGatewayBackendAddressPoolResponse[]; /** * Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). */ backendHttpSettingsCollection?: outputs.network.ApplicationGatewayBackendHttpSettingsResponse[]; /** * Backend settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). */ backendSettingsCollection?: outputs.network.ApplicationGatewayBackendSettingsResponse[]; /** * Custom error configurations of the application gateway resource. */ customErrorConfigurations?: outputs.network.ApplicationGatewayCustomErrorResponse[]; /** * The default predefined SSL Policy applied on the application gateway resource. */ defaultPredefinedSslPolicy: string; /** * Whether FIPS is enabled on the application gateway resource. */ enableFips?: boolean; /** * Whether HTTP2 is enabled on the application gateway resource. */ enableHttp2?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Reference to the FirewallPolicy resource. */ firewallPolicy?: outputs.network.SubResourceResponse; /** * If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config. */ forceFirewallPolicyAssociation?: boolean; /** * Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). */ frontendIPConfigurations?: outputs.network.ApplicationGatewayFrontendIPConfigurationResponse[]; /** * Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). */ frontendPorts?: outputs.network.ApplicationGatewayFrontendPortResponse[]; /** * Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). */ gatewayIPConfigurations?: outputs.network.ApplicationGatewayIPConfigurationResponse[]; /** * Global Configuration. */ globalConfiguration?: outputs.network.ApplicationGatewayGlobalConfigurationResponse; /** * Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). */ httpListeners?: outputs.network.ApplicationGatewayHttpListenerResponse[]; /** * Resource ID. */ id?: string; /** * The identity of the application gateway, if configured. */ identity?: outputs.network.ManagedServiceIdentityResponse; /** * Listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). */ listeners?: outputs.network.ApplicationGatewayListenerResponse[]; /** * Load distribution policies of the application gateway resource. */ loadDistributionPolicies?: outputs.network.ApplicationGatewayLoadDistributionPolicyResponse[]; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * Operational state of the application gateway resource. */ operationalState: string; /** * Private Endpoint connections on application gateway. */ privateEndpointConnections: outputs.network.ApplicationGatewayPrivateEndpointConnectionResponse[]; /** * PrivateLink configurations on application gateway. */ privateLinkConfigurations?: outputs.network.ApplicationGatewayPrivateLinkConfigurationResponse[]; /** * Probes of the application gateway resource. */ probes?: outputs.network.ApplicationGatewayProbeResponse[]; /** * The provisioning state of the application gateway resource. */ provisioningState: string; /** * Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). */ redirectConfigurations?: outputs.network.ApplicationGatewayRedirectConfigurationResponse[]; /** * Request routing rules of the application gateway resource. */ requestRoutingRules?: outputs.network.ApplicationGatewayRequestRoutingRuleResponse[]; /** * The resource GUID property of the application gateway resource. */ resourceGuid: string; /** * Rewrite rules for the application gateway resource. */ rewriteRuleSets?: outputs.network.ApplicationGatewayRewriteRuleSetResponse[]; /** * Routing rules of the application gateway resource. */ routingRules?: outputs.network.ApplicationGatewayRoutingRuleResponse[]; /** * SKU of the application gateway resource. */ sku?: outputs.network.ApplicationGatewaySkuResponse; /** * SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). */ sslCertificates?: outputs.network.ApplicationGatewaySslCertificateResponse[]; /** * SSL policy of the application gateway resource. */ sslPolicy?: outputs.network.ApplicationGatewaySslPolicyResponse; /** * SSL profiles of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). */ sslProfiles?: outputs.network.ApplicationGatewaySslProfileResponse[]; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Trusted client certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). */ trustedClientCertificates?: outputs.network.ApplicationGatewayTrustedClientCertificateResponse[]; /** * Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). */ trustedRootCertificates?: outputs.network.ApplicationGatewayTrustedRootCertificateResponse[]; /** * Resource type. */ type: string; /** * URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits). */ urlPathMaps?: outputs.network.ApplicationGatewayUrlPathMapResponse[]; /** * Web application firewall configuration. */ webApplicationFirewallConfiguration?: outputs.network.ApplicationGatewayWebApplicationFirewallConfigurationResponse; /** * A list of availability zones denoting where the resource needs to come from. */ zones?: string[]; } /** * Set of actions in the Rewrite Rule in Application Gateway. */ interface ApplicationGatewayRewriteRuleActionSetResponse { /** * Request Header Actions in the Action Set. */ requestHeaderConfigurations?: outputs.network.ApplicationGatewayHeaderConfigurationResponse[]; /** * Response Header Actions in the Action Set. */ responseHeaderConfigurations?: outputs.network.ApplicationGatewayHeaderConfigurationResponse[]; /** * Url Configuration Action in the Action Set. */ urlConfiguration?: outputs.network.ApplicationGatewayUrlConfigurationResponse; } /** * Set of conditions in the Rewrite Rule in Application Gateway. */ interface ApplicationGatewayRewriteRuleConditionResponse { /** * Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. */ ignoreCase?: boolean; /** * Setting this value as truth will force to check the negation of the condition given by the user. */ negate?: boolean; /** * The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition. */ pattern?: string; /** * The condition parameter of the RewriteRuleCondition. */ variable?: string; } /** * Rewrite rule of an application gateway. */ interface ApplicationGatewayRewriteRuleResponse { /** * Set of actions to be done as part of the rewrite Rule. */ actionSet?: outputs.network.ApplicationGatewayRewriteRuleActionSetResponse; /** * Conditions based on which the action set execution will be evaluated. */ conditions?: outputs.network.ApplicationGatewayRewriteRuleConditionResponse[]; /** * Name of the rewrite rule that is unique within an Application Gateway. */ name?: string; /** * Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet. */ ruleSequence?: number; } /** * Rewrite rule set of an application gateway. */ interface ApplicationGatewayRewriteRuleSetResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the rewrite rule set that is unique within an Application Gateway. */ name?: string; /** * The provisioning state of the rewrite rule set resource. */ provisioningState: string; /** * Rewrite rules in the rewrite rule set. */ rewriteRules?: outputs.network.ApplicationGatewayRewriteRuleResponse[]; } /** * Routing rule of an application gateway. */ interface ApplicationGatewayRoutingRuleResponse { /** * Backend address pool resource of the application gateway. */ backendAddressPool?: outputs.network.SubResourceResponse; /** * Backend settings resource of the application gateway. */ backendSettings?: outputs.network.SubResourceResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Listener resource of the application gateway. */ listener?: outputs.network.SubResourceResponse; /** * Name of the routing rule that is unique within an Application Gateway. */ name?: string; /** * Priority of the routing rule. */ priority: number; /** * The provisioning state of the request routing rule resource. */ provisioningState: string; /** * Rule type. */ ruleType?: string; /** * Type of the resource. */ type: string; } /** * SKU of an application gateway. */ interface ApplicationGatewaySkuResponse { /** * Capacity (instance count) of an application gateway. */ capacity?: number; /** * Family of an application gateway SKU. */ family?: string; /** * Name of an application gateway SKU. */ name?: string; /** * Tier of an application gateway. */ tier?: string; } /** * SSL certificates of an application gateway. */ interface ApplicationGatewaySslCertificateResponse { /** * Base-64 encoded pfx certificate. Only applicable in PUT Request. */ data?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. */ keyVaultSecretId?: string; /** * Name of the SSL certificate that is unique within an Application Gateway. */ name?: string; /** * Password for the pfx file specified in data. Only applicable in PUT request. */ password?: string; /** * The provisioning state of the SSL certificate resource. */ provisioningState: string; /** * Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request. */ publicCertData: string; /** * Type of the resource. */ type: string; } /** * Application Gateway Ssl policy. */ interface ApplicationGatewaySslPolicyResponse { /** * Ssl cipher suites to be enabled in the specified order to application gateway. */ cipherSuites?: string[]; /** * Ssl protocols to be disabled on application gateway. */ disabledSslProtocols?: string[]; /** * Minimum version of Ssl protocol to be supported on application gateway. */ minProtocolVersion?: string; /** * Name of Ssl predefined policy. */ policyName?: string; /** * Type of Ssl Policy. */ policyType?: string; } /** * SSL profile of an application gateway. */ interface ApplicationGatewaySslProfileResponse { /** * Client authentication configuration of the application gateway resource. */ clientAuthConfiguration?: outputs.network.ApplicationGatewayClientAuthConfigurationResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the SSL profile that is unique within an Application Gateway. */ name?: string; /** * The provisioning state of the HTTP listener resource. */ provisioningState: string; /** * SSL policy of the application gateway resource. */ sslPolicy?: outputs.network.ApplicationGatewaySslPolicyResponse; /** * Array of references to application gateway trusted client certificates. */ trustedClientCertificates?: outputs.network.SubResourceResponse[]; /** * Type of the resource. */ type: string; } /** * Trusted client certificates of an application gateway. */ interface ApplicationGatewayTrustedClientCertificateResponse { /** * Distinguished name of client certificate issuer. */ clientCertIssuerDN: string; /** * Certificate public data. */ data?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the trusted client certificate that is unique within an Application Gateway. */ name?: string; /** * The provisioning state of the trusted client certificate resource. */ provisioningState: string; /** * Type of the resource. */ type: string; /** * Validated certificate data. */ validatedCertData: string; } /** * Trusted Root certificates of an application gateway. */ interface ApplicationGatewayTrustedRootCertificateResponse { /** * Certificate public data. */ data?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. */ keyVaultSecretId?: string; /** * Name of the trusted root certificate that is unique within an Application Gateway. */ name?: string; /** * The provisioning state of the trusted root certificate resource. */ provisioningState: string; /** * Type of the resource. */ type: string; } /** * Url configuration of the Actions set in Application Gateway. */ interface ApplicationGatewayUrlConfigurationResponse { /** * Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null. */ modifiedPath?: string; /** * Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null. */ modifiedQueryString?: string; /** * If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path. Default value is false. */ reroute?: boolean; } /** * UrlPathMaps give a url path to the backend mapping information for PathBasedRouting. */ interface ApplicationGatewayUrlPathMapResponse { /** * Default backend address pool resource of URL path map. */ defaultBackendAddressPool?: outputs.network.SubResourceResponse; /** * Default backend http settings resource of URL path map. */ defaultBackendHttpSettings?: outputs.network.SubResourceResponse; /** * Default Load Distribution Policy resource of URL path map. */ defaultLoadDistributionPolicy?: outputs.network.SubResourceResponse; /** * Default redirect configuration resource of URL path map. */ defaultRedirectConfiguration?: outputs.network.SubResourceResponse; /** * Default Rewrite rule set resource of URL path map. */ defaultRewriteRuleSet?: outputs.network.SubResourceResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the URL path map that is unique within an Application Gateway. */ name?: string; /** * Path rule of URL path map resource. */ pathRules?: outputs.network.ApplicationGatewayPathRuleResponse[]; /** * The provisioning state of the URL path map resource. */ provisioningState: string; /** * Type of the resource. */ type: string; } /** * Application gateway web application firewall configuration. */ interface ApplicationGatewayWebApplicationFirewallConfigurationResponse { /** * The disabled rule groups. */ disabledRuleGroups?: outputs.network.ApplicationGatewayFirewallDisabledRuleGroupResponse[]; /** * Whether the web application firewall is enabled or not. */ enabled: boolean; /** * The exclusion list. */ exclusions?: outputs.network.ApplicationGatewayFirewallExclusionResponse[]; /** * Maximum file upload size in Mb for WAF. */ fileUploadLimitInMb?: number; /** * Web application firewall mode. */ firewallMode: string; /** * Maximum request body size for WAF. */ maxRequestBodySize?: number; /** * Maximum request body size in Kb for WAF. */ maxRequestBodySizeInKb?: number; /** * Whether allow WAF to check request Body. */ requestBodyCheck?: boolean; /** * The type of the web application firewall rule set. Possible values are: 'OWASP'. */ ruleSetType: string; /** * The version of the rule set type. */ ruleSetVersion: string; } /** * Rule condition of type application. */ interface ApplicationRuleConditionResponse { /** * Description of the rule condition. */ description?: string; /** * List of destination IP addresses or Service Tags. */ destinationAddresses?: string[]; /** * List of FQDN Tags for this rule condition. */ fqdnTags?: string[]; /** * Name of the rule condition. */ name?: string; /** * Array of Application Protocols. */ protocols?: outputs.network.FirewallPolicyRuleConditionApplicationProtocolResponse[]; /** * Rule Condition Type. * Expected value is 'ApplicationRuleCondition'. */ ruleConditionType: "ApplicationRuleCondition"; /** * List of source IP addresses for this rule. */ sourceAddresses?: string[]; /** * List of source IpGroups for this rule. */ sourceIpGroups?: string[]; /** * List of FQDNs for this rule condition. */ targetFqdns?: string[]; } /** * Rule of type application. */ interface ApplicationRuleResponse { /** * Description of the rule. */ description?: string; /** * List of destination IP addresses or Service Tags. */ destinationAddresses?: string[]; /** * List of FQDN Tags for this rule. */ fqdnTags?: string[]; /** * List of HTTP/S headers to insert. */ httpHeadersToInsert?: outputs.network.FirewallPolicyHttpHeaderToInsertResponse[]; /** * Name of the rule. */ name?: string; /** * Array of Application Protocols. */ protocols?: outputs.network.FirewallPolicyRuleApplicationProtocolResponse[]; /** * Rule Type. * Expected value is 'ApplicationRule'. */ ruleType: "ApplicationRule"; /** * List of source IP addresses for this rule. */ sourceAddresses?: string[]; /** * List of source IpGroups for this rule. */ sourceIpGroups?: string[]; /** * List of FQDNs for this rule. */ targetFqdns?: string[]; /** * List of Urls for this rule condition. */ targetUrls?: string[]; /** * Terminate TLS connections for this rule. */ terminateTLS?: boolean; /** * List of destination azure web categories. */ webCategories?: string[]; } /** * An application security group in a resource group. */ interface ApplicationSecurityGroupResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * The provisioning state of the application security group resource. */ provisioningState: string; /** * The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups. */ resourceGuid: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * Application rule collection resource. */ interface AzureFirewallApplicationRuleCollectionResponse { /** * The action type of a rule collection. */ action?: outputs.network.AzureFirewallRCActionResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. */ name?: string; /** * Priority of the application rule collection resource. */ priority?: number; /** * The provisioning state of the application rule collection resource. */ provisioningState: string; /** * Collection of rules used by a application rule collection. */ rules?: outputs.network.AzureFirewallApplicationRuleResponse[]; } /** * Properties of the application rule protocol. */ interface AzureFirewallApplicationRuleProtocolResponse { /** * Port number for the protocol, cannot be greater than 64000. This field is optional. */ port?: number; /** * Protocol type. */ protocolType?: string; } /** * Properties of an application rule. */ interface AzureFirewallApplicationRuleResponse { /** * Description of the rule. */ description?: string; /** * List of FQDN Tags for this rule. */ fqdnTags?: string[]; /** * Name of the application rule. */ name?: string; /** * Array of ApplicationRuleProtocols. */ protocols?: outputs.network.AzureFirewallApplicationRuleProtocolResponse[]; /** * List of source IP addresses for this rule. */ sourceAddresses?: string[]; /** * List of source IpGroups for this rule. */ sourceIpGroups?: string[]; /** * List of FQDNs for this rule. */ targetFqdns?: string[]; } /** * Azure Firewall Autoscale Configuration parameters. */ interface AzureFirewallAutoscaleConfigurationResponse { /** * The maximum number of capacity units for this azure firewall. Use null to reset the value to the service default. */ maxCapacity?: number; /** * The minimum number of capacity units for this azure firewall. Use null to reset the value to the service default. */ minCapacity?: number; } /** * IP configuration of an Azure Firewall. */ interface AzureFirewallIPConfigurationResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes. */ privateIPAddress: string; /** * The provisioning state of the Azure firewall IP configuration resource. */ provisioningState: string; /** * Reference to the PublicIP resource. This field is a mandatory input if subnet is not null. */ publicIPAddress?: outputs.network.SubResourceResponse; /** * Reference to the subnet resource. This resource must be named 'AzureFirewallSubnet' or 'AzureFirewallManagementSubnet'. */ subnet?: outputs.network.SubResourceResponse; /** * Type of the resource. */ type: string; } /** * IpGroups associated with azure firewall. */ interface AzureFirewallIpGroupsResponse { /** * The iteration number. */ changeNumber: string; /** * Resource ID. */ id: string; } /** * AzureFirewall NAT Rule Collection Action. */ interface AzureFirewallNatRCActionResponse { /** * The type of action. */ type?: string; } /** * NAT rule collection resource. */ interface AzureFirewallNatRuleCollectionResponse { /** * The action type of a NAT rule collection. */ action?: outputs.network.AzureFirewallNatRCActionResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. */ name?: string; /** * Priority of the NAT rule collection resource. */ priority?: number; /** * The provisioning state of the NAT rule collection resource. */ provisioningState: string; /** * Collection of rules used by a NAT rule collection. */ rules?: outputs.network.AzureFirewallNatRuleResponse[]; } /** * Properties of a NAT rule. */ interface AzureFirewallNatRuleResponse { /** * Description of the rule. */ description?: string; /** * List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags. */ destinationAddresses?: string[]; /** * List of destination ports. */ destinationPorts?: string[]; /** * Name of the NAT rule. */ name?: string; /** * Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule. */ protocols?: string[]; /** * List of source IP addresses for this rule. */ sourceAddresses?: string[]; /** * List of source IpGroups for this rule. */ sourceIpGroups?: string[]; /** * The translated address for this NAT rule. */ translatedAddress?: string; /** * The translated FQDN for this NAT rule. */ translatedFqdn?: string; /** * The translated port for this NAT rule. */ translatedPort?: string; } /** * Network rule collection resource. */ interface AzureFirewallNetworkRuleCollectionResponse { /** * The action type of a rule collection. */ action?: outputs.network.AzureFirewallRCActionResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within the Azure firewall. This name can be used to access the resource. */ name?: string; /** * Priority of the network rule collection resource. */ priority?: number; /** * The provisioning state of the network rule collection resource. */ provisioningState: string; /** * Collection of rules used by a network rule collection. */ rules?: outputs.network.AzureFirewallNetworkRuleResponse[]; } /** * Properties of the network rule. */ interface AzureFirewallNetworkRuleResponse { /** * Description of the rule. */ description?: string; /** * List of destination IP addresses. */ destinationAddresses?: string[]; /** * List of destination FQDNs. */ destinationFqdns?: string[]; /** * List of destination IpGroups for this rule. */ destinationIpGroups?: string[]; /** * List of destination ports. */ destinationPorts?: string[]; /** * Name of the network rule. */ name?: string; /** * Array of AzureFirewallNetworkRuleProtocols. */ protocols?: string[]; /** * List of source IP addresses for this rule. */ sourceAddresses?: string[]; /** * List of source IpGroups for this rule. */ sourceIpGroups?: string[]; } /** * Public IP Address associated with azure firewall. */ interface AzureFirewallPublicIPAddressResponse { /** * Public IP Address value. */ address?: string; } /** * Properties of the AzureFirewallRCAction. */ interface AzureFirewallRCActionResponse { /** * The type of action. */ type?: string; } /** * SKU of an Azure Firewall. */ interface AzureFirewallSkuResponse { /** * Name of an Azure Firewall SKU. */ name?: string; /** * Tier of an Azure Firewall. */ tier?: string; } /** * Pool of backend IP addresses. */ interface BackendAddressPoolInterfaceEndpointResponse { /** * Gets collection of references to IP addresses defined in network interfaces. */ backendIPConfigurations: outputs.network.NetworkInterfaceIPConfigurationResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * Gets load balancing rules that use this backend address pool. */ loadBalancingRules: outputs.network.SubResourceResponse[]; /** * Gets name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * Gets outbound rules that use this backend address pool. */ outboundRule: outputs.network.SubResourceResponse; /** * Gets outbound rules that use this backend address pool. */ outboundRules: outputs.network.SubResourceResponse[]; /** * Get provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState?: string; } /** * Pool of backend IP addresses. */ interface BackendAddressPoolResponse { /** * An array of references to IP addresses defined in network interfaces. */ backendIPConfigurations: outputs.network.NetworkInterfaceIPConfigurationResponse[]; /** * Amount of seconds Load Balancer waits for before sending RESET to client and backend address. */ drainPeriodInSeconds?: number; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * An array of references to inbound NAT rules that use this backend address pool. */ inboundNatRules: outputs.network.SubResourceResponse[]; /** * An array of backend addresses. */ loadBalancerBackendAddresses?: outputs.network.LoadBalancerBackendAddressResponse[]; /** * An array of references to load balancing rules that use this backend address pool. */ loadBalancingRules: outputs.network.SubResourceResponse[]; /** * The location of the backend address pool. */ location?: string; /** * The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource. */ name?: string; /** * A reference to an outbound rule that uses this backend address pool. */ outboundRule: outputs.network.SubResourceResponse; /** * An array of references to outbound rules that use this backend address pool. */ outboundRules: outputs.network.SubResourceResponse[]; /** * The provisioning state of the backend address pool resource. */ provisioningState: string; /** * Backend address synchronous mode for the backend pool */ syncMode?: string; /** * An array of gateway load balancer tunnel interfaces. */ tunnelInterfaces?: outputs.network.GatewayLoadBalancerTunnelInterfaceResponse[]; /** * Type of the resource. */ type: string; /** * A reference to a virtual network. */ virtualNetwork?: outputs.network.SubResourceResponse; } /** * The session detail for a target. */ interface BastionActiveSessionResponse { /** * The protocol used to connect to the target. */ protocol: string; /** * The type of the resource. */ resourceType: string; /** * Duration in mins the session has been active. */ sessionDurationInMins: number; /** * A unique id for the session. */ sessionId: string; /** * The time when the session started. */ startTime: any; /** * The host name of the target. */ targetHostName: string; /** * The IP Address of the target. */ targetIpAddress: string; /** * The resource group of the target. */ targetResourceGroup: string; /** * The resource id of the target. */ targetResourceId: string; /** * The subscription id for the target virtual machine. */ targetSubscriptionId: string; /** * The user name who is active on this session. */ userName: string; } /** * IP configuration of an Bastion Host. */ interface BastionHostIPConfigurationResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * Private IP allocation method. */ privateIPAllocationMethod?: string; /** * The provisioning state of the bastion host IP configuration resource. */ provisioningState: string; /** * Reference of the PublicIP resource. Null for private only bastion */ publicIPAddress?: outputs.network.SubResourceResponse; /** * Reference of the subnet resource. */ subnet: outputs.network.SubResourceResponse; /** * Ip configuration type. */ type: string; } interface BastionHostPropertiesFormatResponseNetworkAcls { /** * Sets the IP ACL rules for Developer Bastion Host. */ ipRules?: outputs.network.IPRuleResponse[]; } /** * Bastion Shareable Link. */ interface BastionShareableLinkResponse { /** * The unique Bastion Shareable Link to the virtual machine. */ bsl: string; /** * The time when the link was created. */ createdAt: string; /** * Optional field indicating the warning or error message related to the vm in case of partial failure. */ message: string; /** * Reference of the virtual machine resource. */ vm: outputs.network.VMResponse; } /** * BGP peer status details. */ interface BgpPeerStatusResponse { /** * The autonomous system number of the remote BGP peer. */ asn: number; /** * For how long the peering has been up. */ connectedDuration: string; /** * The virtual network gateway's local address. */ localAddress: string; /** * The number of BGP messages received. */ messagesReceived: number; /** * The number of BGP messages sent. */ messagesSent: number; /** * The remote BGP peer. */ neighbor: string; /** * The number of routes learned from this peer. */ routesReceived: number; /** * The BGP peer state. */ state: string; } /** * BGP settings details. */ interface BgpSettingsResponse { /** * The BGP speaker's ASN. */ asn?: number; /** * The BGP peering address and BGP identifier of this BGP speaker. */ bgpPeeringAddress?: string; /** * BGP peering address with IP configuration ID for virtual network gateway. */ bgpPeeringAddresses?: outputs.network.IPConfigurationBgpPeeringAddressResponse[]; /** * The weight added to routes learned from this BGP speaker. */ peerWeight?: number; } /** * Network Virtual Appliance Sku Properties. */ interface BreakOutCategoryPoliciesResponse { /** * Flag to control breakout of o365 allow category. */ allow?: boolean; /** * Flag to control breakout of o365 default category. */ default?: boolean; /** * Flag to control breakout of o365 optimize category. */ optimize?: boolean; } interface CircuitMetadataMapResponse { /** * Link to the Express Route circuit */ link?: string; /** * Peering location of the Express Route Circuit */ location?: string; /** * Express Route Circuit Name */ name?: string; } /** * Properties of commit */ interface CommitPropertiesResponse { /** * List of active locations. */ activeLocations: string[]; /** * Commit Type. */ commitType: string; /** * List of configuration IDs. */ configurationIds?: string[]; /** * A description of the commit. */ description?: string; /** * A value that, when changed, forces the commit to be re-evaluated and redeployed. */ forceUpdateTag?: string; /** * The provisioning state of the resource. */ provisioningState: string; /** * Unique identifier for this resource. */ resourceGuid: string; /** * List of target locations. */ targetLocations: string[]; } /** * The network configuration group resource */ interface ConfigurationGroupResponse { /** * Network group conditional filter. */ conditionalMembership?: string; /** * A description of the network group. */ description?: string; /** * A friendly name for the network group. */ displayName?: string; /** * Group members of network group. */ groupMembers?: outputs.network.GroupMembersItemResponse[]; /** * Resource ID. */ id?: string; /** * Group member type. */ memberType?: string; /** * The provisioning state of the scope assignment resource. */ provisioningState: string; } /** * The network configuration group resource */ interface ConfigurationGrouplistActiveConnectivityConfigurationsResponse { /** * A description of the network group. */ description?: string; /** * Network group ID. */ id?: string; /** * The type of the group member. */ memberType?: string; /** * The provisioning state of the scope assignment resource. */ provisioningState: string; /** * Unique identifier for this resource. */ resourceGuid: string; } /** * The network configuration group resource */ interface ConfigurationGrouplistActiveSecurityAdminRulesResponse { /** * A description of the network group. */ description?: string; /** * Network group ID. */ id?: string; /** * The type of the group member. */ memberType?: string; /** * The provisioning state of the scope assignment resource. */ provisioningState: string; /** * Unique identifier for this resource. */ resourceGuid: string; } /** * The network configuration group resource */ interface ConfigurationGrouplistActiveSecurityUserRulesResponse { /** * A description of the network group. */ description?: string; /** * Resource ID. */ id?: string; /** * Group member type. */ memberType: string; /** * The provisioning state of the scope assignment resource. */ provisioningState: string; } /** * The network configuration group resource */ interface ConfigurationGrouplistNetworkManagerEffectiveConnectivityConfigurationsResponse { /** * A description of the network group. */ description?: string; /** * Network group ID. */ id?: string; /** * The type of the group member. */ memberType?: string; /** * The provisioning state of the scope assignment resource. */ provisioningState: string; /** * Unique identifier for this resource. */ resourceGuid: string; } /** * The network configuration group resource */ interface ConfigurationGrouplistNetworkManagerEffectiveSecurityAdminRulesResponse { /** * A description of the network group. */ description?: string; /** * Network group ID. */ id?: string; /** * The type of the group member. */ memberType?: string; /** * The provisioning state of the scope assignment resource. */ provisioningState: string; /** * Unique identifier for this resource. */ resourceGuid: string; } /** * Describes the destination of connection monitor. */ interface ConnectionMonitorDestinationResponse { /** * Address of the connection monitor destination (IP or domain name). */ address?: string; /** * The destination port used by connection monitor. */ port?: number; /** * The ID of the resource used as the destination by connection monitor. */ resourceId?: string; } /** * Describes the connection monitor endpoint filter item. */ interface ConnectionMonitorEndpointFilterItemResponse { /** * The address of the filter item. */ address?: string; /** * The type of item included in the filter. Currently only 'AgentAddress' is supported. */ type?: string; } /** * Describes the connection monitor endpoint filter. */ interface ConnectionMonitorEndpointFilterResponse { /** * List of items in the filter. */ items?: outputs.network.ConnectionMonitorEndpointFilterItemResponse[]; /** * The behavior of the endpoint filter. Currently only 'Include' is supported. */ type?: string; } /** * Connection monitor endpoint location details only being used for 'AzureArcNetwork' type endpoints, which contains the region details. */ interface ConnectionMonitorEndpointLocationDetailsResponse { /** * Region for connection monitor endpoint. */ region?: string; } /** * Describes the connection monitor endpoint. */ interface ConnectionMonitorEndpointResponse { /** * Address of the connection monitor endpoint. Supported for AzureVM, ExternalAddress, ArcMachine, MMAWorkspaceMachine endpoint type. */ address?: string; /** * Test coverage for the endpoint. */ coverageLevel?: string; /** * Filter field is getting deprecated and should not be used. Instead use Include/Exclude scope fields for it. */ filter?: outputs.network.ConnectionMonitorEndpointFilterResponse; /** * Location details is optional and only being used for 'AzureArcNetwork' type endpoints, which contains region details. */ locationDetails?: outputs.network.ConnectionMonitorEndpointLocationDetailsResponse; /** * The name of the connection monitor endpoint. */ name: string; /** * Resource ID of the connection monitor endpoint are supported for AzureVM, AzureVMSS, AzureVNet, AzureSubnet, MMAWorkspaceMachine, MMAWorkspaceNetwork, AzureArcVM endpoint type. */ resourceId?: string; /** * Endpoint scope defines which target resource to monitor in case of compound resource endpoints like VMSS, AzureSubnet, AzureVNet, MMAWorkspaceNetwork, AzureArcNetwork. */ scope?: outputs.network.ConnectionMonitorEndpointScopeResponse; /** * Subscription ID for connection monitor endpoint. It's an optional parameter which is being used for 'AzureArcNetwork' type endpoint. */ subscriptionId?: string; /** * The endpoint type. */ type?: string; } /** * Describes the connection monitor endpoint scope item. */ interface ConnectionMonitorEndpointScopeItemResponse { /** * The address of the endpoint item. Supported types are IPv4/IPv6 subnet mask or IPv4/IPv6 IP address. */ address?: string; } /** * Describes the connection monitor endpoint scope. */ interface ConnectionMonitorEndpointScopeResponse { /** * List of items which needs to be excluded from the endpoint scope. */ exclude?: outputs.network.ConnectionMonitorEndpointScopeItemResponse[]; /** * List of items which needs to be included to the endpoint scope. */ include?: outputs.network.ConnectionMonitorEndpointScopeItemResponse[]; } /** * Describes the HTTP configuration. */ interface ConnectionMonitorHttpConfigurationResponse { /** * The HTTP method to use. */ method?: string; /** * The path component of the URI. For instance, "/dir1/dir2". */ path?: string; /** * The port to connect to. */ port?: number; /** * Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit. */ preferHTTPS?: boolean; /** * The HTTP headers to transmit with the request. */ requestHeaders?: outputs.network.HTTPHeaderResponse[]; /** * HTTP status codes to consider successful. For instance, "2xx,301-304,418". */ validStatusCodeRanges?: string[]; } /** * Describes the ICMP configuration. */ interface ConnectionMonitorIcmpConfigurationResponse { /** * Value indicating whether path evaluation with trace route should be disabled. */ disableTraceRoute?: boolean; } /** * Describes a connection monitor output destination. */ interface ConnectionMonitorOutputResponse { /** * Connection monitor output destination type. Currently, only "Workspace" is supported. */ type?: string; /** * Describes the settings for producing output into a log analytics workspace. */ workspaceSettings?: outputs.network.ConnectionMonitorWorkspaceSettingsResponse; } /** * Describes the source of connection monitor. */ interface ConnectionMonitorSourceResponse { /** * The source port used by connection monitor. */ port?: number; /** * The ID of the resource used as the source by connection monitor. */ resourceId: string; } /** * Describes the threshold for declaring a test successful. */ interface ConnectionMonitorSuccessThresholdResponse { /** * The maximum percentage of failed checks permitted for a test to evaluate as successful. */ checksFailedPercent?: number; /** * The maximum round-trip time in milliseconds permitted for a test to evaluate as successful. */ roundTripTimeMs?: number; } /** * Describes the TCP configuration. */ interface ConnectionMonitorTcpConfigurationResponse { /** * Destination port behavior. */ destinationPortBehavior?: string; /** * Value indicating whether path evaluation with trace route should be disabled. */ disableTraceRoute?: boolean; /** * The port to connect to. */ port?: number; } /** * Describes a connection monitor test configuration. */ interface ConnectionMonitorTestConfigurationResponse { /** * The parameters used to perform test evaluation over HTTP. */ httpConfiguration?: outputs.network.ConnectionMonitorHttpConfigurationResponse; /** * The parameters used to perform test evaluation over ICMP. */ icmpConfiguration?: outputs.network.ConnectionMonitorIcmpConfigurationResponse; /** * The name of the connection monitor test configuration. */ name: string; /** * The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters. */ preferredIPVersion?: string; /** * The protocol to use in test evaluation. */ protocol: string; /** * The threshold for declaring a test successful. */ successThreshold?: outputs.network.ConnectionMonitorSuccessThresholdResponse; /** * The parameters used to perform test evaluation over TCP. */ tcpConfiguration?: outputs.network.ConnectionMonitorTcpConfigurationResponse; /** * The frequency of test evaluation, in seconds. */ testFrequencySec?: number; } /** * Describes the connection monitor test group. */ interface ConnectionMonitorTestGroupResponse { /** * List of destination endpoint names. */ destinations: string[]; /** * Value indicating whether test group is disabled. */ disable?: boolean; /** * The name of the connection monitor test group. */ name: string; /** * List of source endpoint names. */ sources: string[]; /** * List of test configuration names. */ testConfigurations: string[]; } /** * Describes the settings for producing output into a log analytics workspace. */ interface ConnectionMonitorWorkspaceSettingsResponse { /** * Log analytics workspace resource ID. */ workspaceResourceId?: string; } /** * Properties of the ConnectionPolicy resource. */ interface ConnectionPolicyPropertiesResponse { /** * List of connection names (e.g. VpnConnection, HubVirtualNetworkConnection) associated with this ConnectionPolicy. These are resource names, not Azure resource IDs, consistent with the established VirtualWAN pattern used by HubRouteTable.associatedConnections. */ associatedConnections: string[]; /** * Enable internet security. */ enableInternetSecurity?: boolean; /** * The provisioning state of the ConnectionPolicy resource. */ provisioningState: string; /** * The Routing Configuration indicating the associated and propagated route tables on this connection. */ routingConfiguration?: outputs.network.RoutingConfigurationResponse; } /** * Connectivity group item. */ interface ConnectivityGroupItemResponse { /** * Group connectivity type. */ groupConnectivity: string; /** * Flag if global is supported. */ isGlobal?: string; /** * Network group Id. */ networkGroupId: string; /** * Flag if need to use hub gateway. */ useHubGateway?: string; } interface ConnectivityGroupItemlistActiveConnectivityConfigurationResponse { /** * Group connectivity type. */ groupConnectivity?: string; /** * Flag if global is supported. */ isGlobal?: string; /** * Network group Id. */ networkGroupId?: string; /** * Flag if need to use hub gateway. */ useHubGateway?: string; } interface ConnectivityGroupItemlistEffectiveConnectivityConfigurationResponse { /** * Group connectivity type. */ groupConnectivity?: string; /** * Flag if global is supported. */ isGlobal?: string; /** * Network group Id. */ networkGroupId?: string; /** * Flag if need to use hub gateway. */ useHubGateway?: string; } /** * Container network interface configuration child resource. */ interface ContainerNetworkInterfaceConfigurationResponse { /** * A list of container network interfaces created from this container network interface configuration. */ containerNetworkInterfaces?: outputs.network.SubResourceResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * A list of ip configurations of the container network interface configuration. */ ipConfigurations?: outputs.network.IPConfigurationProfileResponse[]; /** * The name of the resource. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the container network interface configuration resource. */ provisioningState: string; /** * Sub Resource type. */ type: string; } /** * The ip configuration for a container network interface. */ interface ContainerNetworkInterfaceIpConfigurationResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The name of the resource. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the container network interface IP configuration resource. */ provisioningState: string; /** * Sub Resource type. */ type: string; } /** * Container network interface child resource. */ interface ContainerNetworkInterfaceResponse { /** * Reference to the container to which this container network interface is attached. */ container?: outputs.network.ContainerResponse; /** * Container network interface configuration from which this container network interface is created. */ containerNetworkInterfaceConfiguration: outputs.network.ContainerNetworkInterfaceConfigurationResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Reference to the ip configuration on this container nic. */ ipConfigurations: outputs.network.ContainerNetworkInterfaceIpConfigurationResponse[]; /** * The name of the resource. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the container network interface resource. */ provisioningState: string; /** * Sub Resource type. */ type: string; } /** * Reference to container resource in remote resource provider. */ interface ContainerResponse { /** * Resource ID. */ id?: string; } /** * A matching criteria which matches routes based on route prefix, community, and AS path. */ interface CriterionResponse { /** * List of AS paths which this criteria matches. */ asPath?: string[]; /** * List of BGP communities which this criteria matches. */ community?: string[]; /** * Match condition to apply RouteMap rules. */ matchCondition?: string; /** * List of route prefixes which this criteria matches. */ routePrefix?: string[]; } /** * Cross tenant scopes. */ interface CrossTenantScopesResponse { /** * List of management groups. */ managementGroups: string[]; /** * List of subscriptions. */ subscriptions: string[]; /** * Tenant ID. */ tenantId: string; } /** * Contains custom Dns resolution configuration from customer. */ interface CustomDnsConfigPropertiesFormatResponse { /** * Fqdn that resolves to private endpoint ip address. */ fqdn?: string; /** * A list of private ip addresses of the private endpoint. */ ipAddresses?: string[]; } /** * Contains the DDoS protection settings of the public IP. */ interface DdosSettingsInterfaceEndpointResponse { /** * The DDoS custom policy associated with the public IP. */ ddosCustomPolicy?: outputs.network.SubResourceResponse; /** * The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized. */ protectionCoverage?: string; } /** * Contains the DDoS protection settings of the public IP. */ interface DdosSettingsResponse { /** * The DDoS protection plan associated with the public IP. Can only be set if ProtectionMode is Enabled */ ddosProtectionPlan?: outputs.network.SubResourceResponse; /** * The DDoS protection mode of the public IP */ protectionMode?: string; } /** * Details the service to which the subnet is delegated. */ interface DelegationInterfaceEndpointResponse { /** * Describes the actions permitted to the service upon delegation */ actions?: string[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a subnet. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the resource. */ provisioningState: string; /** * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers) */ serviceName?: string; } /** * Properties of the delegation. */ interface DelegationPropertiesResponse { /** * The current provisioning state. */ provisioningState: string; /** * The service name to which the NVA is delegated. */ serviceName?: string; } /** * Details the service to which the subnet is delegated. */ interface DelegationResponse { /** * The actions permitted to the service upon delegation. */ actions: string[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a subnet. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the service delegation resource. */ provisioningState: string; /** * The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers). */ serviceName?: string; /** * Resource type. */ type?: string; } /** * List of properties of the device. */ interface DevicePropertiesResponse { /** * Model of the device. */ deviceModel?: string; /** * Name of the device Vendor. */ deviceVendor?: string; /** * Link speed. */ linkSpeedInMbps?: number; } /** * DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options. */ interface DhcpOptionsResponse { /** * The list of DNS servers IP addresses. */ dnsServers?: string[]; } /** * DNS Proxy Settings in Firewall Policy. */ interface DnsSettingsResponse { /** * Enable DNS Proxy on Firewalls attached to the Firewall Policy. */ enableProxy?: boolean; /** * FQDNs in Network Rules are supported when set to true. */ requireProxyForNetworkRules?: boolean; /** * List of Custom DNS Servers. */ servers?: string[]; } /** * The network manager effective connectivity configuration */ interface EffectiveConnectivityConfigurationResponse { /** * Groups for configuration */ appliesToGroups?: outputs.network.ConnectivityGroupItemlistEffectiveConnectivityConfigurationResponse[]; /** * Effective configuration groups. */ configurationGroups?: outputs.network.ConfigurationGroupResponse[]; /** * Connectivity topology type. */ connectivityTopology: string; /** * Flag if need to remove current existing peerings. */ deleteExistingPeering?: string; /** * A description of the connectivity configuration. */ description?: string; /** * A friendly name for the resource. */ displayName?: string; /** * List of hubItems */ hubs?: outputs.network.HubResponse[]; /** * Resource ID. */ id?: string; /** * Flag if global mesh is supported. */ isGlobal?: string; /** * The provisioning state of the connectivity configuration resource. */ provisioningState: string; } /** * The network manager effective connectivity configuration */ interface EffectiveConnectivityConfigurationlistNetworkManagerEffectiveConnectivityConfigurationsResponse { /** * Groups for configuration */ appliesToGroups: outputs.network.ConnectivityGroupItemResponse[]; /** * Effective configuration groups. */ configurationGroups?: outputs.network.ConfigurationGrouplistNetworkManagerEffectiveConnectivityConfigurationsResponse[]; /** * Connectivity topology type. */ connectivityTopology: string; /** * Flag if need to remove current existing peerings. */ deleteExistingPeering?: string; /** * A description of the connectivity configuration. */ description?: string; /** * List of hubItems */ hubs?: outputs.network.HubResponse[]; /** * Connectivity configuration ID. */ id?: string; /** * Flag if global mesh is supported. */ isGlobal?: string; /** * The provisioning state of the connectivity configuration resource. */ provisioningState: string; /** * Unique identifier for this resource. */ resourceGuid: string; } /** * Network default admin rule. */ interface EffectiveDefaultSecurityAdminRuleResponse { /** * Indicates the access allowed for this particular rule */ access: string; /** * A description of the security admin configuration. */ configurationDescription?: string; /** * A display name of the security admin configuration. */ configurationDisplayName?: string; /** * A description for this rule. Restricted to 140 chars. */ description: string; /** * The destination port ranges. */ destinationPortRanges: string[]; /** * The destination address prefixes. CIDR or destination IP ranges. */ destinations: outputs.network.AddressPrefixItemResponse[]; /** * Indicates if the traffic matched against the rule in inbound or outbound. */ direction: string; /** * A friendly name for the rule. */ displayName: string; /** * Default rule flag. */ flag?: string; /** * Resource ID. */ id?: string; /** * Whether the rule is custom or default. * Expected value is 'Default'. */ kind: "Default"; /** * The priority of the rule. The value can be between 1 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. */ priority: number; /** * Network protocol this rule applies to. */ protocol: string; /** * The provisioning state of the resource. */ provisioningState: string; /** * Groups for rule collection */ ruleCollectionAppliesToGroups?: outputs.network.NetworkManagerSecurityGroupItemlistNetworkManagerEffectiveSecurityAdminRuleResponse[]; /** * A description of the rule collection. */ ruleCollectionDescription?: string; /** * A display name of the rule collection. */ ruleCollectionDisplayName?: string; /** * Effective configuration groups. */ ruleGroups?: outputs.network.ConfigurationGroupResponse[]; /** * The source port ranges. */ sourcePortRanges: string[]; /** * The CIDR or source IP ranges. */ sources: outputs.network.AddressPrefixItemResponse[]; } /** * Network default admin rule. */ interface EffectiveDefaultSecurityAdminRulelistNetworkManagerEffectiveSecurityAdminRulesResponse { /** * Indicates the access allowed for this particular rule */ access: string; /** * A description of the security admin configuration. */ configurationDescription?: string; /** * A description for this rule. Restricted to 140 chars. */ description: string; /** * The destination port ranges. */ destinationPortRanges: string[]; /** * The destination address prefixes. CIDR or destination IP ranges. */ destinations: outputs.network.AddressPrefixItemResponse[]; /** * Indicates if the traffic matched against the rule in inbound or outbound. */ direction: string; /** * Default rule flag. */ flag?: string; /** * Resource ID. */ id?: string; /** * Whether the rule is custom or default. * Expected value is 'Default'. */ kind: "Default"; /** * The priority of the rule. The value can be between 1 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. */ priority: number; /** * Network protocol this rule applies to. */ protocol: string; /** * The provisioning state of the resource. */ provisioningState: string; /** * Unique identifier for this resource. */ resourceGuid: string; /** * Groups for rule collection */ ruleCollectionAppliesToGroups?: outputs.network.NetworkManagerSecurityGroupItemResponse[]; /** * A description of the rule collection. */ ruleCollectionDescription?: string; /** * Effective configuration groups. */ ruleGroups?: outputs.network.ConfigurationGrouplistNetworkManagerEffectiveSecurityAdminRulesResponse[]; /** * The source port ranges. */ sourcePortRanges: string[]; /** * The CIDR or source IP ranges. */ sources: outputs.network.AddressPrefixItemResponse[]; } /** * Network admin rule. */ interface EffectiveSecurityAdminRuleResponse { /** * Indicates the access allowed for this particular rule */ access: string; /** * A description of the security admin configuration. */ configurationDescription?: string; /** * A display name of the security admin configuration. */ configurationDisplayName?: string; /** * A description for this rule. Restricted to 140 chars. */ description?: string; /** * The destination port ranges. */ destinationPortRanges?: string[]; /** * The destination address prefixes. CIDR or destination IP ranges. */ destinations?: outputs.network.AddressPrefixItemResponse[]; /** * Indicates if the traffic matched against the rule in inbound or outbound. */ direction: string; /** * A friendly name for the rule. */ displayName?: string; /** * Resource ID. */ id?: string; /** * Whether the rule is custom or default. * Expected value is 'Custom'. */ kind: "Custom"; /** * The priority of the rule. The value can be between 1 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. */ priority?: number; /** * Network protocol this rule applies to. */ protocol: string; /** * The provisioning state of the resource. */ provisioningState: string; /** * Groups for rule collection */ ruleCollectionAppliesToGroups?: outputs.network.NetworkManagerSecurityGroupItemlistNetworkManagerEffectiveSecurityAdminRuleResponse[]; /** * A description of the rule collection. */ ruleCollectionDescription?: string; /** * A display name of the rule collection. */ ruleCollectionDisplayName?: string; /** * Effective configuration groups. */ ruleGroups?: outputs.network.ConfigurationGroupResponse[]; /** * The source port ranges. */ sourcePortRanges?: string[]; /** * The CIDR or source IP ranges. */ sources?: outputs.network.AddressPrefixItemResponse[]; } /** * Network admin rule. */ interface EffectiveSecurityAdminRulelistNetworkManagerEffectiveSecurityAdminRulesResponse { /** * Indicates the access allowed for this particular rule */ access: string; /** * A description of the security admin configuration. */ configurationDescription?: string; /** * A description for this rule. Restricted to 140 chars. */ description?: string; /** * The destination port ranges. */ destinationPortRanges?: string[]; /** * The destination address prefixes. CIDR or destination IP ranges. */ destinations?: outputs.network.AddressPrefixItemResponse[]; /** * Indicates if the traffic matched against the rule in inbound or outbound. */ direction: string; /** * Resource ID. */ id?: string; /** * Whether the rule is custom or default. * Expected value is 'Custom'. */ kind: "Custom"; /** * The priority of the rule. The value can be between 1 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. */ priority: number; /** * Network protocol this rule applies to. */ protocol: string; /** * The provisioning state of the resource. */ provisioningState: string; /** * Unique identifier for this resource. */ resourceGuid: string; /** * Groups for rule collection */ ruleCollectionAppliesToGroups?: outputs.network.NetworkManagerSecurityGroupItemResponse[]; /** * A description of the rule collection. */ ruleCollectionDescription?: string; /** * Effective configuration groups. */ ruleGroups?: outputs.network.ConfigurationGrouplistNetworkManagerEffectiveSecurityAdminRulesResponse[]; /** * The source port ranges. */ sourcePortRanges?: string[]; /** * The CIDR or source IP ranges. */ sources?: outputs.network.AddressPrefixItemResponse[]; } /** * Effective Virtual Network */ interface EffectiveVirtualNetworkResponse { /** * Effective vnet Id. */ id?: string; /** * Location of vnet. */ location?: string; /** * Membership Type. */ membershipType?: string; } /** * Identifies the service being brought into the virtual network. */ interface EndpointServiceResponse { /** * A unique identifier of the service being referenced by the interface endpoint. */ id?: string; } /** * Adds exception to allow a request when the condition is satisfied. */ interface ExceptionEntryResponse { /** * The managed rule sets that are associated with the exception. */ exceptionManagedRuleSets?: outputs.network.ExclusionManagedRuleSetResponse[]; /** * The variable on which we evaluate the exception condition */ matchVariable: string; /** * When the matchVariable points to a key-value pair (e.g, RequestHeader), this identifies the key. */ selector?: string; /** * When the matchVariable points to a key-value pair (e.g, RequestHeader), this operates on the selector */ selectorMatchOperator?: string; /** * Operates on the allowed values for the matchVariable */ valueMatchOperator: string; /** * Allowed values for the matchVariable */ values?: string[]; } /** * Defines a managed rule group to use for exclusion. */ interface ExclusionManagedRuleGroupResponse { /** * The managed rule group for exclusion. */ ruleGroupName: string; /** * List of rules that will be excluded. If none specified, all rules in the group will be excluded. */ rules?: outputs.network.ExclusionManagedRuleResponse[]; } /** * Defines a managed rule to use for exclusion. */ interface ExclusionManagedRuleResponse { /** * Identifier for the managed rule. */ ruleId: string; } /** * Defines a managed rule set for Exclusions. */ interface ExclusionManagedRuleSetResponse { /** * Defines the rule groups to apply to the rule set. */ ruleGroups?: outputs.network.ExclusionManagedRuleGroupResponse[]; /** * Defines the rule set type to use. */ ruleSetType: string; /** * Defines the version of the rule set to use. */ ruleSetVersion: string; } /** * Explicit Proxy Settings in Firewall Policy. */ interface ExplicitProxyResponse { /** * When set to true, explicit proxy mode is enabled. */ enableExplicitProxy?: boolean; /** * When set to true, pac file port and url needs to be provided. */ enablePacFile?: boolean; /** * Port number for explicit proxy http protocol, cannot be greater than 64000. */ httpPort?: number; /** * Port number for explicit proxy https protocol, cannot be greater than 64000. */ httpsPort?: number; /** * SAS URL for PAC file. */ pacFile?: string; /** * Port number for firewall to serve PAC file. */ pacFilePort?: number; } /** * Authorization in an ExpressRouteCircuit resource. */ interface ExpressRouteCircuitAuthorizationResponse { /** * The authorization key. */ authorizationKey?: string; /** * The authorization use status. */ authorizationUseStatus?: string; /** * The reference to the ExpressRoute connection resource using the authorization. */ connectionResourceUri: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the authorization resource. */ provisioningState: string; /** * Type of the resource. */ type: string; } /** * Express Route Circuit Connection in an ExpressRouteCircuitPeering resource. */ interface ExpressRouteCircuitConnectionResponse { /** * /29 IP address space to carve out Customer addresses for tunnels. */ addressPrefix?: string; /** * The authorization key. */ authorizationKey?: string; /** * Express Route Circuit connection state. */ circuitConnectionStatus: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection. */ expressRouteCircuitPeering?: outputs.network.SubResourceResponse; /** * Resource ID. */ id?: string; /** * IPv6 Address PrefixProperties of the express route circuit connection. */ ipv6CircuitConnectionConfig?: outputs.network.Ipv6CircuitConnectionConfigResponse; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * Reference to Express Route Circuit Private Peering Resource of the peered circuit. */ peerExpressRouteCircuitPeering?: outputs.network.SubResourceResponse; /** * The provisioning state of the express route circuit connection resource. */ provisioningState: string; /** * Type of the resource. */ type: string; } /** * Specifies the peering configuration. */ interface ExpressRouteCircuitPeeringConfigResponse { /** * The communities of bgp peering. Specified for microsoft peering. */ advertisedCommunities?: string[]; /** * The reference to AdvertisedPublicPrefixes. */ advertisedPublicPrefixes?: string[]; /** * The advertised public prefix state of the Peering resource. */ advertisedPublicPrefixesState: string; /** * The CustomerASN of the peering. */ customerASN?: number; /** * The legacy mode of the peering. */ legacyMode?: number; /** * The RoutingRegistryName of the configuration. */ routingRegistryName?: string; } /** * ExpressRoute circuit peering identifier. */ interface ExpressRouteCircuitPeeringIdResponse { /** * The ID of the ExpressRoute circuit peering. */ id?: string; } /** * Peering in an ExpressRouteCircuit resource. */ interface ExpressRouteCircuitPeeringResponse { /** * The Azure ASN. */ azureASN?: number; /** * The list of circuit connections associated with Azure Private Peering for this circuit. */ connections?: outputs.network.ExpressRouteCircuitConnectionResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The ExpressRoute connection. */ expressRouteConnection?: outputs.network.ExpressRouteConnectionIdResponse; /** * The GatewayManager Etag. */ gatewayManagerEtag?: string; /** * Resource ID. */ id?: string; /** * The IPv6 peering configuration. */ ipv6PeeringConfig?: outputs.network.Ipv6ExpressRouteCircuitPeeringConfigResponse; /** * Who was the last to modify the peering. */ lastModifiedBy: string; /** * The Microsoft peering configuration. */ microsoftPeeringConfig?: outputs.network.ExpressRouteCircuitPeeringConfigResponse; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The peer ASN. */ peerASN?: number; /** * The list of peered circuit connections associated with Azure Private Peering for this circuit. */ peeredConnections: outputs.network.PeerExpressRouteCircuitConnectionResponse[]; /** * The peering type. */ peeringType?: string; /** * The primary port. */ primaryAzurePort?: string; /** * The primary address prefix. */ primaryPeerAddressPrefix?: string; /** * The provisioning state of the express route circuit peering resource. */ provisioningState: string; /** * The reference to the RouteFilter resource. */ routeFilter?: outputs.network.SubResourceResponse; /** * The secondary port. */ secondaryAzurePort?: string; /** * The secondary address prefix. */ secondaryPeerAddressPrefix?: string; /** * The shared key. */ sharedKey?: string; /** * The peering state. */ state?: string; /** * The peering stats of express route circuit. */ stats?: outputs.network.ExpressRouteCircuitStatsResponse; /** * Type of the resource. */ type: string; /** * The VLAN ID. */ vlanId?: number; } /** * Contains ServiceProviderProperties in an ExpressRouteCircuit. */ interface ExpressRouteCircuitServiceProviderPropertiesResponse { /** * The BandwidthInMbps. */ bandwidthInMbps?: number; /** * The peering location. */ peeringLocation?: string; /** * The serviceProviderName. */ serviceProviderName?: string; } /** * Contains SKU in an ExpressRouteCircuit. */ interface ExpressRouteCircuitSkuResponse { /** * The family of the SKU. */ family?: string; /** * The name of the SKU. */ name?: string; /** * The tier of the SKU. */ tier?: string; } /** * Contains stats associated with the peering. */ interface ExpressRouteCircuitStatsResponse { /** * The Primary BytesIn of the peering. */ primarybytesIn?: number; /** * The primary BytesOut of the peering. */ primarybytesOut?: number; /** * The secondary BytesIn of the peering. */ secondarybytesIn?: number; /** * The secondary BytesOut of the peering. */ secondarybytesOut?: number; } /** * The ID of the ExpressRouteConnection. */ interface ExpressRouteConnectionIdResponse { /** * The ID of the ExpressRouteConnection. */ id: string; } /** * ExpressRouteConnection resource. */ interface ExpressRouteConnectionResponse { /** * Authorization key to establish the connection. */ authorizationKey?: string; /** * Enable internet security. */ enableInternetSecurity?: boolean; /** * Bypass the ExpressRoute gateway when accessing private-links. ExpressRoute FastPath (expressRouteGatewayBypass) must be enabled. */ enablePrivateLinkFastPath?: boolean; /** * The ExpressRoute circuit peering. */ expressRouteCircuitPeering: outputs.network.ExpressRouteCircuitPeeringIdResponse; /** * Enable FastPath to vWan Firewall hub. */ expressRouteGatewayBypass?: boolean; /** * Resource ID. */ id?: string; /** * The name of the resource. */ name: string; /** * The provisioning state of the express route connection resource. */ provisioningState: string; /** * The Routing Configuration indicating the associated and propagated route tables on this connection. */ routingConfiguration?: outputs.network.RoutingConfigurationExpressRouteGatewayResponse; /** * The routing weight associated to the connection. */ routingWeight?: number; } /** * Configuration for auto scaling. */ interface ExpressRouteGatewayPropertiesResponseAutoScaleConfiguration { /** * Minimum and maximum number of scale units to deploy. */ bounds?: outputs.network.ExpressRouteGatewayPropertiesResponseBounds; } /** * Minimum and maximum number of scale units to deploy. */ interface ExpressRouteGatewayPropertiesResponseBounds { /** * Maximum number of scale units deployed for ExpressRoute gateway. */ max?: number; /** * Minimum number of scale units deployed for ExpressRoute gateway. */ min?: number; } /** * ExpressRouteLink Mac Security Configuration. */ interface ExpressRouteLinkMacSecConfigResponse { /** * Keyvault Secret Identifier URL containing Mac security CAK key. */ cakSecretIdentifier?: string; /** * Mac security cipher. */ cipher?: string; /** * Keyvault Secret Identifier URL containing Mac security CKN key. */ cknSecretIdentifier?: string; /** * Sci mode enabled/disabled. */ sciState?: string; } /** * ExpressRouteLink child resource definition. */ interface ExpressRouteLinkResponse { /** * Administrative state of the physical port. */ adminState?: string; /** * Cololocation for ExpressRoute Hybrid Direct. */ coloLocation: string; /** * Physical fiber port type. */ connectorType: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of Azure router interface. */ interfaceName: string; /** * MacSec configuration. */ macSecConfig?: outputs.network.ExpressRouteLinkMacSecConfigResponse; /** * Name of child port resource that is unique among child port resources of the parent. */ name?: string; /** * Mapping between physical port to patch panel port. */ patchPanelId: string; /** * The provisioning state of the express route link resource. */ provisioningState: string; /** * Mapping of physical patch panel to rack. */ rackId: string; /** * Name of Azure router associated with physical port. */ routerName: string; } /** * ExtendedLocation complex type. */ interface ExtendedLocationResponse { /** * The name of the extended location. */ name?: string; /** * The type of the extended location. */ type?: string; } /** * Trusted Root certificates properties for tls. */ interface FirewallPolicyCertificateAuthorityResponse { /** * Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault. */ keyVaultSecretId?: string; /** * Name of the CA certificate. */ name?: string; } /** * Properties of the FirewallPolicyFilterRuleAction. */ interface FirewallPolicyFilterRuleActionResponse { /** * The type of action. */ type?: string; } /** * Properties of the FirewallPolicyFilterRuleCollectionAction. */ interface FirewallPolicyFilterRuleCollectionActionResponse { /** * The type of action. */ type?: string; } /** * Firewall Policy Filter Rule Collection. */ interface FirewallPolicyFilterRuleCollectionResponse { /** * The action type of a Filter rule collection. */ action?: outputs.network.FirewallPolicyFilterRuleCollectionActionResponse; /** * The name of the rule collection. */ name?: string; /** * Priority of the Firewall Policy Rule Collection resource. */ priority?: number; /** * The type of the rule collection. * Expected value is 'FirewallPolicyFilterRuleCollection'. */ ruleCollectionType: "FirewallPolicyFilterRuleCollection"; /** * List of rules included in a rule collection. */ rules?: (outputs.network.ApplicationRuleResponse | outputs.network.NatRuleResponse | outputs.network.NetworkRuleResponse)[]; } /** * Firewall Policy Filter Rule. */ interface FirewallPolicyFilterRuleResponse { /** * The action type of a Filter rule. */ action?: outputs.network.FirewallPolicyFilterRuleActionResponse; /** * The name of the rule. */ name?: string; /** * Priority of the Firewall Policy Rule resource. */ priority?: number; /** * Collection of rule conditions used by a rule. */ ruleConditions?: (outputs.network.ApplicationRuleConditionResponse | outputs.network.NatRuleConditionResponse | outputs.network.NetworkRuleConditionResponse)[]; /** * The type of the rule. * Expected value is 'FirewallPolicyFilterRule'. */ ruleType: "FirewallPolicyFilterRule"; } /** * name and value of HTTP/S header to insert */ interface FirewallPolicyHttpHeaderToInsertResponse { /** * Contains the name of the header */ headerName?: string; /** * Contains the value of the header */ headerValue?: string; } /** * Firewall Policy Insights. */ interface FirewallPolicyInsightsResponse { /** * A flag to indicate if the insights are enabled on the policy. */ isEnabled?: boolean; /** * Workspaces needed to configure the Firewall Policy Insights. */ logAnalyticsResources?: outputs.network.FirewallPolicyLogAnalyticsResourcesResponse; /** * Number of days the insights should be enabled on the policy. */ retentionDays?: number; } /** * Intrusion detection bypass traffic specification. */ interface FirewallPolicyIntrusionDetectionBypassTrafficSpecificationsResponse { /** * Description of the bypass traffic rule. */ description?: string; /** * List of destination IP addresses or ranges for this rule. */ destinationAddresses?: string[]; /** * List of destination IpGroups for this rule. */ destinationIpGroups?: string[]; /** * List of destination ports or ranges. */ destinationPorts?: string[]; /** * Name of the bypass traffic rule. */ name?: string; /** * The rule bypass protocol. */ protocol?: string; /** * List of source IP addresses or ranges for this rule. */ sourceAddresses?: string[]; /** * List of source IpGroups for this rule. */ sourceIpGroups?: string[]; } /** * The operation for configuring intrusion detection. */ interface FirewallPolicyIntrusionDetectionConfigurationResponse { /** * List of rules for traffic to bypass. */ bypassTrafficSettings?: outputs.network.FirewallPolicyIntrusionDetectionBypassTrafficSpecificationsResponse[]; /** * IDPS Private IP address ranges are used to identify traffic direction (i.e. inbound, outbound, etc.). By default, only ranges defined by IANA RFC 1918 are considered private IP addresses. To modify default ranges, specify your Private IP address ranges with this property */ privateRanges?: string[]; /** * List of specific signatures states. */ signatureOverrides?: outputs.network.FirewallPolicyIntrusionDetectionSignatureSpecificationResponse[]; } /** * Configuration for intrusion detection mode and rules. */ interface FirewallPolicyIntrusionDetectionResponse { /** * Intrusion detection configuration properties. */ configuration?: outputs.network.FirewallPolicyIntrusionDetectionConfigurationResponse; /** * Intrusion detection general state. When attached to a parent policy, the firewall's effective IDPS mode is the stricter mode of the two. */ mode?: string; /** * IDPS profile name. When attached to a parent policy, the firewall's effective profile is the profile name of the parent policy. */ profile?: string; } /** * Intrusion detection signatures specification states. */ interface FirewallPolicyIntrusionDetectionSignatureSpecificationResponse { /** * Signature id. */ id?: string; /** * The signature state. */ mode?: string; } /** * Log Analytics Resources for Firewall Policy Insights. */ interface FirewallPolicyLogAnalyticsResourcesResponse { /** * The default workspace Id for Firewall Policy Insights. */ defaultWorkspaceId?: outputs.network.SubResourceResponse; /** * List of workspaces for Firewall Policy Insights. */ workspaces?: outputs.network.FirewallPolicyLogAnalyticsWorkspaceResponse[]; } /** * Log Analytics Workspace for Firewall Policy Insights. */ interface FirewallPolicyLogAnalyticsWorkspaceResponse { /** * Region to configure the Workspace. */ region?: string; /** * The workspace Id for Firewall Policy Insights. */ workspaceId?: outputs.network.SubResourceResponse; } /** * Properties of the FirewallPolicyNatRuleAction. */ interface FirewallPolicyNatRuleActionResponse { /** * The type of action. */ type?: string; } /** * Properties of the FirewallPolicyNatRuleCollectionAction. */ interface FirewallPolicyNatRuleCollectionActionResponse { /** * The type of action. */ type?: string; } /** * Firewall Policy NAT Rule Collection. */ interface FirewallPolicyNatRuleCollectionResponse { /** * The action type of a Nat rule collection. */ action?: outputs.network.FirewallPolicyNatRuleCollectionActionResponse; /** * The name of the rule collection. */ name?: string; /** * Priority of the Firewall Policy Rule Collection resource. */ priority?: number; /** * The type of the rule collection. * Expected value is 'FirewallPolicyNatRuleCollection'. */ ruleCollectionType: "FirewallPolicyNatRuleCollection"; /** * List of rules included in a rule collection. */ rules?: (outputs.network.ApplicationRuleResponse | outputs.network.NatRuleResponse | outputs.network.NetworkRuleResponse)[]; } /** * Firewall Policy NAT Rule. */ interface FirewallPolicyNatRuleResponse { /** * The action type of a Nat rule. */ action?: outputs.network.FirewallPolicyNatRuleActionResponse; /** * The name of the rule. */ name?: string; /** * Priority of the Firewall Policy Rule resource. */ priority?: number; /** * The match conditions for incoming traffic. */ ruleCondition?: outputs.network.ApplicationRuleConditionResponse | outputs.network.NatRuleConditionResponse | outputs.network.NetworkRuleConditionResponse; /** * The type of the rule. * Expected value is 'FirewallPolicyNatRule'. */ ruleType: "FirewallPolicyNatRule"; /** * The translated address for this NAT rule. */ translatedAddress?: string; /** * The translated port for this NAT rule. */ translatedPort?: string; } /** * Properties of the application rule protocol. */ interface FirewallPolicyRuleApplicationProtocolResponse { /** * Port number for the protocol, cannot be greater than 64000. */ port?: number; /** * Protocol type. */ protocolType?: string; } /** * Properties of the application rule protocol. */ interface FirewallPolicyRuleConditionApplicationProtocolResponse { /** * Port number for the protocol, cannot be greater than 64000. */ port?: number; /** * Protocol type. */ protocolType?: string; } /** * The private IP addresses/IP ranges to which traffic will not be SNAT. */ interface FirewallPolicySNATResponse { /** * The operation mode for automatically learning private ranges to not be SNAT */ autoLearnPrivateRanges?: string; /** * List of private IP addresses/IP address ranges to not be SNAT. */ privateRanges?: string[]; } /** * SQL Settings in Firewall Policy. */ interface FirewallPolicySQLResponse { /** * A flag to indicate if SQL Redirect traffic filtering is enabled. Turning on the flag requires no rule using port 11000-11999. */ allowSqlRedirect?: boolean; } /** * SKU of Firewall policy. */ interface FirewallPolicySkuResponse { /** * Tier of Firewall Policy. */ tier?: string; } /** * ThreatIntel Whitelist for Firewall Policy. */ interface FirewallPolicyThreatIntelWhitelistResponse { /** * List of FQDNs for the ThreatIntel Whitelist. */ fqdns?: string[]; /** * List of IP addresses for the ThreatIntel Whitelist. */ ipAddresses?: string[]; } /** * Configuration needed to perform TLS termination & initiation. */ interface FirewallPolicyTransportSecurityResponse { /** * The CA used for intermediate CA generation. */ certificateAuthority?: outputs.network.FirewallPolicyCertificateAuthorityResponse; } /** * Parameters that define the flow log format. */ interface FlowLogFormatParametersResponse { /** * The file type of flow log. */ type?: string; /** * The version (revision) of the flow log. */ version?: number; } /** * flowLogFormatParametersResponseProvideDefaults sets the appropriate defaults for FlowLogFormatParametersResponse */ function flowLogFormatParametersResponseProvideDefaults(val: FlowLogFormatParametersResponse): FlowLogFormatParametersResponse; /** * A flow log resource. */ interface FlowLogResponse { /** * Flag to enable/disable flow logging. */ enabled?: boolean; /** * Optional field to filter network traffic logs based on SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction and Action. If not specified, all network traffic will be logged. */ enabledFilteringCriteria?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Parameters that define the configuration of traffic analytics. */ flowAnalyticsConfiguration?: outputs.network.TrafficAnalyticsPropertiesResponse; /** * Parameters that define the flow log format. */ format?: outputs.network.FlowLogFormatParametersResponse; /** * Resource ID. */ id?: string; /** * FlowLog resource Managed Identity */ identity?: outputs.network.ManagedServiceIdentityResponse; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * The provisioning state of the flow log. */ provisioningState: string; /** * Parameters that define the retention policy for flow log. */ retentionPolicy?: outputs.network.RetentionPolicyParametersResponse; /** * ID of the storage account which is used to store the flow log. */ storageId: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Guid of network security group to which flow log will be applied. */ targetResourceGuid: string; /** * ID of network security group to which flow log will be applied. */ targetResourceId: string; /** * Resource type. */ type: string; } /** * flowLogResponseProvideDefaults sets the appropriate defaults for FlowLogResponse */ function flowLogResponseProvideDefaults(val: FlowLogResponse): FlowLogResponse; /** * A flow log resource. */ interface FlowLogServiceGatewayResponse { /** * Flag to enable/disable flow logging. */ enabled?: boolean; /** * Optional field to filter network traffic logs based on SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction and Action. If not specified, all network traffic will be logged. */ enabledFilteringCriteria?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Parameters that define the configuration of traffic analytics. */ flowAnalyticsConfiguration?: outputs.network.TrafficAnalyticsPropertiesResponse; /** * Parameters that define the flow log format. */ format?: outputs.network.FlowLogFormatParametersResponse; /** * Resource ID. */ id?: string; /** * FlowLog resource Managed Identity */ identity?: outputs.network.ManagedServiceIdentityServiceGatewayResponse; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * The provisioning state of the flow log. */ provisioningState: string; /** * Optional field to filter network traffic logs based on flow states. Value of this field could be any comma separated combination string of letters B,C,E or D. B represents Begin, when a flow is created. C represents Continue for an ongoing flow generated at every five-minute interval. E represents End, when a flow is terminated. D represents Deny, when a flow is denied. If not specified, all network traffic will be logged. */ recordTypes?: string; /** * Parameters that define the retention policy for flow log. */ retentionPolicy?: outputs.network.RetentionPolicyParametersResponse; /** * ID of the storage account which is used to store the flow log. */ storageId: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Guid of network security group to which flow log will be applied. */ targetResourceGuid: string; /** * ID of network security group to which flow log will be applied. */ targetResourceId: string; /** * Resource type. */ type: string; } /** * flowLogServiceGatewayResponseProvideDefaults sets the appropriate defaults for FlowLogServiceGatewayResponse */ function flowLogServiceGatewayResponseProvideDefaults(val: FlowLogServiceGatewayResponse): FlowLogServiceGatewayResponse; /** * A flow log resource. */ interface FlowLogVirtualNetworkApplianceResponse { /** * Flag to enable/disable flow logging. */ enabled?: boolean; /** * Optional field to filter network traffic logs based on SrcIP, SrcPort, DstIP, DstPort, Protocol, Encryption, Direction and Action. If not specified, all network traffic will be logged. */ enabledFilteringCriteria?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Parameters that define the configuration of traffic analytics. */ flowAnalyticsConfiguration?: outputs.network.TrafficAnalyticsPropertiesResponse; /** * Parameters that define the flow log format. */ format?: outputs.network.FlowLogFormatParametersResponse; /** * Resource ID. */ id?: string; /** * FlowLog resource Managed Identity */ identity?: outputs.network.ManagedServiceIdentityVirtualNetworkApplianceResponse; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * The provisioning state of the flow log. */ provisioningState: string; /** * Optional field to filter network traffic logs based on flow states. Value of this field could be any comma separated combination string of letters B,C,E or D. B represents Begin, when a flow is created. C represents Continue for an ongoing flow generated at every five-minute interval. E represents End, when a flow is terminated. D represents Deny, when a flow is denied. If not specified, all network traffic will be logged. */ recordTypes?: string; /** * Parameters that define the retention policy for flow log. */ retentionPolicy?: outputs.network.RetentionPolicyParametersResponse; /** * ID of the storage account which is used to store the flow log. */ storageId: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Guid of network security group to which flow log will be applied. */ targetResourceGuid: string; /** * ID of network security group to which flow log will be applied. */ targetResourceId: string; /** * Resource type. */ type: string; } /** * flowLogVirtualNetworkApplianceResponseProvideDefaults sets the appropriate defaults for FlowLogVirtualNetworkApplianceResponse */ function flowLogVirtualNetworkApplianceResponseProvideDefaults(val: FlowLogVirtualNetworkApplianceResponse): FlowLogVirtualNetworkApplianceResponse; /** * Frontend IP address of the load balancer. */ interface FrontendIPConfigurationInterfaceEndpointResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * Read only. Inbound pools URIs that use this frontend IP. */ inboundNatPools: outputs.network.SubResourceResponse[]; /** * Read only. Inbound rules URIs that use this frontend IP. */ inboundNatRules: outputs.network.SubResourceResponse[]; /** * Gets load balancing rules URIs that use this frontend IP. */ loadBalancingRules: outputs.network.SubResourceResponse[]; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * Read only. Outbound rules URIs that use this frontend IP. */ outboundRules: outputs.network.SubResourceResponse[]; /** * The private IP address of the IP configuration. */ privateIPAddress?: string; /** * The Private IP allocation method. */ privateIPAllocationMethod?: string; /** * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState?: string; /** * The reference of the Public IP resource. */ publicIPAddress?: outputs.network.PublicIPAddressInterfaceEndpointResponse; /** * The reference of the Public IP Prefix resource. */ publicIPPrefix?: outputs.network.SubResourceResponse; /** * The reference of the subnet resource. */ subnet?: outputs.network.SubnetInterfaceEndpointResponse; /** * A list of availability zones denoting the IP allocated for the resource needs to come from. */ zones?: string[]; } /** * frontendIPConfigurationInterfaceEndpointResponseProvideDefaults sets the appropriate defaults for FrontendIPConfigurationInterfaceEndpointResponse */ function frontendIPConfigurationInterfaceEndpointResponseProvideDefaults(val: FrontendIPConfigurationInterfaceEndpointResponse): FrontendIPConfigurationInterfaceEndpointResponse; /** * Frontend IP address of the load balancer. */ interface FrontendIPConfigurationResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The reference to gateway load balancer frontend IP. */ gatewayLoadBalancer?: outputs.network.SubResourceResponse; /** * Resource ID. */ id?: string; /** * An array of references to inbound pools that use this frontend IP. */ inboundNatPools: outputs.network.SubResourceResponse[]; /** * An array of references to inbound rules that use this frontend IP. */ inboundNatRules: outputs.network.SubResourceResponse[]; /** * An array of references to load balancing rules that use this frontend IP. */ loadBalancingRules: outputs.network.SubResourceResponse[]; /** * The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource. */ name?: string; /** * An array of references to outbound rules that use this frontend IP. */ outboundRules: outputs.network.SubResourceResponse[]; /** * The private IP address of the IP configuration. */ privateIPAddress?: string; /** * Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. */ privateIPAddressVersion?: string; /** * The Private IP allocation method. */ privateIPAllocationMethod?: string; /** * The provisioning state of the frontend IP configuration resource. */ provisioningState: string; /** * The reference to the Public IP resource. */ publicIPAddress?: outputs.network.PublicIPAddressResponse; /** * The reference to the Public IP Prefix resource. */ publicIPPrefix?: outputs.network.SubResourceResponse; /** * The reference to the subnet resource. */ subnet?: outputs.network.SubnetResponse; /** * Type of the resource. */ type: string; /** * A list of availability zones denoting the IP allocated for the resource needs to come from. */ zones?: string[]; } /** * frontendIPConfigurationResponseProvideDefaults sets the appropriate defaults for FrontendIPConfigurationResponse */ function frontendIPConfigurationResponseProvideDefaults(val: FrontendIPConfigurationResponse): FrontendIPConfigurationResponse; /** * Frontend IP address of the load balancer. */ interface FrontendIPConfigurationServiceGatewayResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The reference to gateway load balancer frontend IP. */ gatewayLoadBalancer?: outputs.network.SubResourceResponse; /** * Resource ID. */ id?: string; /** * An array of references to inbound pools that use this frontend IP. */ inboundNatPools: outputs.network.SubResourceResponse[]; /** * An array of references to inbound rules that use this frontend IP. */ inboundNatRules: outputs.network.SubResourceResponse[]; /** * An array of references to load balancing rules that use this frontend IP. */ loadBalancingRules: outputs.network.SubResourceResponse[]; /** * Name of the resource. */ name?: string; /** * An array of references to outbound rules that use this frontend IP. */ outboundRules: outputs.network.SubResourceResponse[]; /** * The private IP address of the IP configuration. */ privateIPAddress?: string; /** * Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. */ privateIPAddressVersion?: string; /** * The Private IP allocation method. */ privateIPAllocationMethod?: string; /** * The provisioning state of the frontend IP configuration resource. */ provisioningState: string; /** * The reference to the Public IP resource. */ publicIPAddress?: outputs.network.PublicIPAddressResponseV1; /** * The reference to the Public IP Prefix resource. */ publicIPPrefix?: outputs.network.SubResourceResponse; /** * The reference to the subnet resource. */ subnet?: outputs.network.SubnetResponse; /** * Resource type. */ type: string; /** * A list of availability zones denoting the IP allocated for the resource needs to come from. */ zones?: string[]; } /** * frontendIPConfigurationServiceGatewayResponseProvideDefaults sets the appropriate defaults for FrontendIPConfigurationServiceGatewayResponse */ function frontendIPConfigurationServiceGatewayResponseProvideDefaults(val: FrontendIPConfigurationServiceGatewayResponse): FrontendIPConfigurationServiceGatewayResponse; /** * Frontend IP address of the load balancer. */ interface FrontendIPConfigurationVirtualNetworkApplianceResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The reference to gateway load balancer frontend IP. */ gatewayLoadBalancer?: outputs.network.SubResourceResponse; /** * Resource ID. */ id?: string; /** * An array of references to inbound pools that use this frontend IP. */ inboundNatPools: outputs.network.SubResourceResponse[]; /** * An array of references to inbound rules that use this frontend IP. */ inboundNatRules: outputs.network.SubResourceResponse[]; /** * An array of references to load balancing rules that use this frontend IP. */ loadBalancingRules: outputs.network.SubResourceResponse[]; /** * Name of the resource. */ name?: string; /** * An array of references to outbound rules that use this frontend IP. */ outboundRules: outputs.network.SubResourceResponse[]; /** * The private IP address of the IP configuration. */ privateIPAddress?: string; /** * Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. */ privateIPAddressVersion?: string; /** * The Private IP allocation method. */ privateIPAllocationMethod?: string; /** * The provisioning state of the frontend IP configuration resource. */ provisioningState: string; /** * The reference to the Public IP resource. */ publicIPAddress?: outputs.network.PublicIPAddressResponseV2; /** * The reference to the Public IP Prefix resource. */ publicIPPrefix?: outputs.network.SubResourceResponse; /** * The reference to the subnet resource. */ subnet?: outputs.network.SubnetResponse; /** * Resource type. */ type: string; /** * A list of availability zones denoting the IP allocated for the resource needs to come from. */ zones?: string[]; } /** * frontendIPConfigurationVirtualNetworkApplianceResponseProvideDefaults sets the appropriate defaults for FrontendIPConfigurationVirtualNetworkApplianceResponse */ function frontendIPConfigurationVirtualNetworkApplianceResponseProvideDefaults(val: FrontendIPConfigurationVirtualNetworkApplianceResponse): FrontendIPConfigurationVirtualNetworkApplianceResponse; /** * GatewayCustomBgpIpAddressIpConfiguration for a virtual network gateway connection. */ interface GatewayCustomBgpIpAddressIpConfigurationResponse { /** * The custom BgpPeeringAddress which belongs to IpconfigurationId. */ customBgpIpAddress: string; /** * The IpconfigurationId of ipconfiguration which belongs to gateway. */ ipConfigurationId: string; } /** * Gateway load balancer tunnel interface of a load balancer backend address pool. */ interface GatewayLoadBalancerTunnelInterfaceResponse { /** * Identifier of gateway load balancer tunnel interface. */ identifier?: number; /** * Port of gateway load balancer tunnel interface. */ port?: number; /** * Protocol of gateway load balancer tunnel interface. */ protocol?: string; /** * Traffic type of gateway load balancer tunnel interface. */ type?: string; } /** * Resiliency Recommendation details */ interface GatewayResiliencyRecommendationResponse { /** * Link to the public documentation for the associated recommendation */ callToActionLink?: string; /** * Acton items to apply the recommendation */ callToActionText?: string; /** * Recommendation Id */ recommendationId?: string; /** * Recommendation details */ recommendationText?: string; /** * Recommendation Title */ recommendationTitle?: string; /** * Impact associated with the recommendation */ severity?: string; } /** * Gateway routing details. */ interface GatewayRouteResponse { /** * The route's AS path sequence. */ asPath: string; /** * The gateway's local address. */ localAddress: string; /** * The route's network prefix. */ network: string; /** * The route's next hop. */ nextHop: string; /** * The source this route was learned from. */ origin: string; /** * The peer this route was learned from. */ sourcePeer: string; /** * The route's weight. */ weight: number; } interface GatewayRouteSetResponse { /** * List of different Route Sources */ details?: { [key: string]: outputs.network.RouteSourceDetailsResponse[]; }; /** * List of different locations from where the routes are learned */ locations?: string[]; /** * Route Set name */ name?: string; } /** * Define user session identifier group by clauses. */ interface GroupByUserSessionResponse { /** * List of group by clause variables. */ groupByVariables: outputs.network.GroupByVariableResponse[]; } /** * Define user session group by clause variables. */ interface GroupByVariableResponse { /** * User Session clause variable. */ variableName: string; } /** * GroupMembers Item. */ interface GroupMembersItemResponse { /** * Resource Id. */ resourceId?: string; } /** * The HTTP header. */ interface HTTPHeaderResponse { /** * The name in HTTP header. */ name?: string; /** * The value in HTTP header. */ value?: string; } /** * An optional field under "Rewrite Action". It lets you capture and modify the value(s) of a specific header when multiple headers with the same name exist. Currently supported for Set-Cookie Response header only. For more details, visit https://aka.ms/appgwheadercrud */ interface HeaderValueMatcherResponse { /** * Setting this parameter to truth value with force the pattern to do a case in-sensitive comparison. */ ignoreCase?: boolean; /** * Setting this value as truth will force to check the negation of the condition given by the user in the pattern field. */ negate?: boolean; /** * The pattern, either fixed string or regular expression, that evaluates if a header value should be selected for rewrite. */ pattern?: string; } /** * IP addresses associated with azure firewall. */ interface HubIPAddressesResponse { /** * Private IP Address associated with azure firewall. */ privateIPAddress?: string; /** * Public IP addresses associated with azure firewall. */ publicIPs?: outputs.network.HubPublicIPAddressesResponse; } /** * Public IP addresses associated with azure firewall. */ interface HubPublicIPAddressesResponse { /** * The list of Public IP addresses associated with azure firewall or IP addresses to be retained. */ addresses?: outputs.network.AzureFirewallPublicIPAddressResponse[]; /** * The number of Public IP addresses associated with azure firewall. */ count?: number; } /** * Hub Item. */ interface HubResponse { /** * Resource Id. */ resourceId?: string; /** * Resource Type. */ resourceType?: string; } /** * RouteTable route. */ interface HubRouteResponse { /** * The type of destinations (eg: CIDR, ResourceId, Service). */ destinationType: string; /** * List of all destinations. */ destinations: string[]; /** * The name of the Route that is unique within a RouteTable. This name can be used to access this route. */ name: string; /** * NextHop resource ID. */ nextHop: string; /** * The type of next hop (eg: ResourceId). */ nextHopType: string; } /** * Properties of IPConfigurationBgpPeeringAddress. */ interface IPConfigurationBgpPeeringAddressResponse { /** * The list of custom BGP peering addresses which belong to IP configuration. */ customBgpIpAddresses?: string[]; /** * The list of default BGP peering addresses which belong to IP configuration. */ defaultBgpIpAddresses: string[]; /** * The ID of IP configuration which belongs to gateway. */ ipconfigurationId?: string; /** * The list of tunnel public IP addresses which belong to IP configuration. */ tunnelIpAddresses: string[]; } /** * IP configuration */ interface IPConfigurationInterfaceEndpointResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The private IP address of the IP configuration. */ privateIPAddress?: string; /** * The private IP address allocation method. */ privateIPAllocationMethod?: string; /** * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState?: string; /** * The reference of the public IP resource. */ publicIPAddress?: outputs.network.PublicIPAddressInterfaceEndpointResponse; /** * The reference of the subnet resource. */ subnet?: outputs.network.SubnetResponse; } /** * ipconfigurationInterfaceEndpointResponseProvideDefaults sets the appropriate defaults for IPConfigurationInterfaceEndpointResponse */ function ipconfigurationInterfaceEndpointResponseProvideDefaults(val: IPConfigurationInterfaceEndpointResponse): IPConfigurationInterfaceEndpointResponse; /** * IP configuration profile child resource. */ interface IPConfigurationProfileInterfaceEndpointResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * The name of the resource. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the resource. */ provisioningState: string; /** * The reference of the subnet resource to create a container network interface ip configuration. */ subnet?: outputs.network.SubnetResponse; /** * Sub Resource type. */ type: string; } /** * ipconfigurationProfileInterfaceEndpointResponseProvideDefaults sets the appropriate defaults for IPConfigurationProfileInterfaceEndpointResponse */ function ipconfigurationProfileInterfaceEndpointResponseProvideDefaults(val: IPConfigurationProfileInterfaceEndpointResponse): IPConfigurationProfileInterfaceEndpointResponse; /** * IP configuration profile child resource. */ interface IPConfigurationProfileResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the IP configuration profile resource. */ provisioningState: string; /** * The reference to the subnet resource to create a container network interface ip configuration. */ subnet?: outputs.network.SubnetResponse; /** * Sub Resource type. */ type: string; } /** * ipconfigurationProfileResponseProvideDefaults sets the appropriate defaults for IPConfigurationProfileResponse */ function ipconfigurationProfileResponseProvideDefaults(val: IPConfigurationProfileResponse): IPConfigurationProfileResponse; /** * IP configuration profile child resource. */ interface IPConfigurationProfileServiceGatewayResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the IP configuration profile resource. */ provisioningState: string; /** * The reference to the subnet resource to create a container network interface ip configuration. */ subnet?: outputs.network.SubnetServiceGatewayResponse; /** * Sub Resource type. */ type: string; } /** * ipconfigurationProfileServiceGatewayResponseProvideDefaults sets the appropriate defaults for IPConfigurationProfileServiceGatewayResponse */ function ipconfigurationProfileServiceGatewayResponseProvideDefaults(val: IPConfigurationProfileServiceGatewayResponse): IPConfigurationProfileServiceGatewayResponse; /** * IP configuration profile child resource. */ interface IPConfigurationProfileVirtualNetworkApplianceResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the IP configuration profile resource. */ provisioningState: string; /** * The reference to the subnet resource to create a container network interface ip configuration. */ subnet?: outputs.network.SubnetVirtualNetworkApplianceResponse; /** * Sub Resource type. */ type: string; } /** * ipconfigurationProfileVirtualNetworkApplianceResponseProvideDefaults sets the appropriate defaults for IPConfigurationProfileVirtualNetworkApplianceResponse */ function ipconfigurationProfileVirtualNetworkApplianceResponseProvideDefaults(val: IPConfigurationProfileVirtualNetworkApplianceResponse): IPConfigurationProfileVirtualNetworkApplianceResponse; /** * IP configuration. */ interface IPConfigurationResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The private IP address of the IP configuration. */ privateIPAddress?: string; /** * The private IP address allocation method. */ privateIPAllocationMethod?: string; /** * The provisioning state of the IP configuration resource. */ provisioningState: string; /** * The reference to the public IP resource. */ publicIPAddress?: outputs.network.PublicIPAddressResponse; /** * The reference to the subnet resource. */ subnet?: outputs.network.SubnetResponse; } /** * ipconfigurationResponseProvideDefaults sets the appropriate defaults for IPConfigurationResponse */ function ipconfigurationResponseProvideDefaults(val: IPConfigurationResponse): IPConfigurationResponse; /** * IP configuration. */ interface IPConfigurationServiceGatewayResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The private IP address of the IP configuration. */ privateIPAddress?: string; /** * The private IP address allocation method. */ privateIPAllocationMethod?: string; /** * The provisioning state of the IP configuration resource. */ provisioningState: string; /** * The reference to the public IP resource. */ publicIPAddress?: outputs.network.PublicIPAddressServiceGatewayResponse; /** * The reference to the subnet resource. */ subnet?: outputs.network.SubnetResponse; } /** * ipconfigurationServiceGatewayResponseProvideDefaults sets the appropriate defaults for IPConfigurationServiceGatewayResponse */ function ipconfigurationServiceGatewayResponseProvideDefaults(val: IPConfigurationServiceGatewayResponse): IPConfigurationServiceGatewayResponse; /** * IP configuration. */ interface IPConfigurationVirtualNetworkApplianceResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The private IP address of the IP configuration. */ privateIPAddress?: string; /** * The private IP address allocation method. */ privateIPAllocationMethod?: string; /** * The provisioning state of the IP configuration resource. */ provisioningState: string; /** * The reference to the public IP resource. */ publicIPAddress?: outputs.network.PublicIPAddressVirtualNetworkApplianceResponse; /** * The reference to the subnet resource. */ subnet?: outputs.network.SubnetResponse; } /** * ipconfigurationVirtualNetworkApplianceResponseProvideDefaults sets the appropriate defaults for IPConfigurationVirtualNetworkApplianceResponse */ function ipconfigurationVirtualNetworkApplianceResponseProvideDefaults(val: IPConfigurationVirtualNetworkApplianceResponse): IPConfigurationVirtualNetworkApplianceResponse; interface IPRuleResponse { /** * Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. */ addressPrefix?: string; } /** * IP traffic information. */ interface IPTrafficResponse { /** * List of destination IP addresses of the traffic.. */ destinationIps: string[]; /** * The destination ports of the traffic. */ destinationPorts: string[]; protocols: string[]; /** * List of source IP addresses of the traffic.. */ sourceIps: string[]; /** * The source ports of the traffic. */ sourcePorts: string[]; } /** * Inbound NAT pool of the load balancer. */ interface InboundNatPoolResponse { /** * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. */ backendPort: number; /** * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. */ enableFloatingIP?: boolean; /** * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. */ enableTcpReset?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * A reference to frontend IP addresses. */ frontendIPConfiguration?: outputs.network.SubResourceResponse; /** * The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535. */ frontendPortRangeEnd: number; /** * The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534. */ frontendPortRangeStart: number; /** * Resource ID. */ id?: string; /** * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. */ idleTimeoutInMinutes?: number; /** * The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource. */ name?: string; /** * The reference to the transport protocol used by the inbound NAT pool. */ protocol: string; /** * The provisioning state of the inbound NAT pool resource. */ provisioningState: string; /** * Type of the resource. */ type: string; } /** * Inbound NAT rule of the load balancer. */ interface InboundNatRuleInterfaceEndpointResponse { /** * A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backend IP. */ backendIPConfiguration: outputs.network.NetworkInterfaceIPConfigurationResponse; /** * The port used for the internal endpoint. Acceptable values range from 1 to 65535. */ backendPort?: number; /** * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. */ enableFloatingIP?: boolean; /** * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. */ enableTcpReset?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * A reference to frontend IP addresses. */ frontendIPConfiguration?: outputs.network.SubResourceResponse; /** * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534. */ frontendPort?: number; /** * Resource ID. */ id?: string; /** * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. */ idleTimeoutInMinutes?: number; /** * Gets name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The reference to the transport protocol used by the load balancing rule. */ protocol?: string; /** * Gets the provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState?: string; } /** * inboundNatRuleInterfaceEndpointResponseProvideDefaults sets the appropriate defaults for InboundNatRuleInterfaceEndpointResponse */ function inboundNatRuleInterfaceEndpointResponseProvideDefaults(val: InboundNatRuleInterfaceEndpointResponse): InboundNatRuleInterfaceEndpointResponse; /** * Inbound NAT rule of the load balancer. */ interface InboundNatRuleResponse { /** * A reference to backendAddressPool resource. */ backendAddressPool?: outputs.network.SubResourceResponse; /** * A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backend IP. */ backendIPConfiguration: outputs.network.NetworkInterfaceIPConfigurationResponse; /** * The port used for the internal endpoint. Acceptable values range from 1 to 65535. */ backendPort?: number; /** * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. */ enableFloatingIP?: boolean; /** * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. */ enableTcpReset?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * A reference to frontend IP addresses. */ frontendIPConfiguration?: outputs.network.SubResourceResponse; /** * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534. */ frontendPort?: number; /** * The port range end for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeStart. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. */ frontendPortRangeEnd?: number; /** * The port range start for the external endpoint. This property is used together with BackendAddressPool and FrontendPortRangeEnd. Individual inbound NAT rule port mappings will be created for each backend address from BackendAddressPool. Acceptable values range from 1 to 65534. */ frontendPortRangeStart?: number; /** * Resource ID. */ id?: string; /** * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. */ idleTimeoutInMinutes?: number; /** * The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource. */ name?: string; /** * The reference to the transport protocol used by the load balancing rule. */ protocol?: string; /** * The provisioning state of the inbound NAT rule resource. */ provisioningState: string; /** * Type of the resource. */ type: string; } /** * inboundNatRuleResponseProvideDefaults sets the appropriate defaults for InboundNatRuleResponse */ function inboundNatRuleResponseProvideDefaults(val: InboundNatRuleResponse): InboundNatRuleResponse; /** * Intent information. */ interface IntentContentResponse { description?: string; /** * Destination resource id of the intent. */ destinationResourceId: string; /** * IP traffic information. */ ipTraffic: outputs.network.IPTrafficResponse; /** * Source resource id of the intent. */ sourceResourceId: string; } /** * Interface endpoint resource. */ interface InterfaceEndpointResponse { /** * A reference to the service being brought into the virtual network. */ endpointService?: outputs.network.EndpointServiceResponse; /** * Gets a unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * A first-party service's FQDN that is mapped to the private IP allocated via this interface endpoint. */ fqdn?: string; /** * Resource ID. */ id?: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * Gets an array of references to the network interfaces created for this interface endpoint. */ networkInterfaces: outputs.network.NetworkInterfaceResponse[]; /** * A read-only property that identifies who created this interface endpoint. */ owner: string; /** * The provisioning state of the interface endpoint. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState: string; /** * The ID of the subnet from which the private IP will be allocated. */ subnet?: outputs.network.SubnetInterfaceEndpointResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * Resource Uri of Public Ip for Standard Load Balancer Frontend End. */ interface InternetIngressPublicIpsPropertiesResponse { /** * Resource Uri of Public Ip */ id?: string; } /** * Contains the IpTag associated with the object. */ interface IpTagResponse { /** * The IP tag type. Example: FirstPartyUsage. */ ipTagType?: string; /** * The value of the IP tag associated with the public IP. Example: SQL. */ tag?: string; } /** * IpamPool prefix allocation reference. */ interface IpamPoolPrefixAllocationResponse { /** * List of assigned IP address prefixes in the IpamPool of the associated resource. */ allocatedAddressPrefixes: string[]; /** * Resource id of the associated Azure IpamPool resource. */ id?: string; /** * Number of IP addresses to allocate. */ numberOfIpAddresses?: string; } /** * Properties of IpamPool resource properties which are specific to the Pool resource. */ interface IpamPoolPropertiesResponse { /** * List of IP address prefixes of the resource. */ addressPrefixes: string[]; description?: string; /** * String representing a friendly name for the resource. */ displayName?: string; /** * List of IP address type for the IpamPool. */ ipAddressType: string[]; /** * String representing parent IpamPool resource name. If empty the IpamPool will be a root pool. */ parentPoolName?: string; /** * Provisioning states of a resource. */ provisioningState: string; } /** * An IPSec Policy configuration for a virtual network gateway connection. */ interface IpsecPolicyResponse { /** * The DH Group used in IKE Phase 1 for initial SA. */ dhGroup: string; /** * The IKE encryption algorithm (IKE phase 2). */ ikeEncryption: string; /** * The IKE integrity algorithm (IKE phase 2). */ ikeIntegrity: string; /** * The IPSec encryption algorithm (IKE phase 1). */ ipsecEncryption: string; /** * The IPSec integrity algorithm (IKE phase 1). */ ipsecIntegrity: string; /** * The Pfs Group used in IKE Phase 2 for new child SA. */ pfsGroup: string; /** * The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel. */ saDataSizeKilobytes: number; /** * The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel. */ saLifeTimeSeconds: number; } /** * IPv6 Circuit Connection properties for global reach. */ interface Ipv6CircuitConnectionConfigResponse { /** * /125 IP address space to carve out customer addresses for global reach. */ addressPrefix?: string; /** * Express Route Circuit connection state. */ circuitConnectionStatus: string; } /** * Contains IPv6 peering config. */ interface Ipv6ExpressRouteCircuitPeeringConfigResponse { /** * The Microsoft peering configuration. */ microsoftPeeringConfig?: outputs.network.ExpressRouteCircuitPeeringConfigResponse; /** * The primary address prefix. */ primaryPeerAddressPrefix?: string; /** * The reference to the RouteFilter resource. */ routeFilter?: outputs.network.SubResourceResponse; /** * The secondary address prefix. */ secondaryPeerAddressPrefix?: string; /** * The state of peering. */ state?: string; } /** * Load balancer backend addresses. */ interface LoadBalancerBackendAddressResponse { /** * A list of administrative states which once set can override health probe so that Load Balancer will always forward new connections to backend, or deny new connections and reset existing connections. */ adminState?: string; /** * Collection of inbound NAT rule port mappings. */ inboundNatRulesPortMapping: outputs.network.NatRulePortMappingResponse[]; /** * IP Address belonging to the referenced virtual network. */ ipAddress?: string; /** * Reference to the frontend ip address configuration defined in regional loadbalancer. */ loadBalancerFrontendIPConfiguration?: outputs.network.SubResourceResponse; /** * Name of the backend address. */ name?: string; /** * Reference to IP address defined in network interfaces. */ networkInterfaceIPConfiguration: outputs.network.SubResourceResponse; /** * Reference to an existing subnet. */ subnet?: outputs.network.SubResourceResponse; /** * Reference to an existing virtual network. */ virtualNetwork?: outputs.network.SubResourceResponse; } /** * SKU of a load balancer. */ interface LoadBalancerSkuResponse { /** * Name of a load balancer SKU. */ name?: string; /** * Tier of a load balancer SKU. */ tier?: string; } /** * A load balancing rule for a load balancer. */ interface LoadBalancingRuleResponse { /** * A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs. */ backendAddressPool?: outputs.network.SubResourceResponse; /** * An array of references to pool of DIPs. */ backendAddressPools?: outputs.network.SubResourceResponse[]; /** * The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables "Any Port". */ backendPort?: number; /** * Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule. */ disableOutboundSnat?: boolean; /** * Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint. */ enableFloatingIP?: boolean; /** * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. */ enableTcpReset?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * A reference to frontend IP addresses. */ frontendIPConfiguration?: outputs.network.SubResourceResponse; /** * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables "Any Port". */ frontendPort: number; /** * Resource ID. */ id?: string; /** * The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP. */ idleTimeoutInMinutes?: number; /** * The load distribution policy for this rule. */ loadDistribution?: string; /** * The name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource. */ name?: string; /** * The reference to the load balancer probe used by the load balancing rule. */ probe?: outputs.network.SubResourceResponse; /** * The reference to the transport protocol used by the load balancing rule. */ protocol: string; /** * The provisioning state of the load balancing rule resource. */ provisioningState: string; /** * Type of the resource. */ type: string; } /** * A common class for general resource information. */ interface LocalNetworkGatewayResponse { /** * Local network gateway's BGP speaker settings. */ bgpSettings?: outputs.network.BgpSettingsResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * FQDN of local network gateway. */ fqdn?: string; /** * IP address of local network gateway. */ gatewayIpAddress?: string; /** * Resource ID. */ id?: string; /** * Local network site address space. */ localNetworkAddressSpace?: outputs.network.AddressSpaceResponse; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * The provisioning state of the local network gateway resource. */ provisioningState: string; /** * The resource GUID property of the local network gateway resource. */ resourceGuid: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * Defines a managed rule group override setting. */ interface ManagedRuleGroupOverrideResponse { /** * The managed rule group to override. */ ruleGroupName: string; /** * List of rules that will be disabled. If none specified, all rules in the group will be disabled. */ rules?: outputs.network.ManagedRuleOverrideResponse[]; } /** * Defines a managed rule group override setting. */ interface ManagedRuleOverrideResponse { /** * Describes the override action to be applied when rule matches. */ action?: string; /** * Identifier for the managed rule. */ ruleId: string; /** * Describes the override sensitivity to be applied when rule matches. */ sensitivity?: string; /** * The state of the managed rule. Defaults to Disabled if not specified. */ state?: string; } /** * Defines a managed rule set. */ interface ManagedRuleSetResponse { /** * Defines the rule group overrides to apply to the rule set. */ ruleGroupOverrides?: outputs.network.ManagedRuleGroupOverrideResponse[]; /** * Defines the rule set type to use. */ ruleSetType: string; /** * Defines the version of the rule set to use. */ ruleSetVersion: string; } /** * Allow to exclude some variable satisfy the condition for the WAF check. */ interface ManagedRulesDefinitionResponse { /** * The exceptions that are applied on the policy. */ exceptions?: outputs.network.ExceptionEntryResponse[]; /** * The Exclusions that are applied on the policy. */ exclusions?: outputs.network.OwaspCrsExclusionEntryResponse[]; /** * The managed rule sets that are associated with the policy. */ managedRuleSets: outputs.network.ManagedRuleSetResponse[]; } /** * Identity for the resource. */ interface ManagedServiceIdentityResponse { /** * The principal id of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. */ type?: string; /** * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.network.ManagedServiceIdentityResponseUserAssignedIdentities; }; } interface ManagedServiceIdentityResponseUserAssignedIdentities { /** * The client id of user assigned identity. */ clientId: string; /** * The principal id of user assigned identity. */ principalId: string; } /** * Identity for the resource. */ interface ManagedServiceIdentityServiceGatewayResponse { /** * The principal id of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. */ type?: string; /** * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.network.ManagedServiceIdentityUserAssignedIdentitiesResponse; }; } interface ManagedServiceIdentityUserAssignedIdentitiesResponse { /** * The client id of user assigned identity. */ clientId: string; /** * The principal id of user assigned identity. */ principalId: string; } /** * Identity for the resource. */ interface ManagedServiceIdentityVirtualNetworkApplianceResponse { /** * The principal id of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant id of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine. */ type?: string; /** * The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.network.ManagedServiceIdentityUserAssignedIdentitiesResponse; }; } /** * Define match conditions. */ interface MatchConditionResponse { /** * Match value. */ matchValues: string[]; /** * List of match variables. */ matchVariables: outputs.network.MatchVariableResponse[]; /** * Whether this is negate condition or not. */ negationConditon?: boolean; /** * The operator to be matched. */ operator: string; /** * List of transforms. */ transforms?: string[]; } /** * Define match variables. */ interface MatchVariableResponse { /** * The selector of match variable. */ selector?: string; /** * Match Variable. */ variableName: string; } /** * Nat Gateway resource. */ interface NatGatewayResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The idle timeout of the nat gateway. */ idleTimeoutInMinutes?: number; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * The provisioning state of the NAT gateway resource. */ provisioningState: string; /** * An array of public ip addresses associated with the nat gateway resource. */ publicIpAddresses?: outputs.network.SubResourceResponse[]; /** * An array of public ip prefixes associated with the nat gateway resource. */ publicIpPrefixes?: outputs.network.SubResourceResponse[]; /** * The resource GUID property of the NAT gateway resource. */ resourceGuid: string; /** * The nat gateway SKU. */ sku?: outputs.network.NatGatewaySkuResponse; /** * An array of references to the subnets using this nat gateway resource. */ subnets: outputs.network.SubResourceResponse[]; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; /** * A list of availability zones denoting the zone in which Nat Gateway should be deployed. */ zones?: string[]; } /** * Nat Gateway resource. */ interface NatGatewayServiceGatewayResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The idle timeout of the nat gateway. */ idleTimeoutInMinutes?: number; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * The provisioning state of the NAT gateway resource. */ provisioningState: string; /** * An array of public ip addresses V4 associated with the nat gateway resource. */ publicIpAddresses?: outputs.network.SubResourceResponse[]; /** * An array of public ip addresses V6 associated with the nat gateway resource. */ publicIpAddressesV6?: outputs.network.SubResourceResponse[]; /** * An array of public ip prefixes V4 associated with the nat gateway resource. */ publicIpPrefixes?: outputs.network.SubResourceResponse[]; /** * An array of public ip prefixes V6 associated with the nat gateway resource. */ publicIpPrefixesV6?: outputs.network.SubResourceResponse[]; /** * The resource GUID property of the NAT gateway resource. */ resourceGuid: string; /** * Reference to an existing service gateway. */ serviceGateway?: outputs.network.SubResourceResponse; /** * The nat gateway SKU. */ sku?: outputs.network.NatGatewaySkuResponse; /** * A reference to the source virtual network using this nat gateway resource. */ sourceVirtualNetwork?: outputs.network.SubResourceResponse; /** * An array of references to the subnets using this nat gateway resource. */ subnets: outputs.network.SubResourceResponse[]; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; /** * A list of availability zones denoting the zone in which Nat Gateway should be deployed. */ zones?: string[]; } /** * SKU of nat gateway. */ interface NatGatewaySkuResponse { /** * Name of Nat Gateway SKU. */ name?: string; } /** * Nat Gateway resource. */ interface NatGatewayVirtualNetworkApplianceResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The idle timeout of the nat gateway. */ idleTimeoutInMinutes?: number; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * The provisioning state of the NAT gateway resource. */ provisioningState: string; /** * An array of public ip addresses V4 associated with the nat gateway resource. */ publicIpAddresses?: outputs.network.SubResourceResponse[]; /** * An array of public ip addresses V6 associated with the nat gateway resource. */ publicIpAddressesV6?: outputs.network.SubResourceResponse[]; /** * An array of public ip prefixes V4 associated with the nat gateway resource. */ publicIpPrefixes?: outputs.network.SubResourceResponse[]; /** * An array of public ip prefixes V6 associated with the nat gateway resource. */ publicIpPrefixesV6?: outputs.network.SubResourceResponse[]; /** * The resource GUID property of the NAT gateway resource. */ resourceGuid: string; /** * Reference to an existing service gateway. */ serviceGateway?: outputs.network.SubResourceResponse; /** * The nat gateway SKU. */ sku?: outputs.network.NatGatewaySkuResponse; /** * A reference to the source virtual network using this nat gateway resource. */ sourceVirtualNetwork?: outputs.network.SubResourceResponse; /** * An array of references to the subnets using this nat gateway resource. */ subnets: outputs.network.SubResourceResponse[]; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; /** * A list of availability zones denoting the zone in which Nat Gateway should be deployed. */ zones?: string[]; } /** * Rule condition of type nat. */ interface NatRuleConditionResponse { /** * Description of the rule condition. */ description?: string; /** * List of destination IP addresses or Service Tags. */ destinationAddresses?: string[]; /** * List of destination ports. */ destinationPorts?: string[]; /** * Array of FirewallPolicyRuleConditionNetworkProtocols. */ ipProtocols?: string[]; /** * Name of the rule condition. */ name?: string; /** * Rule Condition Type. * Expected value is 'NatRuleCondition'. */ ruleConditionType: "NatRuleCondition"; /** * List of source IP addresses for this rule. */ sourceAddresses?: string[]; /** * List of source IpGroups for this rule. */ sourceIpGroups?: string[]; } /** * Individual port mappings for inbound NAT rule created for backend pool. */ interface NatRulePortMappingResponse { /** * Backend port. */ backendPort?: number; /** * Frontend port. */ frontendPort?: number; /** * Name of inbound NAT rule. */ inboundNatRuleName?: string; } /** * Rule of type nat. */ interface NatRuleResponse { /** * Description of the rule. */ description?: string; /** * List of destination IP addresses or Service Tags. */ destinationAddresses?: string[]; /** * List of destination ports. */ destinationPorts?: string[]; /** * Array of FirewallPolicyRuleNetworkProtocols. */ ipProtocols?: string[]; /** * Name of the rule. */ name?: string; /** * Rule Type. * Expected value is 'NatRule'. */ ruleType: "NatRule"; /** * List of source IP addresses for this rule. */ sourceAddresses?: string[]; /** * List of source IpGroups for this rule. */ sourceIpGroups?: string[]; /** * The translated address for this NAT rule. */ translatedAddress?: string; /** * The translated FQDN for this NAT rule. */ translatedFqdn?: string; /** * The translated port for this NAT rule. */ translatedPort?: string; } /** * DNS settings of a network interface. */ interface NetworkInterfaceDnsSettingsInterfaceEndpointResponse { /** * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs. */ appliedDnsServers?: string[]; /** * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection. */ dnsServers?: string[]; /** * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. */ internalDnsNameLabel?: string; /** * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix. */ internalDomainNameSuffix?: string; /** * Fully qualified DNS name supporting internal communications between VMs in the same virtual network. */ internalFqdn?: string; } /** * DNS settings of a network interface. */ interface NetworkInterfaceDnsSettingsResponse { /** * If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs. */ appliedDnsServers: string[]; /** * List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection. */ dnsServers?: string[]; /** * Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. */ internalDnsNameLabel?: string; /** * Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix. */ internalDomainNameSuffix: string; /** * Fully qualified DNS name supporting internal communications between VMs in the same virtual network. */ internalFqdn: string; } /** * IPConfiguration in a network interface. */ interface NetworkInterfaceIPConfigurationInterfaceEndpointResponse { /** * The reference of ApplicationGatewayBackendAddressPool resource. */ applicationGatewayBackendAddressPools?: outputs.network.ApplicationGatewayBackendAddressPoolResponse[]; /** * Application security groups in which the IP configuration is included. */ applicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * The reference of LoadBalancerBackendAddressPool resource. */ loadBalancerBackendAddressPools?: outputs.network.BackendAddressPoolInterfaceEndpointResponse[]; /** * A list of references of LoadBalancerInboundNatRules. */ loadBalancerInboundNatRules?: outputs.network.InboundNatRuleInterfaceEndpointResponse[]; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * Gets whether this is a primary customer address on the network interface. */ primary?: boolean; /** * Private IP address of the IP configuration. */ privateIPAddress?: string; /** * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. */ privateIPAddressVersion?: string; /** * The private IP address allocation method. */ privateIPAllocationMethod?: string; /** * The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState?: string; /** * Public IP address bound to the IP configuration. */ publicIPAddress?: outputs.network.PublicIPAddressInterfaceEndpointResponse; /** * Subnet bound to the IP configuration. */ subnet?: outputs.network.SubnetInterfaceEndpointResponse; /** * The reference to Virtual Network Taps. */ virtualNetworkTaps?: outputs.network.VirtualNetworkTapInterfaceEndpointResponse[]; } /** * networkInterfaceIPConfigurationInterfaceEndpointResponseProvideDefaults sets the appropriate defaults for NetworkInterfaceIPConfigurationInterfaceEndpointResponse */ function networkInterfaceIPConfigurationInterfaceEndpointResponseProvideDefaults(val: NetworkInterfaceIPConfigurationInterfaceEndpointResponse): NetworkInterfaceIPConfigurationInterfaceEndpointResponse; /** * PrivateLinkConnection properties for the network interface. */ interface NetworkInterfaceIPConfigurationPrivateLinkConnectionPropertiesResponse { /** * List of FQDNs for current private link connection. */ fqdns: string[]; /** * The group ID for current private link connection. */ groupId: string; /** * The required member name for current private link connection. */ requiredMemberName: string; } /** * IPConfiguration in a network interface. */ interface NetworkInterfaceIPConfigurationResponse { /** * The reference to ApplicationGatewayBackendAddressPool resource. */ applicationGatewayBackendAddressPools?: outputs.network.ApplicationGatewayBackendAddressPoolResponse[]; /** * Application security groups in which the IP configuration is included. */ applicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The reference to gateway load balancer frontend IP. */ gatewayLoadBalancer?: outputs.network.SubResourceResponse; /** * Resource ID. */ id?: string; /** * The reference to LoadBalancerBackendAddressPool resource. */ loadBalancerBackendAddressPools?: outputs.network.BackendAddressPoolResponse[]; /** * A list of references of LoadBalancerInboundNatRules. */ loadBalancerInboundNatRules?: outputs.network.InboundNatRuleResponse[]; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * Whether this is a primary customer address on the network interface. */ primary?: boolean; /** * Private IP address of the IP configuration. It can be a single IP address or a CIDR block in the format
    /. */ privateIPAddress?: string; /** * The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address. */ privateIPAddressPrefixLength?: number; /** * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. */ privateIPAddressVersion?: string; /** * The private IP address allocation method. */ privateIPAllocationMethod?: string; /** * PrivateLinkConnection properties for the network interface. */ privateLinkConnectionProperties: outputs.network.NetworkInterfaceIPConfigurationPrivateLinkConnectionPropertiesResponse; /** * The provisioning state of the network interface IP configuration. */ provisioningState: string; /** * Public IP address bound to the IP configuration. */ publicIPAddress?: outputs.network.PublicIPAddressResponse; /** * Subnet bound to the IP configuration. */ subnet?: outputs.network.SubnetResponse; /** * Resource type. */ type?: string; /** * The reference to Virtual Network Taps. */ virtualNetworkTaps?: outputs.network.VirtualNetworkTapResponse[]; } /** * networkInterfaceIPConfigurationResponseProvideDefaults sets the appropriate defaults for NetworkInterfaceIPConfigurationResponse */ function networkInterfaceIPConfigurationResponseProvideDefaults(val: NetworkInterfaceIPConfigurationResponse): NetworkInterfaceIPConfigurationResponse; /** * IPConfiguration in a network interface. */ interface NetworkInterfaceIPConfigurationResponseV1 { /** * The reference of ApplicationGatewayBackendAddressPool resource. */ applicationGatewayBackendAddressPools?: outputs.network.ApplicationGatewayBackendAddressPoolInterfaceEndpointResponse[]; /** * Application security groups in which the IP configuration is included. */ applicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * The reference of LoadBalancerBackendAddressPool resource. */ loadBalancerBackendAddressPools?: outputs.network.BackendAddressPoolInterfaceEndpointResponse[]; /** * A list of references of LoadBalancerInboundNatRules. */ loadBalancerInboundNatRules?: outputs.network.InboundNatRuleInterfaceEndpointResponse[]; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * Gets whether this is a primary customer address on the network interface. */ primary?: boolean; /** * Private IP address of the IP configuration. */ privateIPAddress?: string; /** * Available from Api-Version 2016-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. */ privateIPAddressVersion?: string; /** * The private IP address allocation method. */ privateIPAllocationMethod?: string; /** * The provisioning state of the network interface IP configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState?: string; /** * Public IP address bound to the IP configuration. */ publicIPAddress?: outputs.network.PublicIPAddressInterfaceEndpointResponse; /** * Subnet bound to the IP configuration. */ subnet?: outputs.network.SubnetInterfaceEndpointResponse; /** * The reference to Virtual Network Taps. */ virtualNetworkTaps?: outputs.network.VirtualNetworkTapInterfaceEndpointResponse[]; } /** * networkInterfaceIPConfigurationResponseV1ProvideDefaults sets the appropriate defaults for NetworkInterfaceIPConfigurationResponseV1 */ function networkInterfaceIPConfigurationResponseV1ProvideDefaults(val: NetworkInterfaceIPConfigurationResponseV1): NetworkInterfaceIPConfigurationResponseV1; /** * IPConfiguration in a network interface. */ interface NetworkInterfaceIPConfigurationResponseV2 { /** * The reference to ApplicationGatewayBackendAddressPool resource. */ applicationGatewayBackendAddressPools?: outputs.network.ApplicationGatewayBackendAddressPoolServiceGatewayResponse[]; /** * Application security groups in which the IP configuration is included. */ applicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The reference to gateway load balancer frontend IP. */ gatewayLoadBalancer?: outputs.network.SubResourceResponse; /** * Resource ID. */ id?: string; /** * The reference to LoadBalancerBackendAddressPool resource. */ loadBalancerBackendAddressPools?: outputs.network.BackendAddressPoolResponse[]; /** * A list of references of LoadBalancerInboundNatRules. */ loadBalancerInboundNatRules?: outputs.network.InboundNatRuleResponse[]; /** * Name of the resource. */ name?: string; /** * Whether this is a primary customer address on the network interface. */ primary?: boolean; /** * Private IP address of the IP configuration. It can be a single IP address or a CIDR block in the format
    /. */ privateIPAddress?: string; /** * The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address. */ privateIPAddressPrefixLength?: number; /** * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. */ privateIPAddressVersion?: string; /** * The private IP address allocation method. */ privateIPAllocationMethod?: string; /** * PrivateLinkConnection properties for the network interface. */ privateLinkConnectionProperties: outputs.network.NetworkInterfaceIPConfigurationPrivateLinkConnectionPropertiesResponse; /** * The provisioning state of the network interface IP configuration. */ provisioningState: string; /** * Public IP address bound to the IP configuration. */ publicIPAddress?: outputs.network.PublicIPAddressServiceGatewayResponse; /** * Subnet bound to the IP configuration. */ subnet?: outputs.network.SubnetResponse; /** * Resource type. */ type: string; /** * The reference to Virtual Network Taps. */ virtualNetworkTaps?: outputs.network.VirtualNetworkTapServiceGatewayResponse[]; } /** * networkInterfaceIPConfigurationResponseV2ProvideDefaults sets the appropriate defaults for NetworkInterfaceIPConfigurationResponseV2 */ function networkInterfaceIPConfigurationResponseV2ProvideDefaults(val: NetworkInterfaceIPConfigurationResponseV2): NetworkInterfaceIPConfigurationResponseV2; /** * IPConfiguration in a network interface. */ interface NetworkInterfaceIPConfigurationResponseV3 { /** * The reference to ApplicationGatewayBackendAddressPool resource. */ applicationGatewayBackendAddressPools?: outputs.network.ApplicationGatewayBackendAddressPoolVirtualNetworkApplianceResponse[]; /** * Application security groups in which the IP configuration is included. */ applicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The reference to gateway load balancer frontend IP. */ gatewayLoadBalancer?: outputs.network.SubResourceResponse; /** * Resource ID. */ id?: string; /** * The reference to LoadBalancerBackendAddressPool resource. */ loadBalancerBackendAddressPools?: outputs.network.BackendAddressPoolResponse[]; /** * A list of references of LoadBalancerInboundNatRules. */ loadBalancerInboundNatRules?: outputs.network.InboundNatRuleResponse[]; /** * Name of the resource. */ name?: string; /** * Whether this is a primary customer address on the network interface. */ primary?: boolean; /** * Private IP address of the IP configuration. It can be a single IP address or a CIDR block in the format
    /. */ privateIPAddress?: string; /** * The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address. */ privateIPAddressPrefixLength?: number; /** * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. */ privateIPAddressVersion?: string; /** * The private IP address allocation method. */ privateIPAllocationMethod?: string; /** * PrivateLinkConnection properties for the network interface. */ privateLinkConnectionProperties: outputs.network.NetworkInterfaceIPConfigurationPrivateLinkConnectionPropertiesResponse; /** * The provisioning state of the network interface IP configuration. */ provisioningState: string; /** * Public IP address bound to the IP configuration. */ publicIPAddress?: outputs.network.PublicIPAddressVirtualNetworkApplianceResponse; /** * Subnet bound to the IP configuration. */ subnet?: outputs.network.SubnetResponse; /** * Resource type. */ type: string; /** * The reference to Virtual Network Taps. */ virtualNetworkTaps?: outputs.network.VirtualNetworkTapVirtualNetworkApplianceResponse[]; } /** * networkInterfaceIPConfigurationResponseV3ProvideDefaults sets the appropriate defaults for NetworkInterfaceIPConfigurationResponseV3 */ function networkInterfaceIPConfigurationResponseV3ProvideDefaults(val: NetworkInterfaceIPConfigurationResponseV3): NetworkInterfaceIPConfigurationResponseV3; /** * IPConfiguration in a network interface. */ interface NetworkInterfaceIPConfigurationServiceGatewayResponse { /** * The reference to ApplicationGatewayBackendAddressPool resource. */ applicationGatewayBackendAddressPools?: outputs.network.ApplicationGatewayBackendAddressPoolResponse[]; /** * Application security groups in which the IP configuration is included. */ applicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The reference to gateway load balancer frontend IP. */ gatewayLoadBalancer?: outputs.network.SubResourceResponse; /** * Resource ID. */ id?: string; /** * The reference to LoadBalancerBackendAddressPool resource. */ loadBalancerBackendAddressPools?: outputs.network.BackendAddressPoolResponse[]; /** * A list of references of LoadBalancerInboundNatRules. */ loadBalancerInboundNatRules?: outputs.network.InboundNatRuleResponse[]; /** * Name of the resource. */ name?: string; /** * Whether this is a primary customer address on the network interface. */ primary?: boolean; /** * Private IP address of the IP configuration. It can be a single IP address or a CIDR block in the format
    /. */ privateIPAddress?: string; /** * The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address. */ privateIPAddressPrefixLength?: number; /** * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. */ privateIPAddressVersion?: string; /** * The private IP address allocation method. */ privateIPAllocationMethod?: string; /** * PrivateLinkConnection properties for the network interface. */ privateLinkConnectionProperties: outputs.network.NetworkInterfaceIPConfigurationPrivateLinkConnectionPropertiesResponse; /** * The provisioning state of the network interface IP configuration. */ provisioningState: string; /** * Public IP address bound to the IP configuration. */ publicIPAddress?: outputs.network.PublicIPAddressServiceGatewayResponse; /** * Subnet bound to the IP configuration. */ subnet?: outputs.network.SubnetResponse; /** * Resource type. */ type: string; /** * The reference to Virtual Network Taps. */ virtualNetworkTaps?: outputs.network.VirtualNetworkTapServiceGatewayResponse[]; } /** * networkInterfaceIPConfigurationServiceGatewayResponseProvideDefaults sets the appropriate defaults for NetworkInterfaceIPConfigurationServiceGatewayResponse */ function networkInterfaceIPConfigurationServiceGatewayResponseProvideDefaults(val: NetworkInterfaceIPConfigurationServiceGatewayResponse): NetworkInterfaceIPConfigurationServiceGatewayResponse; /** * IPConfiguration in a network interface. */ interface NetworkInterfaceIPConfigurationVirtualNetworkApplianceResponse { /** * The reference to ApplicationGatewayBackendAddressPool resource. */ applicationGatewayBackendAddressPools?: outputs.network.ApplicationGatewayBackendAddressPoolResponse[]; /** * Application security groups in which the IP configuration is included. */ applicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The reference to gateway load balancer frontend IP. */ gatewayLoadBalancer?: outputs.network.SubResourceResponse; /** * Resource ID. */ id?: string; /** * The reference to LoadBalancerBackendAddressPool resource. */ loadBalancerBackendAddressPools?: outputs.network.BackendAddressPoolResponse[]; /** * A list of references of LoadBalancerInboundNatRules. */ loadBalancerInboundNatRules?: outputs.network.InboundNatRuleResponse[]; /** * Name of the resource. */ name?: string; /** * Whether this is a primary customer address on the network interface. */ primary?: boolean; /** * Private IP address of the IP configuration. It can be a single IP address or a CIDR block in the format
    /. */ privateIPAddress?: string; /** * The private IP address prefix length. If specified and the allocation method is dynamic, the service will allocate a CIDR block instead of a single IP address. */ privateIPAddressPrefixLength?: number; /** * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. */ privateIPAddressVersion?: string; /** * The private IP address allocation method. */ privateIPAllocationMethod?: string; /** * PrivateLinkConnection properties for the network interface. */ privateLinkConnectionProperties: outputs.network.NetworkInterfaceIPConfigurationPrivateLinkConnectionPropertiesResponse; /** * The provisioning state of the network interface IP configuration. */ provisioningState: string; /** * Public IP address bound to the IP configuration. */ publicIPAddress?: outputs.network.PublicIPAddressVirtualNetworkApplianceResponse; /** * Subnet bound to the IP configuration. */ subnet?: outputs.network.SubnetResponse; /** * Resource type. */ type: string; /** * The reference to Virtual Network Taps. */ virtualNetworkTaps?: outputs.network.VirtualNetworkTapVirtualNetworkApplianceResponse[]; } /** * networkInterfaceIPConfigurationVirtualNetworkApplianceResponseProvideDefaults sets the appropriate defaults for NetworkInterfaceIPConfigurationVirtualNetworkApplianceResponse */ function networkInterfaceIPConfigurationVirtualNetworkApplianceResponseProvideDefaults(val: NetworkInterfaceIPConfigurationVirtualNetworkApplianceResponse): NetworkInterfaceIPConfigurationVirtualNetworkApplianceResponse; /** * A network interface in a resource group. */ interface NetworkInterfaceInterfaceEndpointResponse { /** * The DNS settings in network interface. */ dnsSettings?: outputs.network.NetworkInterfaceDnsSettingsInterfaceEndpointResponse; /** * If the network interface is accelerated networking enabled. */ enableAcceleratedNetworking?: boolean; /** * Indicates whether IP forwarding is enabled on this network interface. */ enableIPForwarding?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * A list of references to linked BareMetal resources */ hostedWorkloads: string[]; /** * Resource ID. */ id?: string; /** * A reference to the interface endpoint to which the network interface is linked. */ interfaceEndpoint: outputs.network.InterfaceEndpointResponse; /** * A list of IPConfigurations of the network interface. */ ipConfigurations?: outputs.network.NetworkInterfaceIPConfigurationResponseV1[]; /** * Resource location. */ location?: string; /** * The MAC address of the network interface. */ macAddress?: string; /** * Resource name. */ name: string; /** * The reference of the NetworkSecurityGroup resource. */ networkSecurityGroup?: outputs.network.NetworkSecurityGroupInterfaceEndpointResponse; /** * Gets whether this is a primary network interface on a virtual machine. */ primary?: boolean; /** * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState?: string; /** * The resource GUID property of the network interface resource. */ resourceGuid?: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * A list of TapConfigurations of the network interface. */ tapConfigurations?: outputs.network.NetworkInterfaceTapConfigurationResponseV1[]; /** * Resource type. */ type: string; /** * The reference of a virtual machine. */ virtualMachine: outputs.network.SubResourceResponse; } /** * A network interface in a resource group. */ interface NetworkInterfaceResponse { /** * Auxiliary mode of Network Interface resource. */ auxiliaryMode?: string; /** * Auxiliary sku of Network Interface resource. */ auxiliarySku?: string; /** * Whether default outbound connectivity for nic was configured or not. */ defaultOutboundConnectivityEnabled: boolean; /** * Indicates whether to disable tcp state tracking. */ disableTcpStateTracking?: boolean; /** * The DNS settings in network interface. */ dnsSettings?: outputs.network.NetworkInterfaceDnsSettingsResponse; /** * A reference to the dscp configuration to which the network interface is linked. */ dscpConfiguration: outputs.network.SubResourceResponse; /** * If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. */ enableAcceleratedNetworking?: boolean; /** * Indicates whether IP forwarding is enabled on this network interface. */ enableIPForwarding?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The extended location of the network interface. */ extendedLocation?: outputs.network.ExtendedLocationResponse; /** * A list of references to linked BareMetal resources. */ hostedWorkloads: string[]; /** * Resource ID. */ id?: string; /** * A list of IPConfigurations of the network interface. */ ipConfigurations?: outputs.network.NetworkInterfaceIPConfigurationResponse[]; /** * Resource location. */ location?: string; /** * The MAC address of the network interface. */ macAddress: string; /** * Migration phase of Network Interface resource. */ migrationPhase?: string; /** * Resource name. */ name: string; /** * The reference to the NetworkSecurityGroup resource. */ networkSecurityGroup?: outputs.network.NetworkSecurityGroupResponse; /** * Type of Network Interface resource. */ nicType?: string; /** * Whether this is a primary network interface on a virtual machine. */ primary: boolean; /** * A reference to the private endpoint to which the network interface is linked. */ privateEndpoint: outputs.network.PrivateEndpointResponse; /** * Privatelinkservice of the network interface resource. */ privateLinkService?: outputs.network.PrivateLinkServiceResponse; /** * The provisioning state of the network interface resource. */ provisioningState: string; /** * The resource GUID property of the network interface resource. */ resourceGuid: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * A list of TapConfigurations of the network interface. */ tapConfigurations: outputs.network.NetworkInterfaceTapConfigurationResponse[]; /** * Resource type. */ type: string; /** * The reference to a virtual machine. */ virtualMachine: outputs.network.SubResourceResponse; /** * Whether the virtual machine this nic is attached to supports encryption. */ vnetEncryptionSupported: boolean; /** * WorkloadType of the NetworkInterface for BareMetal resources */ workloadType?: string; } /** * networkInterfaceResponseProvideDefaults sets the appropriate defaults for NetworkInterfaceResponse */ function networkInterfaceResponseProvideDefaults(val: NetworkInterfaceResponse): NetworkInterfaceResponse; /** * A network interface in a resource group. */ interface NetworkInterfaceServiceGatewayResponse { /** * Auxiliary mode of Network Interface resource. */ auxiliaryMode?: string; /** * Auxiliary sku of Network Interface resource. */ auxiliarySku?: string; /** * Whether default outbound connectivity for nic was configured or not. */ defaultOutboundConnectivityEnabled: boolean; /** * Indicates whether to disable tcp state tracking. */ disableTcpStateTracking?: boolean; /** * The DNS settings in network interface. */ dnsSettings?: outputs.network.NetworkInterfaceDnsSettingsResponse; /** * A reference to the dscp configuration to which the network interface is linked. */ dscpConfiguration: outputs.network.SubResourceResponse; /** * If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. */ enableAcceleratedNetworking?: boolean; /** * Indicates whether IP forwarding is enabled on this network interface. */ enableIPForwarding?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The extended location of the network interface. */ extendedLocation?: outputs.network.ExtendedLocationResponse; /** * A list of references to linked BareMetal resources. */ hostedWorkloads: string[]; /** * Resource ID. */ id?: string; /** * A list of IPConfigurations of the network interface. */ ipConfigurations?: outputs.network.NetworkInterfaceIPConfigurationResponseV2[]; /** * Resource location. */ location?: string; /** * The MAC address of the network interface. */ macAddress: string; /** * Migration phase of Network Interface resource. */ migrationPhase?: string; /** * Resource name. */ name: string; /** * The reference to the NetworkSecurityGroup resource. */ networkSecurityGroup?: outputs.network.NetworkSecurityGroupResponse; /** * Type of Network Interface resource. */ nicType?: string; /** * Whether this is a primary network interface on a virtual machine. */ primary: boolean; /** * A reference to the private endpoint to which the network interface is linked. */ privateEndpoint: outputs.network.PrivateEndpointServiceGatewayResponse; /** * Privatelinkservice of the network interface resource. */ privateLinkService?: outputs.network.PrivateLinkServiceServiceGatewayResponse; /** * The provisioning state of the network interface resource. */ provisioningState: string; /** * The resource GUID property of the network interface resource. */ resourceGuid: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * A list of TapConfigurations of the network interface. */ tapConfigurations: outputs.network.NetworkInterfaceTapConfigurationServiceGatewayResponse[]; /** * Resource type. */ type: string; /** * The reference to a virtual machine. */ virtualMachine: outputs.network.SubResourceResponse; /** * Whether the virtual machine this nic is attached to supports encryption. */ vnetEncryptionSupported: boolean; /** * WorkloadType of the NetworkInterface for BareMetal resources */ workloadType?: string; } /** * networkInterfaceServiceGatewayResponseProvideDefaults sets the appropriate defaults for NetworkInterfaceServiceGatewayResponse */ function networkInterfaceServiceGatewayResponseProvideDefaults(val: NetworkInterfaceServiceGatewayResponse): NetworkInterfaceServiceGatewayResponse; /** * Tap configuration in a Network Interface */ interface NetworkInterfaceTapConfigurationInterfaceEndpointResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState: string; /** * Sub Resource type. */ type: string; /** * The reference of the Virtual Network Tap resource. */ virtualNetworkTap?: outputs.network.VirtualNetworkTapResponse; } /** * networkInterfaceTapConfigurationInterfaceEndpointResponseProvideDefaults sets the appropriate defaults for NetworkInterfaceTapConfigurationInterfaceEndpointResponse */ function networkInterfaceTapConfigurationInterfaceEndpointResponseProvideDefaults(val: NetworkInterfaceTapConfigurationInterfaceEndpointResponse): NetworkInterfaceTapConfigurationInterfaceEndpointResponse; /** * Tap configuration in a Network Interface. */ interface NetworkInterfaceTapConfigurationResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the network interface tap configuration resource. */ provisioningState: string; /** * Sub Resource type. */ type: string; /** * The reference to the Virtual Network Tap resource. */ virtualNetworkTap?: outputs.network.VirtualNetworkTapResponse; } /** * networkInterfaceTapConfigurationResponseProvideDefaults sets the appropriate defaults for NetworkInterfaceTapConfigurationResponse */ function networkInterfaceTapConfigurationResponseProvideDefaults(val: NetworkInterfaceTapConfigurationResponse): NetworkInterfaceTapConfigurationResponse; /** * Tap configuration in a Network Interface */ interface NetworkInterfaceTapConfigurationResponseV1 { /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the network interface tap configuration. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState: string; /** * Sub Resource type. */ type: string; /** * The reference of the Virtual Network Tap resource. */ virtualNetworkTap?: outputs.network.VirtualNetworkTapInterfaceEndpointResponse; } /** * networkInterfaceTapConfigurationResponseV1ProvideDefaults sets the appropriate defaults for NetworkInterfaceTapConfigurationResponseV1 */ function networkInterfaceTapConfigurationResponseV1ProvideDefaults(val: NetworkInterfaceTapConfigurationResponseV1): NetworkInterfaceTapConfigurationResponseV1; /** * Tap configuration in a Network Interface. */ interface NetworkInterfaceTapConfigurationServiceGatewayResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the resource. */ name?: string; /** * The provisioning state of the network interface tap configuration resource. */ provisioningState: string; /** * Resource type. */ type: string; /** * The reference to the Virtual Network Tap resource. */ virtualNetworkTap?: outputs.network.VirtualNetworkTapServiceGatewayResponse; } /** * networkInterfaceTapConfigurationServiceGatewayResponseProvideDefaults sets the appropriate defaults for NetworkInterfaceTapConfigurationServiceGatewayResponse */ function networkInterfaceTapConfigurationServiceGatewayResponseProvideDefaults(val: NetworkInterfaceTapConfigurationServiceGatewayResponse): NetworkInterfaceTapConfigurationServiceGatewayResponse; /** * Tap configuration in a Network Interface. */ interface NetworkInterfaceTapConfigurationVirtualNetworkApplianceResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the resource. */ name?: string; /** * The provisioning state of the network interface tap configuration resource. */ provisioningState: string; /** * Resource type. */ type: string; /** * The reference to the Virtual Network Tap resource. */ virtualNetworkTap?: outputs.network.VirtualNetworkTapVirtualNetworkApplianceResponse; } /** * networkInterfaceTapConfigurationVirtualNetworkApplianceResponseProvideDefaults sets the appropriate defaults for NetworkInterfaceTapConfigurationVirtualNetworkApplianceResponse */ function networkInterfaceTapConfigurationVirtualNetworkApplianceResponseProvideDefaults(val: NetworkInterfaceTapConfigurationVirtualNetworkApplianceResponse): NetworkInterfaceTapConfigurationVirtualNetworkApplianceResponse; /** * A network interface in a resource group. */ interface NetworkInterfaceVirtualNetworkApplianceResponse { /** * Auxiliary mode of Network Interface resource. */ auxiliaryMode?: string; /** * Auxiliary sku of Network Interface resource. */ auxiliarySku?: string; /** * Whether default outbound connectivity for nic was configured or not. */ defaultOutboundConnectivityEnabled: boolean; /** * Indicates whether to disable tcp state tracking. */ disableTcpStateTracking?: boolean; /** * The DNS settings in network interface. */ dnsSettings?: outputs.network.NetworkInterfaceDnsSettingsResponse; /** * A reference to the dscp configuration to which the network interface is linked. */ dscpConfiguration: outputs.network.SubResourceResponse; /** * If the network interface is configured for accelerated networking. Not applicable to VM sizes which require accelerated networking. */ enableAcceleratedNetworking?: boolean; /** * Indicates whether IP forwarding is enabled on this network interface. */ enableIPForwarding?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The extended location of the network interface. */ extendedLocation?: outputs.network.ExtendedLocationResponse; /** * A list of references to linked BareMetal resources. */ hostedWorkloads: string[]; /** * Resource ID. */ id?: string; /** * A list of IPConfigurations of the network interface. */ ipConfigurations?: outputs.network.NetworkInterfaceIPConfigurationResponseV3[]; /** * Resource location. */ location?: string; /** * The MAC address of the network interface. */ macAddress: string; /** * Migration phase of Network Interface resource. */ migrationPhase?: string; /** * Resource name. */ name: string; /** * The reference to the NetworkSecurityGroup resource. */ networkSecurityGroup?: outputs.network.NetworkSecurityGroupResponse; /** * Type of Network Interface resource. */ nicType?: string; /** * Whether this is a primary network interface on a virtual machine. */ primary: boolean; /** * A reference to the private endpoint to which the network interface is linked. */ privateEndpoint: outputs.network.PrivateEndpointVirtualNetworkApplianceResponse; /** * Privatelinkservice of the network interface resource. */ privateLinkService?: outputs.network.PrivateLinkServiceVirtualNetworkApplianceResponse; /** * The provisioning state of the network interface resource. */ provisioningState: string; /** * The resource GUID property of the network interface resource. */ resourceGuid: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * A list of TapConfigurations of the network interface. */ tapConfigurations: outputs.network.NetworkInterfaceTapConfigurationVirtualNetworkApplianceResponse[]; /** * Resource type. */ type: string; /** * The reference to a virtual machine. */ virtualMachine: outputs.network.SubResourceResponse; /** * Whether the virtual machine this nic is attached to supports encryption. */ vnetEncryptionSupported: boolean; /** * WorkloadType of the NetworkInterface for BareMetal resources */ workloadType?: string; } /** * networkInterfaceVirtualNetworkApplianceResponseProvideDefaults sets the appropriate defaults for NetworkInterfaceVirtualNetworkApplianceResponse */ function networkInterfaceVirtualNetworkApplianceResponseProvideDefaults(val: NetworkInterfaceVirtualNetworkApplianceResponse): NetworkInterfaceVirtualNetworkApplianceResponse; /** * Network Manager Deployment Status. */ interface NetworkManagerDeploymentStatusResponse { /** * Commit Time. */ commitTime?: string; /** * List of configuration ids. */ configurationIds?: string[]; /** * Deployment Status. */ deploymentStatus?: string; /** * Configuration Deployment Type. */ deploymentType?: string; /** * Error Message. */ errorMessage?: string; /** * Region Name. */ region?: string; } /** * Scope of Network Manager. */ interface NetworkManagerPropertiesResponseNetworkManagerScopes { /** * List of cross tenant scopes. */ crossTenantScopes: outputs.network.CrossTenantScopesResponse[]; /** * List of management groups. */ managementGroups?: string[]; /** * List of subscriptions. */ subscriptions?: string[]; } /** * Network manager routing group item. */ interface NetworkManagerRoutingGroupItemResponse { /** * Network manager group Id. */ networkGroupId: string; } /** * Network manager security group item. */ interface NetworkManagerSecurityGroupItemResponse { /** * Network manager group Id. */ networkGroupId: string; } /** * Network manager security group item. */ interface NetworkManagerSecurityGroupItemlistActiveSecurityAdminRuleResponse { /** * Network manager group Id. */ networkGroupId?: string; } /** * Network manager security group item. */ interface NetworkManagerSecurityGroupItemlistActiveSecurityUserRuleResponse { /** * Network manager group Id. */ networkGroupId?: string; } /** * Network manager security group item. */ interface NetworkManagerSecurityGroupItemlistNetworkManagerEffectiveSecurityAdminRuleResponse { /** * Network manager group Id. */ networkGroupId?: string; } /** * Rule condition of type network. */ interface NetworkRuleConditionResponse { /** * Description of the rule condition. */ description?: string; /** * List of destination IP addresses or Service Tags. */ destinationAddresses?: string[]; /** * List of destination IpGroups for this rule. */ destinationIpGroups?: string[]; /** * List of destination ports. */ destinationPorts?: string[]; /** * Array of FirewallPolicyRuleConditionNetworkProtocols. */ ipProtocols?: string[]; /** * Name of the rule condition. */ name?: string; /** * Rule Condition Type. * Expected value is 'NetworkRuleCondition'. */ ruleConditionType: "NetworkRuleCondition"; /** * List of source IP addresses for this rule. */ sourceAddresses?: string[]; /** * List of source IpGroups for this rule. */ sourceIpGroups?: string[]; } /** * Rule of type network. */ interface NetworkRuleResponse { /** * Description of the rule. */ description?: string; /** * List of destination IP addresses or Service Tags. */ destinationAddresses?: string[]; /** * List of destination FQDNs. */ destinationFqdns?: string[]; /** * List of destination IpGroups for this rule. */ destinationIpGroups?: string[]; /** * List of destination ports. */ destinationPorts?: string[]; /** * Array of FirewallPolicyRuleNetworkProtocols. */ ipProtocols?: string[]; /** * Name of the rule. */ name?: string; /** * Rule Type. * Expected value is 'NetworkRule'. */ ruleType: "NetworkRule"; /** * List of source IP addresses for this rule. */ sourceAddresses?: string[]; /** * List of source IpGroups for this rule. */ sourceIpGroups?: string[]; } /** * NetworkSecurityGroup resource. */ interface NetworkSecurityGroupInterfaceEndpointResponse { /** * The default security rules of network security group. */ defaultSecurityRules?: outputs.network.SecurityRuleInterfaceEndpointResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * A collection of references to network interfaces. */ networkInterfaces: outputs.network.NetworkInterfaceResponse[]; /** * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState?: string; /** * The resource GUID property of the network security group resource. */ resourceGuid?: string; /** * A collection of security rules of the network security group. */ securityRules?: outputs.network.SecurityRuleInterfaceEndpointResponse[]; /** * A collection of references to subnets. */ subnets: outputs.network.SubnetResponse[]; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * NetworkSecurityGroup resource. */ interface NetworkSecurityGroupResponse { /** * The default security rules of network security group. */ defaultSecurityRules: outputs.network.SecurityRuleResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * A collection of references to flow log resources. */ flowLogs: outputs.network.FlowLogResponse[]; /** * When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation. */ flushConnection?: boolean; /** * Resource ID. */ id?: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * A collection of references to network interfaces. */ networkInterfaces: outputs.network.NetworkInterfaceResponse[]; /** * The provisioning state of the network security group resource. */ provisioningState: string; /** * The resource GUID property of the network security group resource. */ resourceGuid: string; /** * A collection of security rules of the network security group. */ securityRules?: outputs.network.SecurityRuleResponse[]; /** * A collection of references to subnets. */ subnets: outputs.network.SubnetResponse[]; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * NetworkSecurityGroup resource. */ interface NetworkSecurityGroupServiceGatewayResponse { /** * The default security rules of network security group. */ defaultSecurityRules: outputs.network.SecurityRuleServiceGatewayResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * A collection of references to flow log resources. */ flowLogs: outputs.network.FlowLogServiceGatewayResponse[]; /** * When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation. */ flushConnection?: boolean; /** * Resource ID. */ id?: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * A collection of references to network interfaces. */ networkInterfaces: outputs.network.NetworkInterfaceServiceGatewayResponse[]; /** * The provisioning state of the network security group resource. */ provisioningState: string; /** * The resource GUID property of the network security group resource. */ resourceGuid: string; /** * A collection of security rules of the network security group. */ securityRules?: outputs.network.SecurityRuleServiceGatewayResponse[]; /** * A collection of references to subnets. */ subnets: outputs.network.SubnetResponse[]; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * NetworkSecurityGroup resource. */ interface NetworkSecurityGroupVirtualNetworkApplianceResponse { /** * The default security rules of network security group. */ defaultSecurityRules: outputs.network.SecurityRuleVirtualNetworkApplianceResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * A collection of references to flow log resources. */ flowLogs: outputs.network.FlowLogVirtualNetworkApplianceResponse[]; /** * When enabled, flows created from Network Security Group connections will be re-evaluated when rules are updates. Initial enablement will trigger re-evaluation. */ flushConnection?: boolean; /** * Resource ID. */ id?: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * A collection of references to network interfaces. */ networkInterfaces: outputs.network.NetworkInterfaceVirtualNetworkApplianceResponse[]; /** * The provisioning state of the network security group resource. */ provisioningState: string; /** * The resource GUID property of the network security group resource. */ resourceGuid: string; /** * A collection of security rules of the network security group. */ securityRules?: outputs.network.SecurityRuleVirtualNetworkApplianceResponse[]; /** * A collection of references to subnets. */ subnets: outputs.network.SubnetResponse[]; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * Properties of the NetworkVirtualApplianceConnection subresource. */ interface NetworkVirtualApplianceConnectionPropertiesResponse { /** * Network Virtual Appliance ASN. */ asn?: number; /** * List of bgpPeerAddresses for the NVA instances */ bgpPeerAddress?: string[]; /** * Enable internet security. */ enableInternetSecurity?: boolean; /** * The name of the resource. */ name?: string; /** * The provisioning state of the NetworkVirtualApplianceConnection resource. */ provisioningState: string; /** * The Routing Configuration indicating the associated and propagated route tables on this connection. */ routingConfiguration?: outputs.network.RoutingConfigurationNetworkVirtualApplianceConnectionResponse; /** * Unique identifier for the connection. */ tunnelIdentifier?: number; } /** * Network Profile containing configurations for Public and Private NIC. */ interface NetworkVirtualAppliancePropertiesFormatResponseNetworkProfile { networkInterfaceConfigurations?: outputs.network.VirtualApplianceNetworkInterfaceConfigurationResponse[]; } /** * The NSP logging configuration properties. */ interface NspLoggingConfigurationPropertiesResponse { /** * The log categories to enable in the NSP logging configuration. */ enabledLogCategories?: string[]; /** * The version of the NSP logging configuration. */ version?: string; } /** * Office365 breakout categories. */ interface O365BreakOutCategoryPoliciesResponse { /** * Flag to control allow category. */ allow?: boolean; /** * Flag to control default category. */ default?: boolean; /** * Flag to control optimize category. */ optimize?: boolean; } /** * The Office365 breakout policy. */ interface O365PolicyPropertiesResponse { /** * Office365 breakout categories. */ breakOutCategories?: outputs.network.O365BreakOutCategoryPoliciesResponse; } /** * Network Virtual Appliance Sku Properties. */ interface Office365PolicyPropertiesResponse { /** * Office 365 breakout categories. */ breakOutCategories?: outputs.network.BreakOutCategoryPoliciesResponse; } /** * Outbound rule of the load balancer. */ interface OutboundRuleResponse { /** * The number of outbound ports to be used for NAT. */ allocatedOutboundPorts?: number; /** * A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs. */ backendAddressPool: outputs.network.SubResourceResponse; /** * Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP. */ enableTcpReset?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The Frontend IP addresses of the load balancer. */ frontendIPConfigurations: outputs.network.SubResourceResponse[]; /** * Resource ID. */ id?: string; /** * The timeout for the TCP idle connection. */ idleTimeoutInMinutes?: number; /** * The name of the resource that is unique within the set of outbound rules used by the load balancer. This name can be used to access the resource. */ name?: string; /** * The protocol for the outbound rule in load balancer. */ protocol: string; /** * The provisioning state of the outbound rule resource. */ provisioningState: string; /** * Type of the resource. */ type: string; } /** * Allow to exclude some variable satisfy the condition for the WAF check. */ interface OwaspCrsExclusionEntryResponse { /** * The managed rule sets that are associated with the exclusion. */ exclusionManagedRuleSets?: outputs.network.ExclusionManagedRuleSetResponse[]; /** * The variable to be excluded. */ matchVariable: string; /** * When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to. */ selector: string; /** * When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to. */ selectorMatchOperator: string; } /** * P2SConnectionConfiguration Resource. */ interface P2SConnectionConfigurationResponse { /** * List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to. */ configurationPolicyGroupAssociations: outputs.network.SubResourceResponse[]; /** * Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. */ enableInternetSecurity?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to. */ previousConfigurationPolicyGroupAssociations: outputs.network.VpnServerConfigurationPolicyGroupResponse[]; /** * The provisioning state of the P2SConnectionConfiguration resource. */ provisioningState: string; /** * The Routing Configuration indicating the associated and propagated route tables on this connection. */ routingConfiguration?: outputs.network.RoutingConfigurationP2sVpnGatewayResponse; /** * The reference to the address space resource which represents Address space for P2S VpnClient. */ vpnClientAddressPool?: outputs.network.AddressSpaceResponse; } /** * P2SConnectionConfiguration Resource. */ interface P2SConnectionConfigurationVpnServerConfigurationResponse { /** * List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to. */ configurationPolicyGroupAssociations: outputs.network.SubResourceResponse[]; /** * Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. */ enableInternetSecurity?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to. */ previousConfigurationPolicyGroupAssociations: outputs.network.VpnServerConfigurationPolicyGroupResponse[]; /** * The provisioning state of the P2SConnectionConfiguration resource. */ provisioningState: string; /** * The Routing Configuration indicating the associated and propagated route tables on this connection. */ routingConfiguration?: outputs.network.RoutingConfigurationVpnServerConfigurationResponse; /** * The reference to the address space resource which represents Address space for P2S VpnClient. */ vpnClientAddressPool?: outputs.network.AddressSpaceResponse; } /** * P2SConnectionConfiguration Resource. */ interface P2SConnectionConfigurationgetP2sVpnGatewayP2sVpnConnectionHealthResponse { /** * List of Configuration Policy Groups that this P2SConnectionConfiguration is attached to. */ configurationPolicyGroupAssociations: outputs.network.SubResourceResponse[]; /** * Flag indicating whether the enable internet security flag is turned on for the P2S Connections or not. */ enableInternetSecurity?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * List of previous Configuration Policy Groups that this P2SConnectionConfiguration was attached to. */ previousConfigurationPolicyGroupAssociations: outputs.network.VpnServerConfigurationPolicyGroupResponse[]; /** * The provisioning state of the P2SConnectionConfiguration resource. */ provisioningState: string; /** * The Routing Configuration indicating the associated and propagated route tables on this connection. */ routingConfiguration?: outputs.network.RoutingConfigurationgetP2sVpnGatewayP2sVpnConnectionHealthResponse; /** * The reference to the address space resource which represents Address space for P2S VpnClient. */ vpnClientAddressPool?: outputs.network.AddressSpaceResponse; } /** * P2SVpnGateway Resource. */ interface P2SVpnGatewayResponse { /** * List of all customer specified DNS servers IP addresses. */ customDnsServers?: string[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Enable Routing Preference property for the Public IP Interface of the P2SVpnGateway. */ isRoutingPreferenceInternet?: boolean; /** * Resource location. */ location: string; /** * Resource name. */ name: string; /** * List of all p2s connection configurations of the gateway. */ p2SConnectionConfigurations?: outputs.network.P2SConnectionConfigurationVpnServerConfigurationResponse[]; /** * The provisioning state of the P2S VPN gateway resource. */ provisioningState: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; /** * The VirtualHub to which the gateway belongs. */ virtualHub?: outputs.network.SubResourceResponse; /** * All P2S VPN clients' connection health status. */ vpnClientConnectionHealth: outputs.network.VpnClientConnectionHealthResponse; /** * The scale unit for this p2s vpn gateway. */ vpnGatewayScaleUnit?: number; /** * The VpnServerConfiguration to which the p2sVpnGateway is attached to. */ vpnServerConfiguration?: outputs.network.SubResourceResponse; } /** * Radius client root certificate of P2SVpnServerConfiguration. */ interface P2SVpnServerConfigRadiusClientRootCertificateResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the radius client root certificate resource. */ provisioningState: string; /** * The Radius client root certificate thumbprint. */ thumbprint?: string; } /** * Radius Server root certificate of P2SVpnServerConfiguration. */ interface P2SVpnServerConfigRadiusServerRootCertificateResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the radius server root certificate resource. */ provisioningState: string; /** * The certificate public data. */ publicCertData: string; } /** * VPN client revoked certificate of P2SVpnServerConfiguration. */ interface P2SVpnServerConfigVpnClientRevokedCertificateResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the VPN client revoked certificate resource. */ provisioningState: string; /** * The revoked VPN client certificate thumbprint. */ thumbprint?: string; } /** * VPN client root certificate of P2SVpnServerConfiguration. */ interface P2SVpnServerConfigVpnClientRootCertificateResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the VPN client root certificate resource. */ provisioningState: string; /** * The certificate public data. */ publicCertData: string; } /** * Parameters for P2SVpnServerConfiguration. */ interface P2SVpnServerConfigurationPropertiesResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * The name of the P2SVpnServerConfiguration that is unique within a VirtualWan in a resource group. This name can be used to access the resource along with Paren VirtualWan resource name. */ name?: string; /** * List of references to P2SVpnGateways. */ p2SVpnGateways: outputs.network.SubResourceResponse[]; /** * Radius client root certificate of P2SVpnServerConfiguration. */ p2SVpnServerConfigRadiusClientRootCertificates?: outputs.network.P2SVpnServerConfigRadiusClientRootCertificateResponse[]; /** * Radius Server root certificate of P2SVpnServerConfiguration. */ p2SVpnServerConfigRadiusServerRootCertificates?: outputs.network.P2SVpnServerConfigRadiusServerRootCertificateResponse[]; /** * VPN client revoked certificate of P2SVpnServerConfiguration. */ p2SVpnServerConfigVpnClientRevokedCertificates?: outputs.network.P2SVpnServerConfigVpnClientRevokedCertificateResponse[]; /** * VPN client root certificate of P2SVpnServerConfiguration. */ p2SVpnServerConfigVpnClientRootCertificates?: outputs.network.P2SVpnServerConfigVpnClientRootCertificateResponse[]; /** * The provisioning state of the P2S VPN server configuration resource. */ provisioningState: string; /** * The radius server address property of the P2SVpnServerConfiguration resource for point to site client connection. */ radiusServerAddress?: string; /** * The radius secret property of the P2SVpnServerConfiguration resource for point to site client connection. */ radiusServerSecret?: string; /** * VpnClientIpsecPolicies for P2SVpnServerConfiguration. */ vpnClientIpsecPolicies?: outputs.network.IpsecPolicyResponse[]; /** * VPN protocols for the P2SVpnServerConfiguration. */ vpnProtocols?: string[]; } /** * Filter that is applied to packet capture request. Multiple filters can be applied. */ interface PacketCaptureFilterResponse { /** * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. */ localIPAddress?: string; /** * Local port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. */ localPort?: string; /** * Protocol to be filtered on. */ protocol?: string; /** * Local IP Address to be filtered on. Notation: "127.0.0.1" for single address entry. "127.0.0.1-127.0.0.255" for range. "127.0.0.1;127.0.0.5;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. */ remoteIPAddress?: string; /** * Remote port to be filtered on. Notation: "80" for single port entry."80-85" for range. "80;443;" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null. */ remotePort?: string; } /** * packetCaptureFilterResponseProvideDefaults sets the appropriate defaults for PacketCaptureFilterResponse */ function packetCaptureFilterResponseProvideDefaults(val: PacketCaptureFilterResponse): PacketCaptureFilterResponse; /** * A list of AzureVMSS instances which can be included or excluded to run packet capture. If both included and excluded are empty, then the packet capture will run on all instances of AzureVMSS. */ interface PacketCaptureMachineScopeResponse { /** * List of AzureVMSS instances which has to be excluded from the AzureVMSS from running packet capture. */ exclude?: string[]; /** * List of AzureVMSS instances to run packet capture on. */ include?: string[]; } /** * The storage location for a packet capture session. */ interface PacketCaptureSettingsResponse { /** * Number of file count. Default value of count is 10 and maximum number is 10000. */ fileCount?: number; /** * Number of bytes captured per packet. Default value in bytes 104857600 (100MB) and maximum in bytes 4294967295 (4GB). */ fileSizeInBytes?: number; /** * Maximum duration of the capture session in seconds is 604800s (7 days) for a file. Default value in second 86400s (1 day). */ sessionTimeLimitInSeconds?: number; } /** * packetCaptureSettingsResponseProvideDefaults sets the appropriate defaults for PacketCaptureSettingsResponse */ function packetCaptureSettingsResponseProvideDefaults(val: PacketCaptureSettingsResponse): PacketCaptureSettingsResponse; /** * The storage location for a packet capture session. */ interface PacketCaptureStorageLocationResponse { /** * This path is invalid if 'Continuous Capture' is provided with 'true' or 'false'. A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional. */ filePath?: string; /** * This path is valid if 'Continuous Capture' is provided with 'true' or 'false' and required if no storage ID is provided, otherwise optional. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. */ localPath?: string; /** * The ID of the storage account to save the packet capture session. Required if no localPath or filePath is provided. */ storageId?: string; /** * The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture. */ storagePath?: string; } /** * Parameters for an Action. */ interface ParameterResponse { /** * List of AS paths. */ asPath?: string[]; /** * List of BGP communities. */ community?: string[]; /** * List of route prefixes. */ routePrefix?: string[]; } /** * Properties of the partner managed resource. */ interface PartnerManagedResourcePropertiesResponse { /** * The partner managed resource id. */ id: string; /** * The partner managed ILB resource id */ internalLoadBalancerId: string; /** * The partner managed SLB resource id */ standardLoadBalancerId: string; } /** * Peer Express Route Circuit Connection in an ExpressRouteCircuitPeering resource. */ interface PeerExpressRouteCircuitConnectionResponse { /** * /29 IP address space to carve out Customer addresses for tunnels. */ addressPrefix?: string; /** * The resource guid of the authorization used for the express route circuit connection. */ authResourceGuid?: string; /** * Express Route Circuit connection state. */ circuitConnectionStatus: string; /** * The name of the express route circuit connection resource. */ connectionName?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Reference to Express Route Circuit Private Peering Resource of the circuit. */ expressRouteCircuitPeering?: outputs.network.SubResourceResponse; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * Reference to Express Route Circuit Private Peering Resource of the peered circuit. */ peerExpressRouteCircuitPeering?: outputs.network.SubResourceResponse; /** * The provisioning state of the peer express route circuit connection resource. */ provisioningState: string; /** * Type of the resource. */ type: string; } interface PerimeterBasedAccessRuleResponse { /** * NSP id in the ARM id format. */ id: string; /** * Location of the NSP supplied. */ location: string; /** * Resource guid of the NSP supplied. */ perimeterGuid: string; } /** * Defines contents of a web application firewall global configuration. */ interface PolicySettingsResponse { /** * If the action type is block, customer can override the response body. The body must be specified in base64 encoding. */ customBlockResponseBody?: string; /** * If the action type is block, customer can override the response status code. */ customBlockResponseStatusCode?: number; /** * Whether allow WAF to enforce file upload limits. */ fileUploadEnforcement?: boolean; /** * Maximum file upload size in Mb for WAF. */ fileUploadLimitInMb?: number; /** * Web Application Firewall JavaScript Challenge Cookie Expiration time in minutes. */ jsChallengeCookieExpirationInMins?: number; /** * To scrub sensitive log fields */ logScrubbing?: outputs.network.PolicySettingsResponseLogScrubbing; /** * Maximum request body size in Kb for WAF. */ maxRequestBodySizeInKb?: number; /** * The mode of the policy. */ mode?: string; /** * Whether to allow WAF to check request Body. */ requestBodyCheck?: boolean; /** * Whether allow WAF to enforce request body limits. */ requestBodyEnforcement?: boolean; /** * Max inspection limit in KB for request body inspection for WAF. */ requestBodyInspectLimitInKB?: number; /** * The state of the policy. */ state?: string; } /** * policySettingsResponseProvideDefaults sets the appropriate defaults for PolicySettingsResponse */ function policySettingsResponseProvideDefaults(val: PolicySettingsResponse): PolicySettingsResponse; /** * To scrub sensitive log fields */ interface PolicySettingsResponseLogScrubbing { /** * The rules that are applied to the logs for scrubbing. */ scrubbingRules?: outputs.network.WebApplicationFirewallScrubbingRulesResponse[]; /** * State of the log scrubbing config. Default value is Enabled. */ state?: string; } /** * IpamPool association information. */ interface PoolAssociationResponse { /** * List of assigned IP address prefixes in the IpamPool of the associated resource. */ addressPrefixes: string[]; /** * Creation time of the association. */ createdAt: string; description?: string; /** * Total number of reserved IP addresses of the association. */ numberOfReservedIPAddresses: string; /** * IpamPool id for which the resource is associated to. */ poolId?: string; /** * Expire time for IP addresses reserved. */ reservationExpiresAt: string; /** * List of reserved IP address prefixes in the IpamPool of the associated resource. */ reservedPrefixes: string[]; /** * Resource id of the associated Azure resource. */ resourceId: string; /** * Total number of assigned IP addresses of the association. */ totalNumberOfIPAddresses: string; } /** * PrivateDnsZoneConfig resource. */ interface PrivateDnsZoneConfigResponse { /** * Name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The resource id of the private dns zone. */ privateDnsZoneId?: string; /** * A collection of information regarding a recordSet, holding information to identify private resources. */ recordSets: outputs.network.RecordSetResponse[]; } /** * PrivateEndpointConnection resource. */ interface PrivateEndpointConnectionResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The consumer link id. */ linkIdentifier: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The resource of private end point. */ privateEndpoint: outputs.network.PrivateEndpointResponse; /** * The location of the private endpoint. */ privateEndpointLocation: string; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState?: outputs.network.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * The resource type. */ type: string; } /** * privateEndpointConnectionResponseProvideDefaults sets the appropriate defaults for PrivateEndpointConnectionResponse */ function privateEndpointConnectionResponseProvideDefaults(val: PrivateEndpointConnectionResponse): PrivateEndpointConnectionResponse; /** * PrivateEndpointConnection resource. */ interface PrivateEndpointConnectionServiceGatewayResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The consumer link id. */ linkIdentifier: string; /** * Name of the resource. */ name?: string; /** * The resource of private end point. */ privateEndpoint: outputs.network.PrivateEndpointServiceGatewayResponse; /** * The location of the private endpoint. */ privateEndpointLocation: string; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState?: outputs.network.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Resource type. */ type: string; } /** * privateEndpointConnectionServiceGatewayResponseProvideDefaults sets the appropriate defaults for PrivateEndpointConnectionServiceGatewayResponse */ function privateEndpointConnectionServiceGatewayResponseProvideDefaults(val: PrivateEndpointConnectionServiceGatewayResponse): PrivateEndpointConnectionServiceGatewayResponse; /** * PrivateEndpointConnection resource. */ interface PrivateEndpointConnectionVirtualNetworkApplianceResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The consumer link id. */ linkIdentifier: string; /** * Name of the resource. */ name?: string; /** * The resource of private end point. */ privateEndpoint: outputs.network.PrivateEndpointVirtualNetworkApplianceResponse; /** * The location of the private endpoint. */ privateEndpointLocation: string; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState?: outputs.network.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Resource type. */ type: string; } /** * privateEndpointConnectionVirtualNetworkApplianceResponseProvideDefaults sets the appropriate defaults for PrivateEndpointConnectionVirtualNetworkApplianceResponse */ function privateEndpointConnectionVirtualNetworkApplianceResponseProvideDefaults(val: PrivateEndpointConnectionVirtualNetworkApplianceResponse): PrivateEndpointConnectionVirtualNetworkApplianceResponse; /** * An IP Configuration of the private endpoint. */ interface PrivateEndpointIPConfigurationResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The ID of a group obtained from the remote resource that this private endpoint should connect to. */ groupId?: string; /** * The member name of a group obtained from the remote resource that this private endpoint should connect to. */ memberName?: string; /** * The name of the resource that is unique within a resource group. */ name?: string; /** * A private ip address obtained from the private endpoint's subnet. */ privateIPAddress?: string; /** * The resource type. */ type: string; } /** * Private endpoint resource. */ interface PrivateEndpointResponse { /** * Application security groups in which the private endpoint IP configuration is included. */ applicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * An array of custom dns configurations. */ customDnsConfigs?: outputs.network.CustomDnsConfigPropertiesFormatResponse[]; /** * The custom name of the network interface attached to the private endpoint. */ customNetworkInterfaceName?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The extended location of the load balancer. */ extendedLocation?: outputs.network.ExtendedLocationResponse; /** * Resource ID. */ id?: string; /** * A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. */ ipConfigurations?: outputs.network.PrivateEndpointIPConfigurationResponse[]; /** * Resource location. */ location?: string; /** * A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. */ manualPrivateLinkServiceConnections?: outputs.network.PrivateLinkServiceConnectionResponse[]; /** * Resource name. */ name: string; /** * An array of references to the network interfaces created for this private endpoint. */ networkInterfaces: outputs.network.NetworkInterfaceResponse[]; /** * A grouping of information about the connection to the remote resource. */ privateLinkServiceConnections?: outputs.network.PrivateLinkServiceConnectionResponse[]; /** * The provisioning state of the private endpoint resource. */ provisioningState: string; /** * The ID of the subnet from which the private IP will be allocated. */ subnet?: outputs.network.SubnetResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * privateEndpointResponseProvideDefaults sets the appropriate defaults for PrivateEndpointResponse */ function privateEndpointResponseProvideDefaults(val: PrivateEndpointResponse): PrivateEndpointResponse; /** * Private endpoint resource. */ interface PrivateEndpointServiceGatewayResponse { /** * Application security groups in which the private endpoint IP configuration is included. */ applicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * An array of custom dns configurations. */ customDnsConfigs?: outputs.network.CustomDnsConfigPropertiesFormatResponse[]; /** * The custom name of the network interface attached to the private endpoint. */ customNetworkInterfaceName?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The extended location of the load balancer. */ extendedLocation?: outputs.network.ExtendedLocationResponse; /** * Resource ID. */ id?: string; /** * A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. */ ipConfigurations?: outputs.network.PrivateEndpointIPConfigurationResponse[]; /** * Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. */ ipVersionType?: string; /** * Resource location. */ location?: string; /** * A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. */ manualPrivateLinkServiceConnections?: outputs.network.PrivateLinkServiceConnectionResponse[]; /** * Resource name. */ name: string; /** * An array of references to the network interfaces created for this private endpoint. */ networkInterfaces: outputs.network.NetworkInterfaceResponse[]; /** * A grouping of information about the connection to the remote resource. */ privateLinkServiceConnections?: outputs.network.PrivateLinkServiceConnectionResponse[]; /** * The provisioning state of the private endpoint resource. */ provisioningState: string; /** * The ID of the subnet from which the private IP will be allocated. */ subnet?: outputs.network.SubnetResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * privateEndpointServiceGatewayResponseProvideDefaults sets the appropriate defaults for PrivateEndpointServiceGatewayResponse */ function privateEndpointServiceGatewayResponseProvideDefaults(val: PrivateEndpointServiceGatewayResponse): PrivateEndpointServiceGatewayResponse; /** * Private endpoint resource. */ interface PrivateEndpointVirtualNetworkApplianceResponse { /** * Application security groups in which the private endpoint IP configuration is included. */ applicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * An array of custom dns configurations. */ customDnsConfigs?: outputs.network.CustomDnsConfigPropertiesFormatResponse[]; /** * The custom name of the network interface attached to the private endpoint. */ customNetworkInterfaceName?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The extended location of the load balancer. */ extendedLocation?: outputs.network.ExtendedLocationResponse; /** * Resource ID. */ id?: string; /** * A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints. */ ipConfigurations?: outputs.network.PrivateEndpointIPConfigurationResponse[]; /** * Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. */ ipVersionType?: string; /** * Resource location. */ location?: string; /** * A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource. */ manualPrivateLinkServiceConnections?: outputs.network.PrivateLinkServiceConnectionResponse[]; /** * Resource name. */ name: string; /** * An array of references to the network interfaces created for this private endpoint. */ networkInterfaces: outputs.network.NetworkInterfaceResponse[]; /** * A grouping of information about the connection to the remote resource. */ privateLinkServiceConnections?: outputs.network.PrivateLinkServiceConnectionResponse[]; /** * The provisioning state of the private endpoint resource. */ provisioningState: string; /** * The ID of the subnet from which the private IP will be allocated. */ subnet?: outputs.network.SubnetResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * privateEndpointVirtualNetworkApplianceResponseProvideDefaults sets the appropriate defaults for PrivateEndpointVirtualNetworkApplianceResponse */ function privateEndpointVirtualNetworkApplianceResponseProvideDefaults(val: PrivateEndpointVirtualNetworkApplianceResponse): PrivateEndpointVirtualNetworkApplianceResponse; /** * PrivateLinkServiceConnection resource. */ interface PrivateLinkServiceConnectionResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. */ groupIds?: string[]; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * A collection of read-only information about the state of the connection to the remote resource. */ privateLinkServiceConnectionState?: outputs.network.PrivateLinkServiceConnectionStateResponse; /** * The resource id of private link service. */ privateLinkServiceId?: string; /** * The provisioning state of the private link service connection resource. */ provisioningState: string; /** * A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. */ requestMessage?: string; /** * The resource type. */ type: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * The private link service ip configuration. */ interface PrivateLinkServiceIpConfigurationResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of private link service ip configuration. */ name?: string; /** * Whether the ip configuration is primary or not. */ primary?: boolean; /** * The private IP address of the IP configuration. */ privateIPAddress?: string; /** * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. */ privateIPAddressVersion?: string; /** * The private IP address allocation method. */ privateIPAllocationMethod?: string; /** * The provisioning state of the private link service IP configuration resource. */ provisioningState: string; /** * The reference to the subnet resource. */ subnet?: outputs.network.SubnetResponse; /** * The resource type. */ type: string; } /** * privateLinkServiceIpConfigurationResponseProvideDefaults sets the appropriate defaults for PrivateLinkServiceIpConfigurationResponse */ function privateLinkServiceIpConfigurationResponseProvideDefaults(val: PrivateLinkServiceIpConfigurationResponse): PrivateLinkServiceIpConfigurationResponse; /** * The auto-approval list of the private link service. */ interface PrivateLinkServicePropertiesAutoApprovalResponse { /** * The list of subscriptions. */ subscriptions?: string[]; } /** * The auto-approval list of the private link service. */ interface PrivateLinkServicePropertiesResponseAutoApproval { /** * The list of subscriptions. */ subscriptions?: string[]; } /** * The visibility list of the private link service. */ interface PrivateLinkServicePropertiesResponseVisibility { /** * The list of subscriptions. */ subscriptions?: string[]; } /** * The visibility list of the private link service. */ interface PrivateLinkServicePropertiesVisibilityResponse { /** * The list of subscriptions. */ subscriptions?: string[]; } /** * Private link service resource. */ interface PrivateLinkServiceResponse { /** * The alias of the private link service. */ alias: string; /** * The auto-approval list of the private link service. */ autoApproval?: outputs.network.PrivateLinkServicePropertiesResponseAutoApproval; /** * The destination IP address of the private link service. */ destinationIPAddress?: string; /** * Whether the private link service is enabled for proxy protocol or not. */ enableProxyProtocol?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The extended location of the load balancer. */ extendedLocation?: outputs.network.ExtendedLocationResponse; /** * The list of Fqdn. */ fqdns?: string[]; /** * Resource ID. */ id?: string; /** * An array of private link service IP configurations. */ ipConfigurations?: outputs.network.PrivateLinkServiceIpConfigurationResponse[]; /** * An array of references to the load balancer IP configurations. */ loadBalancerFrontendIpConfigurations?: outputs.network.FrontendIPConfigurationResponse[]; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * An array of references to the network interfaces created for this private link service. */ networkInterfaces: outputs.network.NetworkInterfaceResponse[]; /** * An array of list about connections to the private endpoint. */ privateEndpointConnections: outputs.network.PrivateEndpointConnectionResponse[]; /** * The provisioning state of the private link service resource. */ provisioningState: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; /** * The visibility list of the private link service. */ visibility?: outputs.network.PrivateLinkServicePropertiesResponseVisibility; } /** * Private link service resource. */ interface PrivateLinkServiceServiceGatewayResponse { /** * The access mode of the private link service. */ accessMode?: string; /** * The alias of the private link service. */ alias: string; /** * The auto-approval list of the private link service. */ autoApproval?: outputs.network.PrivateLinkServicePropertiesAutoApprovalResponse; /** * The destination IP address of the private link service. */ destinationIPAddress?: string; /** * Whether the private link service is enabled for proxy protocol or not. */ enableProxyProtocol?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The extended location of the load balancer. */ extendedLocation?: outputs.network.ExtendedLocationResponse; /** * The list of Fqdn. */ fqdns?: string[]; /** * Resource ID. */ id?: string; /** * An array of private link service IP configurations. */ ipConfigurations?: outputs.network.PrivateLinkServiceIpConfigurationResponse[]; /** * An array of references to the load balancer IP configurations. */ loadBalancerFrontendIpConfigurations?: outputs.network.FrontendIPConfigurationServiceGatewayResponse[]; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * An array of references to the network interfaces created for this private link service. */ networkInterfaces: outputs.network.NetworkInterfaceResponse[]; /** * An array of list about connections to the private endpoint. */ privateEndpointConnections: outputs.network.PrivateEndpointConnectionServiceGatewayResponse[]; /** * The provisioning state of the private link service resource. */ provisioningState: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; /** * The visibility list of the private link service. */ visibility?: outputs.network.PrivateLinkServicePropertiesVisibilityResponse; } /** * Private link service resource. */ interface PrivateLinkServiceVirtualNetworkApplianceResponse { /** * The access mode of the private link service. */ accessMode?: string; /** * The alias of the private link service. */ alias: string; /** * The auto-approval list of the private link service. */ autoApproval?: outputs.network.PrivateLinkServicePropertiesAutoApprovalResponse; /** * The destination IP address of the private link service. */ destinationIPAddress?: string; /** * Whether the private link service is enabled for proxy protocol or not. */ enableProxyProtocol?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The extended location of the load balancer. */ extendedLocation?: outputs.network.ExtendedLocationResponse; /** * The list of Fqdn. */ fqdns?: string[]; /** * Resource ID. */ id?: string; /** * An array of private link service IP configurations. */ ipConfigurations?: outputs.network.PrivateLinkServiceIpConfigurationResponse[]; /** * An array of references to the load balancer IP configurations. */ loadBalancerFrontendIpConfigurations?: outputs.network.FrontendIPConfigurationVirtualNetworkApplianceResponse[]; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * An array of references to the network interfaces created for this private link service. */ networkInterfaces: outputs.network.NetworkInterfaceResponse[]; /** * An array of list about connections to the private endpoint. */ privateEndpointConnections: outputs.network.PrivateEndpointConnectionVirtualNetworkApplianceResponse[]; /** * The provisioning state of the private link service resource. */ provisioningState: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; /** * The visibility list of the private link service. */ visibility?: outputs.network.PrivateLinkServicePropertiesVisibilityResponse; } /** * A load balancer probe. */ interface ProbeResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5. */ intervalInSeconds?: number; /** * The load balancer rules that use this probe. */ loadBalancingRules: outputs.network.SubResourceResponse[]; /** * The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource. */ name?: string; /** * Determines how new connections are handled by the load balancer when all backend instances are probed down. */ noHealthyBackendsBehavior?: string; /** * The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure. */ numberOfProbes?: number; /** * The port for communicating the probe. Possible values range from 1 to 65535, inclusive. */ port: number; /** * The number of consecutive successful or failed probes in order to allow or deny traffic from being delivered to this endpoint. After failing the number of consecutive probes equal to this value, the endpoint will be taken out of rotation and require the same number of successful consecutive probes to be placed back in rotation. */ probeThreshold?: number; /** * The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful. */ protocol: string; /** * The provisioning state of the probe resource. */ provisioningState: string; /** * The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value. */ requestPath?: string; /** * Type of the resource. */ type: string; } /** * The list of RouteTables to advertise the routes to. */ interface PropagatedRouteTableResponse { /** * The list of resource ids of all the RouteTables. */ ids?: outputs.network.SubResourceResponse[]; /** * The list of labels. */ labels?: string[]; } /** * Contains FQDN of the DNS record associated with the public IP address */ interface PublicIPAddressDnsSettingsInterfaceEndpointResponse { /** * Gets or sets the Domain name label.The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. */ domainNameLabel?: string; /** * Gets the FQDN, Fully qualified domain name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. */ fqdn?: string; /** * Gets or Sets the Reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. */ reverseFqdn?: string; } /** * Contains FQDN of the DNS record associated with the public IP address. */ interface PublicIPAddressDnsSettingsResponse { /** * The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system. */ domainNameLabel?: string; /** * The domain name label scope. If a domain name label and a domain name label scope are specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system with a hashed value includes in FQDN. */ domainNameLabelScope?: string; /** * The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone. */ fqdn?: string; /** * The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN. */ reverseFqdn?: string; } /** * Public IP address resource. */ interface PublicIPAddressInterfaceEndpointResponse { /** * The DDoS protection custom policy associated with the public IP address. */ ddosSettings?: outputs.network.DdosSettingsInterfaceEndpointResponse; /** * The FQDN of the DNS record associated with the public IP address. */ dnsSettings?: outputs.network.PublicIPAddressDnsSettingsInterfaceEndpointResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * The idle timeout of the public IP address. */ idleTimeoutInMinutes?: number; /** * The IP address associated with the public IP address resource. */ ipAddress?: string; /** * The IP configuration associated with the public IP address. */ ipConfiguration: outputs.network.IPConfigurationResponse; /** * The list of tags associated with the public IP address. */ ipTags?: outputs.network.IpTagResponse[]; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * The provisioning state of the PublicIP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState?: string; /** * The public IP address version. */ publicIPAddressVersion?: string; /** * The public IP address allocation method. */ publicIPAllocationMethod?: string; /** * The Public IP Prefix this Public IP Address should be allocated from. */ publicIPPrefix?: outputs.network.SubResourceResponse; /** * The resource GUID property of the public IP resource. */ resourceGuid?: string; /** * The public IP address SKU. */ sku?: outputs.network.PublicIPAddressSkuInterfaceEndpointResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; /** * A list of availability zones denoting the IP allocated for the resource needs to come from. */ zones?: string[]; } /** * publicIPAddressInterfaceEndpointResponseProvideDefaults sets the appropriate defaults for PublicIPAddressInterfaceEndpointResponse */ function publicIPAddressInterfaceEndpointResponseProvideDefaults(val: PublicIPAddressInterfaceEndpointResponse): PublicIPAddressInterfaceEndpointResponse; /** * Public IP address resource. */ interface PublicIPAddressResponse { /** * The DDoS protection custom policy associated with the public IP address. */ ddosSettings?: outputs.network.DdosSettingsResponse; /** * Specify what happens to the public IP address when the VM using it is deleted */ deleteOption?: string; /** * The FQDN of the DNS record associated with the public IP address. */ dnsSettings?: outputs.network.PublicIPAddressDnsSettingsResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The extended location of the public ip address. */ extendedLocation?: outputs.network.ExtendedLocationResponse; /** * Resource ID. */ id?: string; /** * The idle timeout of the public IP address. */ idleTimeoutInMinutes?: number; /** * The IP address associated with the public IP address resource. */ ipAddress?: string; /** * The IP configuration associated with the public IP address. */ ipConfiguration: outputs.network.IPConfigurationResponse; /** * The list of tags associated with the public IP address. */ ipTags?: outputs.network.IpTagResponse[]; /** * The linked public IP address of the public IP address resource. */ linkedPublicIPAddress?: outputs.network.PublicIPAddressResponse; /** * Resource location. */ location?: string; /** * Migration phase of Public IP Address. */ migrationPhase?: string; /** * Resource name. */ name: string; /** * The NatGateway for the Public IP address. */ natGateway?: outputs.network.NatGatewayResponse; /** * The provisioning state of the public IP address resource. */ provisioningState: string; /** * The public IP address version. */ publicIPAddressVersion?: string; /** * The public IP address allocation method. */ publicIPAllocationMethod?: string; /** * The Public IP Prefix this Public IP Address should be allocated from. */ publicIPPrefix?: outputs.network.SubResourceResponse; /** * The resource GUID property of the public IP address resource. */ resourceGuid: string; /** * The service public IP address of the public IP address resource. */ servicePublicIPAddress?: outputs.network.PublicIPAddressResponse; /** * The public IP address SKU. */ sku?: outputs.network.PublicIPAddressSkuResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; /** * A list of availability zones denoting the IP allocated for the resource needs to come from. */ zones?: string[]; } /** * publicIPAddressResponseProvideDefaults sets the appropriate defaults for PublicIPAddressResponse */ function publicIPAddressResponseProvideDefaults(val: PublicIPAddressResponse): PublicIPAddressResponse; /** * Public IP address resource. */ interface PublicIPAddressResponseV1 { /** * The DDoS protection custom policy associated with the public IP address. */ ddosSettings?: outputs.network.DdosSettingsResponse; /** * Specify what happens to the public IP address when the VM using it is deleted */ deleteOption?: string; /** * The FQDN of the DNS record associated with the public IP address. */ dnsSettings?: outputs.network.PublicIPAddressDnsSettingsResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The extended location of the public ip address. */ extendedLocation?: outputs.network.ExtendedLocationResponse; /** * Resource ID. */ id?: string; /** * The idle timeout of the public IP address. */ idleTimeoutInMinutes?: number; /** * The IP address associated with the public IP address resource. */ ipAddress?: string; /** * The IP configuration associated with the public IP address. */ ipConfiguration: outputs.network.IPConfigurationServiceGatewayResponse; /** * The list of tags associated with the public IP address. */ ipTags?: outputs.network.IpTagResponse[]; /** * The linked public IP address of the public IP address resource. */ linkedPublicIPAddress?: outputs.network.PublicIPAddressServiceGatewayResponse; /** * Resource location. */ location?: string; /** * Migration phase of Public IP Address. */ migrationPhase?: string; /** * Resource name. */ name: string; /** * The NatGateway for the Public IP address. */ natGateway?: outputs.network.NatGatewayServiceGatewayResponse; /** * The provisioning state of the public IP address resource. */ provisioningState: string; /** * The public IP address version. */ publicIPAddressVersion?: string; /** * The public IP address allocation method. */ publicIPAllocationMethod?: string; /** * The Public IP Prefix this Public IP Address should be allocated from. */ publicIPPrefix?: outputs.network.SubResourceResponse; /** * The resource GUID property of the public IP address resource. */ resourceGuid: string; /** * The service public IP address of the public IP address resource. */ servicePublicIPAddress?: outputs.network.PublicIPAddressServiceGatewayResponse; /** * The public IP address SKU. */ sku?: outputs.network.PublicIPAddressSkuResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; /** * A list of availability zones denoting the IP allocated for the resource needs to come from. */ zones?: string[]; } /** * publicIPAddressResponseV1ProvideDefaults sets the appropriate defaults for PublicIPAddressResponseV1 */ function publicIPAddressResponseV1ProvideDefaults(val: PublicIPAddressResponseV1): PublicIPAddressResponseV1; /** * Public IP address resource. */ interface PublicIPAddressResponseV2 { /** * The DDoS protection custom policy associated with the public IP address. */ ddosSettings?: outputs.network.DdosSettingsResponse; /** * Specify what happens to the public IP address when the VM using it is deleted */ deleteOption?: string; /** * The FQDN of the DNS record associated with the public IP address. */ dnsSettings?: outputs.network.PublicIPAddressDnsSettingsResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The extended location of the public ip address. */ extendedLocation?: outputs.network.ExtendedLocationResponse; /** * Resource ID. */ id?: string; /** * The idle timeout of the public IP address. */ idleTimeoutInMinutes?: number; /** * The IP address associated with the public IP address resource. */ ipAddress?: string; /** * The IP configuration associated with the public IP address. */ ipConfiguration: outputs.network.IPConfigurationVirtualNetworkApplianceResponse; /** * The list of tags associated with the public IP address. */ ipTags?: outputs.network.IpTagResponse[]; /** * The linked public IP address of the public IP address resource. */ linkedPublicIPAddress?: outputs.network.PublicIPAddressVirtualNetworkApplianceResponse; /** * Resource location. */ location?: string; /** * Migration phase of Public IP Address. */ migrationPhase?: string; /** * Resource name. */ name: string; /** * The NatGateway for the Public IP address. */ natGateway?: outputs.network.NatGatewayVirtualNetworkApplianceResponse; /** * The provisioning state of the public IP address resource. */ provisioningState: string; /** * The public IP address version. */ publicIPAddressVersion?: string; /** * The public IP address allocation method. */ publicIPAllocationMethod?: string; /** * The Public IP Prefix this Public IP Address should be allocated from. */ publicIPPrefix?: outputs.network.SubResourceResponse; /** * The resource GUID property of the public IP address resource. */ resourceGuid: string; /** * The service public IP address of the public IP address resource. */ servicePublicIPAddress?: outputs.network.PublicIPAddressVirtualNetworkApplianceResponse; /** * The public IP address SKU. */ sku?: outputs.network.PublicIPAddressSkuResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; /** * A list of availability zones denoting the IP allocated for the resource needs to come from. */ zones?: string[]; } /** * publicIPAddressResponseV2ProvideDefaults sets the appropriate defaults for PublicIPAddressResponseV2 */ function publicIPAddressResponseV2ProvideDefaults(val: PublicIPAddressResponseV2): PublicIPAddressResponseV2; /** * Public IP address resource. */ interface PublicIPAddressServiceGatewayResponse { /** * The DDoS protection custom policy associated with the public IP address. */ ddosSettings?: outputs.network.DdosSettingsResponse; /** * Specify what happens to the public IP address when the VM using it is deleted */ deleteOption?: string; /** * The FQDN of the DNS record associated with the public IP address. */ dnsSettings?: outputs.network.PublicIPAddressDnsSettingsResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The extended location of the public ip address. */ extendedLocation?: outputs.network.ExtendedLocationResponse; /** * Resource ID. */ id?: string; /** * The idle timeout of the public IP address. */ idleTimeoutInMinutes?: number; /** * The IP address associated with the public IP address resource. */ ipAddress?: string; /** * The IP configuration associated with the public IP address. */ ipConfiguration: outputs.network.IPConfigurationResponse; /** * The list of tags associated with the public IP address. */ ipTags?: outputs.network.IpTagResponse[]; /** * The linked public IP address of the public IP address resource. */ linkedPublicIPAddress?: outputs.network.PublicIPAddressResponse; /** * Resource location. */ location?: string; /** * Migration phase of Public IP Address. */ migrationPhase?: string; /** * Resource name. */ name: string; /** * The NatGateway for the Public IP address. */ natGateway?: outputs.network.NatGatewayServiceGatewayResponse; /** * The provisioning state of the public IP address resource. */ provisioningState: string; /** * The public IP address version. */ publicIPAddressVersion?: string; /** * The public IP address allocation method. */ publicIPAllocationMethod?: string; /** * The Public IP Prefix this Public IP Address should be allocated from. */ publicIPPrefix?: outputs.network.SubResourceResponse; /** * The resource GUID property of the public IP address resource. */ resourceGuid: string; /** * The service public IP address of the public IP address resource. */ servicePublicIPAddress?: outputs.network.PublicIPAddressResponse; /** * The public IP address SKU. */ sku?: outputs.network.PublicIPAddressSkuResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; /** * A list of availability zones denoting the IP allocated for the resource needs to come from. */ zones?: string[]; } /** * publicIPAddressServiceGatewayResponseProvideDefaults sets the appropriate defaults for PublicIPAddressServiceGatewayResponse */ function publicIPAddressServiceGatewayResponseProvideDefaults(val: PublicIPAddressServiceGatewayResponse): PublicIPAddressServiceGatewayResponse; /** * SKU of a public IP address */ interface PublicIPAddressSkuInterfaceEndpointResponse { /** * Name of a public IP address SKU. */ name?: string; } /** * SKU of a public IP address. */ interface PublicIPAddressSkuResponse { /** * Name of a public IP address SKU. */ name?: string; /** * Tier of a public IP address SKU. */ tier?: string; } /** * Public IP address resource. */ interface PublicIPAddressVirtualNetworkApplianceResponse { /** * The DDoS protection custom policy associated with the public IP address. */ ddosSettings?: outputs.network.DdosSettingsResponse; /** * Specify what happens to the public IP address when the VM using it is deleted */ deleteOption?: string; /** * The FQDN of the DNS record associated with the public IP address. */ dnsSettings?: outputs.network.PublicIPAddressDnsSettingsResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The extended location of the public ip address. */ extendedLocation?: outputs.network.ExtendedLocationResponse; /** * Resource ID. */ id?: string; /** * The idle timeout of the public IP address. */ idleTimeoutInMinutes?: number; /** * The IP address associated with the public IP address resource. */ ipAddress?: string; /** * The IP configuration associated with the public IP address. */ ipConfiguration: outputs.network.IPConfigurationResponse; /** * The list of tags associated with the public IP address. */ ipTags?: outputs.network.IpTagResponse[]; /** * The linked public IP address of the public IP address resource. */ linkedPublicIPAddress?: outputs.network.PublicIPAddressResponse; /** * Resource location. */ location?: string; /** * Migration phase of Public IP Address. */ migrationPhase?: string; /** * Resource name. */ name: string; /** * The NatGateway for the Public IP address. */ natGateway?: outputs.network.NatGatewayVirtualNetworkApplianceResponse; /** * The provisioning state of the public IP address resource. */ provisioningState: string; /** * The public IP address version. */ publicIPAddressVersion?: string; /** * The public IP address allocation method. */ publicIPAllocationMethod?: string; /** * The Public IP Prefix this Public IP Address should be allocated from. */ publicIPPrefix?: outputs.network.SubResourceResponse; /** * The resource GUID property of the public IP address resource. */ resourceGuid: string; /** * The service public IP address of the public IP address resource. */ servicePublicIPAddress?: outputs.network.PublicIPAddressResponse; /** * The public IP address SKU. */ sku?: outputs.network.PublicIPAddressSkuResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; /** * A list of availability zones denoting the IP allocated for the resource needs to come from. */ zones?: string[]; } /** * publicIPAddressVirtualNetworkApplianceResponseProvideDefaults sets the appropriate defaults for PublicIPAddressVirtualNetworkApplianceResponse */ function publicIPAddressVirtualNetworkApplianceResponseProvideDefaults(val: PublicIPAddressVirtualNetworkApplianceResponse): PublicIPAddressVirtualNetworkApplianceResponse; /** * SKU of a public IP prefix. */ interface PublicIPPrefixSkuResponse { /** * Name of a public IP prefix SKU. */ name?: string; /** * Tier of a public IP prefix SKU. */ tier?: string; } /** * Quality of Service defines the traffic configuration between endpoints. Mandatory to have one marking. */ interface QosDefinitionResponse { /** * Destination IP ranges. */ destinationIpRanges?: outputs.network.QosIpRangeResponse[]; /** * Destination port ranges. */ destinationPortRanges?: outputs.network.QosPortRangeResponse[]; /** * List of markings to be used in the configuration. */ markings?: number[]; /** * RNM supported protocol types. */ protocol?: string; /** * Source IP ranges. */ sourceIpRanges?: outputs.network.QosIpRangeResponse[]; /** * Sources port ranges. */ sourcePortRanges?: outputs.network.QosPortRangeResponse[]; } /** * Qos Traffic Profiler IP Range properties. */ interface QosIpRangeResponse { /** * End IP Address. */ endIP?: string; /** * Start IP Address. */ startIP?: string; } /** * Qos Traffic Profiler Port range properties. */ interface QosPortRangeResponse { /** * Qos Port Range end. */ end?: number; /** * Qos Port Range start. */ start?: number; } /** * Gateway or VpnServerConfiguration Radius server with radius secret details */ interface RadiusAuthServerResponse { /** * Radius server IPAddress */ radiusServerAddress?: string; /** * Radius server secret */ radiusServerSecret?: string; } /** * Radius Server Settings. */ interface RadiusServerResponse { /** * The address of this radius server. */ radiusServerAddress: string; /** * The initial score assigned to this radius server. */ radiusServerScore?: number; /** * The secret used for this radius server. */ radiusServerSecret?: string; } /** * Represents the Reachability Analysis Intent properties. */ interface ReachabilityAnalysisIntentPropertiesResponse { description?: string; /** * Destination resource id to verify the reachability path of. */ destinationResourceId: string; /** * IP traffic information. */ ipTraffic: outputs.network.IPTrafficResponse; /** * Provisioning states of a resource. */ provisioningState: string; /** * Source resource id to verify the reachability path of. */ sourceResourceId: string; } /** * Represents the Reachability Analysis Run properties. */ interface ReachabilityAnalysisRunPropertiesResponse { analysisResult: string; description?: string; errorMessage: string; /** * Intent information. */ intentContent: outputs.network.IntentContentResponse; /** * Id of the intent resource to run analysis on. */ intentId: string; /** * Provisioning states of a resource. */ provisioningState: string; } /** * A collective group of information about the record set information. */ interface RecordSetResponse { /** * Fqdn that resolves to private endpoint ip address. */ fqdn?: string; /** * The private ip address of the private endpoint. */ ipAddresses?: string[]; /** * The provisioning state of the recordset. */ provisioningState: string; /** * Recordset name. */ recordSetName?: string; /** * Resource record type. */ recordType?: string; /** * Recordset time to live. */ ttl?: number; } /** * Reference to a public IP address. */ interface ReferencedPublicIpAddressResponse { /** * The PublicIPAddress Reference. */ id?: string; } /** * Gateway Resiliency based Recommendations */ interface ResiliencyRecommendationComponentsResponse { /** * Current Score of the gateway */ currentScore?: string; /** * Max score that the gateway can achieve if the specified recommendation is applied */ maxScore?: string; /** * Name of the Resiliency based Recommendation Component */ name?: string; /** * List of Gateway Resiliency based Recommendations */ recommendations?: outputs.network.GatewayResiliencyRecommendationResponse[]; } /** * Representation of basic resource information. */ interface ResourceBasicsResponse { /** * List of IP address prefixes of the resource. */ addressPrefixes?: string[]; /** * ResourceId of the Azure resource. */ resourceId?: string; } /** * ResourceNavigationLink resource. */ interface ResourceNavigationLinkInterfaceEndpointResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Link to the external resource */ link?: string; /** * Resource type of the linked resource. */ linkedResourceType?: string; /** * Name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * Provisioning state of the ResourceNavigationLink resource. */ provisioningState: string; } /** * ResourceNavigationLink resource. */ interface ResourceNavigationLinkResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id: string; /** * Link to the external resource. */ link?: string; /** * Resource type of the linked resource. */ linkedResourceType?: string; /** * Name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the resource navigation link resource. */ provisioningState: string; /** * Resource type. */ type: string; } /** * Parameters that define the retention policy for flow log. */ interface RetentionPolicyParametersResponse { /** * Number of days to retain flow log records. */ days?: number; /** * Flag to enable/disable retention. */ enabled?: boolean; } /** * retentionPolicyParametersResponseProvideDefaults sets the appropriate defaults for RetentionPolicyParametersResponse */ function retentionPolicyParametersResponseProvideDefaults(val: RetentionPolicyParametersResponse): RetentionPolicyParametersResponse; /** * Route Filter Rule Resource. */ interface RouteFilterRuleResponse { /** * The access type of the rule. */ access: string; /** * The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']. */ communities: string[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Resource location. */ location?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the route filter rule resource. */ provisioningState: string; /** * The rule type of the rule. */ routeFilterRuleType: string; } /** * Route resource */ interface RouteInterfaceEndpointResponse { /** * The destination CIDR to which the route applies. */ addressPrefix?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. */ nextHopIpAddress?: string; /** * The type of Azure hop the packet should be sent to. */ nextHopType: string; /** * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState?: string; } /** * A RouteMap Rule. */ interface RouteMapRuleResponse { /** * List of actions which will be applied on a match. */ actions?: outputs.network.ActionResponse[]; /** * List of matching criterion which will be applied to traffic. */ matchCriteria?: outputs.network.CriterionResponse[]; /** * The unique name for the rule. */ name?: string; /** * Next step after rule is evaluated. Current supported behaviors are 'Continue'(to next rule) and 'Terminate'. */ nextStepIfMatched?: string; } /** * Route resource. */ interface RouteResponse { /** * The destination CIDR to which the route applies. */ addressPrefix?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * A value indicating whether this route overrides overlapping BGP routes regardless of LPM. */ hasBgpOverride: boolean; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. */ nextHopIpAddress?: string; /** * The type of Azure hop the packet should be sent to. */ nextHopType: string; /** * The provisioning state of the route resource. */ provisioningState: string; /** * The type of the resource. */ type?: string; } /** * Route resource. */ interface RouteServiceGatewayResponse { /** * The destination CIDR to which the route applies. */ addressPrefix?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * A value indicating whether this route overrides overlapping BGP routes regardless of LPM. */ hasBgpOverride: boolean; /** * Resource ID. */ id?: string; /** * Name of the resource. */ name?: string; /** * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. */ nextHopIpAddress?: string; /** * The type of Azure hop the packet should be sent to. */ nextHopType: string; /** * The provisioning state of the route resource. */ provisioningState: string; /** * Resource type. */ type: string; } interface RouteSourceDetailsResponse { /** * Express Route Circuit identifier */ circuit?: string; /** * Flag to indicate if the route learned from the primary device is active or passive */ pri?: string; /** * Flag to indicate if the route learned from the secondary device is active or passive */ sec?: string; } /** * Route table resource. */ interface RouteTableInterfaceEndpointResponse { /** * Gets or sets whether to disable the routes learned by BGP on that route table. True means disable. */ disableBgpRoutePropagation?: boolean; /** * Gets a unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * The provisioning state of the resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState?: string; /** * Collection of routes contained within a route table. */ routes?: outputs.network.RouteInterfaceEndpointResponse[]; /** * A collection of references to subnets. */ subnets: outputs.network.SubnetResponse[]; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * Route table resource. */ interface RouteTableResponse { /** * Whether to disable the routes learned by BGP on that route table. True means disable. */ disableBgpRoutePropagation?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * The provisioning state of the route table resource. */ provisioningState: string; /** * The resource GUID property of the route table. */ resourceGuid: string; /** * Collection of routes contained within a route table. */ routes?: outputs.network.RouteResponse[]; /** * A collection of references to subnets. */ subnets: outputs.network.SubnetResponse[]; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * Route table resource. */ interface RouteTableServiceGatewayResponse { /** * Whether to disable the routes learned by BGP on that route table. True means disable. */ disableBgpRoutePropagation?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * The provisioning state of the route table resource. */ provisioningState: string; /** * The resource GUID property of the route table. */ resourceGuid: string; /** * Collection of routes contained within a route table. */ routes?: outputs.network.RouteServiceGatewayResponse[]; /** * A collection of references to subnets. */ subnets: outputs.network.SubnetResponse[]; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * Route table resource. */ interface RouteTableVirtualNetworkApplianceResponse { /** * Whether to disable the routes learned by BGP on that route table. True means disable. */ disableBgpRoutePropagation?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * The provisioning state of the route table resource. */ provisioningState: string; /** * The resource GUID property of the route table. */ resourceGuid: string; /** * Collection of routes contained within a route table. */ routes?: outputs.network.RouteVirtualNetworkApplianceResponse[]; /** * A collection of references to subnets. */ subnets: outputs.network.SubnetResponse[]; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * Properties of route target address */ interface RouteTargetAddressPropertiesFormatResponse { /** * The private IPv4 or IPv6 address of the service gateway route target address. */ privateIPAddress?: string; /** * The Private IP allocation method. */ privateIPAllocationMethod?: string; /** * The reference to the subnet resource. */ subnet?: outputs.network.SubnetResponseV1; } /** * routeTargetAddressPropertiesFormatResponseProvideDefaults sets the appropriate defaults for RouteTargetAddressPropertiesFormatResponse */ function routeTargetAddressPropertiesFormatResponseProvideDefaults(val: RouteTargetAddressPropertiesFormatResponse): RouteTargetAddressPropertiesFormatResponse; /** * Route resource. */ interface RouteVirtualNetworkApplianceResponse { /** * The destination CIDR to which the route applies. */ addressPrefix?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * A value indicating whether this route overrides overlapping BGP routes regardless of LPM. */ hasBgpOverride: boolean; /** * Resource ID. */ id?: string; /** * Name of the resource. */ name?: string; /** * The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. */ nextHopIpAddress?: string; /** * The type of Azure hop the packet should be sent to. */ nextHopType: string; /** * The provisioning state of the route resource. */ provisioningState: string; /** * Resource type. */ type: string; } /** * Routing Configuration indicating the associated and propagated route tables for this connection. */ interface RoutingConfigurationExpressRouteConnectionResponse { /** * The resource id RouteTable associated with this RoutingConfiguration. */ associatedRouteTable?: outputs.network.SubResourceResponse; /** * The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. */ inboundRouteMap?: outputs.network.SubResourceResponse; /** * The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. */ outboundRouteMap?: outputs.network.SubResourceResponse; /** * The list of RouteTables to advertise the routes to. */ propagatedRouteTables?: outputs.network.PropagatedRouteTableResponse; /** * List of routes that control routing from VirtualHub into a virtual network connection. */ vnetRoutes?: outputs.network.VnetRouteExpressRouteConnectionResponse; } /** * Routing Configuration indicating the associated and propagated route tables for this connection. */ interface RoutingConfigurationExpressRouteGatewayResponse { /** * The resource id RouteTable associated with this RoutingConfiguration. */ associatedRouteTable?: outputs.network.SubResourceResponse; /** * The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. */ inboundRouteMap?: outputs.network.SubResourceResponse; /** * The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. */ outboundRouteMap?: outputs.network.SubResourceResponse; /** * The list of RouteTables to advertise the routes to. */ propagatedRouteTables?: outputs.network.PropagatedRouteTableResponse; /** * List of routes that control routing from VirtualHub into a virtual network connection. */ vnetRoutes?: outputs.network.VnetRouteExpressRouteGatewayResponse; } /** * Routing Configuration indicating the associated and propagated route tables for this connection. */ interface RoutingConfigurationHubVirtualNetworkConnectionResponse { /** * The resource id RouteTable associated with this RoutingConfiguration. */ associatedRouteTable?: outputs.network.SubResourceResponse; /** * The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. */ inboundRouteMap?: outputs.network.SubResourceResponse; /** * The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. */ outboundRouteMap?: outputs.network.SubResourceResponse; /** * The list of RouteTables to advertise the routes to. */ propagatedRouteTables?: outputs.network.PropagatedRouteTableResponse; /** * List of routes that control routing from VirtualHub into a virtual network connection. */ vnetRoutes?: outputs.network.VnetRouteHubVirtualNetworkConnectionResponse; } /** * Routing Configuration indicating the associated and propagated route tables for this connection. */ interface RoutingConfigurationNetworkVirtualApplianceConnectionResponse { /** * The resource id RouteTable associated with this RoutingConfiguration. */ associatedRouteTable?: outputs.network.SubResourceResponse; /** * The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. */ inboundRouteMap?: outputs.network.SubResourceResponse; /** * The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. */ outboundRouteMap?: outputs.network.SubResourceResponse; /** * The list of RouteTables to advertise the routes to. */ propagatedRouteTables?: outputs.network.PropagatedRouteTableResponse; /** * List of routes that control routing from VirtualHub into a virtual network connection. */ vnetRoutes?: outputs.network.VnetRouteNetworkVirtualApplianceConnectionResponse; } /** * Routing Configuration indicating the associated and propagated route tables for this connection. */ interface RoutingConfigurationP2sVpnGatewayResponse { /** * The resource id RouteTable associated with this RoutingConfiguration. */ associatedRouteTable?: outputs.network.SubResourceResponse; /** * The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. */ inboundRouteMap?: outputs.network.SubResourceResponse; /** * The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. */ outboundRouteMap?: outputs.network.SubResourceResponse; /** * The list of RouteTables to advertise the routes to. */ propagatedRouteTables?: outputs.network.PropagatedRouteTableResponse; /** * List of routes that control routing from VirtualHub into a virtual network connection. */ vnetRoutes?: outputs.network.VnetRouteP2sVpnGatewayResponse; } /** * Routing Configuration indicating the associated and propagated route tables for this connection. */ interface RoutingConfigurationResponse { /** * The resource id RouteTable associated with this RoutingConfiguration. */ associatedRouteTable?: outputs.network.SubResourceResponse; /** * The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. */ inboundRouteMap?: outputs.network.SubResourceResponse; /** * The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. */ outboundRouteMap?: outputs.network.SubResourceResponse; /** * The list of RouteTables to advertise the routes to. */ propagatedRouteTables?: outputs.network.PropagatedRouteTableResponse; /** * List of routes that control routing from VirtualHub into a virtual network connection. */ vnetRoutes?: outputs.network.VnetRouteResponse; } /** * Routing Configuration indicating the associated and propagated route tables for this connection. */ interface RoutingConfigurationVpnConnectionResponse { /** * The resource id RouteTable associated with this RoutingConfiguration. */ associatedRouteTable?: outputs.network.SubResourceResponse; /** * The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. */ inboundRouteMap?: outputs.network.SubResourceResponse; /** * The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. */ outboundRouteMap?: outputs.network.SubResourceResponse; /** * The list of RouteTables to advertise the routes to. */ propagatedRouteTables?: outputs.network.PropagatedRouteTableResponse; /** * List of routes that control routing from VirtualHub into a virtual network connection. */ vnetRoutes?: outputs.network.VnetRouteVpnConnectionResponse; } /** * Routing Configuration indicating the associated and propagated route tables for this connection. */ interface RoutingConfigurationVpnGatewayResponse { /** * The resource id RouteTable associated with this RoutingConfiguration. */ associatedRouteTable?: outputs.network.SubResourceResponse; /** * The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. */ inboundRouteMap?: outputs.network.SubResourceResponse; /** * The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. */ outboundRouteMap?: outputs.network.SubResourceResponse; /** * The list of RouteTables to advertise the routes to. */ propagatedRouteTables?: outputs.network.PropagatedRouteTableResponse; /** * List of routes that control routing from VirtualHub into a virtual network connection. */ vnetRoutes?: outputs.network.VnetRouteVpnGatewayResponse; } /** * Routing Configuration indicating the associated and propagated route tables for this connection. */ interface RoutingConfigurationVpnServerConfigurationResponse { /** * The resource id RouteTable associated with this RoutingConfiguration. */ associatedRouteTable?: outputs.network.SubResourceResponse; /** * The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. */ inboundRouteMap?: outputs.network.SubResourceResponse; /** * The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. */ outboundRouteMap?: outputs.network.SubResourceResponse; /** * The list of RouteTables to advertise the routes to. */ propagatedRouteTables?: outputs.network.PropagatedRouteTableResponse; /** * List of routes that control routing from VirtualHub into a virtual network connection. */ vnetRoutes?: outputs.network.VnetRouteVpnServerConfigurationResponse; } /** * Routing Configuration indicating the associated and propagated route tables for this connection. */ interface RoutingConfigurationgetP2sVpnGatewayP2sVpnConnectionHealthResponse { /** * The resource id RouteTable associated with this RoutingConfiguration. */ associatedRouteTable?: outputs.network.SubResourceResponse; /** * The resource id of the RouteMap associated with this RoutingConfiguration for inbound learned routes. */ inboundRouteMap?: outputs.network.SubResourceResponse; /** * The resource id of theRouteMap associated with this RoutingConfiguration for outbound advertised routes. */ outboundRouteMap?: outputs.network.SubResourceResponse; /** * The list of RouteTables to advertise the routes to. */ propagatedRouteTables?: outputs.network.PropagatedRouteTableResponse; /** * List of routes that control routing from VirtualHub into a virtual network connection. */ vnetRoutes?: outputs.network.VnetRoutegetP2sVpnGatewayP2sVpnConnectionHealthResponse; } /** * The routing policy object used in a RoutingIntent resource. */ interface RoutingPolicyResponse { /** * List of all destinations which this routing policy is applicable to (for example: Internet, PrivateTraffic). */ destinations: string[]; /** * The unique name for the routing policy. */ name: string; /** * The next hop resource id on which this routing policy is applicable to. */ nextHop: string; } /** * Next hop. */ interface RoutingRuleNextHopResponse { /** * Next hop address. Only required if the next hop type is VirtualAppliance. */ nextHopAddress?: string; /** * Next hop type. */ nextHopType: string; } /** * Route destination. */ interface RoutingRuleRouteDestinationResponse { /** * Destination address. */ destinationAddress: string; /** * Destination type. */ type: string; } /** * Network security rule. */ interface SecurityRuleInterfaceEndpointResponse { /** * The network traffic is allowed or denied. */ access: string; /** * A description for this rule. Restricted to 140 chars. */ description?: string; /** * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. */ destinationAddressPrefix?: string; /** * The destination address prefixes. CIDR or destination IP ranges. */ destinationAddressPrefixes?: string[]; /** * The application security group specified as destination. */ destinationApplicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. */ destinationPortRange?: string; /** * The destination port ranges. */ destinationPortRanges?: string[]; /** * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. */ direction: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. */ priority?: number; /** * Network protocol this rule applies to. Possible values are 'Tcp', 'Udp', 'Icmp', 'Esp', and '*'. */ protocol: string; /** * The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState?: string; /** * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. */ sourceAddressPrefix?: string; /** * The CIDR or source IP ranges. */ sourceAddressPrefixes?: string[]; /** * The application security group specified as source. */ sourceApplicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. */ sourcePortRange?: string; /** * The source port ranges. */ sourcePortRanges?: string[]; } /** * Network security rule. */ interface SecurityRuleResponse { /** * The network traffic is allowed or denied. */ access: string; /** * A description for this rule. Restricted to 140 chars. */ description?: string; /** * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. */ destinationAddressPrefix?: string; /** * The destination address prefixes. CIDR or destination IP ranges. */ destinationAddressPrefixes?: string[]; /** * The application security group specified as destination. */ destinationApplicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. */ destinationPortRange?: string; /** * The destination port ranges. */ destinationPortRanges?: string[]; /** * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. */ direction: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. */ priority: number; /** * Network protocol this rule applies to. */ protocol: string; /** * The provisioning state of the security rule resource. */ provisioningState: string; /** * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. */ sourceAddressPrefix?: string; /** * The CIDR or source IP ranges. */ sourceAddressPrefixes?: string[]; /** * The application security group specified as source. */ sourceApplicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. */ sourcePortRange?: string; /** * The source port ranges. */ sourcePortRanges?: string[]; /** * The type of the resource. */ type?: string; } /** * Network security rule. */ interface SecurityRuleServiceGatewayResponse { /** * The network traffic is allowed or denied. */ access: string; /** * A description for this rule. Restricted to 140 chars. */ description?: string; /** * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. */ destinationAddressPrefix?: string; /** * The destination address prefixes. CIDR or destination IP ranges. */ destinationAddressPrefixes?: string[]; /** * The application security group specified as destination. */ destinationApplicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. */ destinationPortRange?: string; /** * The destination port ranges. */ destinationPortRanges?: string[]; /** * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. */ direction: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the resource. */ name?: string; /** * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. */ priority: number; /** * Network protocol this rule applies to. */ protocol: string; /** * The provisioning state of the security rule resource. */ provisioningState: string; /** * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. */ sourceAddressPrefix?: string; /** * The CIDR or source IP ranges. */ sourceAddressPrefixes?: string[]; /** * The application security group specified as source. */ sourceApplicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. */ sourcePortRange?: string; /** * The source port ranges. */ sourcePortRanges?: string[]; /** * Resource type. */ type: string; } /** * Network security rule. */ interface SecurityRuleVirtualNetworkApplianceResponse { /** * The network traffic is allowed or denied. */ access: string; /** * A description for this rule. Restricted to 140 chars. */ description?: string; /** * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. */ destinationAddressPrefix?: string; /** * The destination address prefixes. CIDR or destination IP ranges. */ destinationAddressPrefixes?: string[]; /** * The application security group specified as destination. */ destinationApplicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. */ destinationPortRange?: string; /** * The destination port ranges. */ destinationPortRanges?: string[]; /** * The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic. */ direction: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the resource. */ name?: string; /** * The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. */ priority: number; /** * Network protocol this rule applies to. */ protocol: string; /** * The provisioning state of the security rule resource. */ provisioningState: string; /** * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. */ sourceAddressPrefix?: string; /** * The CIDR or source IP ranges. */ sourceAddressPrefixes?: string[]; /** * The application security group specified as source. */ sourceApplicationSecurityGroups?: outputs.network.ApplicationSecurityGroupResponse[]; /** * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. */ sourcePortRange?: string; /** * The source port ranges. */ sourcePortRanges?: string[]; /** * Resource type. */ type: string; } /** * Network manager security user group item. */ interface SecurityUserGroupItemResponse { /** * Network manager group Id. */ networkGroupId: string; } /** * ServiceAssociationLink resource. */ interface ServiceAssociationLinkInterfaceEndpointResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Link to the external resource. */ link?: string; /** * Resource type of the linked resource. */ linkedResourceType?: string; /** * Name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * Provisioning state of the ServiceAssociationLink resource. */ provisioningState: string; } /** * ServiceAssociationLink resource. */ interface ServiceAssociationLinkResponse { /** * If true, the resource can be deleted. */ allowDelete?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Link to the external resource. */ link?: string; /** * Resource type of the linked resource. */ linkedResourceType?: string; /** * A list of locations. */ locations?: string[]; /** * Name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the service association link resource. */ provisioningState: string; /** * Resource type. */ type: string; } /** * Service Endpoint policy definitions. */ interface ServiceEndpointPolicyDefinitionInterfaceEndpointResponse { /** * A description for this rule. Restricted to 140 chars. */ description?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the service end point policy definition. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState: string; /** * Service endpoint name. */ service?: string; /** * A list of service resources. */ serviceResources?: string[]; } /** * Service Endpoint policy definitions. */ interface ServiceEndpointPolicyDefinitionResponse { /** * A description for this rule. Restricted to 140 chars. */ description?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the service endpoint policy definition resource. */ provisioningState: string; /** * Service endpoint name. */ service?: string; /** * A list of service resources. */ serviceResources?: string[]; /** * The type of the resource. */ type?: string; } /** * Service Endpoint policy definitions. */ interface ServiceEndpointPolicyDefinitionServiceGatewayResponse { /** * A description for this rule. Restricted to 140 chars. */ description?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the resource. */ name?: string; /** * The provisioning state of the service endpoint policy definition resource. */ provisioningState: string; /** * Service endpoint name. */ service?: string; /** * A list of service resources. */ serviceResources?: string[]; /** * Resource type. */ type: string; } /** * Service Endpoint policy definitions. */ interface ServiceEndpointPolicyDefinitionVirtualNetworkApplianceResponse { /** * A description for this rule. Restricted to 140 chars. */ description?: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Name of the resource. */ name?: string; /** * The provisioning state of the service endpoint policy definition resource. */ provisioningState: string; /** * Service endpoint name. */ service?: string; /** * A list of service resources. */ serviceResources?: string[]; /** * Resource type. */ type: string; } /** * Service End point policy resource. */ interface ServiceEndpointPolicyInterfaceEndpointResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * The provisioning state of the service endpoint policy. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState: string; /** * The resource GUID property of the service endpoint policy resource. */ resourceGuid: string; /** * A collection of service endpoint policy definitions of the service endpoint policy. */ serviceEndpointPolicyDefinitions?: outputs.network.ServiceEndpointPolicyDefinitionInterfaceEndpointResponse[]; /** * A collection of references to subnets. */ subnets: outputs.network.SubnetResponse[]; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * Service End point policy resource. */ interface ServiceEndpointPolicyResponse { /** * A collection of contextual service endpoint policy. */ contextualServiceEndpointPolicies?: string[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Kind of service endpoint policy. This is metadata used for the Azure portal experience. */ kind: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * The provisioning state of the service endpoint policy resource. */ provisioningState: string; /** * The resource GUID property of the service endpoint policy resource. */ resourceGuid: string; /** * The alias indicating if the policy belongs to a service */ serviceAlias?: string; /** * A collection of service endpoint policy definitions of the service endpoint policy. */ serviceEndpointPolicyDefinitions?: outputs.network.ServiceEndpointPolicyDefinitionResponse[]; /** * A collection of references to subnets. */ subnets: outputs.network.SubnetResponse[]; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * Service End point policy resource. */ interface ServiceEndpointPolicyServiceGatewayResponse { /** * A collection of contextual service endpoint policy. */ contextualServiceEndpointPolicies?: string[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Kind of service endpoint policy. This is metadata used for the Azure portal experience. */ kind: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * The provisioning state of the service endpoint policy resource. */ provisioningState: string; /** * The resource GUID property of the service endpoint policy resource. */ resourceGuid: string; /** * The alias indicating if the policy belongs to a service */ serviceAlias?: string; /** * A collection of service endpoint policy definitions of the service endpoint policy. */ serviceEndpointPolicyDefinitions?: outputs.network.ServiceEndpointPolicyDefinitionServiceGatewayResponse[]; /** * A collection of references to subnets. */ subnets: outputs.network.SubnetResponse[]; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * Service End point policy resource. */ interface ServiceEndpointPolicyVirtualNetworkApplianceResponse { /** * A collection of contextual service endpoint policy. */ contextualServiceEndpointPolicies?: string[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Kind of service endpoint policy. This is metadata used for the Azure portal experience. */ kind: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * The provisioning state of the service endpoint policy resource. */ provisioningState: string; /** * The resource GUID property of the service endpoint policy resource. */ resourceGuid: string; /** * The alias indicating if the policy belongs to a service */ serviceAlias?: string; /** * A collection of service endpoint policy definitions of the service endpoint policy. */ serviceEndpointPolicyDefinitions?: outputs.network.ServiceEndpointPolicyDefinitionVirtualNetworkApplianceResponse[]; /** * A collection of references to subnets. */ subnets: outputs.network.SubnetResponse[]; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * The service endpoint properties. */ interface ServiceEndpointPropertiesFormatInterfaceEndpointResponse { /** * A list of locations. */ locations?: string[]; /** * The provisioning state of the resource. */ provisioningState?: string; /** * The type of the endpoint service. */ service?: string; } /** * The service endpoint properties. */ interface ServiceEndpointPropertiesFormatResponse { /** * A list of locations. */ locations?: string[]; /** * SubResource as network identifier. */ networkIdentifier?: outputs.network.SubResourceResponse; /** * The provisioning state of the service endpoint resource. */ provisioningState: string; /** * The type of the endpoint service. */ service?: string; } /** * SKU of a service gateway. */ interface ServiceGatewaySkuResponse { /** * Name of a service gateway SKU. */ name?: string; /** * Tier of a service gateway SKU. */ tier?: string; } /** * Parameters for SharedKey. */ interface SharedKeyPropertiesResponse { /** * The provisioning state of the SharedKey resource. */ provisioningState: string; /** * The value of the shared key for the vpn link connection. */ sharedKey?: string; /** * The length of the shared key for the vpn link connection. */ sharedKeyLength?: number; } interface SingleQueryResultResponse { /** * Describes what is the signature enforces */ description?: string; /** * Describes the list of destination ports related to this signature */ destinationPorts?: string[]; /** * Describes in which direction signature is being enforced: 0 - OutBound, 1 - InBound, 2 - Any, 3 - Internal, 4 - InternalOutbound, 5 - InternalInbound */ direction?: number; /** * Describes the groups the signature belongs to */ group?: string; /** * Describes if this override is inherited from base policy or not */ inheritedFromParentPolicy?: boolean; /** * Describes the last updated time of the signature (provided from 3rd party vendor) */ lastUpdated?: string; /** * The current mode enforced, 0 - Disabled, 1 - Alert, 2 -Deny */ mode?: number; /** * Describes the protocol the signatures is being enforced in */ protocol?: string; /** * Describes the severity of signature: 1 - High, 2 - Medium, 3 - Low */ severity?: number; /** * The ID of the signature */ signatureId?: number; /** * Describes the list of source ports related to this signature */ sourcePorts?: string[]; } /** * The sku of this Bastion Host. */ interface SkuResponse { /** * The name of the sku of this Bastion Host. */ name?: string; } /** * skuResponseProvideDefaults sets the appropriate defaults for SkuResponse */ function skuResponseProvideDefaults(val: SkuResponse): SkuResponse; /** * Properties of static CIDR resource. */ interface StaticCidrPropertiesResponse { /** * List of IP address prefixes of the resource. */ addressPrefixes?: string[]; description?: string; /** * Number of IP addresses to allocate for a static CIDR resource. The IP addresses will be assigned based on IpamPools available space. */ numberOfIPAddressesToAllocate?: string; /** * Provisioning states of a resource. */ provisioningState: string; /** * Total number of IP addresses allocated for the static CIDR resource. */ totalNumberOfIPAddresses: string; } /** * List of all Static Routes. */ interface StaticRouteResponse { /** * List of all address prefixes. */ addressPrefixes?: string[]; /** * The name of the StaticRoute that is unique within a VnetRoute. */ name?: string; /** * The ip address of the next hop. */ nextHopIpAddress?: string; } /** * Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection. */ interface StaticRoutesConfigExpressRouteConnectionResponse { /** * Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to. */ propagateStaticRoutes: boolean; /** * Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. */ vnetLocalRouteOverrideCriteria?: string; } /** * Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection. */ interface StaticRoutesConfigExpressRouteGatewayResponse { /** * Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to. */ propagateStaticRoutes: boolean; /** * Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. */ vnetLocalRouteOverrideCriteria?: string; } /** * Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection. */ interface StaticRoutesConfigHubVirtualNetworkConnectionResponse { /** * Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to. */ propagateStaticRoutes: boolean; /** * Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. */ vnetLocalRouteOverrideCriteria?: string; } /** * Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection. */ interface StaticRoutesConfigNetworkVirtualApplianceConnectionResponse { /** * Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to. */ propagateStaticRoutes: boolean; /** * Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. */ vnetLocalRouteOverrideCriteria?: string; } /** * Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection. */ interface StaticRoutesConfigP2sVpnGatewayResponse { /** * Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to. */ propagateStaticRoutes: boolean; /** * Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. */ vnetLocalRouteOverrideCriteria?: string; } /** * Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection. */ interface StaticRoutesConfigResponse { /** * Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to. */ propagateStaticRoutes?: boolean; /** * Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. */ vnetLocalRouteOverrideCriteria?: string; } /** * Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection. */ interface StaticRoutesConfigVpnConnectionResponse { /** * Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to. */ propagateStaticRoutes: boolean; /** * Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. */ vnetLocalRouteOverrideCriteria?: string; } /** * Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection. */ interface StaticRoutesConfigVpnGatewayResponse { /** * Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to. */ propagateStaticRoutes: boolean; /** * Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. */ vnetLocalRouteOverrideCriteria?: string; } /** * Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection. */ interface StaticRoutesConfigVpnServerConfigurationResponse { /** * Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to. */ propagateStaticRoutes: boolean; /** * Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. */ vnetLocalRouteOverrideCriteria?: string; } /** * Configuration for static routes on this HubVnetConnectionConfiguration for static routes on this HubVnetConnection. */ interface StaticRoutesConfiggetP2sVpnGatewayP2sVpnConnectionHealthResponse { /** * Boolean indicating whether static routes on this connection are automatically propagate to route tables which this connection propagates to. */ propagateStaticRoutes: boolean; /** * Parameter determining whether NVA in spoke vnet is bypassed for traffic with destination in spoke. */ vnetLocalRouteOverrideCriteria?: string; } /** * Reference to another subresource. */ interface SubResourceResponse { /** * Resource ID. */ id?: string; } /** * Subgroup profile of the interconnect group resource. */ interface SubgroupProfileResponse { /** * Scope of the subgroup profile. */ scope?: string; /** * Size of the subgroup profile. */ size?: number; /** * VM size of the subgroup profile. */ vmSize: string; } /** * A subgroup in an interconnect group. */ interface SubgroupResponse { /** * Resource ID. */ id?: string; /** * The reference to an interconnect block resource. */ interconnectBlock: outputs.network.SubResourceResponse; /** * The unique identifier of the subgroup. */ internalSubgroupId: string; /** * Name of the resource. */ name?: string; /** * The provisioning state of the subgroup. */ provisioningState: string; /** * Resource type. */ type: string; /** * A list of virtual machine references. */ virtualMachines: outputs.network.SubResourceResponse[]; } /** * Subnet in a virtual network resource. */ interface SubnetInterfaceEndpointResponse { /** * The address prefix for the subnet. */ addressPrefix?: string; /** * List of address prefixes for the subnet. */ addressPrefixes?: string[]; /** * Gets an array of references to the delegations on the subnet. */ delegations?: outputs.network.DelegationInterfaceEndpointResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * An array of references to interface endpoints */ interfaceEndpoints: outputs.network.InterfaceEndpointResponse[]; /** * Array of IP configuration profiles which reference this subnet. */ ipConfigurationProfiles: outputs.network.IPConfigurationProfileInterfaceEndpointResponse[]; /** * Gets an array of references to the network interface IP configurations using subnet. */ ipConfigurations: outputs.network.IPConfigurationInterfaceEndpointResponse[]; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * Nat gateway associated with this subnet. */ natGateway?: outputs.network.SubResourceResponse; /** * The reference of the NetworkSecurityGroup resource. */ networkSecurityGroup?: outputs.network.NetworkSecurityGroupInterfaceEndpointResponse; /** * The provisioning state of the resource. */ provisioningState?: string; /** * A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. */ purpose: string; /** * Gets an array of references to the external resources using subnet. */ resourceNavigationLinks?: outputs.network.ResourceNavigationLinkInterfaceEndpointResponse[]; /** * The reference of the RouteTable resource. */ routeTable?: outputs.network.RouteTableInterfaceEndpointResponse; /** * Gets an array of references to services injecting into this subnet. */ serviceAssociationLinks?: outputs.network.ServiceAssociationLinkInterfaceEndpointResponse[]; /** * An array of service endpoint policies. */ serviceEndpointPolicies?: outputs.network.ServiceEndpointPolicyInterfaceEndpointResponse[]; /** * An array of service endpoints. */ serviceEndpoints?: outputs.network.ServiceEndpointPropertiesFormatInterfaceEndpointResponse[]; } /** * Subnet in a virtual network resource. */ interface SubnetResponse { /** * The address prefix for the subnet. */ addressPrefix?: string; /** * List of address prefixes for the subnet. */ addressPrefixes?: string[]; /** * Application gateway IP configurations of virtual network resource. */ applicationGatewayIPConfigurations?: outputs.network.ApplicationGatewayIPConfigurationResponse[]; /** * Set this property to false to disable default outbound connectivity for all VMs in the subnet. This property can only be set at the time of subnet creation and cannot be updated for an existing subnet. */ defaultOutboundAccess?: boolean; /** * An array of references to the delegations on the subnet. */ delegations?: outputs.network.DelegationResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Array of IpAllocation which reference this subnet. */ ipAllocations?: outputs.network.SubResourceResponse[]; /** * Array of IP configuration profiles which reference this subnet. */ ipConfigurationProfiles: outputs.network.IPConfigurationProfileResponse[]; /** * An array of references to the network interface IP configurations using subnet. */ ipConfigurations: outputs.network.IPConfigurationResponse[]; /** * A list of IPAM Pools for allocating IP address prefixes. */ ipamPoolPrefixAllocations?: outputs.network.IpamPoolPrefixAllocationResponse[]; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * Nat gateway associated with this subnet. */ natGateway?: outputs.network.SubResourceResponse; /** * The reference to the NetworkSecurityGroup resource. */ networkSecurityGroup?: outputs.network.NetworkSecurityGroupResponse; /** * Enable or Disable apply network policies on private end point in the subnet. */ privateEndpointNetworkPolicies?: string; /** * An array of references to private endpoints. */ privateEndpoints: outputs.network.PrivateEndpointResponse[]; /** * Enable or Disable apply network policies on private link service in the subnet. */ privateLinkServiceNetworkPolicies?: string; /** * The provisioning state of the subnet resource. */ provisioningState: string; /** * A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. */ purpose: string; /** * An array of references to the external resources using subnet. */ resourceNavigationLinks: outputs.network.ResourceNavigationLinkResponse[]; /** * The reference to the RouteTable resource. */ routeTable?: outputs.network.RouteTableResponse; /** * An array of references to services injecting into this subnet. */ serviceAssociationLinks: outputs.network.ServiceAssociationLinkResponse[]; /** * An array of service endpoint policies. */ serviceEndpointPolicies?: outputs.network.ServiceEndpointPolicyResponse[]; /** * An array of service endpoints. */ serviceEndpoints?: outputs.network.ServiceEndpointPropertiesFormatResponse[]; /** * Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty. */ sharingScope?: string; /** * Resource type. */ type?: string; } /** * subnetResponseProvideDefaults sets the appropriate defaults for SubnetResponse */ function subnetResponseProvideDefaults(val: SubnetResponse): SubnetResponse; /** * Subnet in a virtual network resource. */ interface SubnetResponseV1 { /** * The address prefix for the subnet. */ addressPrefix?: string; /** * List of address prefixes for the subnet. */ addressPrefixes?: string[]; /** * Application gateway IP configurations of virtual network resource. */ applicationGatewayIPConfigurations?: outputs.network.ApplicationGatewayIPConfigurationResponse[]; /** * Set this property to false to disable default outbound connectivity for all VMs in the subnet. */ defaultOutboundAccess?: boolean; /** * An array of references to the delegations on the subnet. */ delegations?: outputs.network.DelegationResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Array of IpAllocation which reference this subnet. */ ipAllocations?: outputs.network.SubResourceResponse[]; /** * Array of IP configuration profiles which reference this subnet. */ ipConfigurationProfiles: outputs.network.IPConfigurationProfileServiceGatewayResponse[]; /** * An array of references to the network interface IP configurations using subnet. */ ipConfigurations: outputs.network.IPConfigurationServiceGatewayResponse[]; /** * A list of IPAM Pools for allocating IP address prefixes. */ ipamPoolPrefixAllocations?: outputs.network.IpamPoolPrefixAllocationResponse[]; /** * Name of the resource. */ name?: string; /** * Nat gateway associated with this subnet. */ natGateway?: outputs.network.SubResourceResponse; /** * The reference to the NetworkSecurityGroup resource. */ networkSecurityGroup?: outputs.network.NetworkSecurityGroupServiceGatewayResponse; /** * Enable or Disable apply network policies on private end point in the subnet. */ privateEndpointNetworkPolicies?: string; /** * An array of references to private endpoints. */ privateEndpoints: outputs.network.PrivateEndpointServiceGatewayResponse[]; /** * Enable or Disable apply network policies on private link service in the subnet. */ privateLinkServiceNetworkPolicies?: string; /** * The provisioning state of the subnet resource. */ provisioningState: string; /** * A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. */ purpose: string; /** * An array of references to the external resources using subnet. */ resourceNavigationLinks: outputs.network.ResourceNavigationLinkResponse[]; /** * The reference to the RouteTable resource. */ routeTable?: outputs.network.RouteTableServiceGatewayResponse; /** * An array of references to services injecting into this subnet. */ serviceAssociationLinks: outputs.network.ServiceAssociationLinkResponse[]; /** * An array of service endpoint policies. */ serviceEndpointPolicies?: outputs.network.ServiceEndpointPolicyServiceGatewayResponse[]; /** * An array of service endpoints. */ serviceEndpoints?: outputs.network.ServiceEndpointPropertiesFormatResponse[]; /** * Reference to an existing service gateway. */ serviceGateway?: outputs.network.SubResourceResponse; /** * Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty. */ sharingScope?: string; /** * Resource type. */ type: string; } /** * subnetResponseV1ProvideDefaults sets the appropriate defaults for SubnetResponseV1 */ function subnetResponseV1ProvideDefaults(val: SubnetResponseV1): SubnetResponseV1; /** * Subnet in a virtual network resource. */ interface SubnetResponseV2 { /** * The address prefix for the subnet. */ addressPrefix?: string; /** * List of address prefixes for the subnet. */ addressPrefixes?: string[]; /** * Application gateway IP configurations of virtual network resource. */ applicationGatewayIPConfigurations?: outputs.network.ApplicationGatewayIPConfigurationResponse[]; /** * Set this property to false to disable default outbound connectivity for all VMs in the subnet. */ defaultOutboundAccess?: boolean; /** * An array of references to the delegations on the subnet. */ delegations?: outputs.network.DelegationResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Array of IpAllocation which reference this subnet. */ ipAllocations?: outputs.network.SubResourceResponse[]; /** * Array of IP configuration profiles which reference this subnet. */ ipConfigurationProfiles: outputs.network.IPConfigurationProfileVirtualNetworkApplianceResponse[]; /** * An array of references to the network interface IP configurations using subnet. */ ipConfigurations: outputs.network.IPConfigurationVirtualNetworkApplianceResponse[]; /** * A list of IPAM Pools for allocating IP address prefixes. */ ipamPoolPrefixAllocations?: outputs.network.IpamPoolPrefixAllocationResponse[]; /** * Name of the resource. */ name?: string; /** * Nat gateway associated with this subnet. */ natGateway?: outputs.network.SubResourceResponse; /** * The reference to the NetworkSecurityGroup resource. */ networkSecurityGroup?: outputs.network.NetworkSecurityGroupVirtualNetworkApplianceResponse; /** * Enable or Disable apply network policies on private end point in the subnet. */ privateEndpointNetworkPolicies?: string; /** * An array of references to private endpoints. */ privateEndpoints: outputs.network.PrivateEndpointVirtualNetworkApplianceResponse[]; /** * Enable or Disable apply network policies on private link service in the subnet. */ privateLinkServiceNetworkPolicies?: string; /** * The provisioning state of the subnet resource. */ provisioningState: string; /** * A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. */ purpose: string; /** * An array of references to the external resources using subnet. */ resourceNavigationLinks: outputs.network.ResourceNavigationLinkResponse[]; /** * The reference to the RouteTable resource. */ routeTable?: outputs.network.RouteTableVirtualNetworkApplianceResponse; /** * An array of references to services injecting into this subnet. */ serviceAssociationLinks: outputs.network.ServiceAssociationLinkResponse[]; /** * An array of service endpoint policies. */ serviceEndpointPolicies?: outputs.network.ServiceEndpointPolicyVirtualNetworkApplianceResponse[]; /** * An array of service endpoints. */ serviceEndpoints?: outputs.network.ServiceEndpointPropertiesFormatResponse[]; /** * Reference to an existing service gateway. */ serviceGateway?: outputs.network.SubResourceResponse; /** * Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty. */ sharingScope?: string; /** * Resource type. */ type: string; } /** * subnetResponseV2ProvideDefaults sets the appropriate defaults for SubnetResponseV2 */ function subnetResponseV2ProvideDefaults(val: SubnetResponseV2): SubnetResponseV2; /** * Subnet in a virtual network resource. */ interface SubnetServiceGatewayResponse { /** * The address prefix for the subnet. */ addressPrefix?: string; /** * List of address prefixes for the subnet. */ addressPrefixes?: string[]; /** * Application gateway IP configurations of virtual network resource. */ applicationGatewayIPConfigurations?: outputs.network.ApplicationGatewayIPConfigurationResponse[]; /** * Set this property to false to disable default outbound connectivity for all VMs in the subnet. */ defaultOutboundAccess?: boolean; /** * An array of references to the delegations on the subnet. */ delegations?: outputs.network.DelegationResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Array of IpAllocation which reference this subnet. */ ipAllocations?: outputs.network.SubResourceResponse[]; /** * Array of IP configuration profiles which reference this subnet. */ ipConfigurationProfiles: outputs.network.IPConfigurationProfileResponse[]; /** * An array of references to the network interface IP configurations using subnet. */ ipConfigurations: outputs.network.IPConfigurationServiceGatewayResponse[]; /** * A list of IPAM Pools for allocating IP address prefixes. */ ipamPoolPrefixAllocations?: outputs.network.IpamPoolPrefixAllocationResponse[]; /** * Name of the resource. */ name?: string; /** * Nat gateway associated with this subnet. */ natGateway?: outputs.network.SubResourceResponse; /** * The reference to the NetworkSecurityGroup resource. */ networkSecurityGroup?: outputs.network.NetworkSecurityGroupServiceGatewayResponse; /** * Enable or Disable apply network policies on private end point in the subnet. */ privateEndpointNetworkPolicies?: string; /** * An array of references to private endpoints. */ privateEndpoints: outputs.network.PrivateEndpointServiceGatewayResponse[]; /** * Enable or Disable apply network policies on private link service in the subnet. */ privateLinkServiceNetworkPolicies?: string; /** * The provisioning state of the subnet resource. */ provisioningState: string; /** * A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. */ purpose: string; /** * An array of references to the external resources using subnet. */ resourceNavigationLinks: outputs.network.ResourceNavigationLinkResponse[]; /** * The reference to the RouteTable resource. */ routeTable?: outputs.network.RouteTableServiceGatewayResponse; /** * An array of references to services injecting into this subnet. */ serviceAssociationLinks: outputs.network.ServiceAssociationLinkResponse[]; /** * An array of service endpoint policies. */ serviceEndpointPolicies?: outputs.network.ServiceEndpointPolicyServiceGatewayResponse[]; /** * An array of service endpoints. */ serviceEndpoints?: outputs.network.ServiceEndpointPropertiesFormatResponse[]; /** * Reference to an existing service gateway. */ serviceGateway?: outputs.network.SubResourceResponse; /** * Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty. */ sharingScope?: string; /** * Resource type. */ type: string; } /** * subnetServiceGatewayResponseProvideDefaults sets the appropriate defaults for SubnetServiceGatewayResponse */ function subnetServiceGatewayResponseProvideDefaults(val: SubnetServiceGatewayResponse): SubnetServiceGatewayResponse; /** * Subnet in a virtual network resource. */ interface SubnetVirtualNetworkApplianceResponse { /** * The address prefix for the subnet. */ addressPrefix?: string; /** * List of address prefixes for the subnet. */ addressPrefixes?: string[]; /** * Application gateway IP configurations of virtual network resource. */ applicationGatewayIPConfigurations?: outputs.network.ApplicationGatewayIPConfigurationResponse[]; /** * Set this property to false to disable default outbound connectivity for all VMs in the subnet. */ defaultOutboundAccess?: boolean; /** * An array of references to the delegations on the subnet. */ delegations?: outputs.network.DelegationResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Array of IpAllocation which reference this subnet. */ ipAllocations?: outputs.network.SubResourceResponse[]; /** * Array of IP configuration profiles which reference this subnet. */ ipConfigurationProfiles: outputs.network.IPConfigurationProfileResponse[]; /** * An array of references to the network interface IP configurations using subnet. */ ipConfigurations: outputs.network.IPConfigurationVirtualNetworkApplianceResponse[]; /** * A list of IPAM Pools for allocating IP address prefixes. */ ipamPoolPrefixAllocations?: outputs.network.IpamPoolPrefixAllocationResponse[]; /** * Name of the resource. */ name?: string; /** * Nat gateway associated with this subnet. */ natGateway?: outputs.network.SubResourceResponse; /** * The reference to the NetworkSecurityGroup resource. */ networkSecurityGroup?: outputs.network.NetworkSecurityGroupVirtualNetworkApplianceResponse; /** * Enable or Disable apply network policies on private end point in the subnet. */ privateEndpointNetworkPolicies?: string; /** * An array of references to private endpoints. */ privateEndpoints: outputs.network.PrivateEndpointVirtualNetworkApplianceResponse[]; /** * Enable or Disable apply network policies on private link service in the subnet. */ privateLinkServiceNetworkPolicies?: string; /** * The provisioning state of the subnet resource. */ provisioningState: string; /** * A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties. */ purpose: string; /** * An array of references to the external resources using subnet. */ resourceNavigationLinks: outputs.network.ResourceNavigationLinkResponse[]; /** * The reference to the RouteTable resource. */ routeTable?: outputs.network.RouteTableVirtualNetworkApplianceResponse; /** * An array of references to services injecting into this subnet. */ serviceAssociationLinks: outputs.network.ServiceAssociationLinkResponse[]; /** * An array of service endpoint policies. */ serviceEndpointPolicies?: outputs.network.ServiceEndpointPolicyVirtualNetworkApplianceResponse[]; /** * An array of service endpoints. */ serviceEndpoints?: outputs.network.ServiceEndpointPropertiesFormatResponse[]; /** * Reference to an existing service gateway. */ serviceGateway?: outputs.network.SubResourceResponse; /** * Set this property to Tenant to allow sharing subnet with other subscriptions in your AAD tenant. This property can only be set if defaultOutboundAccess is set to false, both properties can only be set if subnet is empty. */ sharingScope?: string; /** * Resource type. */ type: string; } /** * subnetVirtualNetworkApplianceResponseProvideDefaults sets the appropriate defaults for SubnetVirtualNetworkApplianceResponse */ function subnetVirtualNetworkApplianceResponseProvideDefaults(val: SubnetVirtualNetworkApplianceResponse): SubnetVirtualNetworkApplianceResponse; interface SubscriptionIdResponse { /** * Subscription id in the ARM id format. */ id?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The type of identity that last modified the resource. */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Parameters that define the configuration of traffic analytics. */ interface TrafficAnalyticsConfigurationPropertiesResponse { /** * Flag to enable/disable traffic analytics. */ enabled?: boolean; /** * The interval in minutes which would decide how frequently TA service should do flow analytics. */ trafficAnalyticsInterval?: number; /** * The resource guid of the attached workspace. */ workspaceId?: string; /** * The location of the attached workspace. */ workspaceRegion?: string; /** * Resource Id of the attached workspace. */ workspaceResourceId?: string; } /** * Parameters that define the configuration of traffic analytics. */ interface TrafficAnalyticsPropertiesResponse { /** * Parameters that define the configuration of traffic analytics. */ networkWatcherFlowAnalyticsConfiguration?: outputs.network.TrafficAnalyticsConfigurationPropertiesResponse; } /** * An traffic selector policy for a virtual network gateway connection. */ interface TrafficSelectorPolicyResponse { /** * A collection of local address spaces in CIDR format. */ localAddressRanges: string[]; /** * A collection of remote address spaces in CIDR format. */ remoteAddressRanges: string[]; } /** * VirtualNetworkGatewayConnection properties. */ interface TunnelConnectionHealthResponse { /** * Virtual Network Gateway connection status. */ connectionStatus: string; /** * The Egress Bytes Transferred in this connection. */ egressBytesTransferred: number; /** * The Ingress Bytes Transferred in this connection. */ ingressBytesTransferred: number; /** * The time at which connection was established in Utc format. */ lastConnectionEstablishedUtcTime: string; /** * Tunnel name. */ tunnel: string; } /** * Describes a Virtual Machine. */ interface VMResponse { /** * Resource ID. */ id?: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * Properties of Verifier Workspace resource. */ interface VerifierWorkspacePropertiesResponse { description?: string; /** * Provisioning states of a resource. */ provisioningState: string; } /** * Network Virtual Appliance Additional NIC properties. */ interface VirtualApplianceAdditionalNicPropertiesResponse { /** * Flag (true or false) for Intent for Public Ip on additional nic */ hasPublicIp?: boolean; /** * Name of additional nic */ name?: string; } /** * Represents a single IP configuration properties. */ interface VirtualApplianceIPConfigurationPropertiesResponse { /** * Whether or not this is primary IP configuration of the NIC. */ primary?: boolean; } /** * Represents a single IP configuration. */ interface VirtualApplianceIPConfigurationResponse { /** * Name of the IP configuration. */ name?: string; /** * Represents a single IP configuration properties. */ properties?: outputs.network.VirtualApplianceIPConfigurationPropertiesResponse; } /** * Represents a single NIC configuration properties. */ interface VirtualApplianceNetworkInterfaceConfigurationPropertiesResponse { ipConfigurations?: outputs.network.VirtualApplianceIPConfigurationResponse[]; } /** * Represents a single NIC configuration. */ interface VirtualApplianceNetworkInterfaceConfigurationResponse { /** * NIC type. This should be either PublicNic or PrivateNic. */ nicType?: string; /** * Represents a single NIC configuration properties. */ properties?: outputs.network.VirtualApplianceNetworkInterfaceConfigurationPropertiesResponse; } /** * Network Virtual Appliance NIC properties. */ interface VirtualApplianceNicPropertiesResponse { /** * Instance on which nic is attached. */ instanceName: string; /** * NIC name. */ name: string; /** * NIC type - PublicNic, PrivateNic, or AdditionalNic. */ nicType: string; /** * Private IP address. */ privateIpAddress: string; /** * Public IP address. */ publicIpAddress: string; } /** * Network Virtual Appliance Sku Properties. */ interface VirtualApplianceSkuPropertiesResponse { /** * Virtual Appliance Scale Unit. */ bundledScaleUnit?: string; /** * Virtual Appliance Version. */ marketPlaceVersion?: string; /** * Virtual Appliance Vendor. */ vendor?: string; } /** * Virtual Hub identifier. */ interface VirtualHubIdResponse { /** * The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription. */ id?: string; } /** * VirtualHub route. */ interface VirtualHubRouteResponse { /** * List of all addressPrefixes. */ addressPrefixes?: string[]; /** * NextHop ip address. */ nextHopIpAddress?: string; } /** * VirtualHub route table. */ interface VirtualHubRouteTableResponse { /** * List of all routes. */ routes?: outputs.network.VirtualHubRouteResponse[]; } /** * VirtualHubRouteTableV2 Resource. */ interface VirtualHubRouteTableV2Response { /** * List of all connections attached to this route table v2. */ attachedConnections?: string[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the virtual hub route table v2 resource. */ provisioningState: string; /** * List of all routes. */ routes?: outputs.network.VirtualHubRouteV2Response[]; } /** * VirtualHubRouteTableV2 route. */ interface VirtualHubRouteV2Response { /** * The type of destinations. */ destinationType?: string; /** * List of all destinations. */ destinations?: string[]; /** * The type of next hops. */ nextHopType?: string; /** * NextHops ip address. */ nextHops?: string[]; } /** * The virtual network appliance ip configuration. */ interface VirtualNetworkApplianceIpConfigurationResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of virtual network appliance ip configuration. */ name?: string; /** * Whether the ip configuration is primary or not. */ primary?: boolean; /** * The private IP address of the IP configuration. */ privateIPAddress?: string; /** * Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4. */ privateIPAddressVersion?: string; /** * The private IP address allocation method. */ privateIPAllocationMethod?: string; /** * The provisioning state of the private link service IP configuration resource. */ provisioningState: string; /** * The resource type. */ type: string; } /** * Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. */ interface VirtualNetworkBgpCommunitiesResponse { /** * The BGP community associated with the region of the virtual network. */ regionalCommunity: string; /** * The BGP community associated with the virtual network. */ virtualNetworkCommunity: string; } /** * Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet. */ interface VirtualNetworkEncryptionResponse { /** * Indicates if encryption is enabled on the virtual network. */ enabled: boolean; /** * If the encrypted VNet allows VM that does not support encryption. This field is for future support, AllowUnencrypted is the only supported value at general availability. */ enforcement?: string; } interface VirtualNetworkGatewayAutoScaleBoundsResponse { /** * Maximum Scale Units for Autoscale configuration */ max?: number; /** * Minimum scale Units for Autoscale configuration */ min?: number; } /** * Virtual Network Gateway Autoscale Configuration details */ interface VirtualNetworkGatewayAutoScaleConfigurationResponse { /** * The bounds of the autoscale configuration */ bounds?: outputs.network.VirtualNetworkGatewayAutoScaleBoundsResponse; } /** * IP configuration for virtual network gateway. */ interface VirtualNetworkGatewayIPConfigurationResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * Private IP Address for this gateway. */ privateIPAddress: string; /** * The private IP address allocation method. */ privateIPAllocationMethod?: string; /** * The provisioning state of the virtual network gateway IP configuration resource. */ provisioningState: string; /** * The reference to the public IP resource. */ publicIPAddress?: outputs.network.SubResourceResponse; /** * The reference to the subnet resource. */ subnet?: outputs.network.SubResourceResponse; } /** * VirtualNetworkGatewayNatRule Resource. */ interface VirtualNetworkGatewayNatRuleResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The private IP address external mapping for NAT. */ externalMappings?: outputs.network.VpnNatRuleMappingResponse[]; /** * Resource ID. */ id?: string; /** * The private IP address internal mapping for NAT. */ internalMappings?: outputs.network.VpnNatRuleMappingResponse[]; /** * The IP Configuration ID this NAT rule applies to. */ ipConfigurationId?: string; /** * The Source NAT direction of a VPN NAT. */ mode?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the NAT Rule resource. */ provisioningState: string; /** * Resource type. */ type: string; } /** * Vpn Client Connection configuration PolicyGroup member */ interface VirtualNetworkGatewayPolicyGroupMemberResponse { /** * The Vpn Policy member attribute type. */ attributeType?: string; /** * The value of Attribute used for this VirtualNetworkGatewayPolicyGroupMember. */ attributeValue?: string; /** * Name of the VirtualNetworkGatewayPolicyGroupMember. */ name?: string; } /** * Parameters for VirtualNetworkGatewayPolicyGroup. */ interface VirtualNetworkGatewayPolicyGroupResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Shows if this is a Default VirtualNetworkGatewayPolicyGroup or not. */ isDefault: boolean; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * Multiple PolicyMembers for VirtualNetworkGatewayPolicyGroup. */ policyMembers: outputs.network.VirtualNetworkGatewayPolicyGroupMemberResponse[]; /** * Priority for VirtualNetworkGatewayPolicyGroup. */ priority: number; /** * The provisioning state of the VirtualNetworkGatewayPolicyGroup resource. */ provisioningState: string; /** * List of references to vngClientConnectionConfigurations. */ vngClientConnectionConfigurations: outputs.network.SubResourceResponse[]; } /** * A common class for general resource information. */ interface VirtualNetworkGatewayResponse { /** * ActiveActive flag. */ activeActive?: boolean; /** * Property to indicate if the Express Route Gateway serves traffic when there are multiple Express Route Gateways in the vnet */ adminState?: string; /** * Configure this gateway to accept traffic from other Azure Virtual Networks. This configuration does not support connectivity to Azure Virtual WAN. */ allowRemoteVnetTraffic?: boolean; /** * Configures this gateway to accept traffic from remote Virtual WAN networks. */ allowVirtualWanTraffic?: boolean; /** * Autoscale configuration for virutal network gateway */ autoScaleConfiguration?: outputs.network.VirtualNetworkGatewayAutoScaleConfigurationResponse; /** * Virtual network gateway's BGP speaker settings. */ bgpSettings?: outputs.network.BgpSettingsResponse; /** * The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient. */ customRoutes?: outputs.network.AddressSpaceResponse; /** * disableIPSecReplayProtection flag. */ disableIPSecReplayProtection?: boolean; /** * Whether BGP is enabled for this virtual network gateway or not. */ enableBgp?: boolean; /** * EnableBgpRouteTranslationForNat flag. */ enableBgpRouteTranslationForNat?: boolean; /** * Whether dns forwarding is enabled or not. */ enableDnsForwarding?: boolean; /** * Whether private IP needs to be enabled on this gateway for connections or not. */ enablePrivateIpAddress?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The extended location of type local virtual network gateway. */ extendedLocation?: outputs.network.ExtendedLocationResponse; /** * The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting. */ gatewayDefaultSite?: outputs.network.SubResourceResponse; /** * The type of this virtual network gateway. */ gatewayType?: string; /** * Resource ID. */ id?: string; /** * The identity of the virtual network gateway, if configured. */ identity?: outputs.network.ManagedServiceIdentityResponse; /** * The IP address allocated by the gateway to which dns requests can be sent. */ inboundDnsForwardingEndpoint: string; /** * IP configurations for virtual network gateway. */ ipConfigurations?: outputs.network.VirtualNetworkGatewayIPConfigurationResponse[]; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * NatRules for virtual network gateway. */ natRules?: outputs.network.VirtualNetworkGatewayNatRuleResponse[]; /** * The provisioning state of the virtual network gateway resource. */ provisioningState: string; /** * Property to indicate if the Express Route Gateway has resiliency model of MultiHomed or SingleHomed */ resiliencyModel?: string; /** * The resource GUID property of the virtual network gateway resource. */ resourceGuid: string; /** * The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway. */ sku?: outputs.network.VirtualNetworkGatewaySkuResponse; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; /** * Customer vnet resource id. VirtualNetworkGateway of type local gateway is associated with the customer vnet. */ vNetExtendedLocationResourceId?: string; /** * The reference to the VirtualNetworkGatewayPolicyGroup resource which represents the available VirtualNetworkGatewayPolicyGroup for the gateway. */ virtualNetworkGatewayPolicyGroups?: outputs.network.VirtualNetworkGatewayPolicyGroupResponse[]; /** * The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations. */ vpnClientConfiguration?: outputs.network.VpnClientConfigurationResponse; /** * The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN. */ vpnGatewayGeneration?: string; /** * The type of this virtual network gateway. */ vpnType?: string; } /** * VirtualNetworkGatewaySku details. */ interface VirtualNetworkGatewaySkuResponse { /** * The capacity. */ capacity: number; /** * Gateway SKU name. */ name?: string; /** * Gateway SKU tier. */ tier?: string; } /** * Peerings in a virtual network resource. */ interface VirtualNetworkPeeringResponse { /** * Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. */ allowForwardedTraffic?: boolean; /** * If gateway links can be used in remote virtual networking to link to this virtual network. */ allowGatewayTransit?: boolean; /** * Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. */ allowVirtualNetworkAccess?: boolean; /** * If we need to verify the provisioning state of the remote gateway. */ doNotVerifyRemoteGateways?: boolean; /** * Whether only Ipv6 address space is peered for subnet peering. */ enableOnlyIPv6Peering?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The local address space of the local virtual network that is peered. */ localAddressSpace?: outputs.network.AddressSpaceResponse; /** * List of local subnet names that are subnet peered with remote virtual network. */ localSubnetNames?: string[]; /** * The current local address space of the local virtual network that is peered. */ localVirtualNetworkAddressSpace?: outputs.network.AddressSpaceResponse; /** * Name of the resource. */ name?: string; /** * Whether complete virtual network address space is peered. */ peerCompleteVnets?: boolean; /** * The status of the virtual network peering. */ peeringState?: string; /** * The peering sync status of the virtual network peering. */ peeringSyncLevel?: string; /** * The provisioning state of the virtual network peering resource. */ provisioningState: string; /** * The reference to the address space peered with the remote virtual network. */ remoteAddressSpace?: outputs.network.AddressSpaceResponse; /** * The reference to the remote virtual network's Bgp Communities. */ remoteBgpCommunities?: outputs.network.VirtualNetworkBgpCommunitiesResponse; /** * List of remote subnet names from remote virtual network that are subnet peered. */ remoteSubnetNames?: string[]; /** * The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering). */ remoteVirtualNetwork?: outputs.network.SubResourceResponse; /** * The reference to the current address space of the remote virtual network. */ remoteVirtualNetworkAddressSpace?: outputs.network.AddressSpaceResponse; /** * The reference to the remote virtual network's encryption */ remoteVirtualNetworkEncryption: outputs.network.VirtualNetworkEncryptionResponse; /** * The resourceGuid property of the Virtual Network peering resource. */ resourceGuid: string; /** * Resource type. */ type: string; /** * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway. */ useRemoteGateways?: boolean; } /** * Peerings in a virtual network resource. */ interface VirtualNetworkPeeringVirtualNetworkResponse { /** * Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network. */ allowForwardedTraffic?: boolean; /** * If gateway links can be used in remote virtual networking to link to this virtual network. */ allowGatewayTransit?: boolean; /** * Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space. */ allowVirtualNetworkAccess?: boolean; /** * If we need to verify the provisioning state of the remote gateway. */ doNotVerifyRemoteGateways?: boolean; /** * Whether only Ipv6 address space is peered for subnet peering. */ enableOnlyIPv6Peering?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The local address space of the local virtual network that is peered. */ localAddressSpace?: outputs.network.AddressSpaceResponse; /** * List of local subnet names that are subnet peered with remote virtual network. */ localSubnetNames?: string[]; /** * The current local address space of the local virtual network that is peered. */ localVirtualNetworkAddressSpace?: outputs.network.AddressSpaceResponse; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * Whether complete virtual network address space is peered. */ peerCompleteVnets?: boolean; /** * The status of the virtual network peering. */ peeringState?: string; /** * The peering sync status of the virtual network peering. */ peeringSyncLevel?: string; /** * The provisioning state of the virtual network peering resource. */ provisioningState: string; /** * The reference to the address space peered with the remote virtual network. */ remoteAddressSpace?: outputs.network.AddressSpaceResponse; /** * The reference to the remote virtual network's Bgp Communities. */ remoteBgpCommunities?: outputs.network.VirtualNetworkBgpCommunitiesResponse; /** * List of remote subnet names from remote virtual network that are subnet peered. */ remoteSubnetNames?: string[]; /** * The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering). */ remoteVirtualNetwork?: outputs.network.SubResourceResponse; /** * The reference to the current address space of the remote virtual network. */ remoteVirtualNetworkAddressSpace?: outputs.network.AddressSpaceResponse; /** * The reference to the remote virtual network's encryption */ remoteVirtualNetworkEncryption: outputs.network.VirtualNetworkEncryptionResponse; /** * The resourceGuid property of the Virtual Network peering resource. */ resourceGuid: string; /** * Resource type. */ type?: string; /** * If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway. */ useRemoteGateways?: boolean; } /** * Virtual Network resource. */ interface VirtualNetworkResponse { /** * The AddressSpace that contains an array of IP address ranges that can be used by subnets. */ addressSpace?: outputs.network.AddressSpaceResponse; /** * Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET. */ bgpCommunities?: outputs.network.VirtualNetworkBgpCommunitiesResponse; /** * The DDoS protection plan associated with the virtual network. */ ddosProtectionPlan?: outputs.network.SubResourceResponse; /** * A reference to the default public nat gateway being used by this virtual network resource. */ defaultPublicNatGateway: outputs.network.SubResourceResponse; /** * The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network. */ dhcpOptions?: outputs.network.DhcpOptionsResponse; /** * Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource. */ enableDdosProtection?: boolean; /** * Indicates if VM protection is enabled for all the subnets in the virtual network. */ enableVmProtection?: boolean; /** * Indicates if encryption is enabled on virtual network and if VM without encryption is allowed in encrypted VNet. */ encryption?: outputs.network.VirtualNetworkEncryptionResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The extended location of the virtual network. */ extendedLocation?: outputs.network.ExtendedLocationResponse; /** * A collection of references to flow log resources. */ flowLogs: outputs.network.FlowLogServiceGatewayResponse[]; /** * The FlowTimeout value (in minutes) for the Virtual Network */ flowTimeoutInMinutes?: number; /** * Resource ID. */ id?: string; /** * Array of IpAllocation which reference this VNET. */ ipAllocations?: outputs.network.SubResourceResponse[]; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * Private Endpoint VNet Policies. */ privateEndpointVNetPolicies?: string; /** * The provisioning state of the virtual network resource. */ provisioningState: string; /** * The resourceGuid property of the Virtual Network resource. */ resourceGuid: string; /** * A list of subnets in a Virtual Network. */ subnets?: outputs.network.SubnetServiceGatewayResponse[]; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; /** * A list of peerings in a Virtual Network. */ virtualNetworkPeerings?: outputs.network.VirtualNetworkPeeringResponse[]; } /** * virtualNetworkResponseProvideDefaults sets the appropriate defaults for VirtualNetworkResponse */ function virtualNetworkResponseProvideDefaults(val: VirtualNetworkResponse): VirtualNetworkResponse; /** * Virtual Network Tap resource */ interface VirtualNetworkTapInterfaceEndpointResponse { /** * The reference to the private IP address on the internal Load Balancer that will receive the tap */ destinationLoadBalancerFrontEndIPConfiguration?: outputs.network.FrontendIPConfigurationInterfaceEndpointResponse; /** * The reference to the private IP Address of the collector nic that will receive the tap */ destinationNetworkInterfaceIPConfiguration?: outputs.network.NetworkInterfaceIPConfigurationResponse; /** * The VXLAN destination port that will receive the tapped traffic. */ destinationPort?: number; /** * Gets a unique read-only string that changes whenever the resource is updated. */ etag?: string; /** * Resource ID. */ id?: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. */ networkInterfaceTapConfigurations: outputs.network.NetworkInterfaceTapConfigurationInterfaceEndpointResponse[]; /** * The provisioning state of the virtual network tap. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState: string; /** * The resourceGuid property of the virtual network tap. */ resourceGuid: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * virtualNetworkTapInterfaceEndpointResponseProvideDefaults sets the appropriate defaults for VirtualNetworkTapInterfaceEndpointResponse */ function virtualNetworkTapInterfaceEndpointResponseProvideDefaults(val: VirtualNetworkTapInterfaceEndpointResponse): VirtualNetworkTapInterfaceEndpointResponse; /** * Virtual Network Tap resource. */ interface VirtualNetworkTapResponse { /** * The reference to the private IP address on the internal Load Balancer that will receive the tap. */ destinationLoadBalancerFrontEndIPConfiguration?: outputs.network.FrontendIPConfigurationResponse; /** * The reference to the private IP Address of the collector nic that will receive the tap. */ destinationNetworkInterfaceIPConfiguration?: outputs.network.NetworkInterfaceIPConfigurationResponse; /** * The VXLAN destination port that will receive the tapped traffic. */ destinationPort?: number; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. */ networkInterfaceTapConfigurations: outputs.network.NetworkInterfaceTapConfigurationResponse[]; /** * The provisioning state of the virtual network tap resource. */ provisioningState: string; /** * The resource GUID property of the virtual network tap resource. */ resourceGuid: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * virtualNetworkTapResponseProvideDefaults sets the appropriate defaults for VirtualNetworkTapResponse */ function virtualNetworkTapResponseProvideDefaults(val: VirtualNetworkTapResponse): VirtualNetworkTapResponse; /** * Virtual Network Tap resource. */ interface VirtualNetworkTapServiceGatewayResponse { /** * The reference to the private IP address on the internal Load Balancer that will receive the tap. */ destinationLoadBalancerFrontEndIPConfiguration?: outputs.network.FrontendIPConfigurationServiceGatewayResponse; /** * The reference to the private IP Address of the collector nic that will receive the tap. */ destinationNetworkInterfaceIPConfiguration?: outputs.network.NetworkInterfaceIPConfigurationResponse; /** * The VXLAN destination port that will receive the tapped traffic. */ destinationPort?: number; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. */ networkInterfaceTapConfigurations: outputs.network.NetworkInterfaceTapConfigurationResponse[]; /** * The provisioning state of the virtual network tap resource. */ provisioningState: string; /** * The resource GUID property of the virtual network tap resource. */ resourceGuid: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * virtualNetworkTapServiceGatewayResponseProvideDefaults sets the appropriate defaults for VirtualNetworkTapServiceGatewayResponse */ function virtualNetworkTapServiceGatewayResponseProvideDefaults(val: VirtualNetworkTapServiceGatewayResponse): VirtualNetworkTapServiceGatewayResponse; /** * Virtual Network Tap resource. */ interface VirtualNetworkTapVirtualNetworkApplianceResponse { /** * The reference to the private IP address on the internal Load Balancer that will receive the tap. */ destinationLoadBalancerFrontEndIPConfiguration?: outputs.network.FrontendIPConfigurationVirtualNetworkApplianceResponse; /** * The reference to the private IP Address of the collector nic that will receive the tap. */ destinationNetworkInterfaceIPConfiguration?: outputs.network.NetworkInterfaceIPConfigurationResponse; /** * The VXLAN destination port that will receive the tapped traffic. */ destinationPort?: number; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Resource location. */ location?: string; /** * Resource name. */ name: string; /** * Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped. */ networkInterfaceTapConfigurations: outputs.network.NetworkInterfaceTapConfigurationResponse[]; /** * The provisioning state of the virtual network tap resource. */ provisioningState: string; /** * The resource GUID property of the virtual network tap resource. */ resourceGuid: string; /** * Resource tags. */ tags?: { [key: string]: string; }; /** * Resource type. */ type: string; } /** * virtualNetworkTapVirtualNetworkApplianceResponseProvideDefaults sets the appropriate defaults for VirtualNetworkTapVirtualNetworkApplianceResponse */ function virtualNetworkTapVirtualNetworkApplianceResponseProvideDefaults(val: VirtualNetworkTapVirtualNetworkApplianceResponse): VirtualNetworkTapVirtualNetworkApplianceResponse; /** * The VirtualHub Router autoscale configuration. */ interface VirtualRouterAutoScaleConfigurationResponse { /** * The minimum number of scale units for VirtualHub Router. */ minCapacity?: number; } /** * List of routes that control routing from VirtualHub into a virtual network connection. */ interface VnetRouteExpressRouteConnectionResponse { /** * The list of references to HubBgpConnection objects. */ bgpConnections: outputs.network.SubResourceResponse[]; /** * List of all Static Routes. */ staticRoutes?: outputs.network.StaticRouteResponse[]; /** * Configuration for static routes on this HubVnetConnection. */ staticRoutesConfig?: outputs.network.StaticRoutesConfigExpressRouteConnectionResponse; } /** * List of routes that control routing from VirtualHub into a virtual network connection. */ interface VnetRouteExpressRouteGatewayResponse { /** * The list of references to HubBgpConnection objects. */ bgpConnections: outputs.network.SubResourceResponse[]; /** * List of all Static Routes. */ staticRoutes?: outputs.network.StaticRouteResponse[]; /** * Configuration for static routes on this HubVnetConnection. */ staticRoutesConfig?: outputs.network.StaticRoutesConfigExpressRouteGatewayResponse; } /** * List of routes that control routing from VirtualHub into a virtual network connection. */ interface VnetRouteHubVirtualNetworkConnectionResponse { /** * The list of references to HubBgpConnection objects. */ bgpConnections: outputs.network.SubResourceResponse[]; /** * List of all Static Routes. */ staticRoutes?: outputs.network.StaticRouteResponse[]; /** * Configuration for static routes on this HubVnetConnection. */ staticRoutesConfig?: outputs.network.StaticRoutesConfigHubVirtualNetworkConnectionResponse; } /** * List of routes that control routing from VirtualHub into a virtual network connection. */ interface VnetRouteNetworkVirtualApplianceConnectionResponse { /** * The list of references to HubBgpConnection objects. */ bgpConnections: outputs.network.SubResourceResponse[]; /** * List of all Static Routes. */ staticRoutes?: outputs.network.StaticRouteResponse[]; /** * Configuration for static routes on this HubVnetConnection. */ staticRoutesConfig?: outputs.network.StaticRoutesConfigNetworkVirtualApplianceConnectionResponse; } /** * List of routes that control routing from VirtualHub into a virtual network connection. */ interface VnetRouteP2sVpnGatewayResponse { /** * The list of references to HubBgpConnection objects. */ bgpConnections: outputs.network.SubResourceResponse[]; /** * List of all Static Routes. */ staticRoutes?: outputs.network.StaticRouteResponse[]; /** * Configuration for static routes on this HubVnetConnection. */ staticRoutesConfig?: outputs.network.StaticRoutesConfigP2sVpnGatewayResponse; } /** * List of routes that control routing from VirtualHub into a virtual network connection. */ interface VnetRouteResponse { /** * The list of references to HubBgpConnection objects. */ bgpConnections: outputs.network.SubResourceResponse[]; /** * List of all Static Routes. */ staticRoutes?: outputs.network.StaticRouteResponse[]; /** * Configuration for static routes on this HubVnetConnection. */ staticRoutesConfig?: outputs.network.StaticRoutesConfigResponse; } /** * List of routes that control routing from VirtualHub into a virtual network connection. */ interface VnetRouteVpnConnectionResponse { /** * The list of references to HubBgpConnection objects. */ bgpConnections: outputs.network.SubResourceResponse[]; /** * List of all Static Routes. */ staticRoutes?: outputs.network.StaticRouteResponse[]; /** * Configuration for static routes on this HubVnetConnection. */ staticRoutesConfig?: outputs.network.StaticRoutesConfigVpnConnectionResponse; } /** * List of routes that control routing from VirtualHub into a virtual network connection. */ interface VnetRouteVpnGatewayResponse { /** * The list of references to HubBgpConnection objects. */ bgpConnections: outputs.network.SubResourceResponse[]; /** * List of all Static Routes. */ staticRoutes?: outputs.network.StaticRouteResponse[]; /** * Configuration for static routes on this HubVnetConnection. */ staticRoutesConfig?: outputs.network.StaticRoutesConfigVpnGatewayResponse; } /** * List of routes that control routing from VirtualHub into a virtual network connection. */ interface VnetRouteVpnServerConfigurationResponse { /** * The list of references to HubBgpConnection objects. */ bgpConnections: outputs.network.SubResourceResponse[]; /** * List of all Static Routes. */ staticRoutes?: outputs.network.StaticRouteResponse[]; /** * Configuration for static routes on this HubVnetConnection. */ staticRoutesConfig?: outputs.network.StaticRoutesConfigVpnServerConfigurationResponse; } /** * List of routes that control routing from VirtualHub into a virtual network connection. */ interface VnetRoutegetP2sVpnGatewayP2sVpnConnectionHealthResponse { /** * The list of references to HubBgpConnection objects. */ bgpConnections: outputs.network.SubResourceResponse[]; /** * List of all Static Routes. */ staticRoutes?: outputs.network.StaticRouteResponse[]; /** * Configuration for static routes on this HubVnetConnection. */ staticRoutesConfig?: outputs.network.StaticRoutesConfiggetP2sVpnGatewayP2sVpnConnectionHealthResponse; } /** * A vpn client connection configuration for client connection configuration. */ interface VngClientConnectionConfigurationResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the VngClientConnectionConfiguration resource. */ provisioningState: string; /** * List of references to virtualNetworkGatewayPolicyGroups */ virtualNetworkGatewayPolicyGroups: outputs.network.SubResourceResponse[]; /** * The reference to the address space resource which represents Address space for P2S VpnClient. */ vpnClientAddressPool: outputs.network.AddressSpaceResponse; } /** * VpnClientConfiguration for P2S client. */ interface VpnClientConfigurationResponse { /** * The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. */ aadAudience?: string; /** * The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. */ aadIssuer?: string; /** * The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication. */ aadTenant?: string; /** * The radius server address property of the VirtualNetworkGateway resource for vpn client connection. */ radiusServerAddress?: string; /** * The radius secret property of the VirtualNetworkGateway resource for vpn client connection. */ radiusServerSecret?: string; /** * The radiusServers property for multiple radius server configuration. */ radiusServers?: outputs.network.RadiusServerResponse[]; /** * per ip address pool connection policy for virtual network gateway P2S client. */ vngClientConnectionConfigurations?: outputs.network.VngClientConnectionConfigurationResponse[]; /** * VPN authentication types for the virtual network gateway.. */ vpnAuthenticationTypes?: string[]; /** * The reference to the address space resource which represents Address space for P2S VpnClient. */ vpnClientAddressPool?: outputs.network.AddressSpaceResponse; /** * VpnClientIpsecPolicies for virtual network gateway P2S client. */ vpnClientIpsecPolicies?: outputs.network.IpsecPolicyResponse[]; /** * VpnClientProtocols for Virtual network gateway. */ vpnClientProtocols?: string[]; /** * VpnClientRevokedCertificate for Virtual network gateway. */ vpnClientRevokedCertificates?: outputs.network.VpnClientRevokedCertificateResponse[]; /** * VpnClientRootCertificate for virtual network gateway. */ vpnClientRootCertificates?: outputs.network.VpnClientRootCertificateResponse[]; } /** * VPN client connection health detail. */ interface VpnClientConnectionHealthDetailResponse { /** * The egress bytes per second. */ egressBytesTransferred: number; /** * The egress packets per second. */ egressPacketsTransferred: number; /** * The ingress bytes per second. */ ingressBytesTransferred: number; /** * The ingress packets per second. */ ingressPacketsTransferred: number; /** * The max band width. */ maxBandwidth: number; /** * The max packets transferred per second. */ maxPacketsPerSecond: number; /** * The assigned private Ip of a connected vpn client. */ privateIpAddress: string; /** * The public Ip of a connected vpn client. */ publicIpAddress: string; /** * The duration time of a connected vpn client. */ vpnConnectionDuration: number; /** * The vpn client Id. */ vpnConnectionId: string; /** * The start time of a connected vpn client. */ vpnConnectionTime: string; /** * The user name of a connected vpn client. */ vpnUserName: string; } /** * VpnClientConnectionHealth properties. */ interface VpnClientConnectionHealthResponse { /** * List of allocated ip addresses to the connected p2s vpn clients. */ allocatedIpAddresses?: string[]; /** * Total of the Egress Bytes Transferred in this connection. */ totalEgressBytesTransferred: number; /** * Total of the Ingress Bytes Transferred in this P2S Vpn connection. */ totalIngressBytesTransferred: number; /** * The total of p2s vpn clients connected at this time to this P2SVpnGateway. */ vpnClientConnectionsCount?: number; } /** * VPN client revoked certificate of virtual network gateway. */ interface VpnClientRevokedCertificateResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the VPN client revoked certificate resource. */ provisioningState: string; /** * The revoked VPN client certificate thumbprint. */ thumbprint?: string; } /** * VPN client root certificate of virtual network gateway. */ interface VpnClientRootCertificateResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the VPN client root certificate resource. */ provisioningState: string; /** * The certificate public data. */ publicCertData: string; } /** * VpnConnection Resource. */ interface VpnConnectionResponse { /** * Expected bandwidth in MBPS. */ connectionBandwidth?: number; /** * The connection status. */ connectionStatus: string; /** * DPD timeout in seconds for vpn connection. */ dpdTimeoutSeconds?: number; /** * Egress bytes transferred. */ egressBytesTransferred: number; /** * EnableBgp flag. */ enableBgp?: boolean; /** * Enable internet security. */ enableInternetSecurity?: boolean; /** * EnableBgp flag. */ enableRateLimiting?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Ingress bytes transferred. */ ingressBytesTransferred: number; /** * The IPSec Policies to be considered by this connection. */ ipsecPolicies?: outputs.network.IpsecPolicyResponse[]; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the VPN connection resource. */ provisioningState: string; /** * Id of the connected vpn site. */ remoteVpnSite?: outputs.network.SubResourceResponse; /** * The Routing Configuration indicating the associated and propagated route tables on this connection. */ routingConfiguration?: outputs.network.RoutingConfigurationVpnGatewayResponse; /** * Routing weight for vpn connection. */ routingWeight?: number; /** * SharedKey for the vpn connection. */ sharedKey?: string; /** * The Traffic Selector Policies to be considered by this connection. */ trafficSelectorPolicies?: outputs.network.TrafficSelectorPolicyResponse[]; /** * Use local azure ip to initiate connection. */ useLocalAzureIpAddress?: boolean; /** * Enable policy-based traffic selectors. */ usePolicyBasedTrafficSelectors?: boolean; /** * Connection protocol used for this connection. */ vpnConnectionProtocolType?: string; /** * List of all vpn site link connections to the gateway. */ vpnLinkConnections?: outputs.network.VpnSiteLinkConnectionResponse[]; } /** * IP Configuration of a VPN Gateway Resource. */ interface VpnGatewayIpConfigurationResponse { /** * The identifier of the IP configuration for a VPN Gateway. */ id?: string; /** * The private IP address of this IP configuration. */ privateIpAddress?: string; /** * The public IP address of this IP configuration. */ publicIpAddress?: string; } /** * VpnGatewayNatRule Resource. */ interface VpnGatewayNatRuleResponse { /** * List of egress VpnSiteLinkConnections. */ egressVpnSiteLinkConnections: outputs.network.SubResourceResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The private IP address external mapping for NAT. */ externalMappings?: outputs.network.VpnNatRuleMappingResponse[]; /** * Resource ID. */ id?: string; /** * List of ingress VpnSiteLinkConnections. */ ingressVpnSiteLinkConnections: outputs.network.SubResourceResponse[]; /** * The private IP address internal mapping for NAT. */ internalMappings?: outputs.network.VpnNatRuleMappingResponse[]; /** * The IP Configuration ID this NAT rule applies to. */ ipConfigurationId?: string; /** * The Source NAT direction of a VPN NAT. */ mode?: string; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the NAT Rule resource. */ provisioningState: string; /** * Resource type. */ type: string; } /** * BGP settings details for a link. */ interface VpnLinkBgpSettingsResponse { /** * The BGP speaker's ASN. */ asn?: number; /** * The BGP peering address and BGP identifier of this BGP speaker. */ bgpPeeringAddress?: string; } /** * List of properties of a link provider. */ interface VpnLinkProviderPropertiesResponse { /** * Name of the link provider. */ linkProviderName?: string; /** * Link speed. */ linkSpeedInMbps?: number; } /** * Vpn NatRule mapping. */ interface VpnNatRuleMappingResponse { /** * Address space for Vpn NatRule mapping. */ addressSpace?: string; /** * Port range for Vpn NatRule mapping. */ portRange?: string; } /** * Properties of the Radius client root certificate of VpnServerConfiguration. */ interface VpnServerConfigRadiusClientRootCertificateResponse { /** * The certificate name. */ name?: string; /** * The Radius client root certificate thumbprint. */ thumbprint?: string; } /** * Properties of Radius Server root certificate of VpnServerConfiguration. */ interface VpnServerConfigRadiusServerRootCertificateResponse { /** * The certificate name. */ name?: string; /** * The certificate public data. */ publicCertData?: string; } /** * Properties of the revoked VPN client certificate of VpnServerConfiguration. */ interface VpnServerConfigVpnClientRevokedCertificateResponse { /** * The certificate name. */ name?: string; /** * The revoked VPN client certificate thumbprint. */ thumbprint?: string; } /** * Properties of VPN client root certificate of VpnServerConfiguration. */ interface VpnServerConfigVpnClientRootCertificateResponse { /** * The certificate name. */ name?: string; /** * The certificate public data. */ publicCertData?: string; } /** * VpnServerConfiguration PolicyGroup member */ interface VpnServerConfigurationPolicyGroupMemberResponse { /** * The Vpn Policy member attribute type. */ attributeType?: string; /** * The value of Attribute used for this VpnServerConfigurationPolicyGroupMember. */ attributeValue?: string; /** * Name of the VpnServerConfigurationPolicyGroupMember. */ name?: string; } /** * VpnServerConfigurationPolicyGroup Resource. */ interface VpnServerConfigurationPolicyGroupResponse { /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Shows if this is a Default VpnServerConfigurationPolicyGroup or not. */ isDefault?: boolean; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * List of references to P2SConnectionConfigurations. */ p2SConnectionConfigurations: outputs.network.SubResourceResponse[]; /** * Multiple PolicyMembers for VpnServerConfigurationPolicyGroup. */ policyMembers?: outputs.network.VpnServerConfigurationPolicyGroupMemberResponse[]; /** * Priority for VpnServerConfigurationPolicyGroup. */ priority?: number; /** * The provisioning state of the VpnServerConfigurationPolicyGroup resource. */ provisioningState: string; /** * Resource type. */ type: string; } /** * Parameters for VpnServerConfiguration. */ interface VpnServerConfigurationPropertiesResponse { /** * The set of aad vpn authentication parameters. */ aadAuthenticationParameters?: outputs.network.AadAuthenticationParametersResponse; /** * List of all VpnServerConfigurationPolicyGroups. */ configurationPolicyGroups?: outputs.network.VpnServerConfigurationPolicyGroupResponse[]; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * The name of the VpnServerConfiguration that is unique within a resource group. */ name?: string; /** * List of references to P2SVpnGateways. */ p2SVpnGateways: outputs.network.P2SVpnGatewayResponse[]; /** * The provisioning state of the VpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'. */ provisioningState: string; /** * Radius client root certificate of VpnServerConfiguration. */ radiusClientRootCertificates?: outputs.network.VpnServerConfigRadiusClientRootCertificateResponse[]; /** * The radius server address property of the VpnServerConfiguration resource for point to site client connection. */ radiusServerAddress?: string; /** * Radius Server root certificate of VpnServerConfiguration. */ radiusServerRootCertificates?: outputs.network.VpnServerConfigRadiusServerRootCertificateResponse[]; /** * The radius secret property of the VpnServerConfiguration resource for point to site client connection. */ radiusServerSecret?: string; /** * Multiple Radius Server configuration for VpnServerConfiguration. */ radiusServers?: outputs.network.RadiusServerResponse[]; /** * VPN authentication types for the VpnServerConfiguration. */ vpnAuthenticationTypes?: string[]; /** * VpnClientIpsecPolicies for VpnServerConfiguration. */ vpnClientIpsecPolicies?: outputs.network.IpsecPolicyResponse[]; /** * VPN client revoked certificate of VpnServerConfiguration. */ vpnClientRevokedCertificates?: outputs.network.VpnServerConfigVpnClientRevokedCertificateResponse[]; /** * VPN client root certificate of VpnServerConfiguration. */ vpnClientRootCertificates?: outputs.network.VpnServerConfigVpnClientRootCertificateResponse[]; /** * VPN protocols for the VpnServerConfiguration. */ vpnProtocols?: string[]; } /** * VpnSiteLinkConnection Resource. */ interface VpnSiteLinkConnectionResponse { /** * Expected bandwidth in MBPS. */ connectionBandwidth?: number; /** * The connection status. */ connectionStatus: string; /** * Dead Peer Detection timeout in seconds for VpnLink connection. */ dpdTimeoutSeconds?: number; /** * Egress bytes transferred. */ egressBytesTransferred: number; /** * List of egress NatRules. */ egressNatRules?: outputs.network.SubResourceResponse[]; /** * EnableBgp flag. */ enableBgp?: boolean; /** * EnableBgp flag. */ enableRateLimiting?: boolean; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * Resource ID. */ id?: string; /** * Ingress bytes transferred. */ ingressBytesTransferred: number; /** * List of ingress NatRules. */ ingressNatRules?: outputs.network.SubResourceResponse[]; /** * The IPSec Policies to be considered by this connection. */ ipsecPolicies?: outputs.network.IpsecPolicyResponse[]; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the VPN site link connection resource. */ provisioningState: string; /** * Routing weight for vpn connection. */ routingWeight?: number; /** * SharedKey for the vpn connection. */ sharedKey?: string; /** * Resource type. */ type: string; /** * Use local azure ip to initiate connection. */ useLocalAzureIpAddress?: boolean; /** * Enable policy-based traffic selectors. */ usePolicyBasedTrafficSelectors?: boolean; /** * Connection protocol used for this connection. */ vpnConnectionProtocolType?: string; /** * vpnGatewayCustomBgpAddresses used by this connection. */ vpnGatewayCustomBgpAddresses?: outputs.network.GatewayCustomBgpIpAddressIpConfigurationResponse[]; /** * Vpn link connection mode. */ vpnLinkConnectionMode?: string; /** * Id of the connected vpn site link. */ vpnSiteLink?: outputs.network.SubResourceResponse; } /** * VpnSiteLink Resource. */ interface VpnSiteLinkResponse { /** * The set of bgp properties. */ bgpProperties?: outputs.network.VpnLinkBgpSettingsResponse; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * FQDN of vpn-site-link. */ fqdn?: string; /** * Resource ID. */ id?: string; /** * The ip-address for the vpn-site-link. */ ipAddress?: string; /** * The link provider properties. */ linkProperties?: outputs.network.VpnLinkProviderPropertiesResponse; /** * The name of the resource that is unique within a resource group. This name can be used to access the resource. */ name?: string; /** * The provisioning state of the VPN site link resource. */ provisioningState: string; /** * Resource type. */ type: string; } /** * Defines contents of a web application rule. */ interface WebApplicationFirewallCustomRuleResponse { /** * Type of Actions. */ action: string; /** * A unique read-only string that changes whenever the resource is updated. */ etag: string; /** * List of user session identifier group by clauses. */ groupByUserSession?: outputs.network.GroupByUserSessionResponse[]; /** * List of match conditions. */ matchConditions: outputs.network.MatchConditionResponse[]; /** * The name of the resource that is unique within a policy. This name can be used to access the resource. */ name?: string; /** * Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. */ priority: number; /** * Duration over which Rate Limit policy will be applied. Applies only when ruleType is RateLimitRule. */ rateLimitDuration?: string; /** * Rate Limit threshold to apply in case ruleType is RateLimitRule. Must be greater than or equal to 1 */ rateLimitThreshold?: number; /** * The rule type. */ ruleType: string; /** * Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified. */ state?: string; } /** * Allow certain variables to be scrubbed on WAF logs */ interface WebApplicationFirewallScrubbingRulesResponse { /** * The variable to be scrubbed from the logs. */ matchVariable: string; /** * When matchVariable is a collection, operator used to specify which elements in the collection this rule applies to. */ selector?: string; /** * When matchVariable is a collection, operate on the selector to specify which elements in the collection this rule applies to. */ selectorMatchOperator: string; /** * Defines the state of log scrubbing rule. Default value is Enabled. */ state?: string; } } export declare namespace networkcloud { interface AadConfigurationResponse { /** * The list of Azure Active Directory group object IDs that will have an administrative role on the Kubernetes cluster. */ adminGroupObjectIds: string[]; } /** * AccessBridgeEndpoint describes a single advertised service endpoint. */ interface AccessBridgeEndpointResponse { /** * The fully qualified domain name used to describe the certificate name for the endpoint. */ fqdn: string; /** * The IPv4 address associated with the endpoint. */ ipv4Address: string; /** * The IPv6 address associated with the endpoint. */ ipv6Address: string; /** * The name that identifies the type of endpoint (for example VIP or host). */ name: string; } /** * AccessBridgeSecurityRule captures an individual access rule enforced by the bridge. */ interface AccessBridgeSecurityRuleResponse { /** * The user provided value describing this rule. */ description?: string; /** * The direction of allowed network traffic based on the rule. */ direction: string; /** * The set of IPv4 addresses permitted as the source or destination of the security rule. For as single address, utilize a /32 (CIDR notation). One or both Ipv4Addresses and Ipv6Addresses must be specified. Example formats: 10.10.10.10-10.10.10.20 or 10.10.10.10/24. */ ipv4Addresses?: string[]; /** * The set of IPv6 addresses permitted as the source or destination of the security rule. For as single address, utilize a /128 (CIDR notation). One or both Ipv4Addresses and Ipv6Addresses must be specified. Example formats: 2001:db8:abcd::1-2001:db8:abcd::ff or 2001:db8:abcd::1/64. */ ipv6Addresses?: string[]; /** * The source or destination port or port range. Example 24562 or 24562-24570. */ port: string; } interface AdministrativeCredentialsResponse { /** * The password of the administrator of the device used during initialization. */ password: string; /** * The username of the administrator of the device used during initialization. */ username: string; } interface AdministratorConfigurationResponse { /** * The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service. */ adminUsername?: string; /** * The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment. */ sshPublicKeys?: outputs.networkcloud.SshPublicKeyResponse[]; } interface AgentOptionsResponse { /** * The number of hugepages to allocate. */ hugepagesCount: number; /** * The size of the hugepages to allocate. */ hugepagesSize?: string; } /** * agentOptionsResponseProvideDefaults sets the appropriate defaults for AgentOptionsResponse */ function agentOptionsResponseProvideDefaults(val: AgentOptionsResponse): AgentOptionsResponse; interface AgentPoolUpgradeSettingsResponse { /** * The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used. */ drainTimeout?: number; /** * The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0. */ maxSurge?: string; /** * The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0. */ maxUnavailable?: string; } interface AnalyticsOutputSettingsResponse { /** * The resource ID of the analytics workspace that is to be used by the specified identity. */ analyticsWorkspaceId?: string; /** * The selection of the managed identity to use with this analytics workspace. The identity type must be either system assigned or user assigned. */ associatedIdentity?: outputs.networkcloud.IdentitySelectorResponse; } interface AttachedNetworkConfigurationResponse { /** * The list of Layer 2 Networks and related configuration for attachment. */ l2Networks?: outputs.networkcloud.L2NetworkAttachmentConfigurationResponse[]; /** * The list of Layer 3 Networks and related configuration for attachment. */ l3Networks?: outputs.networkcloud.L3NetworkAttachmentConfigurationResponse[]; /** * The list of Trunked Networks and related configuration for attachment. */ trunkedNetworks?: outputs.networkcloud.TrunkedNetworkAttachmentConfigurationResponse[]; } interface AvailableUpgradeResponse { /** * The version lifecycle indicator. */ availabilityLifecycle: string; /** * The version available for upgrading. */ version: string; } interface BareMetalMachineConfigurationDataResponse { /** * The connection string for the baseboard management controller including IP address and protocol. */ bmcConnectionString: string; /** * The credentials of the baseboard management controller on this bare metal machine. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. */ bmcCredentials: outputs.networkcloud.AdministrativeCredentialsResponse; /** * The MAC address of the BMC for this machine. */ bmcMacAddress: string; /** * The MAC address associated with the PXE NIC card. */ bootMacAddress: string; /** * The free-form additional information about the machine, e.g. an asset tag. */ machineDetails?: string; /** * The user-provided name for the bare metal machine created from this specification. * If not provided, the machine name will be generated programmatically. */ machineName?: string; /** * The slot the physical machine is in the rack based on the BOM configuration. */ rackSlot: number; /** * The serial number of the machine. Hardware suppliers may use an alternate value. For example, service tag. */ serialNumber: string; } interface BgpAdvertisementResponse { /** * The indicator of if this advertisement is also made to the network fabric associated with the Network Cloud Cluster. This field is ignored if fabricPeeringEnabled is set to False. */ advertiseToFabric?: string; /** * The names of the BGP communities to be associated with the announcement, utilizing a BGP community string in 1234:1234 format. */ communities?: string[]; /** * The names of the IP address pools associated with this announcement. */ ipAddressPools: string[]; /** * The names of the BGP peers to limit this advertisement to. If no values are specified, all BGP peers will receive this advertisement. */ peers?: string[]; } /** * bgpAdvertisementResponseProvideDefaults sets the appropriate defaults for BgpAdvertisementResponse */ function bgpAdvertisementResponseProvideDefaults(val: BgpAdvertisementResponse): BgpAdvertisementResponse; interface BgpServiceLoadBalancerConfigurationResponse { /** * The association of IP address pools to the communities and peers, allowing for announcement of IPs. */ bgpAdvertisements?: outputs.networkcloud.BgpAdvertisementResponse[]; /** * The list of additional BgpPeer entities that the Kubernetes cluster will peer with. All peering must be explicitly defined. */ bgpPeers?: outputs.networkcloud.ServiceLoadBalancerBgpPeerResponse[]; /** * The indicator to specify if the load balancer peers with the network fabric. */ fabricPeeringEnabled?: string; /** * The list of pools of IP addresses that can be allocated to load balancer services. */ ipAddressPools?: outputs.networkcloud.IpAddressPoolResponse[]; } /** * bgpServiceLoadBalancerConfigurationResponseProvideDefaults sets the appropriate defaults for BgpServiceLoadBalancerConfigurationResponse */ function bgpServiceLoadBalancerConfigurationResponseProvideDefaults(val: BgpServiceLoadBalancerConfigurationResponse): BgpServiceLoadBalancerConfigurationResponse; interface ClusterAvailableUpgradeVersionResponse { /** * The indicator of whether the control plane will be impacted during the upgrade. */ controlImpact: string; /** * The expected duration needed for this upgrade. */ expectedDuration: string; /** * The impact description including the specific details and release notes. */ impactDescription: string; /** * The last date the version of the platform is supported. */ supportExpiryDate: string; /** * The target version this cluster will be upgraded to. */ targetClusterVersion: string; /** * The indicator of whether the workload will be impacted during the upgrade. */ workloadImpact: string; } interface ClusterAvailableVersionResponse { /** * The last date the version of the platform is supported. */ supportExpiryDate: string; /** * The version of the cluster to be deployed. */ targetClusterVersion: string; } interface ClusterCapacityResponse { /** * The remaining appliance-based storage in GB available for workload use. Measured in gibibytes. */ availableApplianceStorageGB?: number; /** * The remaining number of cores that are available in this cluster for workload use. */ availableCoreCount?: number; /** * The remaining machine or host-based storage in GB available for workload use. Measured in gibibytes. */ availableHostStorageGB?: number; /** * The remaining memory in GB that are available in this cluster for workload use. Measured in gibibytes. */ availableMemoryGB?: number; /** * The total appliance-based storage in GB supported by this cluster for workload use. Measured in gibibytes. */ totalApplianceStorageGB?: number; /** * The total number of cores that are supported by this cluster for workload use. */ totalCoreCount?: number; /** * The total machine or host-based storage in GB supported by this cluster for workload use. Measured in gibibytes. */ totalHostStorageGB?: number; /** * The total memory supported by this cluster for workload use. Measured in gibibytes. */ totalMemoryGB?: number; } interface ClusterSecretArchiveResponse { /** * The resource ID of the key vault to archive the secrets of the cluster. */ keyVaultId: string; /** * The indicator if the specified key vault should be used to archive the secrets of the cluster. */ useKeyVault?: string; } /** * clusterSecretArchiveResponseProvideDefaults sets the appropriate defaults for ClusterSecretArchiveResponse */ function clusterSecretArchiveResponseProvideDefaults(val: ClusterSecretArchiveResponse): ClusterSecretArchiveResponse; interface ClusterUpdateStrategyResponse { /** * The maximum number of worker nodes that can be offline within the increment of update, e.g., rack-by-rack. * Limited by the maximum number of machines in the increment. Defaults to the whole increment size. */ maxUnavailable?: number; /** * The mode of operation for runtime protection. */ strategyType: string; /** * Selection of how the threshold should be evaluated. */ thresholdType: string; /** * The numeric threshold value. */ thresholdValue: number; /** * The time to wait between the increments of update defined by the strategy. */ waitTimeMinutes?: number; } /** * clusterUpdateStrategyResponseProvideDefaults sets the appropriate defaults for ClusterUpdateStrategyResponse */ function clusterUpdateStrategyResponseProvideDefaults(val: ClusterUpdateStrategyResponse): ClusterUpdateStrategyResponse; interface CommandOutputSettingsResponse { /** * The selection of the managed identity to use with this storage account container. The identity type must be either system assigned or user assigned. */ associatedIdentity?: outputs.networkcloud.IdentitySelectorResponse; /** * The URL of the storage account container that is to be used by the specified identities. */ containerUrl?: string; } interface ControlPlaneNodeConfigurationResponse { /** * The administrator credentials to be used for the nodes in the control plane. */ administratorConfiguration?: outputs.networkcloud.AdministratorConfigurationResponse; /** * The list of availability zones of the Network Cloud cluster to be used for the provisioning of nodes in the control plane. If not specified, all availability zones will be used. */ availabilityZones?: string[]; /** * The number of virtual machines that use this configuration. */ count: number; /** * The name of the VM SKU supplied during creation. */ vmSkuName: string; } interface EgressEndpointResponse { /** * The descriptive category name of endpoints accessible by the AKS agent node. For example, azure-resource-management, API server, etc. The platform egress endpoints provided by default will use the category 'default'. */ category: string; /** * The list of endpoint dependencies. */ endpoints: outputs.networkcloud.EndpointDependencyResponse[]; } interface EndpointDependencyResponse { /** * The domain name of the dependency. */ domainName: string; /** * The port of this endpoint. */ port?: number; } interface ExtendedLocationResponse { /** * The resource ID of the extended location on which the resource will be created. */ name: string; /** * The extended location type, for example, CustomLocation. */ type: string; } interface FeatureStatusResponse { /** * The status representing the state of this feature. */ detailedStatus: string; /** * The descriptive message about the current detailed status. */ detailedStatusMessage: string; /** * The name of the feature. */ name: string; /** * The version of the feature. */ version: string; } interface HardwareInventoryNetworkInterfaceResponse { /** * The current status of the link. */ linkStatus: string; /** * The MAC address associated with this interface. */ macAddress: string; /** * The name of the interface. */ name: string; /** * The resource ID of the network interface for the port on the switch that this machine's interface is connected to. */ networkInterfaceId: string; } interface HardwareInventoryResponse { /** * Freeform data extracted from the environment about this machine. This information varies depending on the specific hardware and configuration. */ additionalHostInformation: string; /** * The list of network interfaces and associated details for the bare metal machine. */ interfaces: outputs.networkcloud.HardwareInventoryNetworkInterfaceResponse[]; /** * Field Deprecated. Will be removed in an upcoming version. The list of network interface cards and associated details for the bare metal machine. */ nics: outputs.networkcloud.NicResponse[]; } interface HardwareValidationStatusResponse { /** * The timestamp of the hardware validation execution. */ lastValidationTime: string; /** * The outcome of the hardware validation. */ result: string; } interface IdentitySelectorResponse { /** * The type of managed identity that is being selected. */ identityType?: string; /** * The user assigned managed identity resource ID to use. Mutually exclusive with a system assigned identity type. */ userAssignedIdentityResourceId?: string; } interface ImageRepositoryCredentialsResponse { /** * The password or token used to access an image in the target repository. */ password: string; /** * The URL of the authentication server used to validate the repository credentials. */ registryUrl: string; /** * The username used to access an image in the target repository. */ username: string; } interface InitialAgentPoolConfigurationResponse { /** * The administrator credentials to be used for the nodes in this agent pool. */ administratorConfiguration?: outputs.networkcloud.AdministratorConfigurationResponse; /** * The configurations that will be applied to each agent in this agent pool. */ agentOptions?: outputs.networkcloud.AgentOptionsResponse; /** * The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster. */ attachedNetworkConfiguration?: outputs.networkcloud.AttachedNetworkConfigurationResponse; /** * The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used. */ availabilityZones?: string[]; /** * The number of virtual machines that use this configuration. */ count: number; /** * The labels applied to the nodes in this agent pool. */ labels?: outputs.networkcloud.KubernetesLabelResponse[]; /** * The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node. */ mode: string; /** * The name that will be used for the agent pool resource representing this agent pool. */ name: string; /** * The taints applied to the nodes in this agent pool. */ taints?: outputs.networkcloud.KubernetesLabelResponse[]; /** * The configuration of the agent pool. */ upgradeSettings?: outputs.networkcloud.AgentPoolUpgradeSettingsResponse; /** * The name of the VM SKU that determines the size of resources allocated for node VMs. */ vmSkuName: string; } /** * initialAgentPoolConfigurationResponseProvideDefaults sets the appropriate defaults for InitialAgentPoolConfigurationResponse */ function initialAgentPoolConfigurationResponseProvideDefaults(val: InitialAgentPoolConfigurationResponse): InitialAgentPoolConfigurationResponse; interface IpAddressPoolResponse { /** * The list of IP address ranges. Each range can be a either a subnet in CIDR format or an explicit start-end range of IP addresses. For a BGP service load balancer configuration, only CIDR format is supported and excludes /32 (IPv4) and /128 (IPv6) prefixes. */ addresses: string[]; /** * The indicator to determine if automatic allocation from the pool should occur. */ autoAssign?: string; /** * The name used to identify this IP address pool for association with a BGP advertisement. */ name: string; /** * The indicator to prevent the use of IP addresses ending with .0 and .255 for this pool. Enabling this option will only use IP addresses between .1 and .254 inclusive. */ onlyUseHostIps?: string; } /** * ipAddressPoolResponseProvideDefaults sets the appropriate defaults for IpAddressPoolResponse */ function ipAddressPoolResponseProvideDefaults(val: IpAddressPoolResponse): IpAddressPoolResponse; interface KeySetUserResponse { /** * The user name that will be used for access. */ azureUserName: string; /** * The free-form description for this user. */ description?: string; /** * The SSH public key that will be provisioned for user access. The user is expected to have the corresponding SSH private key for logging in. */ sshPublicKey: outputs.networkcloud.SshPublicKeyResponse; /** * The user principal name (email format) used to validate this user's group membership. */ userPrincipalName?: string; } interface KeySetUserStatusResponse { /** * The user name that will be used for access. */ azureUserName: string; /** * The indicator of whether the user is currently deployed for access. */ status: string; /** * The additional information describing the current status of this user, if any available. */ statusMessage: string; } interface KubernetesClusterNodeResponse { /** * The resource ID of the agent pool that this node belongs to. This value is not represented on control plane nodes. */ agentPoolId: string; /** * The availability zone this node is running within. */ availabilityZone: string; /** * The resource ID of the bare metal machine that hosts this node. */ bareMetalMachineId: string; /** * The number of CPU cores configured for this node, derived from the VM SKU specified. */ cpuCores: number; /** * The detailed state of this node. */ detailedStatus: string; /** * The descriptive message about the current detailed status. */ detailedStatusMessage: string; /** * The size of the disk configured for this node. Allocations are measured in gibibytes. */ diskSizeGB: number; /** * The machine image used to deploy this node. */ image: string; /** * The currently running version of Kubernetes and bundled features running on this node. */ kubernetesVersion: string; /** * The list of labels on this node that have been assigned to the agent pool containing this node. */ labels: outputs.networkcloud.KubernetesLabelResponse[]; /** * The amount of memory configured for this node, derived from the vm SKU specified. Allocations are measured in gibibytes. */ memorySizeGB: number; /** * The mode of the agent pool containing this node. Not applicable for control plane nodes. */ mode: string; /** * The name of this node, as realized in the Kubernetes cluster. */ name: string; /** * The NetworkAttachments made to this node. */ networkAttachments: outputs.networkcloud.NetworkAttachmentResponse[]; /** * The power state of this node. */ powerState: string; /** * The role of this node in the cluster. */ role: string; /** * The list of taints that have been assigned to the agent pool containing this node. */ taints: outputs.networkcloud.KubernetesLabelResponse[]; /** * The VM SKU name that was used to create this cluster node. */ vmSkuName: string; } interface KubernetesLabelResponse { /** * The name of the label or taint. */ key: string; /** * The value of the label or taint. */ value: string; } /** * KubernetesVersionValue describes a specific Kubernetes version that can be deployed. */ interface KubernetesVersionValueResponse { /** * Additional description for the Kubernetes version. */ description: string; /** * The Kubernetes version identifier. */ version: string; } interface L2NetworkAttachmentConfigurationResponse { /** * The resource ID of the network that is being configured for attachment. */ networkId: string; /** * The indicator of how this network will be utilized by the Kubernetes cluster. */ pluginType?: string; } /** * l2networkAttachmentConfigurationResponseProvideDefaults sets the appropriate defaults for L2NetworkAttachmentConfigurationResponse */ function l2networkAttachmentConfigurationResponseProvideDefaults(val: L2NetworkAttachmentConfigurationResponse): L2NetworkAttachmentConfigurationResponse; interface L2ServiceLoadBalancerConfigurationResponse { /** * The list of pools of IP addresses that can be allocated to load balancer services. */ ipAddressPools?: outputs.networkcloud.IpAddressPoolResponse[]; } interface L3NetworkAttachmentConfigurationResponse { /** * The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached. */ ipamEnabled?: string; /** * The resource ID of the network that is being configured for attachment. */ networkId: string; /** * The indicator of how this network will be utilized by the Kubernetes cluster. */ pluginType?: string; } /** * l3networkAttachmentConfigurationResponseProvideDefaults sets the appropriate defaults for L3NetworkAttachmentConfigurationResponse */ function l3networkAttachmentConfigurationResponseProvideDefaults(val: L3NetworkAttachmentConfigurationResponse): L3NetworkAttachmentConfigurationResponse; interface LldpNeighborResponse { /** * The descriptive information about the port on the connected device. */ portDescription: string; /** * The system-assigned name of the port on the connected device. */ portName: string; /** * The descriptive information about the connected device. */ systemDescription: string; /** * The system-assigned name of the connected device. */ systemName: string; } interface ManagedResourceGroupConfigurationResponse { /** * The location of the managed resource group. If not specified, the location of the parent resource is chosen. */ location?: string; /** * The name for the managed resource group. If not specified, the unique name is automatically generated. */ name?: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.networkcloud.UserAssignedIdentityResponse; }; } interface NetworkAttachmentResponse { /** * The resource ID of the associated network attached to the virtual machine. * It can be one of cloudServicesNetwork, l3Network, l2Network or trunkedNetwork resources. */ attachedNetworkId: string; /** * The indicator of whether this is the default gateway. * Only one of the attached networks (including the CloudServicesNetwork attachment) for a single machine may be specified as True. */ defaultGateway?: string; /** * The IP allocation mechanism for the virtual machine. * Dynamic and Static are only valid for l3Network which may also specify Disabled. * Otherwise, Disabled is the only permitted value. */ ipAllocationMethod: string; /** * The IPv4 address of the virtual machine. * * This field is used only if the attached network has IPAllocationType of IPV4 or DualStack. * * If IPAllocationMethod is: * Static - this field must contain a user specified IPv4 address from within the subnet specified in the attached network. * Dynamic - this field is read-only, but will be populated with an address from within the subnet specified in the attached network. * Disabled - this field will be empty. */ ipv4Address?: string; /** * The IPv6 address of the virtual machine. * * This field is used only if the attached network has IPAllocationType of IPV6 or DualStack. * * If IPAllocationMethod is: * Static - this field must contain an IPv6 address range from within the range specified in the attached network. * Dynamic - this field is read-only, but will be populated with an range from within the subnet specified in the attached network. * Disabled - this field will be empty. */ ipv6Address?: string; /** * The MAC address of the interface for the virtual machine that corresponds to this network attachment. */ macAddress: string; /** * The associated network's interface name. * If specified, the network attachment name has a maximum length of 15 characters and must be unique to this virtual machine. * If the user doesn’t specify this value, the default interface name of the network resource will be used. * For a CloudServicesNetwork resource, this name will be ignored. */ networkAttachmentName?: string; } interface NetworkConfigurationResponse { /** * The configuration of networks being attached to the cluster for use by the workloads that run on this Kubernetes cluster. */ attachedNetworkConfiguration?: outputs.networkcloud.AttachedNetworkConfigurationResponse; /** * The configuration of the BGP service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. */ bgpServiceLoadBalancerConfiguration?: outputs.networkcloud.BgpServiceLoadBalancerConfigurationResponse; /** * The resource ID of the associated Cloud Services network. */ cloudServicesNetworkId: string; /** * The resource ID of the Layer 3 network that is used for creation of the Container Networking Interface network. */ cniNetworkId: string; /** * The IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in service CIDR. */ dnsServiceIp?: string; /** * The configuration of the Layer 2 service load balancer for this Kubernetes cluster. A maximum of one service load balancer may be specified, either Layer 2 or BGP. */ l2ServiceLoadBalancerConfiguration?: outputs.networkcloud.L2ServiceLoadBalancerConfigurationResponse; /** * The CIDR notation IP ranges from which to assign pod IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. */ podCidrs?: string[]; /** * The CIDR notation IP ranges from which to assign service IPs. One IPv4 CIDR is expected for single-stack networking. Two CIDRs, one for each IP family (IPv4/IPv6), is expected for dual-stack networking. */ serviceCidrs?: string[]; } /** * networkConfigurationResponseProvideDefaults sets the appropriate defaults for NetworkConfigurationResponse */ function networkConfigurationResponseProvideDefaults(val: NetworkConfigurationResponse): NetworkConfigurationResponse; interface NicResponse { /** * The information about the device connected to this NIC. */ lldpNeighbor: outputs.networkcloud.LldpNeighborResponse; /** * The MAC address associated with this NIC. */ macAddress: string; /** * The name of the NIC/interface. */ name: string; } interface OsDiskResponse { /** * The strategy for creating the OS disk. */ createOption?: string; /** * The strategy for deleting the OS disk. */ deleteOption?: string; /** * The size of the disk. Required if the createOption is Ephemeral. Allocations are measured in gibibytes. */ diskSizeGB: number; } /** * osDiskResponseProvideDefaults sets the appropriate defaults for OsDiskResponse */ function osDiskResponseProvideDefaults(val: OsDiskResponse): OsDiskResponse; interface RackDefinitionResponse { /** * The zone name used for this rack when created. Availability zones are used for workload placement. */ availabilityZone?: string; /** * The unordered list of bare metal machine configuration. */ bareMetalMachineConfigurationData?: outputs.networkcloud.BareMetalMachineConfigurationDataResponse[]; /** * The resource ID of the network rack that matches this rack definition. */ networkRackId: string; /** * The free-form description of the rack's location. */ rackLocation?: string; /** * The unique identifier for the rack within Network Cloud cluster. An alternate unique alphanumeric value other than a serial number may be provided if desired. */ rackSerialNumber: string; /** * The resource ID of the sku for the rack being added. */ rackSkuId: string; /** * The list of storage appliance configuration data for this rack. */ storageApplianceConfigurationData?: outputs.networkcloud.StorageApplianceConfigurationDataResponse[]; } interface RuntimeProtectionConfigurationResponse { /** * The mode of operation for runtime protection. */ enforcementLevel?: string; } /** * runtimeProtectionConfigurationResponseProvideDefaults sets the appropriate defaults for RuntimeProtectionConfigurationResponse */ function runtimeProtectionConfigurationResponseProvideDefaults(val: RuntimeProtectionConfigurationResponse): RuntimeProtectionConfigurationResponse; interface RuntimeProtectionStatusResponse { /** * The timestamp when the malware definitions were last updated. */ definitionsLastUpdated: string; /** * The version of the malware definitions. */ definitionsVersion: string; /** * The timestamp of the most recently completed scan, or empty if there has never been a scan. */ scanCompletedTime: string; /** * The timestamp of the most recently scheduled scan, or empty if no scan has been scheduled. */ scanScheduledTime: string; /** * The timestamp of the most recently started scan, or empty if there has never been a scan. */ scanStartedTime: string; } interface SecretArchiveReferenceResponse { /** * The resource ID of the key vault containing the secret. */ keyVaultId: string; /** * The name of the secret in the key vault. */ secretName: string; /** * The version of the secret in the key vault. */ secretVersion: string; } interface SecretArchiveSettingsResponse { /** * The selection of the managed identity to use with this vault URI. The identity type must be either system assigned or user assigned. */ associatedIdentity?: outputs.networkcloud.IdentitySelectorResponse; /** * The URI for the key vault used as the secret archive. */ vaultUri?: string; } interface SecretRotationStatusResponse { /** * The maximum number of days the secret may be used before it must be changed. */ expirePeriodDays: number; /** * The date and time when the secret was last changed. */ lastRotationTime: string; /** * The number of days a secret exists before rotations will be attempted. */ rotationPeriodDays: number; /** * The reference to the secret in a key vault. */ secretArchiveReference: outputs.networkcloud.SecretArchiveReferenceResponse; /** * The type name used to identify the purpose of the secret. */ secretType: string; } interface ServiceLoadBalancerBgpPeerResponse { /** * The indicator of BFD enablement for this BgpPeer. */ bfdEnabled?: string; /** * The indicator to enable multi-hop peering support. */ bgpMultiHop?: string; /** * Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP hold time value. This field uses ISO 8601 duration format, for example P1H. */ holdTime?: string; /** * Field Deprecated. The field was previously optional, now it will have no defined behavior and will be ignored. The requested BGP keepalive time value. This field uses ISO 8601 duration format, for example P1H. */ keepAliveTime?: string; /** * The autonomous system number used for the local end of the BGP session. */ myAsn?: number; /** * The name used to identify this BGP peer for association with a BGP advertisement. */ name: string; /** * The IPv4 or IPv6 address used to connect this BGP session. */ peerAddress: string; /** * The autonomous system number expected from the remote end of the BGP session. */ peerAsn: number; /** * The port used to connect this BGP session. */ peerPort?: number; } /** * serviceLoadBalancerBgpPeerResponseProvideDefaults sets the appropriate defaults for ServiceLoadBalancerBgpPeerResponse */ function serviceLoadBalancerBgpPeerResponseProvideDefaults(val: ServiceLoadBalancerBgpPeerResponse): ServiceLoadBalancerBgpPeerResponse; interface ServicePrincipalInformationResponse { /** * The application ID, also known as client ID, of the service principal. */ applicationId: string; /** * The password of the service principal. */ password: string; /** * The principal ID, also known as the object ID, of the service principal. */ principalId: string; /** * The tenant ID, also known as the directory ID, of the tenant in which the service principal is created. */ tenantId: string; } interface SshPublicKeyResponse { /** * The SSH public key data. */ keyData: string; } interface StorageApplianceConfigurationDataResponse { /** * The credentials of the administrative interface on this storage appliance. The password field is expected to be an Azure Key Vault key URL. Until the cluster is converted to utilize managed identity by setting the secret archive settings, the actual password value should be provided instead. */ adminCredentials: outputs.networkcloud.AdministrativeCredentialsResponse; /** * The slot that storage appliance is in the rack based on the BOM configuration. */ rackSlot: number; /** * The serial number of the appliance. */ serialNumber: string; /** * The user-provided name for the storage appliance that will be created from this specification. */ storageApplianceName?: string; } interface StorageProfileResponse { /** * The disk to use with this virtual machine. */ osDisk: outputs.networkcloud.OsDiskResponse; /** * The resource IDs of volumes that are requested to be attached to the virtual machine. */ volumeAttachments?: string[]; } /** * storageProfileResponseProvideDefaults sets the appropriate defaults for StorageProfileResponse */ function storageProfileResponseProvideDefaults(val: StorageProfileResponse): StorageProfileResponse; interface StringKeyValuePairResponse { /** * The key to the mapped value. */ key: string; /** * The value of the mapping key. */ value: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } interface TrunkedNetworkAttachmentConfigurationResponse { /** * The resource ID of the network that is being configured for attachment. */ networkId: string; /** * The indicator of how this network will be utilized by the Kubernetes cluster. */ pluginType?: string; } /** * trunkedNetworkAttachmentConfigurationResponseProvideDefaults sets the appropriate defaults for TrunkedNetworkAttachmentConfigurationResponse */ function trunkedNetworkAttachmentConfigurationResponseProvideDefaults(val: TrunkedNetworkAttachmentConfigurationResponse): TrunkedNetworkAttachmentConfigurationResponse; /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } interface ValidationThresholdResponse { /** * Selection of how the type evaluation is applied to the cluster calculation. */ grouping: string; /** * Selection of how the threshold should be evaluated. */ type: string; /** * The numeric threshold value. */ value: number; } interface VirtualMachinePlacementHintResponse { /** * The specification of whether this hint supports affinity or anti-affinity with the referenced resources. */ hintType: string; /** * The resource ID of the target object that the placement hints will be checked against, e.g., the bare metal node to host the virtual machine. */ resourceId: string; /** * The indicator of whether the hint is a hard or soft requirement during scheduling. */ schedulingExecution: string; /** * The scope for the virtual machine affinity or anti-affinity placement hint. It should always be "Machine" in the case of node affinity. */ scope: string; } interface VulnerabilityScanningSettingsResponse { /** * The mode selection for container vulnerability scanning. */ containerScan?: string; } /** * vulnerabilityScanningSettingsResponseProvideDefaults sets the appropriate defaults for VulnerabilityScanningSettingsResponse */ function vulnerabilityScanningSettingsResponseProvideDefaults(val: VulnerabilityScanningSettingsResponse): VulnerabilityScanningSettingsResponse; } export declare namespace networkfunction { /** * Emission policy properties. */ interface EmissionPoliciesPropertiesFormatResponse { /** * Emission policy destinations. */ emissionDestinations?: outputs.networkfunction.EmissionPolicyDestinationResponse[]; /** * Emission format type. */ emissionType?: string; } /** * Emission policy destination properties. */ interface EmissionPolicyDestinationResponse { /** * Emission destination type. */ destinationType?: string; } /** * Ingestion Policy properties. */ interface IngestionPolicyPropertiesFormatResponse { /** * Ingestion Sources. */ ingestionSources?: outputs.networkfunction.IngestionSourcesPropertiesFormatResponse[]; /** * The ingestion type. */ ingestionType?: string; } /** * Ingestion policy properties. */ interface IngestionSourcesPropertiesFormatResponse { /** * Resource ID. */ resourceId?: string; /** * Ingestion source type. */ sourceType?: string; } /** * Resource reference properties. */ interface ResourceReferenceResponse { /** * Resource ID. */ id: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace notificationhubs { /** * Description of a NotificationHub AdmCredential. */ interface AdmCredentialResponse { /** * Gets or sets the URL of the authorization token. */ authTokenUrl: string; /** * Gets or sets the client identifier. */ clientId: string; /** * Gets or sets the credential secret access key. */ clientSecret: string; } /** * Description of a NotificationHub ApnsCredential. */ interface ApnsCredentialResponse { /** * Gets or sets the APNS certificate. */ apnsCertificate?: string; /** * Gets or sets the issuer (iss) registered claim key, whose value is * your 10-character Team ID, obtained from your developer account */ appId?: string; /** * Gets or sets the name of the application */ appName?: string; /** * Gets or sets the certificate key. */ certificateKey?: string; /** * Gets or sets the endpoint of this credential. */ endpoint: string; /** * Gets or sets a 10-character key identifier (kid) key, obtained from * your developer account */ keyId?: string; /** * Gets or sets the APNS certificate Thumbprint */ thumbprint?: string; /** * Gets or sets provider Authentication Token, obtained through your * developer account */ token?: string; } /** * Description of a NotificationHub BaiduCredential. */ interface BaiduCredentialResponse { /** * Gets or sets baidu Api Key. */ baiduApiKey: string; /** * Gets or sets baidu Endpoint. */ baiduEndPoint: string; /** * Gets or sets baidu Secret Key */ baiduSecretKey: string; } /** * Description of a NotificationHub BrowserCredential. */ interface BrowserCredentialResponse { /** * Gets or sets web push subject. */ subject: string; /** * Gets or sets VAPID private key. */ vapidPrivateKey: string; /** * Gets or sets VAPID public key. */ vapidPublicKey: string; } /** * Description of a NotificationHub FcmV1Credential. */ interface FcmV1CredentialResponse { /** * Gets or sets client email. */ clientEmail: string; /** * Gets or sets private key. */ privateKey: string; /** * Gets or sets project id. */ projectId: string; } /** * Description of a NotificationHub GcmCredential. */ interface GcmCredentialResponse { /** * Gets or sets the GCM endpoint. */ gcmEndpoint?: string; /** * Gets or sets the Google API key. */ googleApiKey: string; } /** * A network authorization rule that filters traffic based on IP address. */ interface IpRuleResponse { /** * IP mask. */ ipMask: string; /** * List of access rights. */ rights: string[]; } /** * Description of a NotificationHub MpnsCredential. */ interface MpnsCredentialResponse { /** * Gets or sets the certificate key for this credential. */ certificateKey: string; /** * Gets or sets the MPNS certificate. */ mpnsCertificate: string; /** * Gets or sets the MPNS certificate Thumbprint */ thumbprint: string; } /** * A collection of network authorization rules. */ interface NetworkAclsResponse { /** * List of IP rules. */ ipRules?: outputs.notificationhubs.IpRuleResponse[]; /** * A default (public Internet) network authorization rule, which contains rights if no other network rule matches. */ publicNetworkRule?: outputs.notificationhubs.PublicInternetAuthorizationRuleResponse; } /** * Collection of Notification Hub or Notification Hub Namespace PNS credentials. */ interface PnsCredentialsResponse { /** * Description of a NotificationHub AdmCredential. */ admCredential?: outputs.notificationhubs.AdmCredentialResponse; /** * Description of a NotificationHub ApnsCredential. */ apnsCredential?: outputs.notificationhubs.ApnsCredentialResponse; /** * Description of a NotificationHub BaiduCredential. */ baiduCredential?: outputs.notificationhubs.BaiduCredentialResponse; /** * Description of a NotificationHub BrowserCredential. */ browserCredential?: outputs.notificationhubs.BrowserCredentialResponse; /** * Description of a NotificationHub FcmV1Credential. */ fcmV1Credential?: outputs.notificationhubs.FcmV1CredentialResponse; /** * Description of a NotificationHub GcmCredential. */ gcmCredential?: outputs.notificationhubs.GcmCredentialResponse; /** * Description of a NotificationHub MpnsCredential. */ mpnsCredential?: outputs.notificationhubs.MpnsCredentialResponse; /** * Description of a NotificationHub WnsCredential. */ wnsCredential?: outputs.notificationhubs.WnsCredentialResponse; /** * Description of a NotificationHub XiaomiCredential. */ xiaomiCredential?: outputs.notificationhubs.XiaomiCredentialResponse; } /** * Private Endpoint Connection properties. */ interface PrivateEndpointConnectionPropertiesResponse { /** * List of group ids. For Notification Hubs, it always contains a single "namespace" element. */ groupIds: string[]; /** * Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. */ privateEndpoint?: outputs.notificationhubs.RemotePrivateEndpointConnectionResponse; /** * State of the Private Link Service connection. */ privateLinkServiceConnectionState?: outputs.notificationhubs.RemotePrivateLinkServiceConnectionStateResponse; /** * State of Private Endpoint Connection. */ provisioningState?: string; } /** * Represents a Private Endpoint Connection ARM resource - a sub-resource of Notification Hubs namespace. */ interface PrivateEndpointConnectionResourceResponse { /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * Private Endpoint Connection properties. */ properties?: outputs.notificationhubs.PrivateEndpointConnectionPropertiesResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.notificationhubs.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * A default (public Internet) network authorization rule, which contains rights if no other network rule matches. */ interface PublicInternetAuthorizationRuleResponse { /** * List of access rights. */ rights: string[]; } /** * Represents a Private Endpoint that is connected to Notification Hubs namespace using Private Endpoint Connection. */ interface RemotePrivateEndpointConnectionResponse { /** * ARM resource ID of the Private Endpoint. This may belong to different subscription and resource group than a Notification Hubs namespace. */ id: string; } /** * State of the Private Link Service connection. */ interface RemotePrivateLinkServiceConnectionStateResponse { /** * Human-friendly description of required actions. */ actionsRequired: string; /** * Human-friendly description. */ description: string; /** * State of Private Link Connection. */ status?: string; } /** * SharedAccessAuthorizationRule properties. */ interface SharedAccessAuthorizationRulePropertiesResponse { /** * Gets a string that describes the claim type */ claimType: string; /** * Gets a string that describes the claim value */ claimValue: string; /** * Gets the created time for this rule */ createdTime: string; /** * Gets a string that describes the authorization rule. */ keyName: string; /** * Gets the last modified time for this rule */ modifiedTime: string; /** * Gets a base64-encoded 256-bit primary key for signing and * validating the SAS token. */ primaryKey?: string; /** * Gets the revision number for the rule */ revision: number; /** * Gets or sets the rights associated with the rule. */ rights: string[]; /** * Gets a base64-encoded 256-bit primary key for signing and * validating the SAS token. */ secondaryKey?: string; } /** * The Sku description for a namespace */ interface SkuResponse { /** * Gets or sets the capacity of the resource */ capacity?: number; /** * Gets or sets the Sku Family */ family?: string; /** * Namespace SKU name. */ name: string; /** * Gets or sets the Sku size */ size?: string; /** * Gets or sets the tier of particular sku */ tier?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Description of a NotificationHub WnsCredential. */ interface WnsCredentialResponse { /** * Ges or sets the WNS Certificate Key. */ certificateKey?: string; /** * Gets or sets the package ID for this credential. */ packageSid?: string; /** * Gets or sets the secret key. */ secretKey?: string; /** * Gets or sets the Windows Live endpoint. */ windowsLiveEndpoint?: string; /** * Gets or sets the WNS Certificate. */ wnsCertificate?: string; } /** * Description of a NotificationHub XiaomiCredential. */ interface XiaomiCredentialResponse { /** * Gets or sets app secret. */ appSecret?: string; /** * Gets or sets xiaomi service endpoint. */ endpoint?: string; } } export declare namespace offazure { /** * Error contract returned when some exception occurs in Rest API. */ interface HealthErrorDetailsResponse { /** * Gets the appliance name. */ applianceName: string; /** * Gets the error name. */ code: string; /** * Gets discovery scope for which error is encountered. */ discoveryScope: string; /** * Gets the error ID. */ id: number; /** * Gets the error message. */ message: string; /** * Gets the message parameters. */ messageParameters: { [key: string]: string; }; /** * Gets the possible causes of error. */ possibleCauses: string; /** * Gets the recommended action to resolve error. */ recommendedAction: string; /** * Gets run as account id used while performing discovery of entity. */ runAsAccountId: string; /** * Gets the error severity. */ severity: string; /** * Gets the error source. */ source: string; /** * Gets the error summary message. */ summaryMessage: string; /** * Gets the time stamp when the error was updated. */ updatedTimeStamp: string; } interface PrivateEndpointConnectionPropertiesResponse { privateEndpoint: outputs.offazure.ResourceIdResponse; privateLinkServiceConnectionState?: outputs.offazure.PrivateLinkServiceConnectionStateResponse; provisioningState: string; } /** * REST model used to encapsulate Private Link properties for tracked resources. */ interface PrivateEndpointConnectionResponse { /** * array of group ids */ groupIds: string[]; /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * private endpoints */ privateEndpoint: outputs.offazure.ResourceIdResponse; /** * private endpoints connection state */ privateLinkServiceConnectionState?: outputs.offazure.PrivateLinkServiceConnectionStateResponse; /** * provisioning state enum */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.offazure.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Service Connection State */ interface PrivateLinkServiceConnectionStateResponse { /** * actions required */ actionsRequired?: string; /** * description string */ description?: string; /** * state status */ status?: string; } /** * PrivateEndpointModelsResourceId */ interface ResourceIdResponse { /** * id name */ id: string; } /** * Class for site agent properties. */ interface SiteAgentPropertiesResponse { /** * Gets the ID of the agent. */ id: string; /** * Gets or sets the key vault ARM Id. */ keyVaultId?: string; /** * Gets or sets the key vault URI. */ keyVaultUri?: string; /** * Gets the last heartbeat time of the agent in UTC. */ lastHeartBeatUtc: string; /** * Gets the version of the agent. */ version: string; } /** * Class for site appliance properties. */ interface SiteAppliancePropertiesResponse { /** * Gets or sets the on-premises agent details. */ agentDetails?: outputs.offazure.SiteAgentPropertiesResponse; /** * Gets or sets the Appliance Name. */ applianceName?: string; /** * Gets or sets the service principal identity details used by agent for communication to the service. */ servicePrincipalIdentityDetails?: outputs.offazure.SiteSpnPropertiesResponse; } /** * The properties of ServerSiteResource. */ interface SiteHealthSummaryResponse { /** * Gets or sets the count of affected objects. */ affectedObjectsCount?: number; /** * Gets the affected resource type. */ affectedResourceType: string; /** * Gets or sets the affected resources. */ affectedResources?: string[]; /** * Gets the appliance name. */ applianceName: string; /** * Gets the error code. */ errorCode: string; /** * Gets the error Id. */ errorId: number; /** * Gets the error message. */ errorMessage: string; /** * Gets or sets sources of the exception. */ fabricLayoutUpdateSources?: string[]; /** * Gets or sets the hit count of the error. */ hitCount?: number; /** * Gets the remediation guidance. */ remediationGuidance: string; /** * Gets the severity of error. */ severity: string; /** * Gets the summary message. */ summaryMessage: string; } /** * Class for site properties. */ interface SitePropertiesResponse { /** * On-premises agent details. */ agentDetails?: outputs.offazure.SiteAgentPropertiesResponse; /** * Appliance Name. */ applianceName?: string; /** * ARM ID of migration hub solution for SDS. */ discoverySolutionId?: string; /** * Service endpoint. */ serviceEndpoint: string; /** * Service principal identity details used by agent for communication to the service. */ servicePrincipalIdentityDetails?: outputs.offazure.SiteSpnPropertiesResponse; } /** * Class for site properties. */ interface SiteSpnPropertiesResponse { /** * Gets or sets the AAD Authority URL which was used to request the token for * the * service principal. */ aadAuthority?: string; /** * Gets or sets the application/client Id for the service principal with which * the * on-premise management/data plane components would communicate * with our Azure * services. */ applicationId?: string; /** * Gets or sets the intended audience for the service principal. */ audience?: string; /** * Gets or sets the object Id of the service principal with which the on-premise * * management/data plane components would communicate with our Azure * services. */ objectId?: string; /** * Gets or sets the raw certificate data for building certificate expiry flows. */ rawCertData?: string; /** * Gets or sets the tenant Id for the service principal with which the * on-premise * management/data plane components would communicate with * our Azure services. */ tenantId?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace offazurespringboot { /** * Defines the error. */ interface ErrorResponse { /** * The error code. */ code?: string; /** * The error ID. */ id?: number; /** * The detailed error message. */ message?: string; /** * The error possible causes. */ possibleCauses?: string; /** * The error recommended action */ recommendedAction?: string; /** * The account ID used to login. */ runAsAccountId?: string; /** * The error severity */ severity?: string; /** * The summarized error message. */ summaryMessage?: string; /** * Time when this error was last updated. */ updatedTimeStamp?: string; } /** * The springbootapps resource definition. */ interface SpringbootappsPropertiesResponse { /** * The name of SpringBootApp. */ appName?: string; /** * The application port. */ appPort?: number; /** * The application type, whether it is a SpringBoot app. */ appType?: string; /** * The application configuration file list. */ applicationConfigurations?: outputs.offazurespringboot.SpringbootappsPropertiesResponseApplicationConfigurations[]; /** * The artifact name of SpringBootApp. */ artifactName?: string; /** * The application binding port list. */ bindingPorts?: number[]; /** * The jdk version in build. */ buildJdkVersion?: string; /** * The certificate file list. */ certificates?: string[]; /** * The checksum of jar file. */ checksum?: string; /** * The connection string list. */ connectionStrings?: string[]; /** * The dependency list. */ dependencies?: string[]; /** * The environment variable list. */ environments?: string[]; /** * The list of errors. */ errors?: outputs.offazurespringboot.ErrorResponse[]; /** * The total instance count the app deployed. */ instanceCount?: number; /** * The breakdown info for app instances on all the servers */ instances?: outputs.offazurespringboot.SpringbootappsPropertiesResponseInstances[]; /** * The jar file location on the server. */ jarFileLocation?: string; /** * The jvm heap memory allocated. */ jvmMemoryInMB?: number; /** * The jvm options. */ jvmOptions?: string[]; /** * Resource labels */ labels?: { [key: string]: string; }; /** * Time when this springbootapps jar file was last modified. */ lastModifiedTime?: string; /** * Time when this springbootapps instance was last refreshed. */ lastUpdatedTime?: string; /** * The machine ARM id list the app belongs to. */ machineArmIds?: string[]; /** * The other types of date collected. */ miscs?: outputs.offazurespringboot.SpringbootappsPropertiesResponseMiscs[]; /** * The resource provisioning state. */ provisioningState: string; /** * The jdk version installed on server */ runtimeJdkVersion?: string; /** * The server list the app installed */ servers?: string[]; /** * The spring boot version. */ springBootVersion?: string; /** * The static content location list. */ staticContentLocations?: string[]; } interface SpringbootappsPropertiesResponseApplicationConfigurations { /** * The application config file name. */ key: string; /** * The application config file content, only contains config keys. */ value?: string; } interface SpringbootappsPropertiesResponseInstances { /** * The instance count of this app instance */ instanceCount?: number; /** * The jvm heap memory allocated of this app instance */ jvmMemoryInMB?: number; /** * The machine ARM resource Id of this app instance */ machineArmId: string; } interface SpringbootappsPropertiesResponseMiscs { /** * The miscs. key. */ key: string; /** * The miscs. value. */ value?: string; } /** * The springbootservers resource definition. */ interface SpringbootserversPropertiesResponse { /** * The list of errors. */ errors?: outputs.offazurespringboot.ErrorResponse[]; /** * The alternative FQDN or IP addresses to discover for this server */ fqdnAndIpAddressList?: string[]; /** * Resource labels */ labels?: { [key: string]: string; }; /** * The machine Id from ARM */ machineArmId?: string; /** * Target server port for remote login */ port?: number; /** * The resource provisioning state. */ provisioningState?: string; /** * Server is the target server name or ip address to discover of SpringBootServer. */ server: string; /** * The total number of spring boot apps been discovered */ springBootApps?: number; /** * The total number of apps been discovered */ totalApps?: number; } /** * The extended location definition. */ interface SpringbootsitesModelResponseExtendedLocation { /** * The extended location name. */ name?: string; /** * The extended location type. */ type?: string; } /** * The springbootsites resource definition. */ interface SpringbootsitesPropertiesResponse { /** * The master site ID from Azure Migrate. */ masterSiteId?: string; /** * The migrate project ID from Azure Migrate. */ migrateProjectId?: string; /** * The resource provisioning state. */ provisioningState?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace onlineexperimentation { /** * Customer-managed key encryption properties for the resource. */ interface CustomerManagedKeyEncryptionResponse { /** * All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. */ keyEncryptionKeyIdentity?: outputs.onlineexperimentation.KeyEncryptionKeyIdentityResponse; /** * key encryption key Url, versioned or non-versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. */ keyEncryptionKeyUrl?: string; } /** * All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. */ interface KeyEncryptionKeyIdentityResponse { /** * application client identity to use for accessing key encryption key Url in a different tenant. Ex: f83c6b1b-4d34-47e4-bb34-9d83df58b540 */ federatedClientId?: string; /** * The type of identity to use. Values can be systemAssignedIdentity, userAssignedIdentity, or delegatedResourceIdentity. */ identityType?: string; /** * User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions/fa5fc227-a624-475e-b696-cdd604c735bc/resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. Mutually exclusive with identityType systemAssignedIdentity. */ userAssignedIdentityResourceId?: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.onlineexperimentation.UserAssignedIdentityResponse; }; } /** * The properties of an online experimentation workspace. */ interface OnlineExperimentationWorkspacePropertiesResponse { /** * The resource identifier of App Configuration with which this online experimentation workspace is tied for experimentation. This is a required field for creating an online experimentation workspace. */ appConfigurationResourceId: string; /** * The encryption configuration for the online experimentation workspace resource. */ encryption?: outputs.onlineexperimentation.ResourceEncryptionConfigurationResponse; /** * The data plane endpoint for the online experimentation workspace resource. */ endpoint: string; /** * The resource identifier of the Log Analytics workspace which online experimentation workspace uses for generating experiment analysis results. */ logAnalyticsWorkspaceResourceId: string; /** * The resource identifier of storage account where logs are exported from Log Analytics workspace. online experimentation workspace uses it generating experiment analysis results. */ logsExporterStorageAccountResourceId: string; /** * The provisioning state for the resource */ provisioningState: string; /** * The Id of the workspace. */ workspaceId: string; } /** * The SKU (Stock Keeping Unit) assigned to this resource. */ interface OnlineExperimentationWorkspaceSkuResponse { /** * The name of the SKU. Ex - F0, P0. It is typically a letter+number code */ name: string; /** * The name of the SKU tier */ tier: string; } /** * Properties of the private endpoint connection. */ interface PrivateEndpointConnectionPropertiesResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * The private endpoint resource. */ privateEndpoint?: outputs.onlineexperimentation.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.onlineexperimentation.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * The encryption configuration for the online experimentation workspace resource. */ interface ResourceEncryptionConfigurationResponse { /** * All Customer-managed key encryption properties for the resource. */ customerManagedKeyEncryption?: outputs.onlineexperimentation.CustomerManagedKeyEncryptionResponse; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace openenergyplatform { /** * The list of Energy services resource's Data Partition Names. */ interface DataPartitionNamesResponse { name?: string; } /** * Defines the properties of an individual data partition. */ interface DataPartitionPropertiesResponse { /** * Name of the data partition */ name?: string; /** * Name of the data partition */ provisioningState?: string; } interface EnergyServicePropertiesResponse { authAppId?: string; dataPartitionNames?: outputs.openenergyplatform.DataPartitionNamesResponse[]; dnsName: string; provisioningState: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace operationalinsights { /** * The list of Log Analytics workspaces associated with the cluster. */ interface AssociatedWorkspaceResponse { /** * The time of workspace association. */ associateDate: string; /** * Associated workspace arm resource id, in the form of: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}. */ resourceId: string; /** * Associated workspace immutable id. */ workspaceId: string; /** * Associated workspace resource name. */ workspaceName: string; } /** * The Capacity Reservation properties. */ interface CapacityReservationPropertiesResponse { /** * The last time Sku was updated. */ lastSkuUpdate: string; /** * Minimum CapacityReservation value in Gigabytes. */ minCapacity: number; } /** * The cluster sku definition. */ interface ClusterSkuResponse { /** * The capacity reservation level in Gigabytes for this cluster. */ capacity?: number; /** * The SKU (tier) of a cluster. */ name?: string; } /** * Table column. */ interface ColumnResponse { /** * Column data type logical hint. */ dataTypeHint?: string; /** * Column description. */ description?: string; /** * Column display name. Can be set at creation time; after creation, updates must either match column name or set to null/empty. If not provided, defaults to column name. */ displayName?: string; /** * Is displayed by default. */ isDefaultDisplay: boolean; /** * Is column hidden. */ isHidden: boolean; /** * Column name. */ name?: string; /** * Column data type. */ type?: string; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * Type of managed service identity. */ type: string; /** * The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.operationalinsights.UserIdentityPropertiesResponse; }; } /** * The key vault properties. */ interface KeyVaultPropertiesResponse { /** * The name of the key associated with the Log Analytics cluster. */ keyName?: string; /** * Selected key minimum required size. */ keyRsaSize?: number; /** * The Key Vault uri which holds they key associated with the Log Analytics cluster. */ keyVaultUri?: string; /** * The version of the key associated with the Log Analytics cluster. */ keyVersion?: string; } /** * The related metadata items for the function. */ interface LogAnalyticsQueryPackQueryPropertiesResponseRelated { /** * The related categories for the function. */ categories?: string[]; /** * The related resource types for the function. */ resourceTypes?: string[]; /** * The related Log Analytics solutions for the function. */ solutions?: string[]; } /** * A machine reference with a hint of the machine's name and operating system. */ interface MachineReferenceWithHintsResponse { /** * Last known display name. */ displayNameHint: string; /** * Resource URI. */ id: string; /** * Specifies the sub-class of the reference. * Expected value is 'ref:machinewithhints'. */ kind: "ref:machinewithhints"; /** * Resource name. */ name: string; /** * Last known operating system family. */ osFamilyHint: string; /** * Resource type qualifier. */ type: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.operationalinsights.UserAssignedIdentityResponse; }; } /** * The private link scope resource reference. */ interface PrivateLinkScopedResourceResponse { /** * The full resource Id of the private link scope resource. */ resourceId?: string; /** * The private link scope unique Identifier. */ scopeId?: string; } /** * Restore parameters. */ interface RestoredLogsResponse { /** * Search results table async operation id. */ azureAsyncOperationId: string; /** * The timestamp to end the restore by (UTC). */ endRestoreTime?: string; /** * The table to restore data from. */ sourceTable?: string; /** * The timestamp to start the restore from (UTC). */ startRestoreTime?: string; } /** * Search job execution statistics. */ interface ResultStatisticsResponse { /** * The number of rows that were returned by the search job. */ ingestedRecords: number; /** * Search job completion percentage. */ progress: number; /** * Search job: Amount of scanned data. */ scannedGb: number; } /** * Rule definition parameters. */ interface RuleDefinitionResponse { /** * The minimum delay in seconds before bin processing. */ binDelay?: number; /** * Scheduled window in minutes. Allowed values: 20, 30, 60, 120, 180, 360, 720, 1440. */ binSize?: number; /** * The start time (UTC) when Summary rule execution starts. */ binStartTime?: string; /** * The destination table used for the Summary rule results. */ destinationTable?: string; /** * Summary rule query. */ query?: string; /** * The time cursor used in Summary rules bins processing, e.g. TimeGenerated. */ timeSelector?: string; } /** * Table's schema. */ interface SchemaResponse { /** * Table category. */ categories: string[]; /** * A list of table custom columns. */ columns?: outputs.operationalinsights.ColumnResponse[]; /** * Table description. */ description?: string; /** * Table display name. */ displayName?: string; /** * Table labels. */ labels: string[]; /** * Table name. */ name?: string; /** * List of solutions the table is affiliated with */ solutions: string[]; /** * Table's creator. */ source: string; /** * A list of table standard columns. */ standardColumns: outputs.operationalinsights.ColumnResponse[]; /** * The subtype describes what APIs can be used to interact with the table, and what features are available against it. */ tableSubType: string; /** * Table's creator. */ tableType: string; } /** * Parameters of the search job that initiated this table. */ interface SearchResultsResponse { /** * Search results table async operation id. */ azureAsyncOperationId: string; /** * Search job Description. */ description?: string; /** * The timestamp to end the search by (UTC) */ endSearchTime?: string; /** * Limit the search job to return up to specified number of rows. */ limit?: number; /** * Search job query. */ query?: string; /** * The table used in the search job. */ sourceTable: string; /** * The timestamp to start the search from (UTC) */ startSearchTime?: string; } /** * Describes a storage account connection. */ interface StorageAccountResponse { /** * The Azure Resource Manager ID of the storage account resource. */ id: string; /** * The storage account key. */ key: string; } /** * The status of the storage insight. */ interface StorageInsightStatusResponse { /** * Description of the state of the storage insight. */ description?: string; /** * The state of the storage insight connection to the workspace */ state: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * A tag of a saved search. */ interface TagResponse { /** * The tag name. */ name: string; /** * The tag value. */ value: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * User assigned identity properties. */ interface UserIdentityPropertiesResponse { /** * The client id of user assigned identity. */ clientId: string; /** * The principal id of user assigned identity. */ principalId: string; } /** * The daily volume cap for ingestion. */ interface WorkspaceCappingResponse { /** * The workspace daily quota for ingestion. */ dailyQuotaGb?: number; /** * The status of data ingestion for this workspace. */ dataIngestionStatus: string; /** * The time when the quota will be rest. */ quotaNextResetTime: string; } /** * Workspace features. */ interface WorkspaceFeaturesResponse { /** * Dedicated LA cluster resourceId that is linked to the workspaces. */ clusterResourceId?: string; /** * Disable Non-AAD based Auth. */ disableLocalAuth?: boolean; /** * Flag that indicate if data should be exported. */ enableDataExport?: boolean; /** * Flag that indicate which permission to use - resource or workspace or both. */ enableLogAccessUsingOnlyResourcePermissions?: boolean; /** * Flag that describes if we want to remove the data after 30 days. */ immediatePurgeDataOn30Days?: boolean; /** * An indication if the specify workspace is limited to sentinel's unified billing model only. */ unifiedSentinelBillingOnly: boolean; } /** * The SKU (tier) of a workspace. */ interface WorkspaceSkuResponse { /** * The capacity reservation level in GB for this workspace, when CapacityReservation sku is selected. */ capacityReservationLevel?: number; /** * The last time when the sku was updated. */ lastSkuUpdate: string; /** * The name of the SKU. */ name: string; } } export declare namespace operationsmanagement { /** * Parameter to pass to ARM template */ interface ArmTemplateParameterResponse { /** * name of the parameter. */ name?: string; /** * value for the parameter. In Jtoken */ value?: string; } /** * ManagementAssociation properties supported by the OperationsManagement resource provider. */ interface ManagementAssociationPropertiesResponse { /** * The applicationId of the appliance for this association. */ applicationId: string; } /** * ManagementConfiguration properties supported by the OperationsManagement resource provider. */ interface ManagementConfigurationPropertiesResponse { /** * The applicationId of the appliance for this Management. */ applicationId?: string; /** * Parameters to run the ARM template */ parameters: outputs.operationsmanagement.ArmTemplateParameterResponse[]; /** * The type of the parent resource. */ parentResourceType: string; /** * The provisioning state for the ManagementConfiguration. */ provisioningState: string; /** * The Json object containing the ARM template to deploy */ template: any; } /** * Plan for solution object supported by the OperationsManagement resource provider. */ interface SolutionPlanResponse { /** * name of the solution to be created. For Microsoft published solution it should be in the format of solutionType(workspaceName). SolutionType part is case sensitive. For third party solution, it can be anything. */ name?: string; /** * name of the solution to enabled/add. For Microsoft published gallery solution it should be in the format of OMSGallery/. This is case sensitive */ product?: string; /** * promotionCode, Not really used now, can you left as empty */ promotionCode?: string; /** * Publisher name. For gallery solution, it is Microsoft. */ publisher?: string; } /** * Solution properties supported by the OperationsManagement resource provider. */ interface SolutionPropertiesResponse { /** * The azure resources that will be contained within the solutions. They will be locked and gets deleted automatically when the solution is deleted. */ containedResources?: string[]; /** * The provisioning state for the solution. */ provisioningState: string; /** * The resources that will be referenced from this solution. Deleting any of those solution out of band will break the solution. */ referencedResources?: string[]; /** * The azure resourceId for the workspace where the solution will be deployed/enabled. */ workspaceResourceId: string; } } export declare namespace orbital { /** * Authorized groundstation. */ interface AuthorizedGroundstationResponse { /** * Date of authorization expiration. */ expirationDate: string; /** * Groundstation name. */ groundStation: string; } /** * Customer retrieves list of Available Contacts for a spacecraft resource. Later, one of the available contact can be selected to create a contact. */ interface AvailableContactsResponse { /** * Azimuth of the antenna at the end of the contact in decimal degrees. */ endAzimuthDegrees: number; /** * Spacecraft elevation above the horizon at contact end. */ endElevationDegrees: number; /** * Name of Azure Ground Station. */ groundStationName: string; /** * Maximum elevation of the antenna during the contact in decimal degrees. */ maximumElevationDegrees: number; /** * Time to lost receiving a signal (ISO 8601 UTC standard). */ rxEndTime: string; /** * Earliest time to receive a signal (ISO 8601 UTC standard). */ rxStartTime: string; /** * The reference to the spacecraft resource. */ spacecraft?: outputs.orbital.AvailableContactsResponseSpacecraft; /** * Azimuth of the antenna at the start of the contact in decimal degrees. */ startAzimuthDegrees: number; /** * Spacecraft elevation above the horizon at contact start. */ startElevationDegrees: number; /** * Time at which antenna transmit will be disabled (ISO 8601 UTC standard). */ txEndTime: string; /** * Time at which antenna transmit will be enabled (ISO 8601 UTC standard). */ txStartTime: string; } /** * The reference to the spacecraft resource. */ interface AvailableContactsResponseSpacecraft { /** * Resource ID. */ id: string; } /** * Contact Profile Link Channel. */ interface ContactProfileLinkChannelResponse { /** * Bandwidth in MHz. */ bandwidthMHz: number; /** * Center Frequency in MHz. */ centerFrequencyMHz: number; /** * Currently unused. */ decodingConfiguration?: string; /** * Copy of the modem configuration file such as Kratos QRadio or Kratos QuantumRx. Only valid for downlink directions. If provided, the modem connects to the customer endpoint and sends demodulated data instead of a VITA.49 stream. */ demodulationConfiguration?: string; /** * Currently unused. */ encodingConfiguration?: string; /** * Customer end point to store and retrieve data during a contact with the spacecraft. */ endPoint: outputs.orbital.EndPointResponse; /** * Copy of the modem configuration file such as Kratos QRadio. Only valid for uplink directions. If provided, the modem connects to the customer endpoint and accepts commands from the customer instead of a VITA.49 stream. */ modulationConfiguration?: string; /** * Channel name. */ name: string; } /** * Contact Profile Link. */ interface ContactProfileLinkResponse { /** * Contact Profile Link Channel. */ channels: outputs.orbital.ContactProfileLinkChannelResponse[]; /** * Direction (Uplink or Downlink). */ direction: string; /** * Effective Isotropic Radiated Power (EIRP) in dBW. It is the required EIRP by the customer. Not used yet. */ eirpdBW?: number; /** * Gain to noise temperature in db/K. It is the required G/T by the customer. Not used yet. */ gainOverTemperature?: number; /** * Link name. */ name: string; /** * Polarization. e.g. (RHCP, LHCP). */ polarization: string; } /** * Contact Profile third-party partner configuration. */ interface ContactProfileThirdPartyConfigurationResponse { /** * Name of string referencing the configuration describing contact set-up for a particular mission. Expected values are those which have been created in collaboration with the partner network. */ missionConfiguration: string; /** * Name of the third-party provider. */ providerName: string; } /** * Network configuration of customer virtual network. */ interface ContactProfilesPropertiesResponseNetworkConfiguration { /** * ARM resource identifier of the subnet delegated to the Microsoft.Orbital/orbitalGateways. Needs to be at least a class C subnet, and should not have any IP created in it. */ subnetId: string; } /** * The configuration associated with the allocated antenna. */ interface ContactsPropertiesResponseAntennaConfiguration { /** * The destination IP a packet can be sent to. This would for example be the TCP endpoint you would send data to. */ destinationIp?: string; /** * List of Source IP */ sourceIps?: string[]; } /** * The reference to the contact profile resource. */ interface ContactsPropertiesResponseContactProfile { /** * Resource ID. */ id: string; } /** * A reference to global communications site. */ interface EdgeSitesPropertiesResponseGlobalCommunicationsSite { /** * Resource ID. */ id: string; } /** * Customer end point to store and retrieve data during a contact with the spacecraft. */ interface EndPointResponse { /** * Name of an end point. */ endPointName: string; /** * IP Address (IPv4). */ ipAddress: string; /** * TCP port to listen on to receive data. */ port: string; /** * Protocol either UDP or TCP. */ protocol: string; } /** * The details of the Microsoft Planetary Computer Pro GeoCatalog. */ interface GeoCatalogPropertiesResponse { /** * The scope of the auto-generated domain name label. If not provided, defaults to TenantReuse. */ autoGeneratedDomainNameLabelScope?: string; /** * The URI of the catalog management UI. */ catalogUri: string; /** * The status of the last operation. */ provisioningState: string; /** * Tier of the catalog. This cannot be changed after the catalog is created. If not provided, defaults to Basic. */ tier?: string; } /** * geoCatalogPropertiesResponseProvideDefaults sets the appropriate defaults for GeoCatalogPropertiesResponse */ function geoCatalogPropertiesResponseProvideDefaults(val: GeoCatalogPropertiesResponse): GeoCatalogPropertiesResponse; /** * A reference to global communications site. */ interface GroundStationsPropertiesResponseGlobalCommunicationsSite { /** * Resource ID. */ id: string; } /** * A reference to an Microsoft.Orbital/edgeSites resource to route traffic for. */ interface L2ConnectionsPropertiesResponseEdgeSite { /** * Resource ID. */ id: string; } /** * A reference to an Microsoft.Orbital/groundStations resource to route traffic for. */ interface L2ConnectionsPropertiesResponseGroundStation { /** * Resource ID. */ id: string; } /** * The name of the partner router to establish a connection to within the ground station. */ interface L2ConnectionsPropertiesResponseGroundStationPartnerRouter { /** * The unique name of the partner router that cross-connects with the Orbital Edge Router at the ground station site. */ name: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.orbital.UserAssignedIdentityResponse; }; } interface ResourceIdListResultResponseValue { /** * The Azure Resource ID. */ id?: string; } /** * List of authorized spacecraft links per ground station and the expiration date of the authorization. */ interface SpacecraftLinkResponse { /** * Authorized Ground Stations */ authorizations: outputs.orbital.AuthorizedGroundstationResponse[]; /** * Bandwidth in MHz. */ bandwidthMHz: number; /** * Center Frequency in MHz. */ centerFrequencyMHz: number; /** * Direction (Uplink or Downlink). */ direction: string; /** * Link name. */ name: string; /** * Polarization. e.g. (RHCP, LHCP). */ polarization: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace peering { /** * The properties that define a BGP session. */ interface BgpSessionResponse { /** * The maximum number of prefixes advertised over the IPv4 session. */ maxPrefixesAdvertisedV4?: number; /** * The maximum number of prefixes advertised over the IPv6 session. */ maxPrefixesAdvertisedV6?: number; /** * The MD5 authentication key of the session. */ md5AuthenticationKey?: string; /** * The IPv4 session address on Microsoft's end. */ microsoftSessionIPv4Address?: string; /** * The IPv6 session address on Microsoft's end. */ microsoftSessionIPv6Address?: string; /** * The IPv4 session address on peer's end. */ peerSessionIPv4Address?: string; /** * The IPv6 session address on peer's end. */ peerSessionIPv6Address?: string; /** * The IPv4 prefix that contains both ends' IPv4 addresses. */ sessionPrefixV4?: string; /** * The IPv6 prefix that contains both ends' IPv6 addresses. */ sessionPrefixV6?: string; /** * The state of the IPv4 session. */ sessionStateV4: string; /** * The state of the IPv6 session. */ sessionStateV6: string; } /** * The contact detail class. */ interface ContactDetailResponse { /** * The e-mail address of the contact. */ email?: string; /** * The phone number of the contact. */ phone?: string; /** * The role of the contact. */ role?: string; } /** * The properties that define a direct connection. */ interface DirectConnectionResponse { /** * The bandwidth of the connection. */ bandwidthInMbps?: number; /** * The BGP session associated with the connection. */ bgpSession?: outputs.peering.BgpSessionResponse; /** * The unique identifier (GUID) for the connection. */ connectionIdentifier?: string; /** * The state of the connection. */ connectionState: string; /** * The error message related to the connection state, if any. */ errorMessage: string; /** * The ID used within Microsoft's peering provisioning system to track the connection */ microsoftTrackingId: string; /** * The PeeringDB.com ID of the facility at which the connection has to be set up. */ peeringDBFacilityId?: number; /** * The bandwidth that is actually provisioned. */ provisionedBandwidthInMbps: number; /** * The field indicating if Microsoft provides session ip addresses. */ sessionAddressProvider?: string; /** * The flag that indicates whether or not the connection is used for peering service. */ useForPeeringService?: boolean; } /** * The properties that define an exchange connection. */ interface ExchangeConnectionResponse { /** * The BGP session associated with the connection. */ bgpSession?: outputs.peering.BgpSessionResponse; /** * The unique identifier (GUID) for the connection. */ connectionIdentifier?: string; /** * The state of the connection. */ connectionState: string; /** * The error message related to the connection state, if any. */ errorMessage: string; /** * The PeeringDB.com ID of the facility at which the connection has to be set up. */ peeringDBFacilityId?: number; } /** * The properties that define a Log Analytics Workspace. */ interface LogAnalyticsWorkspacePropertiesResponse { /** * The list of connected agents. */ connectedAgents: string[]; /** * The Workspace Key. */ key: string; /** * The Workspace ID. */ workspaceID: string; } /** * The properties that define a direct peering. */ interface PeeringPropertiesDirectResponse { /** * The set of connections that constitute a direct peering. */ connections?: outputs.peering.DirectConnectionResponse[]; /** * The type of direct peering. */ directPeeringType?: string; /** * The reference of the peer ASN. */ peerAsn?: outputs.peering.SubResourceResponse; /** * The flag that indicates whether or not the peering is used for peering service. */ useForPeeringService: boolean; } /** * The properties that define an exchange peering. */ interface PeeringPropertiesExchangeResponse { /** * The set of connections that constitute an exchange peering. */ connections?: outputs.peering.ExchangeConnectionResponse[]; /** * The reference of the peer ASN. */ peerAsn?: outputs.peering.SubResourceResponse; } /** * The details of the event associated with a prefix. */ interface PeeringServicePrefixEventResponse { /** * The description of the event associated with a prefix. */ eventDescription: string; /** * The level of the event associated with a prefix. */ eventLevel: string; /** * The summary of the event associated with a prefix. */ eventSummary: string; /** * The timestamp of the event associated with a prefix. */ eventTimestamp: string; /** * The type of the event associated with a prefix. */ eventType: string; } /** * The SKU that defines the type of the peering service. */ interface PeeringServiceSkuResponse { /** * The name of the peering service SKU. */ name?: string; } /** * The SKU that defines the tier and kind of the peering. */ interface PeeringSkuResponse { /** * The family of the peering SKU. */ family: string; /** * The name of the peering SKU. */ name?: string; /** * The size of the peering SKU. */ size: string; /** * The tier of the peering SKU. */ tier: string; } /** * The sub resource. */ interface SubResourceResponse { /** * The identifier of the referenced resource. */ id?: string; } } export declare namespace policyinsights { /** * A piece of evidence supporting the compliance state set in the attestation. */ interface AttestationEvidenceResponse { /** * The description for this piece of evidence. */ description?: string; /** * The URI location of the evidence. */ sourceUri?: string; } /** * Error definition. */ interface ErrorDefinitionResponse { /** * Additional scenario specific error details. */ additionalInfo: outputs.policyinsights.TypedErrorInfoResponse[]; /** * Service specific error code which serves as the substatus for the HTTP error code. */ code: string; /** * Internal error details. */ details: outputs.policyinsights.ErrorDefinitionResponse[]; /** * Description of the error. */ message: string; /** * The target of the error. */ target: string; } /** * Details of a single deployment created by the remediation. */ interface RemediationDeploymentResponse { /** * The time at which the remediation was created. */ createdOn: string; /** * Resource ID of the template deployment that will remediate the resource. */ deploymentId: string; /** * Error encountered while remediated the resource. */ error: outputs.policyinsights.ErrorDefinitionResponse; /** * The time at which the remediation deployment was last updated. */ lastUpdatedOn: string; /** * Resource ID of the resource that is being remediated by the deployment. */ remediatedResourceId: string; /** * Location of the resource that is being remediated. */ resourceLocation: string; /** * Status of the remediation deployment. */ status: string; } /** * The deployment status summary for all deployments created by the remediation. */ interface RemediationDeploymentSummaryResponse { /** * The number of deployments required by the remediation that have failed. */ failedDeployments: number; /** * The number of deployments required by the remediation that have succeeded. */ successfulDeployments: number; /** * The number of deployments required by the remediation. */ totalDeployments: number; } /** * The filters that will be applied to determine which resources to remediate. */ interface RemediationFiltersResponse { /** * The resource locations that will be remediated. */ locations?: string[]; /** * The IDs of the resources that will be remediated. Can specify at most 100 IDs. This filter cannot be used when ReEvaluateCompliance is set to ReEvaluateCompliance, and cannot be empty if provided. */ resourceIds?: string[]; } /** * The remediation failure threshold settings */ interface RemediationPropertiesFailureThresholdResponse { /** * A number between 0.0 to 1.0 representing the percentage failure threshold. The remediation will fail if the percentage of failed remediation operations (i.e. failed deployments) exceeds this threshold. */ percentage?: number; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Scenario specific error details. */ interface TypedErrorInfoResponse { /** * The scenario specific error details. */ info: any; /** * The type of included error details. */ type: string; } } export declare namespace portal { /** * Tenant Configuration Properties with Provisioning state */ interface ConfigurationPropertiesResponse { /** * When flag is set to true Markdown tile will require external storage configuration (URI). The inline content configuration will be prohibited. */ enforcePrivateMarkdownStorage?: boolean; /** * The status of the last operation. */ provisioningState: string; } /** * Cloud shell console properties. */ interface ConsolePropertiesResponse { /** * The operating system type of the cloud shell. */ osType: string; /** * Provisioning state of the console. */ provisioningState: string; /** * Uri of the console. */ uri: string; } /** * A dashboard lens. */ interface DashboardLensResponse { /** * The dashboard len's metadata. */ metadata?: any; /** * The lens order. */ order: number; /** * The dashboard parts. */ parts: outputs.portal.DashboardPartsResponse[]; } /** * A dashboard part metadata. */ interface DashboardPartMetadataResponse { /** * Inputs to dashboard part. */ inputs?: any[]; /** * Settings of dashboard part. */ settings?: { [key: string]: any; }; /** * The type of dashboard part. */ type: string; } /** * The dashboard's part position. */ interface DashboardPartsPositionResponse { /** * The dashboard's part column span. */ colSpan: number; /** * The dashboard part's metadata. */ metadata?: any; /** * The dashboard's part row span. */ rowSpan: number; /** * The dashboard's part x coordinate. */ x: number; /** * The dashboard's part y coordinate. */ y: number; } /** * A dashboard part. */ interface DashboardPartsResponse { /** * The dashboard's part metadata. */ metadata?: outputs.portal.DashboardPartMetadataResponse; /** * The dashboard's part position. */ position: outputs.portal.DashboardPartsPositionResponse; } /** * Dashboard Properties with Provisioning state */ interface DashboardPropertiesWithProvisioningStateResponse { /** * The dashboard lenses. */ lenses?: outputs.portal.DashboardLensResponse[]; /** * The dashboard metadata. */ metadata?: any; /** * The status of the last operation. */ provisioningState: string; } /** * The storage profile of the user settings. */ interface StorageProfileResponse { /** * Size of file share */ diskSizeInGB?: number; /** * Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - */ fileShareName?: string; /** * Full resource ID of storage account. */ storageAccountResourceId?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Settings for terminal appearance. */ interface TerminalSettingsResponse { /** * Size of terminal font. */ fontSize?: string; /** * Style of terminal font. */ fontStyle?: string; } /** * The cloud shell user settings properties. */ interface UserPropertiesResponse { /** * The preferred location of the cloud shell. */ preferredLocation: string; /** * The operating system type of the cloud shell. Deprecated, use preferredShellType. */ preferredOsType: string; /** * The shell type of the cloud shell. */ preferredShellType: string; /** * The storage profile of the user settings. */ storageProfile: outputs.portal.StorageProfileResponse; /** * Settings for terminal appearance. */ terminalSettings: outputs.portal.TerminalSettingsResponse; } /** * Violation information. */ interface ViolationResponse { /** * Error message. */ errorMessage: string; /** * Id of the item that violates tenant configuration. */ id: string; /** * Id of the user who owns violated item. */ userId: string; } } export declare namespace portalservices { /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace powerbi { interface AzureSkuResponse { /** * SKU name */ name: string; /** * SKU tier */ tier: string; } /** * ConnectionState information. */ interface ConnectionStateResponse { /** * Actions required (if any). */ actionsRequired?: string; /** * Description of the connection state. */ description?: string; /** * Status of the connection. */ status?: string; } interface PrivateEndpointConnectionResponse { /** * Specifies the id of the resource. */ id: string; /** * Specifies the name of the resource. */ name: string; /** * Specifies the private endpoint. */ privateEndpoint?: outputs.powerbi.PrivateEndpointResponse; /** * Specifies the connection state. */ privateLinkServiceConnectionState?: outputs.powerbi.ConnectionStateResponse; /** * Provisioning state of the Private Endpoint Connection. */ provisioningState?: string; /** * The system meta data relating to this resource. */ systemData: outputs.powerbi.SystemDataResponse; /** * Specifies the type of the resource. */ type: string; } interface PrivateEndpointResponse { /** * Specifies the id of private endpoint. */ id?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace powerbidedicated { /** * Represents the SKU name and Azure pricing tier for auto scale v-core resource. */ interface AutoScaleVCoreSkuResponse { /** * The capacity of an auto scale v-core resource. */ capacity?: number; /** * Name of the SKU level. */ name: string; /** * The name of the Azure pricing tier to which the SKU applies. */ tier?: string; } /** * Represents the SKU name and Azure pricing tier for PowerBI Dedicated capacity resource. */ interface CapacitySkuResponse { /** * The capacity of the SKU. */ capacity?: number; /** * Name of the SKU level. */ name: string; /** * The name of the Azure pricing tier to which the SKU applies. */ tier?: string; } /** * An array of administrator user identities */ interface DedicatedCapacityAdministratorsResponse { /** * An array of administrator user identities. */ members?: string[]; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace powerplatform { /** * The identity of the EnterprisePolicy. */ interface EnterprisePolicyIdentityResponse { /** * The principal id of EnterprisePolicy identity. */ systemAssignedIdentityPrincipalId: string; /** * The tenant id associated with the EnterprisePolicy. */ tenantId: string; /** * The type of identity used for the EnterprisePolicy. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity. */ type?: string; } /** * Url and version of the KeyVault Secret */ interface KeyPropertiesResponse { /** * The identifier of the key vault key used to encrypt data. */ name?: string; /** * The version of the identity which will be used to access key vault. */ version?: string; } /** * Settings concerning key vault encryption for a configuration store. */ interface KeyVaultPropertiesResponse { /** * Uri of KeyVault */ id?: string; /** * Identity of the secret that includes name and version. */ key?: outputs.powerplatform.KeyPropertiesResponse; } /** * The Private Endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * The encryption settings for a configuration store. */ interface PropertiesEncryptionResponse { /** * Key vault properties. */ keyVault?: outputs.powerplatform.KeyVaultPropertiesResponse; /** * The state of onboarding, which only appears in the response. */ state?: string; } /** * Settings concerning lockbox. */ interface PropertiesLockboxResponse { /** * lockbox configuration */ state?: string; } /** * Settings concerning network injection. */ interface PropertiesNetworkInjectionResponse { /** * Network injection configuration */ virtualNetworks?: outputs.powerplatform.VirtualNetworkPropertiesResponse[]; } /** * Properties of a subnet. */ interface SubnetPropertiesResponse { /** * Subnet name. */ name?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Settings concerning the virtual network. */ interface VirtualNetworkPropertiesResponse { /** * Uri of the virtual network. */ id?: string; /** * Properties of a subnet. */ subnet?: outputs.powerplatform.SubnetPropertiesResponse; } } export declare namespace privatedns { /** * An A record. */ interface ARecordResponse { /** * The IPv4 address of this A record. */ ipv4Address?: string; } /** * An AAAA record. */ interface AaaaRecordResponse { /** * The IPv6 address of this AAAA record. */ ipv6Address?: string; } /** * A CNAME record. */ interface CnameRecordResponse { /** * The canonical name for this CNAME record. */ cname?: string; } /** * An MX record. */ interface MxRecordResponse { /** * The domain name of the mail host for this MX record. */ exchange?: string; /** * The preference value for this MX record. */ preference?: number; } /** * A PTR record. */ interface PtrRecordResponse { /** * The PTR target domain name for this PTR record. */ ptrdname?: string; } /** * An SOA record. */ interface SoaRecordResponse { /** * The email contact for this SOA record. */ email?: string; /** * The expire time for this SOA record. */ expireTime?: number; /** * The domain name of the authoritative name server for this SOA record. */ host?: string; /** * The minimum value for this SOA record. By convention this is used to determine the negative caching duration. */ minimumTtl?: number; /** * The refresh value for this SOA record. */ refreshTime?: number; /** * The retry time for this SOA record. */ retryTime?: number; /** * The serial number for this SOA record. */ serialNumber?: number; } /** * An SRV record. */ interface SrvRecordResponse { /** * The port value for this SRV record. */ port?: number; /** * The priority value for this SRV record. */ priority?: number; /** * The target domain name for this SRV record. */ target?: string; /** * The weight value for this SRV record. */ weight?: number; } /** * Reference to another subresource. */ interface SubResourceResponse { /** * Resource ID. */ id?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * A TXT record. */ interface TxtRecordResponse { /** * The text value of this TXT record. */ value?: string[]; } } export declare namespace professionalservice { /** * The current Term object. */ interface ProfessionalServicePropertiesResponseTerm { /** * The end date of the current term */ endDate?: string; /** * The start date of the current term */ startDate?: string; /** * The unit term eg P1M,P1Y,P2Y,P3Y meaning month,1year,2year,3year respectively */ termUnit?: string; } /** * professionalService properties */ interface ProfessionalServiceResourceResponseProperties { /** * Whether the ProfessionalService subscription will auto renew upon term end. */ autoRenew?: boolean; /** * The billing period eg P1M,P1Y for monthly,yearly respectively */ billingPeriod?: string; /** * The created date of this resource. */ created: string; /** * Whether the current term is a Free Trial term */ isFreeTrial?: boolean; /** * The last modifier date if this resource. */ lastModified?: string; /** * The offer id. */ offerId?: string; /** * The metadata about the ProfessionalService subscription such as the AzureSubscriptionId and ResourceUri. */ paymentChannelMetadata?: { [key: string]: string; }; /** * The Payment channel for the ProfessionalServiceSubscription. */ paymentChannelType?: string; /** * The publisher id. */ publisherId?: string; /** * The quote id which the ProfessionalService will be purchase with. */ quoteId?: string; /** * The plan id. */ skuId?: string; /** * The ProfessionalService Subscription Status. */ status?: string; /** * The store front which initiates the purchase. */ storeFront?: string; /** * The current Term object. */ term?: outputs.professionalservice.ProfessionalServicePropertiesResponseTerm; /** * The unit term eg P1M,P1Y,P2Y,P3Y meaning month,1year,2year,3year respectively */ termUnit?: string; } } export declare namespace programenrollment { /** * A group of edu domains scoped to an Entra tenant. */ interface DomainGroupResponse { /** * The edu domain names in this group. */ domainNames: string[]; /** * Failure detail when state is Failed or ActionRequired. Omitted otherwise. */ failureReason: outputs.programenrollment.ErrorDetailResponse; /** * The assessment state of this domain group. */ state: string; /** * The Entra tenant ID that owns these domains. Defaults to the caller's tenant if omitted. */ tenantId?: string; } /** * Details of the Program EduEnrollment. */ interface EduEnrollmentPropertiesResponse { /** * The domain groups associated with this enrollment. */ domains: outputs.programenrollment.DomainGroupResponse[]; /** * Failure detail when provisioningState is Failed. Omitted otherwise. */ failureReason: outputs.programenrollment.ErrorDetailResponse; /** * The status of the last operation. */ provisioningState: string; } /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.programenrollment.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.programenrollment.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace programmableconnectivity { /** * Details about the Application that would use the Operator's Network APIs. */ interface ApplicationPropertiesResponse { /** * Description of the application. */ applicationDescription?: string; /** * The category that describes the application. */ applicationType?: string; /** * Legal name of the organization owning the application. */ legalName?: string; /** * Name of the application. */ name?: string; /** * A description of the organization owning the application. */ organizationDescription?: string; /** * Email address of the Privacy contact or Data Protection officer of the organization. */ privacyContactEmailAddress?: string; /** * Unique Tax Number for the user's organization in the country/region the APC Gateway is being purchased. */ taxNumber?: string; } /** * Details about the SaaS offer purchased from the marketplace. */ interface SaasPropertiesResponse { /** * Resource ID of the SaaS offer purchased from the marketplace. */ saasResourceId?: string; /** * Subscription ID of the SaaS offer purchased from the marketplace. */ saasSubscriptionId?: string; } /** * Description of the current status of the OperatorApiConnection resource. */ interface StatusResponse { /** * Explanation of the current state of the OperatorApiConnection resource. */ reason?: string; /** * Current state of the OperatorApiConnection resource. */ state?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace providerhub { interface AdditionalAuthorizationResponse { applicationId?: string; roleDefinitionId?: string; } interface AllowedResourceNameResponse { /** * Get action verb. */ getActionVerb?: string; /** * Resource name. */ name?: string; } interface AllowedUnauthorizedActionsExtensionResponse { /** * The action. */ action?: string; /** * The intent. */ intent?: string; } interface ApiProfileResponse { /** * Api version. */ apiVersion?: string; /** * Profile version. */ profileVersion?: string; } interface ApplicationDataAuthorizationResponse { /** * The resource types from the defined resource types in the provider namespace that the application can access. If no resource types are specified and the role is service owner, the default is * which is all resource types */ resourceTypes?: string[]; /** * The ownership role the application has on the resource types. The service owner role gives the application owner permissions. The limited owner role gives elevated permissions but does not allow all the permissions of a service owner, such as read/write on internal metadata. */ role: string; } interface ApplicationProviderAuthorizationResponse { /** * The managed by role definition ID for the application. */ managedByRoleDefinitionId?: string; /** * The role definition ID for the application. */ roleDefinitionId?: string; } interface AsyncOperationPollingRulesResponse { /** * The additional options. */ additionalOptions?: string; /** * The authorization actions. */ authorizationActions?: string[]; } interface AsyncTimeoutRuleResponse { actionName?: string; /** * This is a TimeSpan property */ timeout?: string; } interface AuthorizationActionMappingResponse { /** * The desired action name. */ desired?: string; /** * The original action name. */ original?: string; } interface AuthorizedApplicationPropertiesResponse { /** * The authorizations that determine the level of data access permissions on the specified resource types. */ dataAuthorizations?: outputs.providerhub.ApplicationDataAuthorizationResponse[]; providerAuthorization?: outputs.providerhub.ApplicationProviderAuthorizationResponse; /** * The provisioning state. */ provisioningState: string; } interface CustomRolloutPropertiesResponse { /** * The provisioned state of the resource. */ provisioningState: string; /** * The specification. */ specification: outputs.providerhub.CustomRolloutPropertiesSpecificationResponse; /** * The status. */ status?: outputs.providerhub.CustomRolloutPropertiesStatusResponse; } /** * customRolloutPropertiesResponseProvideDefaults sets the appropriate defaults for CustomRolloutPropertiesResponse */ function customRolloutPropertiesResponseProvideDefaults(val: CustomRolloutPropertiesResponse): CustomRolloutPropertiesResponse; /** * The specification. */ interface CustomRolloutPropertiesSpecificationResponse { /** * The auto provisioning configuration. */ autoProvisionConfig?: outputs.providerhub.CustomRolloutSpecificationAutoProvisionConfigResponse; /** * The canary region configuration. */ canary?: outputs.providerhub.CustomRolloutSpecificationCanaryResponse; /** * The provider registration. */ providerRegistration?: outputs.providerhub.CustomRolloutSpecificationProviderRegistrationResponse; /** * Whether refreshing subscription registration is enabled or disabled. */ refreshSubscriptionRegistration?: boolean; /** * The list of ARM regions scoped for the release. */ releaseScopes?: string[]; /** * The resource type registrations. */ resourceTypeRegistrations?: outputs.providerhub.ResourceTypeRegistrationResponse[]; /** * Whether release scope validation should be skipped. */ skipReleaseScopeValidation?: boolean; } /** * customRolloutPropertiesSpecificationResponseProvideDefaults sets the appropriate defaults for CustomRolloutPropertiesSpecificationResponse */ function customRolloutPropertiesSpecificationResponseProvideDefaults(val: CustomRolloutPropertiesSpecificationResponse): CustomRolloutPropertiesSpecificationResponse; /** * The status. */ interface CustomRolloutPropertiesStatusResponse { /** * The completed regions. */ completedRegions?: string[]; /** * The failed or skipped regions. */ failedOrSkippedRegions?: { [key: string]: outputs.providerhub.ExtendedErrorInfoResponse; }; /** * The manifest checkin status. */ manifestCheckinStatus?: outputs.providerhub.CustomRolloutStatusManifestCheckinStatusResponse; } /** * The auto provisioning configuration. */ interface CustomRolloutSpecificationAutoProvisionConfigResponse { resourceGraph?: boolean; storage?: boolean; } /** * The canary region configuration. */ interface CustomRolloutSpecificationCanaryResponse { regions?: string[]; } /** * The provider registration. */ interface CustomRolloutSpecificationProviderRegistrationResponse { /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * Provider registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. */ kind?: string; /** * The name of the resource */ name: string; properties?: outputs.providerhub.ProviderRegistrationPropertiesResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.providerhub.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * customRolloutSpecificationProviderRegistrationResponseProvideDefaults sets the appropriate defaults for CustomRolloutSpecificationProviderRegistrationResponse */ function customRolloutSpecificationProviderRegistrationResponseProvideDefaults(val: CustomRolloutSpecificationProviderRegistrationResponse): CustomRolloutSpecificationProviderRegistrationResponse; /** * The manifest checkin status. */ interface CustomRolloutStatusManifestCheckinStatusResponse { /** * The commit id. */ commitId?: string; /** * Whether the manifest is checked in. */ isCheckedIn: boolean; /** * The pull request. */ pullRequest?: string; /** * The status message. */ statusMessage: string; } interface DefaultRolloutPropertiesResponse { /** * The provisioned state of the resource. */ provisioningState: string; /** * The default rollout specification. */ specification?: outputs.providerhub.DefaultRolloutPropertiesSpecificationResponse; /** * The default rollout status. */ status?: outputs.providerhub.DefaultRolloutPropertiesStatusResponse; } /** * defaultRolloutPropertiesResponseProvideDefaults sets the appropriate defaults for DefaultRolloutPropertiesResponse */ function defaultRolloutPropertiesResponseProvideDefaults(val: DefaultRolloutPropertiesResponse): DefaultRolloutPropertiesResponse; /** * The default rollout specification. */ interface DefaultRolloutPropertiesSpecificationResponse { /** * The auto provisioning config. */ autoProvisionConfig?: outputs.providerhub.DefaultRolloutSpecificationAutoProvisionConfigResponse; /** * The canary traffic region configuration. */ canary?: outputs.providerhub.DefaultRolloutSpecificationCanaryResponse; /** * The expedited rollout definition. */ expeditedRollout?: outputs.providerhub.DefaultRolloutSpecificationExpeditedRolloutResponse; /** * The high traffic region configuration. */ highTraffic?: outputs.providerhub.DefaultRolloutSpecificationHighTrafficResponse; /** * The low traffic region configuration. */ lowTraffic?: outputs.providerhub.DefaultRolloutSpecificationLowTrafficResponse; /** * The medium traffic region configuration. */ mediumTraffic?: outputs.providerhub.DefaultRolloutSpecificationMediumTrafficResponse; /** * The provider registration. */ providerRegistration?: outputs.providerhub.DefaultRolloutSpecificationProviderRegistrationResponse; /** * The resource type registrations. */ resourceTypeRegistrations?: outputs.providerhub.ResourceTypeRegistrationResponse[]; /** * The rest of the world group one region configuration. */ restOfTheWorldGroupOne?: outputs.providerhub.DefaultRolloutSpecificationRestOfTheWorldGroupOneResponse; /** * The rest of the world group two region configuration. */ restOfTheWorldGroupTwo?: outputs.providerhub.DefaultRolloutSpecificationRestOfTheWorldGroupTwoResponse; } /** * defaultRolloutPropertiesSpecificationResponseProvideDefaults sets the appropriate defaults for DefaultRolloutPropertiesSpecificationResponse */ function defaultRolloutPropertiesSpecificationResponseProvideDefaults(val: DefaultRolloutPropertiesSpecificationResponse): DefaultRolloutPropertiesSpecificationResponse; /** * The default rollout status. */ interface DefaultRolloutPropertiesStatusResponse { /** * The completed regions. */ completedRegions?: string[]; /** * The failed or skipped regions. */ failedOrSkippedRegions?: { [key: string]: outputs.providerhub.ExtendedErrorInfoResponse; }; /** * The manifest checkin status. */ manifestCheckinStatus?: outputs.providerhub.DefaultRolloutStatusManifestCheckinStatusResponse; /** * The next traffic region. */ nextTrafficRegion?: string; /** * The next traffic region scheduled time. */ nextTrafficRegionScheduledTime?: string; /** * The subscription reregistration result. */ subscriptionReregistrationResult?: string; } /** * The auto provisioning config. */ interface DefaultRolloutSpecificationAutoProvisionConfigResponse { /** * Whether auto provisioning for resource graph is enabled. */ resourceGraph?: boolean; /** * Whether auto provisioning for storage is enabled. */ storage?: boolean; } /** * The canary traffic region configuration. */ interface DefaultRolloutSpecificationCanaryResponse { /** * The regions. */ regions?: string[]; /** * The skip regions. */ skipRegions?: string[]; } /** * The expedited rollout definition. */ interface DefaultRolloutSpecificationExpeditedRolloutResponse { /** * Indicates whether expedited rollout is enabled/disabled */ enabled?: boolean; } /** * The high traffic region configuration. */ interface DefaultRolloutSpecificationHighTrafficResponse { regions?: string[]; /** * The wait duration. */ waitDuration?: string; } /** * The low traffic region configuration. */ interface DefaultRolloutSpecificationLowTrafficResponse { regions?: string[]; /** * The wait duration. */ waitDuration?: string; } /** * The medium traffic region configuration. */ interface DefaultRolloutSpecificationMediumTrafficResponse { regions?: string[]; /** * The wait duration. */ waitDuration?: string; } /** * The provider registration. */ interface DefaultRolloutSpecificationProviderRegistrationResponse { /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * Provider registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. */ kind?: string; /** * The name of the resource */ name: string; properties?: outputs.providerhub.ProviderRegistrationPropertiesResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.providerhub.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * defaultRolloutSpecificationProviderRegistrationResponseProvideDefaults sets the appropriate defaults for DefaultRolloutSpecificationProviderRegistrationResponse */ function defaultRolloutSpecificationProviderRegistrationResponseProvideDefaults(val: DefaultRolloutSpecificationProviderRegistrationResponse): DefaultRolloutSpecificationProviderRegistrationResponse; /** * The rest of the world group one region configuration. */ interface DefaultRolloutSpecificationRestOfTheWorldGroupOneResponse { regions?: string[]; /** * The wait duration. */ waitDuration?: string; } /** * The rest of the world group two region configuration. */ interface DefaultRolloutSpecificationRestOfTheWorldGroupTwoResponse { regions?: string[]; /** * The wait duration. */ waitDuration?: string; } /** * The manifest checkin status. */ interface DefaultRolloutStatusManifestCheckinStatusResponse { /** * The commit id. */ commitId?: string; /** * Whether the manifest is checked in. */ isCheckedIn: boolean; /** * The pull request. */ pullRequest?: string; /** * The status message. */ statusMessage: string; } interface DeleteDependencyResponse { /** * Linked property. */ linkedProperty?: string; /** * Linked type. */ linkedType?: string; /** * Required features. */ requiredFeatures?: string[]; } interface EndpointInformationResponse { /** * The endpoint. */ endpoint?: string; /** * The endpoint type. */ endpointType?: string; /** * The schema version. */ schemaVersion?: string; } /** * Error information. */ interface ExtendedErrorInfoResponse { /** * The additional error information. */ additionalInfo?: outputs.providerhub.TypedErrorInfoResponse[]; /** * The error code. */ code?: string; /** * The error details. */ details?: outputs.providerhub.ExtendedErrorInfoResponse[]; /** * The error message. */ message?: string; /** * The target of the error. */ target?: string; } interface ExtendedLocationOptionsResponse { supportedPolicy?: string; /** * The type. */ type?: string; } /** * The dsts configuration. */ interface FanoutLinkedNotificationRuleDstsConfigurationResponse { /** * This is a URI property. */ serviceDnsName?: string; /** * The service name. */ serviceName: string; } interface FanoutLinkedNotificationRuleResponse { /** * The actions. */ actions?: string[]; /** * The dsts configuration. */ dstsConfiguration?: outputs.providerhub.FanoutLinkedNotificationRuleDstsConfigurationResponse; /** * The endpoints. */ endpoints?: outputs.providerhub.ResourceProviderEndpointResponse[]; /** * The token auth configuration. */ tokenAuthConfiguration?: outputs.providerhub.TokenAuthConfigurationResponse; } interface FilterRuleResponse { /** * The endpoint information. */ endpointInformation?: outputs.providerhub.EndpointInformationResponse[]; /** * The filter query. */ filterQuery?: string; } interface LegacyDisallowedConditionResponse { /** * The disallowed legacy operations. */ disallowedLegacyOperations?: string[]; /** * Feature string. */ feature?: string; } interface LightHouseAuthorizationResponse { /** * The principal id. */ principalId: string; /** * The role definition id. */ roleDefinitionId: string; } interface LinkedAccessCheckResponse { /** * The action name. */ actionName?: string; /** * The linked action. */ linkedAction?: string; /** * The linked action verb. */ linkedActionVerb?: string; /** * The linked property. */ linkedProperty?: string; /** * The linked type. */ linkedType?: string; } interface LinkedNotificationRuleResponse { /** * The actions. */ actions?: string[]; /** * The actions on failed operation. */ actionsOnFailedOperation?: string[]; /** * The fast path actions. */ fastPathActions?: string[]; /** * The fast path action on failed operation. */ fastPathActionsOnFailedOperation?: string[]; /** * This is a TimeSpan property. */ linkedNotificationTimeout?: string; } interface LinkedOperationRuleResponse { /** * Depends on types. */ dependsOnTypes?: string[]; /** * The linked action. */ linkedAction: string; /** * The linked operation. */ linkedOperation: string; } interface LocationQuotaRuleResponse { /** * The location. */ location?: string; /** * The policy. */ policy?: string; /** * The quota id. */ quotaId?: string; } /** * The hidden property paths. */ interface LoggingRuleHiddenPropertyPathsResponse { /** * The hidden paths on request. */ hiddenPathsOnRequest?: string[]; /** * The hidden paths on response. */ hiddenPathsOnResponse?: string[]; } interface LoggingRuleResponse { /** * The action. */ action: string; /** * The detail level. */ detailLevel: string; /** * The direction. */ direction: string; /** * The hidden property paths. */ hiddenPropertyPaths?: outputs.providerhub.LoggingRuleHiddenPropertyPathsResponse; } interface NotificationEndpointResponse { /** * The locations. */ locations?: string[]; /** * The notification destination. */ notificationDestination?: string; } interface NotificationRegistrationPropertiesResponse { /** * The included events. */ includedEvents?: string[]; /** * The message scope. */ messageScope?: string; /** * The notification endpoints. */ notificationEndpoints?: outputs.providerhub.NotificationEndpointResponse[]; /** * The notification mode. */ notificationMode?: string; /** * The provisioned state of the resource. */ provisioningState: string; } interface NotificationResponse { /** * The notification type. */ notificationType?: string; /** * Whether notifications should be skipped. */ skipNotifications?: string; } interface OpenApiConfigurationResponse { /** * The open api validation. */ validation?: outputs.providerhub.OpenApiValidationResponse; } interface OpenApiValidationResponse { /** * Indicates whether a non compliance response is allowed for a LIST call */ allowNoncompliantCollectionResponse?: boolean; } /** * The provider authentication. */ interface ProviderHubMetadataProviderAuthenticationResponse { /** * The allowed audiences. */ allowedAudiences: string[]; } /** * The third party provider authorization. */ interface ProviderHubMetadataThirdPartyProviderAuthorizationResponse { /** * The authorizations. */ authorizations?: outputs.providerhub.LightHouseAuthorizationResponse[]; /** * The managed by tenant id. */ managedByTenantId?: string; } interface ProviderMonitorSettingPropertiesResponse { /** * The provisioning state. */ provisioningState: string; } /** * The private resource provider configuration. */ interface ProviderRegistrationPropertiesPrivateResourceProviderConfigurationResponse { /** * The allowed subscriptions. */ allowedSubscriptions?: string[]; } /** * The provider hub metadata. */ interface ProviderRegistrationPropertiesProviderHubMetadataResponse { /** * The direct RP role definition id. */ directRpRoleDefinitionId?: string; /** * The global async operation resource type name. */ globalAsyncOperationResourceTypeName?: string; /** * The provider authentication. */ providerAuthentication?: outputs.providerhub.ProviderHubMetadataProviderAuthenticationResponse; /** * The provider authorizations. */ providerAuthorizations?: outputs.providerhub.ResourceProviderAuthorizationResponse[]; /** * The regional async operation resource type name. */ regionalAsyncOperationResourceTypeName?: string; /** * The third party provider authorization. */ thirdPartyProviderAuthorization?: outputs.providerhub.ProviderHubMetadataThirdPartyProviderAuthorizationResponse; } interface ProviderRegistrationPropertiesResponse { /** * The capabilities. */ capabilities?: outputs.providerhub.ResourceProviderCapabilitiesResponse[]; /** * The cross tenant token validation. */ crossTenantTokenValidation?: string; /** * Custom manifest version. */ customManifestVersion?: string; /** * The dsts configuration. */ dstsConfiguration?: outputs.providerhub.ResourceProviderManifestPropertiesDstsConfigurationResponse; /** * The enable tenant linked notification. */ enableTenantLinkedNotification?: boolean; /** * The features rule. */ featuresRule?: outputs.providerhub.ResourceProviderManifestPropertiesFeaturesRuleResponse; /** * The global notification endpoints. */ globalNotificationEndpoints?: outputs.providerhub.ResourceProviderEndpointResponse[]; /** * Legacy namespace. */ legacyNamespace?: string; /** * Legacy registrations. */ legacyRegistrations?: string[]; /** * The linked notification rules. */ linkedNotificationRules?: outputs.providerhub.FanoutLinkedNotificationRuleResponse[]; /** * The resource provider management. */ management?: outputs.providerhub.ResourceProviderManifestPropertiesManagementResponse; /** * Management groups global notification endpoints. */ managementGroupGlobalNotificationEndpoints?: outputs.providerhub.ResourceProviderEndpointResponse[]; /** * The metadata. */ metadata?: any; /** * The namespace. */ namespace?: string; /** * Notification options. */ notificationOptions?: string; /** * Notification settings. */ notificationSettings?: outputs.providerhub.ResourceProviderManifestPropertiesNotificationSettingsResponse; /** * The notifications. */ notifications?: outputs.providerhub.NotificationResponse[]; /** * Optional features. */ optionalFeatures?: string[]; /** * The private resource provider configuration. */ privateResourceProviderConfiguration?: outputs.providerhub.ProviderRegistrationPropertiesPrivateResourceProviderConfigurationResponse; /** * The provider authentication. */ providerAuthentication?: outputs.providerhub.ResourceProviderManifestPropertiesProviderAuthenticationResponse; /** * The provider authorizations. */ providerAuthorizations?: outputs.providerhub.ResourceProviderAuthorizationResponse[]; /** * The provider hub metadata. */ providerHubMetadata?: outputs.providerhub.ProviderRegistrationPropertiesProviderHubMetadataResponse; /** * The provider type. */ providerType?: string; /** * The provider version. */ providerVersion?: string; /** * The provisioning state. */ provisioningState: string; /** * The request header options. */ requestHeaderOptions?: outputs.providerhub.ResourceProviderManifestPropertiesRequestHeaderOptionsResponse; /** * The required features. */ requiredFeatures?: string[]; /** * Resource group lock option during move. */ resourceGroupLockOptionDuringMove?: outputs.providerhub.ResourceProviderManifestPropertiesResourceGroupLockOptionDuringMoveResponse; /** * resource hydration accounts */ resourceHydrationAccounts?: outputs.providerhub.ResourceHydrationAccountResponse[]; /** * The resource provider authorization rules. */ resourceProviderAuthorizationRules?: outputs.providerhub.ResourceProviderAuthorizationRulesResponse; /** * Response options. */ responseOptions?: outputs.providerhub.ResourceProviderManifestPropertiesResponseOptionsResponse; /** * The service name. */ serviceName?: string; /** * The services. */ services?: outputs.providerhub.ResourceProviderServiceResponse[]; /** * The subscription lifecycle notification specifications. */ subscriptionLifecycleNotificationSpecifications?: outputs.providerhub.ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecificationsResponse; /** * The template deployment options. */ templateDeploymentOptions?: outputs.providerhub.ResourceProviderManifestPropertiesTemplateDeploymentOptionsResponse; /** * The token auth configuration. */ tokenAuthConfiguration?: outputs.providerhub.TokenAuthConfigurationResponse; } /** * The subscription lifecycle notification specifications. */ interface ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecificationsResponse { /** * The soft delete TTL. */ softDeleteTTL?: string; /** * The subscription state override actions. */ subscriptionStateOverrideActions?: outputs.providerhub.SubscriptionStateOverrideActionResponse[]; } interface QuotaRuleResponse { /** * The location rules. */ locationRules?: outputs.providerhub.LocationQuotaRuleResponse[]; /** * The quota policy. */ quotaPolicy?: string; /** * The required features. */ requiredFeatures?: string[]; } interface ResourceAccessRoleResponse { /** * The actions. */ actions?: string[]; /** * The allowed group claims. */ allowedGroupClaims?: string[]; } interface ResourceConcurrencyControlOptionResponse { /** * The policy. */ policy?: string; } interface ResourceHydrationAccountResponse { /** * The account name. */ accountName?: string; /** * The encrypted key. */ encryptedKey?: string; /** * The max child resource consistency job limit. */ maxChildResourceConsistencyJobLimit?: number; /** * The subscription id. */ subscriptionId?: string; } /** * Managed by authorization. */ interface ResourceProviderAuthorizationManagedByAuthorizationResponse { additionalAuthorizations?: outputs.providerhub.AdditionalAuthorizationResponse[]; /** * Indicates whether the managed by resource role definition ID should be inherited. */ allowManagedByInheritance?: boolean; /** * The managed by resource role definition ID for the application. */ managedByResourceRoleDefinitionId?: string; } interface ResourceProviderAuthorizationResponse { /** * The allowed third party extensions. */ allowedThirdPartyExtensions?: outputs.providerhub.ThirdPartyExtensionResponse[]; /** * The application id. */ applicationId?: string; /** * The grouping tag. */ groupingTag?: string; /** * Managed by authorization. */ managedByAuthorization?: outputs.providerhub.ResourceProviderAuthorizationManagedByAuthorizationResponse; /** * The managed by role definition id. */ managedByRoleDefinitionId?: string; /** * The role definition id. */ roleDefinitionId?: string; } interface ResourceProviderAuthorizationRulesResponse { /** * The async operation polling rules. */ asyncOperationPollingRules?: outputs.providerhub.AsyncOperationPollingRulesResponse; } interface ResourceProviderCapabilitiesResponse { /** * The effect. */ effect: string; /** * The quota id. */ quotaId: string; /** * The required features. */ requiredFeatures?: string[]; } /** * The feature rules. */ interface ResourceProviderEndpointFeaturesRuleResponse { /** * The required feature policy. */ requiredFeaturesPolicy: string; } interface ResourceProviderEndpointResponse { /** * The api versions. */ apiVersions?: string[]; /** * Whether the endpoint is enabled. */ enabled?: boolean; /** * The endpoint type. */ endpointType?: string; /** * The endpoint uri. */ endpointUri?: string; /** * The feature rules. */ featuresRule?: outputs.providerhub.ResourceProviderEndpointFeaturesRuleResponse; /** * The locations. */ locations?: string[]; /** * The required features. */ requiredFeatures?: string[]; /** * The sku link. */ skuLink?: string; /** * The timeout. */ timeout?: string; } /** * Options for error response messages. */ interface ResourceProviderManagementErrorResponseMessageOptionsResponse { /** * Type of server failure response message. */ serverFailureResponseMessageType?: string; } /** * Metadata for expedited rollout. */ interface ResourceProviderManagementExpeditedRolloutMetadataResponse { /** * Expedited rollout enabled? */ enabled?: boolean; /** * Expedited rollout intent. */ expeditedRolloutIntent?: string; } /** * The dsts configuration. */ interface ResourceProviderManifestPropertiesDstsConfigurationResponse { /** * This is a URI property. */ serviceDnsName?: string; /** * The service name. */ serviceName: string; } /** * The features rule. */ interface ResourceProviderManifestPropertiesFeaturesRuleResponse { /** * The required feature policy. */ requiredFeaturesPolicy: string; } /** * The resource provider management. */ interface ResourceProviderManifestPropertiesManagementResponse { /** * The authorization owners. */ authorizationOwners?: string[]; /** * List of manifest owners for canary. */ canaryManifestOwners?: string[]; /** * Options for error response messages. */ errorResponseMessageOptions?: outputs.providerhub.ResourceProviderManagementErrorResponseMessageOptionsResponse; /** * Metadata for expedited rollout. */ expeditedRolloutMetadata?: outputs.providerhub.ResourceProviderManagementExpeditedRolloutMetadataResponse; /** * List of expedited rollout submitters. */ expeditedRolloutSubmitters?: string[]; /** * The incident contact email. */ incidentContactEmail?: string; /** * The incident routing service. */ incidentRoutingService?: string; /** * The incident routing team. */ incidentRoutingTeam?: string; /** * The manifest owners. */ manifestOwners?: string[]; /** * The profit center code for the subscription. */ pcCode?: string; /** * The profit center program id for the subscription. */ profitCenterProgramId?: string; /** * The resource access policy. */ resourceAccessPolicy?: string; /** * The resource access roles. */ resourceAccessRoles?: outputs.providerhub.ResourceAccessRoleResponse[]; /** * The schema owners. */ schemaOwners?: string[]; /** * The service tree infos. */ serviceTreeInfos?: outputs.providerhub.ServiceTreeInfoResponse[]; } /** * Notification settings. */ interface ResourceProviderManifestPropertiesNotificationSettingsResponse { subscriberSettings?: outputs.providerhub.SubscriberSettingResponse[]; } /** * The provider authentication. */ interface ResourceProviderManifestPropertiesProviderAuthenticationResponse { /** * The allowed audiences. */ allowedAudiences: string[]; } /** * The request header options. */ interface ResourceProviderManifestPropertiesRequestHeaderOptionsResponse { /** * The opt in headers. */ optInHeaders?: string; /** * The opt out headers. */ optOutHeaders?: string; } /** * Resource group lock option during move. */ interface ResourceProviderManifestPropertiesResourceGroupLockOptionDuringMoveResponse { /** * The action verb that will be blocked when the resource group is locked during move. */ blockActionVerb?: string; } /** * Response options. */ interface ResourceProviderManifestPropertiesResponseOptionsResponse { serviceClientOptionsType?: string; } /** * The template deployment options. */ interface ResourceProviderManifestPropertiesTemplateDeploymentOptionsResponse { /** * The preflight options. */ preflightOptions?: string[]; /** * Whether preflight is supported. */ preflightSupported?: boolean; } /** * Resource provider service. */ interface ResourceProviderServiceResponse { /** * The service name. */ serviceName?: string; /** * The status. */ status?: string; } /** * The dsts configuration. */ interface ResourceTypeEndpointDstsConfigurationResponse { /** * This is a URI property. */ serviceDnsName?: string; /** * The service name. */ serviceName: string; } /** * The features rule. */ interface ResourceTypeEndpointFeaturesRuleResponse { /** * The required feature policy. */ requiredFeaturesPolicy: string; } interface ResourceTypeEndpointResponse { /** * Api version. */ apiVersion?: string; /** * The api versions. */ apiVersions?: string[]; /** * The data boundary. */ dataBoundary?: string; /** * The dsts configuration. */ dstsConfiguration?: outputs.providerhub.ResourceTypeEndpointDstsConfigurationResponse; /** * Whether the endpoint is enabled. */ enabled?: boolean; /** * The endpoint type. */ endpointType?: string; /** * The endpoint uri. */ endpointUri?: string; /** * The extensions. */ extensions?: outputs.providerhub.ResourceTypeExtensionResponse[]; /** * The features rule. */ featuresRule?: outputs.providerhub.ResourceTypeEndpointFeaturesRuleResponse; /** * Resource type endpoint kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. */ kind?: string; /** * The locations. */ locations?: string[]; /** * The required features. */ requiredFeatures?: string[]; /** * The sku link. */ skuLink?: string; /** * The timeout. */ timeout?: string; /** * The token auth configuration. */ tokenAuthConfiguration?: outputs.providerhub.TokenAuthConfigurationResponse; /** * List of zones. */ zones?: string[]; } /** * resourceTypeEndpointResponseProvideDefaults sets the appropriate defaults for ResourceTypeEndpointResponse */ function resourceTypeEndpointResponseProvideDefaults(val: ResourceTypeEndpointResponse): ResourceTypeEndpointResponse; /** * Resource creation begin. */ interface ResourceTypeExtensionOptionsResourceCreationBeginResponse { /** * The request. */ request?: string[]; /** * The response. */ response?: string[]; } interface ResourceTypeExtensionResponse { /** * The endpoint uri. */ endpointUri?: string; /** * The extension categories. */ extensionCategories?: string[]; /** * The timeout. */ timeout?: string; } interface ResourceTypeOnBehalfOfTokenResponse { /** * The action name. */ actionName?: string; /** * This is a TimeSpan property. */ lifeTime?: string; } /** * The availability zone rule. */ interface ResourceTypeRegistrationPropertiesAvailabilityZoneRuleResponse { availabilityZonePolicy?: string; } /** * Capacity rule. */ interface ResourceTypeRegistrationPropertiesCapacityRuleResponse { /** * Capacity policy. */ capacityPolicy?: string; /** * Sku alias */ skuAlias?: string; } /** * The check name availability specifications. */ interface ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecificationsResponse { /** * Whether default validation is enabled. */ enableDefaultValidation?: boolean; /** * The resource types with custom validation. */ resourceTypesWithCustomValidation?: string[]; } /** * The dsts configuration. */ interface ResourceTypeRegistrationPropertiesDstsConfigurationResponse { /** * This is a URI property. */ serviceDnsName?: string; /** * The service name. */ serviceName: string; } /** * The extension options. */ interface ResourceTypeRegistrationPropertiesExtensionOptionsResponse { /** * Resource creation begin. */ resourceCreationBegin?: outputs.providerhub.ResourceTypeExtensionOptionsResourceCreationBeginResponse; } /** * The features rule. */ interface ResourceTypeRegistrationPropertiesFeaturesRuleResponse { /** * The required feature policy. */ requiredFeaturesPolicy: string; } /** * The identity management. */ interface ResourceTypeRegistrationPropertiesIdentityManagementResponse { /** * The application id. */ applicationId?: string; /** * The application ids. */ applicationIds?: string[]; /** * The delegation app ids. */ delegationAppIds?: string[]; /** * The type. */ type?: string; } /** * The legacy policy. */ interface ResourceTypeRegistrationPropertiesLegacyPolicyResponse { disallowedConditions?: outputs.providerhub.LegacyDisallowedConditionResponse[]; disallowedLegacyOperations?: string[]; } /** * The resource provider management. */ interface ResourceTypeRegistrationPropertiesManagementResponse { /** * The authorization owners. */ authorizationOwners?: string[]; /** * List of manifest owners for canary. */ canaryManifestOwners?: string[]; /** * Options for error response messages. */ errorResponseMessageOptions?: outputs.providerhub.ResourceProviderManagementErrorResponseMessageOptionsResponse; /** * Metadata for expedited rollout. */ expeditedRolloutMetadata?: outputs.providerhub.ResourceProviderManagementExpeditedRolloutMetadataResponse; /** * List of expedited rollout submitters. */ expeditedRolloutSubmitters?: string[]; /** * The incident contact email. */ incidentContactEmail?: string; /** * The incident routing service. */ incidentRoutingService?: string; /** * The incident routing team. */ incidentRoutingTeam?: string; /** * The manifest owners. */ manifestOwners?: string[]; /** * The profit center code for the subscription. */ pcCode?: string; /** * The profit center program id for the subscription. */ profitCenterProgramId?: string; /** * The resource access policy. */ resourceAccessPolicy?: string; /** * The resource access roles. */ resourceAccessRoles?: outputs.providerhub.ResourceAccessRoleResponse[]; /** * The schema owners. */ schemaOwners?: string[]; /** * The service tree infos. */ serviceTreeInfos?: outputs.providerhub.ServiceTreeInfoResponse[]; } /** * Marketplace options. */ interface ResourceTypeRegistrationPropertiesMarketplaceOptionsResponse { /** * Add-on plan conversion allowed. */ addOnPlanConversionAllowed?: boolean; } /** * The request header options. */ interface ResourceTypeRegistrationPropertiesRequestHeaderOptionsResponse { /** * The opt in headers. */ optInHeaders?: string; /** * The opt out headers. */ optOutHeaders?: string; } /** * Resource cache options. */ interface ResourceTypeRegistrationPropertiesResourceCacheResponse { /** * Enable resource cache. */ enableResourceCache?: boolean; /** * Resource cache expiration timespan. This is a TimeSpan property. */ resourceCacheExpirationTimespan?: string; } /** * The resource graph configuration. */ interface ResourceTypeRegistrationPropertiesResourceGraphConfigurationResponse { /** * The api version. */ apiVersion?: string; /** * Whether it's enabled. */ enabled?: boolean; } /** * Batch provisioning support. */ interface ResourceTypeRegistrationPropertiesResourceManagementOptionsBatchProvisioningSupportResponse { /** * Supported operations. */ supportedOperations?: string; } /** * Nested provisioning support. */ interface ResourceTypeRegistrationPropertiesResourceManagementOptionsNestedProvisioningSupportResponse { /** * Minimum API version. */ minimumApiVersion?: string; } /** * Resource management options. */ interface ResourceTypeRegistrationPropertiesResourceManagementOptionsResponse { /** * Batch provisioning support. */ batchProvisioningSupport?: outputs.providerhub.ResourceTypeRegistrationPropertiesResourceManagementOptionsBatchProvisioningSupportResponse; /** * Delete dependencies. */ deleteDependencies?: outputs.providerhub.DeleteDependencyResponse[]; /** * Nested provisioning support. */ nestedProvisioningSupport?: outputs.providerhub.ResourceTypeRegistrationPropertiesResourceManagementOptionsNestedProvisioningSupportResponse; } /** * The resource move policy. */ interface ResourceTypeRegistrationPropertiesResourceMovePolicyResponse { /** * Whether cross resource group move is enabled. */ crossResourceGroupMoveEnabled?: boolean; /** * Whether cross subscription move is enabled. */ crossSubscriptionMoveEnabled?: boolean; /** * Whether validation is required. */ validationRequired?: boolean; } /** * Resource query management options. */ interface ResourceTypeRegistrationPropertiesResourceQueryManagementResponse { /** * Filter option. */ filterOption?: string; } /** * Resource type common attribute management. */ interface ResourceTypeRegistrationPropertiesResourceTypeCommonAttributeManagementResponse { /** * Common api versions merge mode. */ commonApiVersionsMergeMode?: string; } interface ResourceTypeRegistrationPropertiesResponse { /** * Add resource list target locations? */ addResourceListTargetLocations?: boolean; /** * The additional options. */ additionalOptions?: string; /** * The allow empty role assignments. */ allowEmptyRoleAssignments?: boolean; /** * The allowed resource names. */ allowedResourceNames?: outputs.providerhub.AllowedResourceNameResponse[]; /** * Allowed template deployment reference actions. */ allowedTemplateDeploymentReferenceActions?: string[]; /** * The allowed unauthorized actions. */ allowedUnauthorizedActions?: string[]; /** * The allowed unauthorized actions extensions. */ allowedUnauthorizedActionsExtensions?: outputs.providerhub.AllowedUnauthorizedActionsExtensionResponse[]; /** * The api profiles. */ apiProfiles?: outputs.providerhub.ApiProfileResponse[]; /** * The async operation resource type name. */ asyncOperationResourceTypeName?: string; /** * Async timeout rules */ asyncTimeoutRules?: outputs.providerhub.AsyncTimeoutRuleResponse[]; /** * The authorization action mappings */ authorizationActionMappings?: outputs.providerhub.AuthorizationActionMappingResponse[]; /** * The availability zone rule. */ availabilityZoneRule?: outputs.providerhub.ResourceTypeRegistrationPropertiesAvailabilityZoneRuleResponse; /** * Capacity rule. */ capacityRule?: outputs.providerhub.ResourceTypeRegistrationPropertiesCapacityRuleResponse; /** * The category. */ category?: string; /** * The check name availability specifications. */ checkNameAvailabilitySpecifications?: outputs.providerhub.ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecificationsResponse; /** * Common API versions for the resource type. */ commonApiVersions?: string[]; /** * The cross tenant token validation. */ crossTenantTokenValidation?: string; /** * The default api version. */ defaultApiVersion?: string; /** * The disallowed action verbs. */ disallowedActionVerbs?: string[]; /** * The disallowed end user operations. */ disallowedEndUserOperations?: string[]; /** * The dsts configuration. */ dstsConfiguration?: outputs.providerhub.ResourceTypeRegistrationPropertiesDstsConfigurationResponse; /** * Whether async operation is enabled. */ enableAsyncOperation?: boolean; /** * Whether third party S2S is enabled. */ enableThirdPartyS2S?: boolean; /** * The extensions. */ endpoints?: outputs.providerhub.ResourceTypeEndpointResponse[]; /** * The extended locations. */ extendedLocations?: outputs.providerhub.ExtendedLocationOptionsResponse[]; /** * The extension options. */ extensionOptions?: outputs.providerhub.ResourceTypeRegistrationPropertiesExtensionOptionsResponse; /** * The features rule. */ featuresRule?: outputs.providerhub.ResourceTypeRegistrationPropertiesFeaturesRuleResponse; /** * The frontdoor request mode. */ frontdoorRequestMode?: string; /** * Grouping tag. */ groupingTag?: string; /** * The identity management. */ identityManagement?: outputs.providerhub.ResourceTypeRegistrationPropertiesIdentityManagementResponse; /** * Whether it is pure proxy. */ isPureProxy?: boolean; /** * The legacy name. */ legacyName?: string; /** * The legacy names. */ legacyNames?: string[]; /** * The legacy policy. */ legacyPolicy?: outputs.providerhub.ResourceTypeRegistrationPropertiesLegacyPolicyResponse; /** * The linked access checks. */ linkedAccessChecks?: outputs.providerhub.LinkedAccessCheckResponse[]; /** * The linked notification rules. */ linkedNotificationRules?: outputs.providerhub.LinkedNotificationRuleResponse[]; /** * The linked operation rules. */ linkedOperationRules?: outputs.providerhub.LinkedOperationRuleResponse[]; /** * The logging rules. */ loggingRules?: outputs.providerhub.LoggingRuleResponse[]; /** * The resource provider management. */ management?: outputs.providerhub.ResourceTypeRegistrationPropertiesManagementResponse; /** * Manifest link. */ manifestLink?: string; /** * Marketplace options. */ marketplaceOptions?: outputs.providerhub.ResourceTypeRegistrationPropertiesMarketplaceOptionsResponse; /** * The marketplace type. */ marketplaceType?: string; /** * The metadata. */ metadata?: any; /** * The notifications. */ notifications?: outputs.providerhub.NotificationResponse[]; /** * The on behalf of tokens. */ onBehalfOfTokens?: outputs.providerhub.ResourceTypeOnBehalfOfTokenResponse; /** * The open api configuration. */ openApiConfiguration?: outputs.providerhub.OpenApiConfigurationResponse; /** * The policy execution type. */ policyExecutionType?: string; /** * The provisioning state. */ provisioningState: string; /** * The quota rule. */ quotaRule?: outputs.providerhub.QuotaRuleResponse; /** * The regionality. */ regionality?: string; /** * The request header options. */ requestHeaderOptions?: outputs.providerhub.ResourceTypeRegistrationPropertiesRequestHeaderOptionsResponse; /** * The required features. */ requiredFeatures?: string[]; /** * Resource cache options. */ resourceCache?: outputs.providerhub.ResourceTypeRegistrationPropertiesResourceCacheResponse; /** * The resource concurrency control options. */ resourceConcurrencyControlOptions?: { [key: string]: outputs.providerhub.ResourceConcurrencyControlOptionResponse; }; /** * The resource deletion policy. */ resourceDeletionPolicy?: string; /** * The resource graph configuration. */ resourceGraphConfiguration?: outputs.providerhub.ResourceTypeRegistrationPropertiesResourceGraphConfigurationResponse; /** * Resource management options. */ resourceManagementOptions?: outputs.providerhub.ResourceTypeRegistrationPropertiesResourceManagementOptionsResponse; /** * The resource move policy. */ resourceMovePolicy?: outputs.providerhub.ResourceTypeRegistrationPropertiesResourceMovePolicyResponse; /** * The resource provider authorization rules. */ resourceProviderAuthorizationRules?: outputs.providerhub.ResourceProviderAuthorizationRulesResponse; /** * Resource query management options. */ resourceQueryManagement?: outputs.providerhub.ResourceTypeRegistrationPropertiesResourceQueryManagementResponse; /** * The resource sub type. */ resourceSubType?: string; /** * Resource type common attribute management. */ resourceTypeCommonAttributeManagement?: outputs.providerhub.ResourceTypeRegistrationPropertiesResourceTypeCommonAttributeManagementResponse; /** * The resource validation. */ resourceValidation?: string; /** * Routing rule. */ routingRule?: outputs.providerhub.ResourceTypeRegistrationPropertiesRoutingRuleResponse; /** * The resource routing type. */ routingType?: string; /** * The service tree infos. */ serviceTreeInfos?: outputs.providerhub.ServiceTreeInfoResponse[]; /** * The sku link. */ skuLink?: string; /** * The subscription lifecycle notification specifications. */ subscriptionLifecycleNotificationSpecifications?: outputs.providerhub.ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecificationsResponse; /** * The subscription state rules. */ subscriptionStateRules?: outputs.providerhub.SubscriptionStateRuleResponse[]; /** * Whether tags are supported. */ supportsTags?: boolean; /** * The swagger specifications. */ swaggerSpecifications?: outputs.providerhub.SwaggerSpecificationResponse[]; /** * The template deployment options. */ templateDeploymentOptions?: outputs.providerhub.ResourceTypeRegistrationPropertiesTemplateDeploymentOptionsResponse; /** * The template deployment policy. */ templateDeploymentPolicy?: outputs.providerhub.ResourceTypeRegistrationPropertiesTemplateDeploymentPolicyResponse; /** * The throttling rules. */ throttlingRules?: outputs.providerhub.ThrottlingRuleResponse[]; /** * The token auth configuration. */ tokenAuthConfiguration?: outputs.providerhub.TokenAuthConfigurationResponse; } /** * Routing rule. */ interface ResourceTypeRegistrationPropertiesRoutingRuleResponse { /** * Hosted resource type. */ hostResourceType?: string; } /** * The subscription lifecycle notification specifications. */ interface ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecificationsResponse { /** * The soft delete TTL. */ softDeleteTTL?: string; /** * The subscription state override actions. */ subscriptionStateOverrideActions?: outputs.providerhub.SubscriptionStateOverrideActionResponse[]; } /** * The template deployment options. */ interface ResourceTypeRegistrationPropertiesTemplateDeploymentOptionsResponse { /** * The preflight options. */ preflightOptions?: string[]; /** * Whether preflight is supported. */ preflightSupported?: boolean; } /** * The template deployment policy. */ interface ResourceTypeRegistrationPropertiesTemplateDeploymentPolicyResponse { /** * The capabilities. */ capabilities: string; /** * The preflight notifications. */ preflightNotifications?: string; /** * The preflight options. */ preflightOptions: string; } /** * Concrete proxy resource types can be created by aliasing this type using a specific property type. */ interface ResourceTypeRegistrationResponse { /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * Resource type registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. */ kind?: string; /** * The name of the resource */ name: string; properties?: outputs.providerhub.ResourceTypeRegistrationPropertiesResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.providerhub.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * resourceTypeRegistrationResponseProvideDefaults sets the appropriate defaults for ResourceTypeRegistrationResponse */ function resourceTypeRegistrationResponseProvideDefaults(val: ResourceTypeRegistrationResponse): ResourceTypeRegistrationResponse; interface ServiceTreeInfoResponse { /** * The component id. */ componentId?: string; /** * The readiness. */ readiness?: string; /** * The service id. */ serviceId?: string; } interface SkuCapabilityResponse { /** * The name. */ name: string; /** * The value. */ value: string; } interface SkuCostResponse { /** * The extended unit. */ extendedUnit?: string; /** * The meter id. */ meterId: string; /** * The quantity. */ quantity?: number; } interface SkuLocationInfoResponse { /** * The extended locations. */ extendedLocations?: string[]; /** * The location. */ location: string; /** * The type. */ type?: string; /** * The zone details. */ zoneDetails?: outputs.providerhub.SkuZoneDetailResponse[]; /** * The zones. */ zones?: string[]; } interface SkuResourcePropertiesResponse { /** * The provisioning state. */ provisioningState: string; /** * The sku settings. */ skuSettings: outputs.providerhub.SkuSettingResponse[]; } /** * The capacity. */ interface SkuSettingCapacityResponse { /** * The default. */ default?: number; /** * The maximum. */ maximum?: number; /** * The minimum. */ minimum: number; /** * The scale type. */ scaleType?: string; } interface SkuSettingResponse { /** * The capabilities. */ capabilities?: outputs.providerhub.SkuCapabilityResponse[]; /** * The capacity. */ capacity?: outputs.providerhub.SkuSettingCapacityResponse; /** * The costs. */ costs?: outputs.providerhub.SkuCostResponse[]; /** * The family. */ family?: string; /** * The kind. */ kind?: string; /** * The location info. */ locationInfo?: outputs.providerhub.SkuLocationInfoResponse[]; /** * The locations. */ locations?: string[]; /** * The name. */ name: string; /** * The required features. */ requiredFeatures?: string[]; /** * The required quota ids. */ requiredQuotaIds?: string[]; /** * The size. */ size?: string; /** * The tier. */ tier?: string; } interface SkuZoneDetailResponse { /** * The capabilities. */ capabilities?: outputs.providerhub.SkuCapabilityResponse[]; /** * The name. */ name?: string[]; } interface SubscriberSettingResponse { /** * The filter rules. */ filterRules?: outputs.providerhub.FilterRuleResponse[]; } interface SubscriptionStateOverrideActionResponse { /** * The action. */ action: string; /** * The state. */ state: string; } interface SubscriptionStateRuleResponse { /** * The allowed actions. */ allowedActions?: string[]; /** * The subscription state. */ state?: string; } interface SwaggerSpecificationResponse { /** * The api versions. */ apiVersions?: string[]; /** * The swagger spec folder uri. */ swaggerSpecFolderUri?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } interface ThirdPartyExtensionResponse { /** * Name of third party extension. */ name?: string; } interface ThrottlingMetricResponse { /** * The interval. */ interval?: string; /** * The limit. */ limit: number; /** * The throttling metric type */ type: string; } interface ThrottlingRuleResponse { /** * The action. */ action: string; /** * The application id. */ applicationId?: string[]; /** * The metrics. */ metrics: outputs.providerhub.ThrottlingMetricResponse[]; /** * The required features. */ requiredFeatures?: string[]; } interface TokenAuthConfigurationResponse { /** * The authentication scheme. */ authenticationScheme?: string; /** * Whether certification authentication fallback is disabled. */ disableCertificateAuthenticationFallback?: boolean; /** * The signed request scope. */ signedRequestScope?: string; } /** * Error information. */ interface TypedErrorInfoResponse { /** * The error information. */ info: any; /** * The type of the error. */ type: string; } } export declare namespace purview { /** * The public Account Merge Info model. */ interface AccountMergeInfoResponse { /** * The account location of the *other* account in the merge operation. */ accountLocation: string; /** * The account name of the *other* account in the merge operation. */ accountName: string; /** * The resource group name of the *other* account in the merge operation. */ accountResourceGroupName: string; /** * The subscription id of the *other* account in the merge operation. */ accountSubscriptionId: string; /** * The deprovisioned status of the account. * Only applicable for the secondary account. */ deprovisioned: boolean; /** * The status of the merge operation. */ mergeStatus: string; /** * The account's type for the merge operation. */ typeOfAccount: string; } /** * Gets or sets the status of the account. */ interface AccountPropertiesAccountStatusResponse { /** * Gets the account status code. */ accountProvisioningState: string; /** * Gets the account error details. */ errorDetails: outputs.purview.AccountStatusErrorDetailsResponse; } /** * The URIs that are the public endpoints of the account. */ interface AccountPropertiesEndpointsResponse { /** * Gets the catalog endpoint. */ catalog: string; /** * Gets the scan endpoint. */ scan: string; } /** * Gets the resource identifiers of the managed resources. */ interface AccountPropertiesManagedResourcesResponse { /** * Gets the managed event hub namespace resource identifier. */ eventHubNamespace: string; /** * Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account. */ resourceGroup: string; /** * Gets the managed storage account resource identifier. */ storageAccount: string; } /** * The Sku */ interface AccountSkuResponse { /** * Gets or sets the sku capacity. */ capacity?: number; /** * Gets or sets the sku name. */ name?: string; } /** * Gets the account error details. */ interface AccountStatusErrorDetailsResponse { /** * Gets or sets the code. */ code: string; /** * Gets or sets the details. */ details: outputs.purview.ErrorModelResponse[]; /** * Gets or sets the messages. */ message: string; /** * Gets or sets the target. */ target: string; } /** * External Cloud Service connectors */ interface CloudConnectorsResponse { /** * AWS external identifier. * Configured in AWS to allow use of the role arn used for scanning */ awsExternalId: string; } /** * Credentials to access the event streaming service attached to the purview account. */ interface CredentialsResponse { /** * Identity identifier for UserAssign type. */ identityId?: string; /** * Identity Type. */ type?: string; } /** * Default error model */ interface ErrorModelResponse { /** * Gets or sets the code. */ code: string; /** * Gets or sets the details. */ details: outputs.purview.ErrorModelResponse[]; /** * Gets or sets the messages. */ message: string; /** * Gets or sets the target. */ target: string; } /** * The Managed Identity of the resource */ interface IdentityResponse { /** * Service principal object Id */ principalId: string; /** * Tenant Id */ tenantId: string; /** * Identity Type */ type?: string; /** * User Assigned Identities */ userAssignedIdentities?: { [key: string]: outputs.purview.UserAssignedIdentityResponse; }; } /** * Ingestion Storage Account Info */ interface IngestionStorageResponse { /** * Gets or sets the Id. */ id: string; /** * Gets or sets the primary endpoint. */ primaryEndpoint: string; /** * Gets or sets the public network access setting */ publicNetworkAccess?: string; } /** * A private endpoint connection class. */ interface PrivateEndpointConnectionResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint information. */ privateEndpoint?: outputs.purview.PrivateEndpointResponse; /** * The private link service connection state. */ privateLinkServiceConnectionState?: outputs.purview.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.purview.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * A private endpoint class. */ interface PrivateEndpointResponse { /** * The private endpoint identifier. */ id?: string; } /** * The private link service connection state. */ interface PrivateLinkServiceConnectionStateResponse { /** * The required actions. */ actionsRequired?: string; /** * The description. */ description?: string; /** * The status. */ status?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Uses client ID and Principal ID */ interface UserAssignedIdentityResponse { /** * Gets or Sets Client ID */ clientId: string; /** * Gets or Sets Principal ID */ principalId: string; } } export declare namespace quantum { /** * Azure quantum workspace Api key details. */ interface ApiKeyResponse { /** * The creation time of the api key. */ createdAt?: string; /** * The Api key. */ key: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.quantum.UserAssignedIdentityResponse; }; } /** * Information about a Provider. A Provider is an entity that offers Targets to run Azure Quantum Jobs. */ interface ProviderResponse { /** * The provider's marketplace application display name. */ applicationName?: string; /** * A Uri identifying the specific instance of this provider. */ instanceUri?: string; /** * Unique id of this provider. */ providerId?: string; /** * The sku associated with pricing information for this provider. */ providerSku?: string; /** * Provisioning status field */ provisioningState?: string; /** * Id to track resource usage for the provider. */ resourceUsageId?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Properties of a Workspace */ interface WorkspaceResourcePropertiesResponse { /** * Indicator of enablement of the Quantum workspace Api keys. */ apiKeyEnabled?: boolean; /** * The URI of the workspace endpoint. */ endpointUri: string; /** * List of Providers selected for this Workspace */ providers?: outputs.quantum.ProviderResponse[]; /** * Provisioning status field */ provisioningState: string; /** * ARM Resource Id of the storage account associated with this workspace. */ storageAccount?: string; /** * Whether the current workspace is ready to accept Jobs. */ usable: string; } } export declare namespace quota { interface GroupQuotaSubscriptionIdResponseProperties { /** * Status of this subscriptionId being associated with the GroupQuotasEntity. */ provisioningState: string; /** * An Azure subscriptionId. */ subscriptionId?: string; } interface GroupQuotasEntityResponseProperties { /** * Display name of the GroupQuota entity. */ displayName?: string; /** * Provisioning state of the operation. */ provisioningState: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace recommendationsservice { /** * Account resource properties. */ interface AccountResourceResponseProperties { /** * Account configuration. This can only be set at RecommendationsService Account creation. */ configuration?: string; /** * The list of CORS details. */ cors?: outputs.recommendationsservice.CorsRuleResponse[]; /** * The list of service endpoints authentication details. */ endpointAuthentications?: outputs.recommendationsservice.EndpointAuthenticationResponse[]; /** * The resource provisioning state. */ provisioningState: string; /** * Connection string to write Accounts reports to. */ reportsConnectionString?: string; } /** * CORS details. */ interface CorsRuleResponse { /** * The request headers that the origin domain may specify on the CORS request. */ allowedHeaders?: string[]; /** * The methods (HTTP request verbs) that the origin domain may use for a CORS request. */ allowedMethods?: string[]; /** * The origin domains that are permitted to make a request against the service via CORS. */ allowedOrigins: string[]; /** * The response headers to expose to CORS clients. */ exposedHeaders?: string[]; /** * The number of seconds that the client/browser should cache a preflight response. */ maxAgeInSeconds?: number; } /** * Service endpoints authentication details. */ interface EndpointAuthenticationResponse { /** * AAD tenant ID. */ aadTenantID?: string; /** * AAD principal ID. */ principalID?: string; /** * AAD principal type. */ principalType?: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.recommendationsservice.UserAssignedIdentityResponse; }; } /** * The configuration to raw CDM data to be used as Modeling resource input. */ interface ModelingInputDataResponse { /** * Connection string to raw input data. */ connectionString?: string; } /** * Modeling resource properties. */ interface ModelingResourceResponseProperties { /** * Modeling features controls the set of supported scenarios\models being computed. This can only be set at Modeling creation. */ features?: string; /** * Modeling frequency controls the modeling compute frequency. */ frequency?: string; /** * The configuration to raw CDM data to be used as Modeling resource input. */ inputData?: outputs.recommendationsservice.ModelingInputDataResponse; /** * The resource provisioning state. */ provisioningState: string; /** * Modeling size controls the maximum supported input data size. */ size?: string; } /** * ServiceEndpoint resource properties. */ interface ServiceEndpointResourceResponseProperties { /** * The paired location that will be used by this ServiceEndpoint. */ pairedLocation: string; /** * ServiceEndpoint pre-allocated capacity controls the maximum requests-per-second allowed for that endpoint. Only applicable when Account configuration is Capacity. */ preAllocatedCapacity?: number; /** * The resource provisioning state. */ provisioningState: string; /** * The URL where the ServiceEndpoint API is accessible at. */ url: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace recoveryservices { /** * A2A provider specific settings. */ interface A2ACrossClusterMigrationReplicationDetailsResponse { /** * The fabric specific object Id of the virtual machine. */ fabricObjectId?: string; /** * Gets the Instance type. * Expected value is 'A2ACrossClusterMigration'. */ instanceType: "A2ACrossClusterMigration"; /** * An id associated with the PE that survives actions like switch protection which change the backing PE/CPE objects internally.The lifecycle id gets carried forward to have a link/continuity in being able to have an Id that denotes the "same" protected item even though other internal Ids/ARM Id might be changing. */ lifecycleId?: string; /** * The type of operating system. */ osType?: string; /** * Primary fabric location. */ primaryFabricLocation?: string; /** * The protection state for the vm. */ vmProtectionState?: string; /** * The protection state description for the vm. */ vmProtectionStateDescription?: string; } /** * ExtendedLocation details data. */ interface A2AExtendedLocationDetailsResponse { /** * The primary ExtendedLocation. */ primaryExtendedLocation?: outputs.recoveryservices.ExtendedLocationResponse; /** * The recovery ExtendedLocation. */ recoveryExtendedLocation?: outputs.recoveryservices.ExtendedLocationResponse; } /** * ExtendedLocation details data. */ interface A2AFabricSpecificLocationDetailsResponse { /** * The initial primary ExtendedLocation. */ initialPrimaryExtendedLocation?: outputs.recoveryservices.ExtendedLocationResponse; /** * Initial primary fabric location info. */ initialPrimaryFabricLocation?: string; /** * The initial source zone info. */ initialPrimaryZone?: string; /** * The initial recovery ExtendedLocation. */ initialRecoveryExtendedLocation?: outputs.recoveryservices.ExtendedLocationResponse; /** * The initial recovery fabric location info. */ initialRecoveryFabricLocation?: string; /** * The initial target zone info. */ initialRecoveryZone?: string; /** * The primary ExtendedLocation. */ primaryExtendedLocation?: outputs.recoveryservices.ExtendedLocationResponse; /** * Primary fabric location info. */ primaryFabricLocation?: string; /** * Source zone info. */ primaryZone?: string; /** * The recovery ExtendedLocation. */ recoveryExtendedLocation?: outputs.recoveryservices.ExtendedLocationResponse; /** * The recovery fabric location info. */ recoveryFabricLocation?: string; /** * The target zone info. */ recoveryZone?: string; } /** * A2A specific policy details. */ interface A2APolicyDetailsResponse { /** * The app consistent snapshot frequency in minutes. */ appConsistentFrequencyInMinutes?: number; /** * The crash consistent snapshot frequency in minutes. */ crashConsistentFrequencyInMinutes?: number; /** * Gets the class type. Overridden in derived classes. * Expected value is 'A2A'. */ instanceType: "A2A"; /** * A value indicating whether multi-VM sync has to be enabled. */ multiVmSyncStatus?: string; /** * The duration in minutes until which the recovery points need to be stored. */ recoveryPointHistory?: number; /** * The recovery point threshold in minutes. */ recoveryPointThresholdInMinutes?: number; } /** * A2A protected disk details. */ interface A2AProtectedDiskDetailsResponse { /** * The disk level operations list. */ allowedDiskLevelOperation?: string[]; /** * The data pending at source virtual machine in MB. */ dataPendingAtSourceAgentInMB?: number; /** * The data pending for replication in MB at staging account. */ dataPendingInStagingStorageAccountInMB?: number; /** * The KeyVault resource id for secret (BEK). */ dekKeyVaultArmId?: string; /** * The disk capacity in bytes. */ diskCapacityInBytes?: number; /** * The disk name. */ diskName?: string; /** * The disk state. */ diskState?: string; /** * The type of disk. */ diskType?: string; /** * The disk uri. */ diskUri?: string; /** * The failover name for the managed disk. */ failoverDiskName?: string; /** * A value indicating whether vm has encrypted os disk or not. */ isDiskEncrypted?: boolean; /** * A value indicating whether disk key got encrypted or not. */ isDiskKeyEncrypted?: boolean; /** * The KeyVault resource id for key (KEK). */ kekKeyVaultArmId?: string; /** * The key URL / identifier (KEK). */ keyIdentifier?: string; /** * The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. */ monitoringJobType?: string; /** * The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. */ monitoringPercentageCompletion?: number; /** * The primary disk storage account. */ primaryDiskAzureStorageAccountId?: string; /** * The primary staging storage account. */ primaryStagingAzureStorageAccountId?: string; /** * The recovery disk storage account. */ recoveryAzureStorageAccountId?: string; /** * Recovery disk uri. */ recoveryDiskUri?: string; /** * A value indicating whether resync is required for this disk. */ resyncRequired?: boolean; /** * The secret URL / identifier (BEK). */ secretIdentifier?: string; /** * The test failover name for the managed disk. */ tfoDiskName?: string; } /** * A2A protected managed disk details. */ interface A2AProtectedManagedDiskDetailsResponse { /** * The disk level operations list. */ allowedDiskLevelOperation?: string[]; /** * The data pending at source virtual machine in MB. */ dataPendingAtSourceAgentInMB?: number; /** * The data pending for replication in MB at staging account. */ dataPendingInStagingStorageAccountInMB?: number; /** * The KeyVault resource id for secret (BEK). */ dekKeyVaultArmId?: string; /** * The disk capacity in bytes. */ diskCapacityInBytes?: number; /** * The managed disk Arm id. */ diskId?: string; /** * The disk name. */ diskName?: string; /** * The disk state. */ diskState?: string; /** * The type of disk. */ diskType?: string; /** * The failover name for the managed disk. */ failoverDiskName?: string; /** * A value indicating whether vm has encrypted os disk or not. */ isDiskEncrypted?: boolean; /** * A value indicating whether disk key got encrypted or not. */ isDiskKeyEncrypted?: boolean; /** * The KeyVault resource id for key (KEK). */ kekKeyVaultArmId?: string; /** * The key URL / identifier (KEK). */ keyIdentifier?: string; /** * The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. */ monitoringJobType?: string; /** * The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. */ monitoringPercentageCompletion?: number; /** * The primary disk encryption set Id. */ primaryDiskEncryptionSetId?: string; /** * The primary staging storage account. */ primaryStagingAzureStorageAccountId?: string; /** * The recovery disk encryption set Id. */ recoveryDiskEncryptionSetId?: string; /** * Recovery original target disk Arm Id. */ recoveryOrignalTargetDiskId?: string; /** * The replica disk type. Its an optional value and will be same as source disk type if not user provided. */ recoveryReplicaDiskAccountType?: string; /** * Recovery replica disk Arm Id. */ recoveryReplicaDiskId?: string; /** * The recovery disk resource group Arm Id. */ recoveryResourceGroupId?: string; /** * The target disk type after failover. Its an optional value and will be same as source disk type if not user provided. */ recoveryTargetDiskAccountType?: string; /** * Recovery target disk Arm Id. */ recoveryTargetDiskId?: string; /** * A value indicating whether resync is required for this disk. */ resyncRequired?: boolean; /** * The secret URL / identifier (BEK). */ secretIdentifier?: string; /** * The test failover name for the managed disk. */ tfoDiskName?: string; } /** * A2A provider specific settings. */ interface A2AProtectionContainerMappingDetailsResponse { /** * A value indicating whether the auto update is enabled. */ agentAutoUpdateStatus?: string; /** * The automation account arm id. */ automationAccountArmId?: string; /** * A value indicating the type authentication to use for automation Account. */ automationAccountAuthenticationType?: string; /** * Gets the class type. Overridden in derived classes. * Expected value is 'A2A'. */ instanceType: "A2A"; /** * The job schedule arm name. */ jobScheduleName?: string; /** * The schedule arm name. */ scheduleName?: string; } /** * a2aprotectionContainerMappingDetailsResponseProvideDefaults sets the appropriate defaults for A2AProtectionContainerMappingDetailsResponse */ function a2aprotectionContainerMappingDetailsResponseProvideDefaults(val: A2AProtectionContainerMappingDetailsResponse): A2AProtectionContainerMappingDetailsResponse; /** * A2A provider specific settings. */ interface A2AReplicationDetailsResponse { /** * Agent certificate expiry date. */ agentCertificateExpiryDate: string; /** * Agent expiry date. */ agentExpiryDate?: string; /** * The agent version. */ agentVersion?: string; /** * A value indicating whether the auto protection is enabled. */ autoProtectionOfDataDisk?: string; /** * A value indicating the churn option selected by user. */ churnOptionSelected: string; /** * The fabric specific object Id of the virtual machine. */ fabricObjectId?: string; /** * The initial primary extended location. */ initialPrimaryExtendedLocation?: outputs.recoveryservices.ExtendedLocationResponse; /** * The initial primary fabric location. */ initialPrimaryFabricLocation: string; /** * The initial primary availability zone. */ initialPrimaryZone: string; /** * The initial recovery extended location. */ initialRecoveryExtendedLocation?: outputs.recoveryservices.ExtendedLocationResponse; /** * The initial recovery fabric location. */ initialRecoveryFabricLocation: string; /** * The initial recovery availability zone. */ initialRecoveryZone: string; /** * Gets the Instance type. * Expected value is 'A2A'. */ instanceType: "A2A"; /** * A value indicating if the cluster infra is ready or not. */ isClusterInfraReady?: boolean; /** * A value indicating whether agent certificate update is required. */ isReplicationAgentCertificateUpdateRequired?: boolean; /** * A value indicating whether replication agent update is required. */ isReplicationAgentUpdateRequired?: boolean; /** * The last heartbeat received from the source server. */ lastHeartbeat?: string; /** * The time (in UTC) when the last RPO value was calculated by Protection Service. */ lastRpoCalculatedTime?: string; /** * An id associated with the PE that survives actions like switch protection which change the backing PE/CPE objects internally.The lifecycle id gets carried forward to have a link/continuity in being able to have an Id that denotes the "same" protected item even though other internal Ids/ARM Id might be changing. */ lifecycleId?: string; /** * The management Id. */ managementId?: string; /** * The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. */ monitoringJobType?: string; /** * The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. */ monitoringPercentageCompletion?: number; /** * Whether Multi VM group is auto created or specified by user. */ multiVmGroupCreateOption?: string; /** * The multi vm group Id. */ multiVmGroupId?: string; /** * The multi vm group name. */ multiVmGroupName?: string; /** * The type of operating system. */ osType?: string; /** * The primary availability zone. */ primaryAvailabilityZone?: string; /** * The primary Extended Location. */ primaryExtendedLocation?: outputs.recoveryservices.ExtendedLocationResponse; /** * Primary fabric location. */ primaryFabricLocation?: string; /** * The list of protected disks. */ protectedDisks?: outputs.recoveryservices.A2AProtectedDiskDetailsResponse[]; /** * The list of protected managed disks. */ protectedManagedDisks?: outputs.recoveryservices.A2AProtectedManagedDiskDetailsResponse[]; /** * The replication protection cluster Id. */ protectionClusterId?: string; /** * The recovery availability set. */ recoveryAvailabilitySet?: string; /** * The recovery availability zone. */ recoveryAvailabilityZone?: string; /** * The recovery azure generation. */ recoveryAzureGeneration: string; /** * The recovery resource group. */ recoveryAzureResourceGroupId?: string; /** * The name of recovery virtual machine. */ recoveryAzureVMName?: string; /** * The size of recovery virtual machine. */ recoveryAzureVMSize?: string; /** * The recovery boot diagnostic storage account Arm Id. */ recoveryBootDiagStorageAccountId?: string; /** * The recovery capacity reservation group Id. */ recoveryCapacityReservationGroupId?: string; /** * The recovery cloud service. */ recoveryCloudService?: string; /** * The recovery Extended Location. */ recoveryExtendedLocation?: outputs.recoveryservices.ExtendedLocationResponse; /** * The recovery fabric location. */ recoveryFabricLocation?: string; /** * The recovery fabric object Id. */ recoveryFabricObjectId?: string; /** * The recovery proximity placement group Id. */ recoveryProximityPlacementGroupId?: string; /** * The recovery virtual machine scale set id. */ recoveryVirtualMachineScaleSetId?: string; /** * The last RPO value in seconds. */ rpoInSeconds?: number; /** * The recovery virtual network. */ selectedRecoveryAzureNetworkId?: string; /** * The test failover virtual network. */ selectedTfoAzureNetworkId?: string; /** * The test failover fabric object Id. */ testFailoverRecoveryFabricObjectId?: string; /** * The test failover vm name. */ tfoAzureVMName?: string; /** * The list of unprotected disks. */ unprotectedDisks?: outputs.recoveryservices.A2AUnprotectedDiskDetailsResponse[]; /** * The encryption type of the VM. */ vmEncryptionType: string; /** * The virtual machine nic details. */ vmNics?: outputs.recoveryservices.VMNicDetailsResponse[]; /** * The protection state for the vm. */ vmProtectionState?: string; /** * The protection state description for the vm. */ vmProtectionStateDescription?: string; /** * The synced configuration details. */ vmSyncedConfigDetails?: outputs.recoveryservices.AzureToAzureVmSyncedConfigDetailsResponse; } /** * A2A provider specific settings. */ interface A2AReplicationProtectionClusterDetailsResponse { /** * The cluster management Id. */ clusterManagementId?: string; /** * The recovery point Id to which the cluster was failed over. */ failoverRecoveryPointId?: string; /** * The initial primary extended location. */ initialPrimaryExtendedLocation?: outputs.recoveryservices.ExtendedLocationResponse; /** * The initial primary fabric location. */ initialPrimaryFabricLocation?: string; /** * The initial primary availability zone. */ initialPrimaryZone?: string; /** * The initial recovery extended location. */ initialRecoveryExtendedLocation?: outputs.recoveryservices.ExtendedLocationResponse; /** * The initial recovery fabric location. */ initialRecoveryFabricLocation?: string; /** * The initial recovery availability zone. */ initialRecoveryZone?: string; /** * Gets the Instance type. * Expected value is 'A2A'. */ instanceType: "A2A"; /** * The time (in UTC) when the last RPO value was calculated by Protection Service. */ lastRpoCalculatedTime?: string; /** * An id that survives actions like switch protection which change the backing PE/CPE objects internally.The lifecycle id gets carried forward to have a link/continuity in being able to have an Id that denotes the "same" protected cluster even though other internal Ids/ARM Id might be changing. */ lifecycleId?: string; /** * Whether Multi VM group is auto created or specified by user. */ multiVmGroupCreateOption?: string; /** * The multi vm group Id. */ multiVmGroupId?: string; /** * The multi vm group name. */ multiVmGroupName?: string; /** * The primary availability zone. */ primaryAvailabilityZone?: string; /** * The primary Extended Location. */ primaryExtendedLocation?: outputs.recoveryservices.ExtendedLocationResponse; /** * Primary fabric location. */ primaryFabricLocation?: string; /** * The recovery availability zone. */ recoveryAvailabilityZone?: string; /** * The recovery Extended Location. */ recoveryExtendedLocation?: outputs.recoveryservices.ExtendedLocationResponse; /** * The recovery fabric location. */ recoveryFabricLocation?: string; /** * The last RPO value in seconds. */ rpoInSeconds?: number; } /** * Extended location of the resource. */ interface A2ASharedDiskIRErrorDetailsResponse { /** * The error code. */ errorCode: string; /** * The error code enum. */ errorCodeEnum: string; /** * The error message. */ errorMessage: string; /** * The possible causes. */ possibleCauses: string; /** * The recommended action. */ recommendedAction: string; } /** * A2A provider specific settings. */ interface A2ASharedDiskReplicationDetailsResponse { /** * The recovery point id to which the Virtual node was failed over. */ failoverRecoveryPointId?: string; /** * Gets the Instance type. * Expected value is 'A2A'. */ instanceType: "A2A"; /** * The time (in UTC) when the last RPO value was calculated by Protection Service. */ lastRpoCalculatedTime?: string; /** * The management Id. */ managementId?: string; /** * The type of the monitoring job. The progress is contained in MonitoringPercentageCompletion property. */ monitoringJobType?: string; /** * The percentage of the monitoring job. The type of the monitoring job is defined by MonitoringJobType property. */ monitoringPercentageCompletion?: number; /** * Primary fabric location. */ primaryFabricLocation?: string; /** * The list of protected managed disks. */ protectedManagedDisks?: outputs.recoveryservices.A2AProtectedManagedDiskDetailsResponse[]; /** * The recovery fabric location. */ recoveryFabricLocation?: string; /** * The last RPO value in seconds. */ rpoInSeconds?: number; /** * The IR Errors. */ sharedDiskIRErrors?: outputs.recoveryservices.A2ASharedDiskIRErrorDetailsResponse[]; /** * The list of unprotected disks. */ unprotectedDisks?: outputs.recoveryservices.A2AUnprotectedDiskDetailsResponse[]; } /** * A2A unprotected disk details. */ interface A2AUnprotectedDiskDetailsResponse { /** * A value indicating whether the disk auto protection is enabled. */ diskAutoProtectionStatus?: string; /** * The source lun Id for the data disk. */ diskLunId?: number; } /** * Zone details data. */ interface A2AZoneDetailsResponse { /** * Source zone info. */ source?: string; /** * The target zone info. */ target?: string; } /** * Agent details. */ interface AgentDetailsResponse { /** * The Id of the agent running on the server. */ agentId: string; /** * The machine BIOS Id. */ biosId: string; /** * The disks. */ disks: outputs.recoveryservices.AgentDiskDetailsResponse[]; /** * The machine FQDN. */ fqdn: string; /** * The Id of the machine to which the agent is registered. */ machineId: string; } /** * Agent disk details. */ interface AgentDiskDetailsResponse { /** * The disk capacity in bytes. */ capacityInBytes: number; /** * The disk Id. */ diskId: string; /** * The disk name. */ diskName: string; /** * A value indicating whether the disk is the OS disk. */ isOSDisk: string; /** * The lun of disk. */ lunId: number; } /** * Appliance details of the migration item. */ interface ApplianceMonitoringDetailsResponse { /** * The appliance CPU details. */ cpuDetails: outputs.recoveryservices.ApplianceResourceDetailsResponse; /** * The appliance datastore snapshot details. */ datastoreSnapshot: outputs.recoveryservices.DataStoreUtilizationDetailsResponse[]; /** * The disk replication details. */ disksReplicationDetails: outputs.recoveryservices.ApplianceResourceDetailsResponse; /** * The ESXi NFC buffer details. */ esxiNfcBuffer: outputs.recoveryservices.ApplianceResourceDetailsResponse; /** * The appliance network bandwidth details. */ networkBandwidth: outputs.recoveryservices.ApplianceResourceDetailsResponse; /** * The appliance RAM details. */ ramDetails: outputs.recoveryservices.ApplianceResourceDetailsResponse; } /** * Details of the appliance resource. */ interface ApplianceResourceDetailsResponse { /** * A value indicating the total capacity of appliance resource. */ capacity: number; /** * A value indicating the utilization percentage by gateway agent on appliance. */ processUtilization: number; /** * A value indicating the status of appliance resource. */ status: string; /** * A value indicating the total utilization percentage for all processes on the appliance. */ totalUtilization: number; } /** * AzureBackupServer (DPMVenus) workload-specific protection container. */ interface AzureBackupServerContainerResponse { /** * Type of backup management for the container. */ backupManagementType?: string; /** * Specifies whether the container is re-registrable. */ canReRegister?: boolean; /** * ID of container. */ containerId?: string; /** * Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. * Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is * Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload * Backup is VMAppContainer * Expected value is 'AzureBackupServerContainer'. */ containerType: "AzureBackupServerContainer"; /** * Backup engine Agent version */ dpmAgentVersion?: string; /** * List of BackupEngines protecting the container */ dpmServers?: string[]; /** * Extended Info of the container. */ extendedInfo?: outputs.recoveryservices.DPMContainerExtendedInfoResponse; /** * Friendly name of the container. */ friendlyName?: string; /** * Status of health of the container. */ healthStatus?: string; /** * Type of the protectable object associated with this container */ protectableObjectType?: string; /** * Number of protected items in the BackupEngine */ protectedItemCount?: number; /** * Protection status of the container. */ protectionStatus?: string; /** * Status of registration of the container with the Recovery Services Vault. */ registrationStatus?: string; /** * To check if upgrade available */ upgradeAvailable?: boolean; } /** * Azure Fabric Specific Details. */ interface AzureFabricSpecificDetailsResponse { /** * The container Ids for the Azure fabric. */ containerIds?: string[]; /** * The ExtendedLocations. */ extendedLocations?: outputs.recoveryservices.A2AExtendedLocationDetailsResponse[]; /** * Gets the class type. Overridden in derived classes. * Expected value is 'Azure'. */ instanceType: "Azure"; /** * The Location for the Azure fabric. */ location?: string; /** * The location details. */ locationDetails?: outputs.recoveryservices.A2AFabricSpecificLocationDetailsResponse[]; /** * The zones. */ zones?: outputs.recoveryservices.A2AZoneDetailsResponse[]; } /** * AzureStorage backup policy. */ interface AzureFileShareProtectionPolicyResponse { /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'AzureStorage'. */ backupManagementType: "AzureStorage"; /** * Number of items associated with this policy. */ protectedItemsCount?: number; /** * ResourceGuard Operation Requests */ resourceGuardOperationRequests?: string[]; /** * Retention policy with the details on backup copy retention ranges. */ retentionPolicy?: outputs.recoveryservices.LongTermRetentionPolicyResponse | outputs.recoveryservices.SimpleRetentionPolicyResponse; /** * Backup schedule specified as part of backup policy. */ schedulePolicy?: outputs.recoveryservices.LogSchedulePolicyResponse | outputs.recoveryservices.LongTermSchedulePolicyResponse | outputs.recoveryservices.SimpleSchedulePolicyResponse | outputs.recoveryservices.SimpleSchedulePolicyV2Response; /** * TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time". */ timeZone?: string; /** * Retention policy with the details on hardened backup copy retention ranges. */ vaultRetentionPolicy?: outputs.recoveryservices.VaultRetentionPolicyResponse; /** * Type of workload for the backup management */ workLoadType?: string; } /** * Additional information about Azure File Share backup item. */ interface AzureFileshareProtectedItemExtendedInfoResponse { /** * The oldest backup copy available for this item in the service. */ oldestRecoveryPoint?: string; /** * Indicates consistency of policy object and policy applied to this backup item. */ policyState?: string; /** * Number of available backup copies associated with this backup item. */ recoveryPointCount?: number; /** * Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} */ resourceState: string; /** * The resource state sync time for this backup item. */ resourceStateSyncTime: string; } /** * Azure File Share workload-specific backup item. */ interface AzureFileshareProtectedItemResponse { /** * Type of backup management for the backed up item. */ backupManagementType: string; /** * Name of the backup set the backup item belongs to */ backupSetName?: string; /** * Unique name of container */ containerName?: string; /** * Create mode to indicate recovery of existing soft deleted data source or creation of new data source. */ createMode?: string; /** * Time for deferred deletion in UTC */ deferredDeleteTimeInUTC?: string; /** * Time remaining before the DS marked for deferred delete is permanently deleted */ deferredDeleteTimeRemaining?: string; /** * Additional information with this backup item. */ extendedInfo?: outputs.recoveryservices.AzureFileshareProtectedItemExtendedInfoResponse; /** * Friendly name of the fileshare represented by this backup item. */ friendlyName?: string; /** * Flag to identify whether datasource is protected in archive */ isArchiveEnabled?: boolean; /** * Flag to identify whether the deferred deleted DS is to be purged soon */ isDeferredDeleteScheduleUpcoming?: boolean; /** * Flag to identify that deferred deleted DS is to be moved into Pause state */ isRehydrate?: boolean; /** * Flag to identify whether the DS is scheduled for deferred delete */ isScheduledForDeferredDelete?: boolean; /** * Health details of different KPIs */ kpisHealths?: { [key: string]: outputs.recoveryservices.KPIResourceHealthDetailsResponse; }; /** * Last backup operation status. Possible values: Healthy, Unhealthy. */ lastBackupStatus?: string; /** * Timestamp of the last backup operation on this backup item. */ lastBackupTime?: string; /** * Timestamp when the last (latest) backup copy was created for this backup item. */ lastRecoveryPoint?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * Name of the policy used for protection */ policyName?: string; /** * backup item type. * Expected value is 'AzureFileShareProtectedItem'. */ protectedItemType: "AzureFileShareProtectedItem"; /** * Backup state of this backup item. */ protectionState?: string; /** * Backup status of this backup item. */ protectionStatus?: string; /** * ResourceGuardOperationRequests on which LAC check will be performed */ resourceGuardOperationRequests?: string[]; /** * Soft delete retention period in days */ softDeleteRetentionPeriodInDays?: number; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; /** * ID of the vault which protects this item */ vaultId: string; /** * Type of workload this item represents. */ workloadType: string; } /** * IaaS VM workload-specific backup item representing a classic virtual machine. */ interface AzureIaaSClassicComputeVMContainerResponse { /** * Type of backup management for the container. */ backupManagementType?: string; /** * Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. * Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is * Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload * Backup is VMAppContainer * Expected value is 'Microsoft.ClassicCompute/virtualMachines'. */ containerType: "Microsoft.ClassicCompute/virtualMachines"; /** * Friendly name of the container. */ friendlyName?: string; /** * Status of health of the container. */ healthStatus?: string; /** * Type of the protectable object associated with this container */ protectableObjectType?: string; /** * Status of registration of the container with the Recovery Services Vault. */ registrationStatus?: string; /** * Resource group name of Recovery Services Vault. */ resourceGroup?: string; /** * Fully qualified ARM url of the virtual machine represented by this Azure IaaS VM container. */ virtualMachineId?: string; /** * Specifies whether the container represents a Classic or an Azure Resource Manager VM. */ virtualMachineVersion?: string; } /** * IaaS VM workload-specific backup item representing the Classic Compute VM. */ interface AzureIaaSClassicComputeVMProtectedItemResponse { /** * Type of backup management for the backed up item. */ backupManagementType: string; /** * Name of the backup set the backup item belongs to */ backupSetName?: string; /** * Unique name of container */ containerName?: string; /** * Create mode to indicate recovery of existing soft deleted data source or creation of new data source. */ createMode?: string; /** * Time for deferred deletion in UTC */ deferredDeleteTimeInUTC?: string; /** * Time remaining before the DS marked for deferred delete is permanently deleted */ deferredDeleteTimeRemaining?: string; /** * Additional information for this backup item. */ extendedInfo?: outputs.recoveryservices.AzureIaaSVMProtectedItemExtendedInfoResponse; /** * Extended Properties for Azure IaasVM Backup. */ extendedProperties?: outputs.recoveryservices.ExtendedPropertiesResponse; /** * Friendly name of the VM represented by this backup item. */ friendlyName: string; /** * Health details on this backup item. */ healthDetails?: outputs.recoveryservices.AzureIaaSVMHealthDetailsResponse[]; /** * Health status of protected item. */ healthStatus: string; /** * Flag to identify whether datasource is protected in archive */ isArchiveEnabled?: boolean; /** * Flag to identify whether the deferred deleted DS is to be purged soon */ isDeferredDeleteScheduleUpcoming?: boolean; /** * Flag to identify that deferred deleted DS is to be moved into Pause state */ isRehydrate?: boolean; /** * Flag to identify whether the DS is scheduled for deferred delete */ isScheduledForDeferredDelete?: boolean; /** * Health details of different KPIs */ kpisHealths?: { [key: string]: outputs.recoveryservices.KPIResourceHealthDetailsResponse; }; /** * Last backup operation status. */ lastBackupStatus?: string; /** * Timestamp of the last backup operation on this backup item. */ lastBackupTime: string; /** * Timestamp when the last (latest) backup copy was created for this backup item. */ lastRecoveryPoint?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * Name of the policy used for protection */ policyName?: string; /** * Data ID of the protected item. */ protectedItemDataId: string; /** * backup item type. * Expected value is 'Microsoft.ClassicCompute/virtualMachines'. */ protectedItemType: "Microsoft.ClassicCompute/virtualMachines"; /** * Backup state of this backup item. */ protectionState?: string; /** * Backup status of this backup item. */ protectionStatus?: string; /** * ResourceGuardOperationRequests on which LAC check will be performed */ resourceGuardOperationRequests?: string[]; /** * Soft delete retention period in days */ softDeleteRetentionPeriodInDays?: number; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; /** * ID of the vault which protects this item */ vaultId: string; /** * Fully qualified ARM ID of the virtual machine represented by this item. */ virtualMachineId: string; /** * Type of workload this item represents. */ workloadType: string; } /** * IaaS VM workload-specific backup item representing an Azure Resource Manager virtual machine. */ interface AzureIaaSComputeVMContainerResponse { /** * Type of backup management for the container. */ backupManagementType?: string; /** * Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. * Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is * Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload * Backup is VMAppContainer * Expected value is 'Microsoft.Compute/virtualMachines'. */ containerType: "Microsoft.Compute/virtualMachines"; /** * Friendly name of the container. */ friendlyName?: string; /** * Status of health of the container. */ healthStatus?: string; /** * Type of the protectable object associated with this container */ protectableObjectType?: string; /** * Status of registration of the container with the Recovery Services Vault. */ registrationStatus?: string; /** * Resource group name of Recovery Services Vault. */ resourceGroup?: string; /** * Fully qualified ARM url of the virtual machine represented by this Azure IaaS VM container. */ virtualMachineId?: string; /** * Specifies whether the container represents a Classic or an Azure Resource Manager VM. */ virtualMachineVersion?: string; } /** * IaaS VM workload-specific backup item representing the Azure Resource Manager VM. */ interface AzureIaaSComputeVMProtectedItemResponse { /** * Type of backup management for the backed up item. */ backupManagementType: string; /** * Name of the backup set the backup item belongs to */ backupSetName?: string; /** * Unique name of container */ containerName?: string; /** * Create mode to indicate recovery of existing soft deleted data source or creation of new data source. */ createMode?: string; /** * Time for deferred deletion in UTC */ deferredDeleteTimeInUTC?: string; /** * Time remaining before the DS marked for deferred delete is permanently deleted */ deferredDeleteTimeRemaining?: string; /** * Additional information for this backup item. */ extendedInfo?: outputs.recoveryservices.AzureIaaSVMProtectedItemExtendedInfoResponse; /** * Extended Properties for Azure IaasVM Backup. */ extendedProperties?: outputs.recoveryservices.ExtendedPropertiesResponse; /** * Friendly name of the VM represented by this backup item. */ friendlyName: string; /** * Health details on this backup item. */ healthDetails?: outputs.recoveryservices.AzureIaaSVMHealthDetailsResponse[]; /** * Health status of protected item. */ healthStatus: string; /** * Flag to identify whether datasource is protected in archive */ isArchiveEnabled?: boolean; /** * Flag to identify whether the deferred deleted DS is to be purged soon */ isDeferredDeleteScheduleUpcoming?: boolean; /** * Flag to identify that deferred deleted DS is to be moved into Pause state */ isRehydrate?: boolean; /** * Flag to identify whether the DS is scheduled for deferred delete */ isScheduledForDeferredDelete?: boolean; /** * Health details of different KPIs */ kpisHealths?: { [key: string]: outputs.recoveryservices.KPIResourceHealthDetailsResponse; }; /** * Last backup operation status. */ lastBackupStatus?: string; /** * Timestamp of the last backup operation on this backup item. */ lastBackupTime: string; /** * Timestamp when the last (latest) backup copy was created for this backup item. */ lastRecoveryPoint?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * Name of the policy used for protection */ policyName?: string; /** * Data ID of the protected item. */ protectedItemDataId: string; /** * backup item type. * Expected value is 'Microsoft.Compute/virtualMachines'. */ protectedItemType: "Microsoft.Compute/virtualMachines"; /** * Backup state of this backup item. */ protectionState?: string; /** * Backup status of this backup item. */ protectionStatus?: string; /** * ResourceGuardOperationRequests on which LAC check will be performed */ resourceGuardOperationRequests?: string[]; /** * Soft delete retention period in days */ softDeleteRetentionPeriodInDays?: number; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; /** * ID of the vault which protects this item */ vaultId: string; /** * Fully qualified ARM ID of the virtual machine represented by this item. */ virtualMachineId: string; /** * Type of workload this item represents. */ workloadType: string; } /** * Azure IaaS VM workload-specific Health Details. */ interface AzureIaaSVMHealthDetailsResponse { /** * Health Code */ code: number; /** * Health Message */ message: string; /** * Health Recommended Actions */ recommendations: string[]; /** * Health Title */ title: string; } /** * Additional information on Azure IaaS VM specific backup item. */ interface AzureIaaSVMProtectedItemExtendedInfoResponse { /** * The latest backup copy available for this backup item in archive tier */ newestRecoveryPointInArchive?: string; /** * The oldest backup copy available for this backup item across all tiers. */ oldestRecoveryPoint?: string; /** * The oldest backup copy available for this backup item in archive tier */ oldestRecoveryPointInArchive?: string; /** * The oldest backup copy available for this backup item in vault tier */ oldestRecoveryPointInVault?: string; /** * Specifies if backup policy associated with the backup item is inconsistent. */ policyInconsistent?: boolean; /** * Number of backup copies available for this backup item. */ recoveryPointCount?: number; } /** * IaaS VM workload-specific backup item. */ interface AzureIaaSVMProtectedItemResponse { /** * Type of backup management for the backed up item. */ backupManagementType: string; /** * Name of the backup set the backup item belongs to */ backupSetName?: string; /** * Unique name of container */ containerName?: string; /** * Create mode to indicate recovery of existing soft deleted data source or creation of new data source. */ createMode?: string; /** * Time for deferred deletion in UTC */ deferredDeleteTimeInUTC?: string; /** * Time remaining before the DS marked for deferred delete is permanently deleted */ deferredDeleteTimeRemaining?: string; /** * Additional information for this backup item. */ extendedInfo?: outputs.recoveryservices.AzureIaaSVMProtectedItemExtendedInfoResponse; /** * Extended Properties for Azure IaasVM Backup. */ extendedProperties?: outputs.recoveryservices.ExtendedPropertiesResponse; /** * Friendly name of the VM represented by this backup item. */ friendlyName: string; /** * Health details on this backup item. */ healthDetails?: outputs.recoveryservices.AzureIaaSVMHealthDetailsResponse[]; /** * Health status of protected item. */ healthStatus: string; /** * Flag to identify whether datasource is protected in archive */ isArchiveEnabled?: boolean; /** * Flag to identify whether the deferred deleted DS is to be purged soon */ isDeferredDeleteScheduleUpcoming?: boolean; /** * Flag to identify that deferred deleted DS is to be moved into Pause state */ isRehydrate?: boolean; /** * Flag to identify whether the DS is scheduled for deferred delete */ isScheduledForDeferredDelete?: boolean; /** * Health details of different KPIs */ kpisHealths?: { [key: string]: outputs.recoveryservices.KPIResourceHealthDetailsResponse; }; /** * Last backup operation status. */ lastBackupStatus?: string; /** * Timestamp of the last backup operation on this backup item. */ lastBackupTime: string; /** * Timestamp when the last (latest) backup copy was created for this backup item. */ lastRecoveryPoint?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * Name of the policy used for protection */ policyName?: string; /** * Data ID of the protected item. */ protectedItemDataId: string; /** * backup item type. * Expected value is 'AzureIaaSVMProtectedItem'. */ protectedItemType: "AzureIaaSVMProtectedItem"; /** * Backup state of this backup item. */ protectionState?: string; /** * Backup status of this backup item. */ protectionStatus?: string; /** * ResourceGuardOperationRequests on which LAC check will be performed */ resourceGuardOperationRequests?: string[]; /** * Soft delete retention period in days */ softDeleteRetentionPeriodInDays?: number; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; /** * ID of the vault which protects this item */ vaultId: string; /** * Fully qualified ARM ID of the virtual machine represented by this item. */ virtualMachineId: string; /** * Type of workload this item represents. */ workloadType: string; } /** * IaaS VM workload-specific backup policy. */ interface AzureIaaSVMProtectionPolicyResponse { /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'AzureIaasVM'. */ backupManagementType: "AzureIaasVM"; instantRPDetails?: outputs.recoveryservices.InstantRPAdditionalDetailsResponse; /** * Instant RP retention policy range in days */ instantRpRetentionRangeInDays?: number; policyType?: string; /** * Number of items associated with this policy. */ protectedItemsCount?: number; /** * ResourceGuard Operation Requests */ resourceGuardOperationRequests?: string[]; /** * Retention policy with the details on backup copy retention ranges. */ retentionPolicy?: outputs.recoveryservices.LongTermRetentionPolicyResponse | outputs.recoveryservices.SimpleRetentionPolicyResponse; /** * Backup schedule specified as part of backup policy. */ schedulePolicy?: outputs.recoveryservices.LogSchedulePolicyResponse | outputs.recoveryservices.LongTermSchedulePolicyResponse | outputs.recoveryservices.SimpleSchedulePolicyResponse | outputs.recoveryservices.SimpleSchedulePolicyV2Response; snapshotConsistencyType?: string; /** * Tiering policy to automatically move RPs to another tier * Key is Target Tier, defined in RecoveryPointTierType enum. * Tiering policy specifies the criteria to move RP to the target tier. */ tieringPolicy?: { [key: string]: outputs.recoveryservices.TieringPolicyResponse; }; /** * TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time". */ timeZone?: string; } /** * Settings for Azure Monitor based alerts */ interface AzureMonitorAlertSettingsResponse { alertsForAllFailoverIssues?: string; alertsForAllJobFailures?: string; alertsForAllReplicationIssues?: string; } /** * Azure Recovery Services Vault specific protection intent item. */ interface AzureRecoveryServiceVaultProtectionIntentResponse { /** * Type of backup management for the backed up item. */ backupManagementType?: string; /** * ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId */ itemId?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * backup protectionIntent type. * Expected value is 'RecoveryServiceVaultItem'. */ protectionIntentItemType: "RecoveryServiceVaultItem"; /** * Backup state of this backup item. */ protectionState?: string; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; } /** * IaaS VM specific backup protection intent item. */ interface AzureResourceProtectionIntentResponse { /** * Type of backup management for the backed up item. */ backupManagementType?: string; /** * Friendly name of the VM represented by this backup item. */ friendlyName?: string; /** * ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId */ itemId?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * backup protectionIntent type. * Expected value is 'AzureResourceItem'. */ protectionIntentItemType: "AzureResourceItem"; /** * Backup state of this backup item. */ protectionState?: string; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; } /** * Container for SQL workloads under SQL Availability Group. */ interface AzureSQLAGWorkloadContainerProtectionContainerResponse { /** * Type of backup management for the container. */ backupManagementType?: string; /** * Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. * Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is * Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload * Backup is VMAppContainer * Expected value is 'SQLAGWorkLoadContainer'. */ containerType: "SQLAGWorkLoadContainer"; /** * Additional details of a workload container. */ extendedInfo?: outputs.recoveryservices.AzureWorkloadContainerExtendedInfoResponse; /** * Friendly name of the container. */ friendlyName?: string; /** * Status of health of the container. */ healthStatus?: string; /** * Time stamp when this container was updated. */ lastUpdatedTime?: string; /** * Re-Do Operation */ operationType?: string; /** * Type of the protectable object associated with this container */ protectableObjectType?: string; /** * Status of registration of the container with the Recovery Services Vault. */ registrationStatus?: string; /** * ARM ID of the virtual machine represented by this Azure Workload Container */ sourceResourceId?: string; /** * Workload type for which registration was sent. */ workloadType?: string; } /** * Azure Sql workload-specific container. */ interface AzureSqlContainerResponse { /** * Type of backup management for the container. */ backupManagementType?: string; /** * Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. * Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is * Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload * Backup is VMAppContainer * Expected value is 'AzureSqlContainer'. */ containerType: "AzureSqlContainer"; /** * Friendly name of the container. */ friendlyName?: string; /** * Status of health of the container. */ healthStatus?: string; /** * Type of the protectable object associated with this container */ protectableObjectType?: string; /** * Status of registration of the container with the Recovery Services Vault. */ registrationStatus?: string; } /** * Additional information on Azure Sql specific protected item. */ interface AzureSqlProtectedItemExtendedInfoResponse { /** * The oldest backup copy available for this item in the service. */ oldestRecoveryPoint?: string; /** * State of the backup policy associated with this backup item. */ policyState?: string; /** * Number of available backup copies associated with this backup item. */ recoveryPointCount?: number; } /** * Azure SQL workload-specific backup item. */ interface AzureSqlProtectedItemResponse { /** * Type of backup management for the backed up item. */ backupManagementType: string; /** * Name of the backup set the backup item belongs to */ backupSetName?: string; /** * Unique name of container */ containerName?: string; /** * Create mode to indicate recovery of existing soft deleted data source or creation of new data source. */ createMode?: string; /** * Time for deferred deletion in UTC */ deferredDeleteTimeInUTC?: string; /** * Time remaining before the DS marked for deferred delete is permanently deleted */ deferredDeleteTimeRemaining?: string; /** * Additional information for this backup item. */ extendedInfo?: outputs.recoveryservices.AzureSqlProtectedItemExtendedInfoResponse; /** * Flag to identify whether datasource is protected in archive */ isArchiveEnabled?: boolean; /** * Flag to identify whether the deferred deleted DS is to be purged soon */ isDeferredDeleteScheduleUpcoming?: boolean; /** * Flag to identify that deferred deleted DS is to be moved into Pause state */ isRehydrate?: boolean; /** * Flag to identify whether the DS is scheduled for deferred delete */ isScheduledForDeferredDelete?: boolean; /** * Timestamp when the last (latest) backup copy was created for this backup item. */ lastRecoveryPoint?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * Name of the policy used for protection */ policyName?: string; /** * Internal ID of a backup item. Used by Azure SQL Backup engine to contact Recovery Services. */ protectedItemDataId?: string; /** * backup item type. * Expected value is 'Microsoft.Sql/servers/databases'. */ protectedItemType: "Microsoft.Sql/servers/databases"; /** * Backup state of the backed up item. */ protectionState?: string; /** * ResourceGuardOperationRequests on which LAC check will be performed */ resourceGuardOperationRequests?: string[]; /** * Soft delete retention period in days */ softDeleteRetentionPeriodInDays?: number; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; /** * ID of the vault which protects this item */ vaultId: string; /** * Type of workload this item represents. */ workloadType: string; } /** * Azure SQL workload-specific backup policy. */ interface AzureSqlProtectionPolicyResponse { /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'AzureSql'. */ backupManagementType: "AzureSql"; /** * Number of items associated with this policy. */ protectedItemsCount?: number; /** * ResourceGuard Operation Requests */ resourceGuardOperationRequests?: string[]; /** * Retention policy details. */ retentionPolicy?: outputs.recoveryservices.LongTermRetentionPolicyResponse | outputs.recoveryservices.SimpleRetentionPolicyResponse; } /** * Azure Storage Account workload-specific container. */ interface AzureStorageContainerResponse { /** * Whether storage account lock is to be acquired for this container or not. */ acquireStorageAccountLock?: string; /** * Type of backup management for the container. */ backupManagementType?: string; /** * Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. * Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is * Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload * Backup is VMAppContainer * Expected value is 'StorageContainer'. */ containerType: "StorageContainer"; /** * Friendly name of the container. */ friendlyName?: string; /** * Status of health of the container. */ healthStatus?: string; /** * Re-Do Operation */ operationType?: string; /** * Type of the protectable object associated with this container */ protectableObjectType?: string; /** * Number of items backed up in this container. */ protectedItemCount?: number; /** * Status of registration of the container with the Recovery Services Vault. */ registrationStatus?: string; /** * Resource group name of Recovery Services Vault. */ resourceGroup?: string; /** * Fully qualified ARM url. */ sourceResourceId?: string; /** * Storage account version. */ storageAccountVersion?: string; } /** * A2A Network Mapping fabric specific settings. */ interface AzureToAzureNetworkMappingSettingsResponse { /** * Gets the Instance type. * Expected value is 'AzureToAzure'. */ instanceType: "AzureToAzure"; /** * The primary fabric location. */ primaryFabricLocation?: string; /** * The recovery fabric location. */ recoveryFabricLocation?: string; } /** * Azure to Azure VM synced configuration details. */ interface AzureToAzureVmSyncedConfigDetailsResponse { /** * The Azure VM input endpoints. */ inputEndpoints?: outputs.recoveryservices.InputEndpointResponse[]; /** * The Azure VM tags. */ tags?: { [key: string]: string; }; } /** * Container for SQL workloads under Azure Virtual Machines. */ interface AzureVMAppContainerProtectionContainerResponse { /** * Type of backup management for the container. */ backupManagementType?: string; /** * Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. * Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is * Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload * Backup is VMAppContainer * Expected value is 'VMAppContainer'. */ containerType: "VMAppContainer"; /** * Additional details of a workload container. */ extendedInfo?: outputs.recoveryservices.AzureWorkloadContainerExtendedInfoResponse; /** * Friendly name of the container. */ friendlyName?: string; /** * Status of health of the container. */ healthStatus?: string; /** * Time stamp when this container was updated. */ lastUpdatedTime?: string; /** * Re-Do Operation */ operationType?: string; /** * Type of the protectable object associated with this container */ protectableObjectType?: string; /** * Status of registration of the container with the Recovery Services Vault. */ registrationStatus?: string; /** * ARM ID of the virtual machine represented by this Azure Workload Container */ sourceResourceId?: string; /** * Workload type for which registration was sent. */ workloadType?: string; } /** * Disk details for E2A provider. */ interface AzureVmDiskDetailsResponse { /** * The custom target Azure disk name. */ customTargetDiskName?: string; /** * The DiskEncryptionSet ARM ID. */ diskEncryptionSetId?: string; /** * The disk resource id. */ diskId?: string; /** * Ordinal\LunId of the disk for the Azure VM. */ lunId?: string; /** * Max side in MB. */ maxSizeMB?: string; /** * Blob uri of the Azure disk. */ targetDiskLocation?: string; /** * The target Azure disk name. */ targetDiskName?: string; /** * The VHD id. */ vhdId?: string; /** * VHD name. */ vhdName?: string; /** * VHD type. */ vhdType?: string; } /** * Additional information on Azure Workload for SQL specific backup item. */ interface AzureVmWorkloadProtectedItemExtendedInfoResponse { /** * The latest backup copy available for this backup item in archive tier */ newestRecoveryPointInArchive?: string; /** * The oldest backup copy available for this backup item across all tiers. */ oldestRecoveryPoint?: string; /** * The oldest backup copy available for this backup item in archive tier */ oldestRecoveryPointInArchive?: string; /** * The oldest backup copy available for this backup item in vault tier */ oldestRecoveryPointInVault?: string; /** * Indicates consistency of policy object and policy applied to this backup item. */ policyState?: string; /** * Indicates consistency of policy object and policy applied to this backup item. */ recoveryModel?: string; /** * Number of backup copies available for this backup item. */ recoveryPointCount?: number; } /** * Azure VM workload-specific protected item. */ interface AzureVmWorkloadProtectedItemResponse { /** * Type of backup management for the backed up item. */ backupManagementType: string; /** * Name of the backup set the backup item belongs to */ backupSetName?: string; /** * Unique name of container */ containerName?: string; /** * Create mode to indicate recovery of existing soft deleted data source or creation of new data source. */ createMode?: string; /** * Time for deferred deletion in UTC */ deferredDeleteTimeInUTC?: string; /** * Time remaining before the DS marked for deferred delete is permanently deleted */ deferredDeleteTimeRemaining?: string; /** * Additional information for this backup item. */ extendedInfo?: outputs.recoveryservices.AzureVmWorkloadProtectedItemExtendedInfoResponse; /** * Friendly name of the DB represented by this backup item. */ friendlyName: string; /** * Flag to identify whether datasource is protected in archive */ isArchiveEnabled?: boolean; /** * Flag to identify whether the deferred deleted DS is to be purged soon */ isDeferredDeleteScheduleUpcoming?: boolean; /** * Flag to identify that deferred deleted DS is to be moved into Pause state */ isRehydrate?: boolean; /** * Flag to identify whether the DS is scheduled for deferred delete */ isScheduledForDeferredDelete?: boolean; /** * Health details of different KPIs */ kpisHealths?: { [key: string]: outputs.recoveryservices.KPIResourceHealthDetailsResponse; }; /** * Error details in last backup */ lastBackupErrorDetail?: outputs.recoveryservices.ErrorDetailResponse; /** * Last backup operation status. Possible values: Healthy, Unhealthy. */ lastBackupStatus?: string; /** * Timestamp of the last backup operation on this backup item. */ lastBackupTime?: string; /** * Timestamp when the last (latest) backup copy was created for this backup item. */ lastRecoveryPoint?: string; /** * List of the nodes in case of distributed container. */ nodesList?: outputs.recoveryservices.DistributedNodesInfoResponse[]; /** * Parent name of the DB such as Instance or Availability Group. */ parentName?: string; /** * Parent type of protected item, example: for a DB, standalone server or distributed */ parentType?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * Name of the policy used for protection */ policyName?: string; /** * Data ID of the protected item. */ protectedItemDataSourceId?: string; /** * Health status of the backup item, evaluated based on last heartbeat received */ protectedItemHealthStatus?: string; /** * backup item type. * Expected value is 'AzureVmWorkloadProtectedItem'. */ protectedItemType: "AzureVmWorkloadProtectedItem"; /** * Backup state of this backup item. */ protectionState?: string; /** * Backup status of this backup item. */ protectionStatus: string; /** * ResourceGuardOperationRequests on which LAC check will be performed */ resourceGuardOperationRequests?: string[]; /** * Host/Cluster Name for instance or AG */ serverName?: string; /** * Soft delete retention period in days */ softDeleteRetentionPeriodInDays?: number; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; /** * ID of the vault which protects this item */ vaultId: string; /** * Type of workload this item represents. */ workloadType: string; } /** * Azure VM (Mercury) workload-specific backup policy. */ interface AzureVmWorkloadProtectionPolicyResponse { /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'AzureWorkload'. */ backupManagementType: "AzureWorkload"; /** * Fix the policy inconsistency */ makePolicyConsistent?: boolean; /** * Number of items associated with this policy. */ protectedItemsCount?: number; /** * ResourceGuard Operation Requests */ resourceGuardOperationRequests?: string[]; /** * Common settings for the backup management */ settings?: outputs.recoveryservices.SettingsResponse; /** * List of sub-protection policies which includes schedule and retention */ subProtectionPolicy?: outputs.recoveryservices.SubProtectionPolicyResponse[]; /** * Type of workload for the backup management */ workLoadType?: string; } /** * Azure VM workload-specific protected item representing SAP ASE Database. */ interface AzureVmWorkloadSAPAseDatabaseProtectedItemResponse { /** * Type of backup management for the backed up item. */ backupManagementType: string; /** * Name of the backup set the backup item belongs to */ backupSetName?: string; /** * Unique name of container */ containerName?: string; /** * Create mode to indicate recovery of existing soft deleted data source or creation of new data source. */ createMode?: string; /** * Time for deferred deletion in UTC */ deferredDeleteTimeInUTC?: string; /** * Time remaining before the DS marked for deferred delete is permanently deleted */ deferredDeleteTimeRemaining?: string; /** * Additional information for this backup item. */ extendedInfo?: outputs.recoveryservices.AzureVmWorkloadProtectedItemExtendedInfoResponse; /** * Friendly name of the DB represented by this backup item. */ friendlyName: string; /** * Flag to identify whether datasource is protected in archive */ isArchiveEnabled?: boolean; /** * Flag to identify whether the deferred deleted DS is to be purged soon */ isDeferredDeleteScheduleUpcoming?: boolean; /** * Flag to identify that deferred deleted DS is to be moved into Pause state */ isRehydrate?: boolean; /** * Flag to identify whether the DS is scheduled for deferred delete */ isScheduledForDeferredDelete?: boolean; /** * Health details of different KPIs */ kpisHealths?: { [key: string]: outputs.recoveryservices.KPIResourceHealthDetailsResponse; }; /** * Error details in last backup */ lastBackupErrorDetail?: outputs.recoveryservices.ErrorDetailResponse; /** * Last backup operation status. Possible values: Healthy, Unhealthy. */ lastBackupStatus?: string; /** * Timestamp of the last backup operation on this backup item. */ lastBackupTime?: string; /** * Timestamp when the last (latest) backup copy was created for this backup item. */ lastRecoveryPoint?: string; /** * List of the nodes in case of distributed container. */ nodesList?: outputs.recoveryservices.DistributedNodesInfoResponse[]; /** * Parent name of the DB such as Instance or Availability Group. */ parentName?: string; /** * Parent type of protected item, example: for a DB, standalone server or distributed */ parentType?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * Name of the policy used for protection */ policyName?: string; /** * Data ID of the protected item. */ protectedItemDataSourceId?: string; /** * Health status of the backup item, evaluated based on last heartbeat received */ protectedItemHealthStatus?: string; /** * backup item type. * Expected value is 'AzureVmWorkloadSAPAseDatabase'. */ protectedItemType: "AzureVmWorkloadSAPAseDatabase"; /** * Backup state of this backup item. */ protectionState?: string; /** * Backup status of this backup item. */ protectionStatus: string; /** * ResourceGuardOperationRequests on which LAC check will be performed */ resourceGuardOperationRequests?: string[]; /** * Host/Cluster Name for instance or AG */ serverName?: string; /** * Soft delete retention period in days */ softDeleteRetentionPeriodInDays?: number; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; /** * ID of the vault which protects this item */ vaultId: string; /** * Type of workload this item represents. */ workloadType: string; } /** * Azure VM workload-specific protected item representing SAP HANA DBInstance. */ interface AzureVmWorkloadSAPHanaDBInstanceProtectedItemResponse { /** * Type of backup management for the backed up item. */ backupManagementType: string; /** * Name of the backup set the backup item belongs to */ backupSetName?: string; /** * Unique name of container */ containerName?: string; /** * Create mode to indicate recovery of existing soft deleted data source or creation of new data source. */ createMode?: string; /** * Time for deferred deletion in UTC */ deferredDeleteTimeInUTC?: string; /** * Time remaining before the DS marked for deferred delete is permanently deleted */ deferredDeleteTimeRemaining?: string; /** * Additional information for this backup item. */ extendedInfo?: outputs.recoveryservices.AzureVmWorkloadProtectedItemExtendedInfoResponse; /** * Friendly name of the DB represented by this backup item. */ friendlyName: string; /** * Flag to identify whether datasource is protected in archive */ isArchiveEnabled?: boolean; /** * Flag to identify whether the deferred deleted DS is to be purged soon */ isDeferredDeleteScheduleUpcoming?: boolean; /** * Flag to identify that deferred deleted DS is to be moved into Pause state */ isRehydrate?: boolean; /** * Flag to identify whether the DS is scheduled for deferred delete */ isScheduledForDeferredDelete?: boolean; /** * Health details of different KPIs */ kpisHealths?: { [key: string]: outputs.recoveryservices.KPIResourceHealthDetailsResponse; }; /** * Error details in last backup */ lastBackupErrorDetail?: outputs.recoveryservices.ErrorDetailResponse; /** * Last backup operation status. Possible values: Healthy, Unhealthy. */ lastBackupStatus?: string; /** * Timestamp of the last backup operation on this backup item. */ lastBackupTime?: string; /** * Timestamp when the last (latest) backup copy was created for this backup item. */ lastRecoveryPoint?: string; /** * List of the nodes in case of distributed container. */ nodesList?: outputs.recoveryservices.DistributedNodesInfoResponse[]; /** * Parent name of the DB such as Instance or Availability Group. */ parentName?: string; /** * Parent type of protected item, example: for a DB, standalone server or distributed */ parentType?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * Name of the policy used for protection */ policyName?: string; /** * Data ID of the protected item. */ protectedItemDataSourceId?: string; /** * Health status of the backup item, evaluated based on last heartbeat received */ protectedItemHealthStatus?: string; /** * backup item type. * Expected value is 'AzureVmWorkloadSAPHanaDBInstance'. */ protectedItemType: "AzureVmWorkloadSAPHanaDBInstance"; /** * Backup state of this backup item. */ protectionState?: string; /** * Backup status of this backup item. */ protectionStatus: string; /** * ResourceGuardOperationRequests on which LAC check will be performed */ resourceGuardOperationRequests?: string[]; /** * Host/Cluster Name for instance or AG */ serverName?: string; /** * Soft delete retention period in days */ softDeleteRetentionPeriodInDays?: number; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; /** * ID of the vault which protects this item */ vaultId: string; /** * Type of workload this item represents. */ workloadType: string; } /** * Azure VM workload-specific protected item representing SAP HANA Database. */ interface AzureVmWorkloadSAPHanaDatabaseProtectedItemResponse { /** * Type of backup management for the backed up item. */ backupManagementType: string; /** * Name of the backup set the backup item belongs to */ backupSetName?: string; /** * Unique name of container */ containerName?: string; /** * Create mode to indicate recovery of existing soft deleted data source or creation of new data source. */ createMode?: string; /** * Time for deferred deletion in UTC */ deferredDeleteTimeInUTC?: string; /** * Time remaining before the DS marked for deferred delete is permanently deleted */ deferredDeleteTimeRemaining?: string; /** * Additional information for this backup item. */ extendedInfo?: outputs.recoveryservices.AzureVmWorkloadProtectedItemExtendedInfoResponse; /** * Friendly name of the DB represented by this backup item. */ friendlyName: string; /** * Flag to identify whether datasource is protected in archive */ isArchiveEnabled?: boolean; /** * Flag to identify whether the deferred deleted DS is to be purged soon */ isDeferredDeleteScheduleUpcoming?: boolean; /** * Flag to identify that deferred deleted DS is to be moved into Pause state */ isRehydrate?: boolean; /** * Flag to identify whether the DS is scheduled for deferred delete */ isScheduledForDeferredDelete?: boolean; /** * Health details of different KPIs */ kpisHealths?: { [key: string]: outputs.recoveryservices.KPIResourceHealthDetailsResponse; }; /** * Error details in last backup */ lastBackupErrorDetail?: outputs.recoveryservices.ErrorDetailResponse; /** * Last backup operation status. Possible values: Healthy, Unhealthy. */ lastBackupStatus?: string; /** * Timestamp of the last backup operation on this backup item. */ lastBackupTime?: string; /** * Timestamp when the last (latest) backup copy was created for this backup item. */ lastRecoveryPoint?: string; /** * List of the nodes in case of distributed container. */ nodesList?: outputs.recoveryservices.DistributedNodesInfoResponse[]; /** * Parent name of the DB such as Instance or Availability Group. */ parentName?: string; /** * Parent type of protected item, example: for a DB, standalone server or distributed */ parentType?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * Name of the policy used for protection */ policyName?: string; /** * Data ID of the protected item. */ protectedItemDataSourceId?: string; /** * Health status of the backup item, evaluated based on last heartbeat received */ protectedItemHealthStatus?: string; /** * backup item type. * Expected value is 'AzureVmWorkloadSAPHanaDatabase'. */ protectedItemType: "AzureVmWorkloadSAPHanaDatabase"; /** * Backup state of this backup item. */ protectionState?: string; /** * Backup status of this backup item. */ protectionStatus: string; /** * ResourceGuardOperationRequests on which LAC check will be performed */ resourceGuardOperationRequests?: string[]; /** * Host/Cluster Name for instance or AG */ serverName?: string; /** * Soft delete retention period in days */ softDeleteRetentionPeriodInDays?: number; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; /** * ID of the vault which protects this item */ vaultId: string; /** * Type of workload this item represents. */ workloadType: string; } /** * Azure VM workload-specific protected item representing SQL Database. */ interface AzureVmWorkloadSQLDatabaseProtectedItemResponse { /** * Type of backup management for the backed up item. */ backupManagementType: string; /** * Name of the backup set the backup item belongs to */ backupSetName?: string; /** * Unique name of container */ containerName?: string; /** * Create mode to indicate recovery of existing soft deleted data source or creation of new data source. */ createMode?: string; /** * Time for deferred deletion in UTC */ deferredDeleteTimeInUTC?: string; /** * Time remaining before the DS marked for deferred delete is permanently deleted */ deferredDeleteTimeRemaining?: string; /** * Additional information for this backup item. */ extendedInfo?: outputs.recoveryservices.AzureVmWorkloadProtectedItemExtendedInfoResponse; /** * Friendly name of the DB represented by this backup item. */ friendlyName: string; /** * Flag to identify whether datasource is protected in archive */ isArchiveEnabled?: boolean; /** * Flag to identify whether the deferred deleted DS is to be purged soon */ isDeferredDeleteScheduleUpcoming?: boolean; /** * Flag to identify that deferred deleted DS is to be moved into Pause state */ isRehydrate?: boolean; /** * Flag to identify whether the DS is scheduled for deferred delete */ isScheduledForDeferredDelete?: boolean; /** * Health details of different KPIs */ kpisHealths?: { [key: string]: outputs.recoveryservices.KPIResourceHealthDetailsResponse; }; /** * Error details in last backup */ lastBackupErrorDetail?: outputs.recoveryservices.ErrorDetailResponse; /** * Last backup operation status. Possible values: Healthy, Unhealthy. */ lastBackupStatus?: string; /** * Timestamp of the last backup operation on this backup item. */ lastBackupTime?: string; /** * Timestamp when the last (latest) backup copy was created for this backup item. */ lastRecoveryPoint?: string; /** * List of the nodes in case of distributed container. */ nodesList?: outputs.recoveryservices.DistributedNodesInfoResponse[]; /** * Parent name of the DB such as Instance or Availability Group. */ parentName?: string; /** * Parent type of protected item, example: for a DB, standalone server or distributed */ parentType?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * Name of the policy used for protection */ policyName?: string; /** * Data ID of the protected item. */ protectedItemDataSourceId?: string; /** * Health status of the backup item, evaluated based on last heartbeat received */ protectedItemHealthStatus?: string; /** * backup item type. * Expected value is 'AzureVmWorkloadSQLDatabase'. */ protectedItemType: "AzureVmWorkloadSQLDatabase"; /** * Backup state of this backup item. */ protectionState?: string; /** * Backup status of this backup item. */ protectionStatus: string; /** * ResourceGuardOperationRequests on which LAC check will be performed */ resourceGuardOperationRequests?: string[]; /** * Host/Cluster Name for instance or AG */ serverName?: string; /** * Soft delete retention period in days */ softDeleteRetentionPeriodInDays?: number; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; /** * ID of the vault which protects this item */ vaultId: string; /** * Type of workload this item represents. */ workloadType: string; } /** * Azure Recovery Services Vault specific protection intent item. */ interface AzureWorkloadAutoProtectionIntentResponse { /** * Type of backup management for the backed up item. */ backupManagementType?: string; /** * ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId */ itemId?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * backup protectionIntent type. * Expected value is 'AzureWorkloadAutoProtectionIntent'. */ protectionIntentItemType: "AzureWorkloadAutoProtectionIntent"; /** * Backup state of this backup item. */ protectionState?: string; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; } /** * Azure workload specific protection intent item. */ interface AzureWorkloadContainerAutoProtectionIntentResponse { /** * Type of backup management for the backed up item. */ backupManagementType?: string; /** * ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId */ itemId?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * backup protectionIntent type. * Expected value is 'AzureWorkloadContainerAutoProtectionIntent'. */ protectionIntentItemType: "AzureWorkloadContainerAutoProtectionIntent"; /** * Backup state of this backup item. */ protectionState?: string; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; } /** * Extended information of the container. */ interface AzureWorkloadContainerExtendedInfoResponse { /** * Host Os Name in case of Stand Alone and Cluster Name in case of distributed container. */ hostServerName?: string; /** * Inquiry Status for the container. */ inquiryInfo?: outputs.recoveryservices.InquiryInfoResponse; /** * List of the nodes in case of distributed container. */ nodesList?: outputs.recoveryservices.DistributedNodesInfoResponse[]; } /** * Container for the workloads running inside Azure Compute or Classic Compute. */ interface AzureWorkloadContainerResponse { /** * Type of backup management for the container. */ backupManagementType?: string; /** * Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. * Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is * Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload * Backup is VMAppContainer * Expected value is 'AzureWorkloadContainer'. */ containerType: "AzureWorkloadContainer"; /** * Additional details of a workload container. */ extendedInfo?: outputs.recoveryservices.AzureWorkloadContainerExtendedInfoResponse; /** * Friendly name of the container. */ friendlyName?: string; /** * Status of health of the container. */ healthStatus?: string; /** * Time stamp when this container was updated. */ lastUpdatedTime?: string; /** * Re-Do Operation */ operationType?: string; /** * Type of the protectable object associated with this container */ protectableObjectType?: string; /** * Status of registration of the container with the Recovery Services Vault. */ registrationStatus?: string; /** * ARM ID of the virtual machine represented by this Azure Workload Container */ sourceResourceId?: string; /** * Workload type for which registration was sent. */ workloadType?: string; } /** * Azure Workload SQL Auto Protection intent item. */ interface AzureWorkloadSQLAutoProtectionIntentResponse { /** * Type of backup management for the backed up item. */ backupManagementType?: string; /** * ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId */ itemId?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * backup protectionIntent type. * Expected value is 'AzureWorkloadSQLAutoProtectionIntent'. */ protectionIntentItemType: "AzureWorkloadSQLAutoProtectionIntent"; /** * Backup state of this backup item. */ protectionState?: string; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; /** * Workload item type of the item for which intent is to be set */ workloadItemType?: string; } /** * Settings for classic alerts */ interface ClassicAlertSettingsResponse { alertsForCriticalOperations?: string; emailNotificationsForSiteRecovery?: string; } /** * The details of the identity used for CMK */ interface CmkKekIdentityResponse { /** * Indicate that system assigned identity should be used. Mutually exclusive with 'userAssignedIdentity' field */ useSystemAssignedIdentity?: boolean; /** * The user assigned identity to be used to grant permissions in case the type of identity used is UserAssigned */ userAssignedIdentity?: string; } /** * The properties of the Key Vault which hosts CMK */ interface CmkKeyVaultPropertiesResponse { /** * The key uri of the Customer Managed Key */ keyUri?: string; } /** * Container identity information */ interface ContainerIdentityInfoResponse { /** * Protection container identity - AAD Tenant */ aadTenantId?: string; /** * Protection container identity - Audience */ audience?: string; /** * Protection container identity - AAD Service Principal */ servicePrincipalClientId?: string; /** * Unique name of the container */ uniqueName?: string; } /** * Critical past job details of the migration item. */ interface CriticalJobHistoryDetailsResponse { /** * The ARM Id of the job being executed. */ jobId: string; /** * The job name. */ jobName: string; /** * The job state. */ jobStatus: string; /** * The start time of the job. */ startTime: string; } /** * Settings for Cross Subscription Restore Settings */ interface CrossSubscriptionRestoreSettingsResponse { crossSubscriptionRestoreState?: string; } /** * Current job details of the migration item. */ interface CurrentJobDetailsResponse { /** * The ARM Id of the job being executed. */ jobId: string; /** * The job name. */ jobName: string; /** * The start time of the job. */ startTime: string; } /** * Current scenario details of the protected entity. */ interface CurrentScenarioDetailsResponse { /** * ARM Id of the job being executed. */ jobId?: string; /** * Scenario name. */ scenarioName?: string; /** * Start time of the workflow. */ startTime?: string; } /** * Additional information of the DPMContainer. */ interface DPMContainerExtendedInfoResponse { /** * Last refresh time of the DPMContainer. */ lastRefreshedAt?: string; } /** * Additional information of DPM Protected item. */ interface DPMProtectedItemExtendedInfoResponse { /** * Used Disk storage in bytes. */ diskStorageUsedInBytes?: string; /** * To check if backup item is collocated. */ isCollocated?: boolean; /** * To check if backup item is cloud protected. */ isPresentOnCloud?: boolean; /** * Last backup status information on backup item. */ lastBackupStatus?: string; /** * Last refresh time on backup item. */ lastRefreshedAt?: string; /** * Oldest cloud recovery point time. */ oldestRecoveryPoint?: string; /** * latest disk recovery point time. */ onPremiseLatestRecoveryPoint?: string; /** * Oldest disk recovery point time. */ onPremiseOldestRecoveryPoint?: string; /** * disk recovery point count. */ onPremiseRecoveryPointCount?: number; /** * Attribute to provide information on various DBs. */ protectableObjectLoadPath?: { [key: string]: string; }; /** * To check if backup item is disk protected. */ protected?: boolean; /** * Protection group name of the backup item. */ protectionGroupName?: string; /** * cloud recovery point count. */ recoveryPointCount?: number; /** * total Disk storage in bytes. */ totalDiskStorageSizeInBytes?: string; } /** * Additional information on Backup engine specific backup item. */ interface DPMProtectedItemResponse { /** * Backup Management server protecting this backup item */ backupEngineName?: string; /** * Type of backup management for the backed up item. */ backupManagementType: string; /** * Name of the backup set the backup item belongs to */ backupSetName?: string; /** * Unique name of container */ containerName?: string; /** * Create mode to indicate recovery of existing soft deleted data source or creation of new data source. */ createMode?: string; /** * Time for deferred deletion in UTC */ deferredDeleteTimeInUTC?: string; /** * Time remaining before the DS marked for deferred delete is permanently deleted */ deferredDeleteTimeRemaining?: string; /** * Extended info of the backup item. */ extendedInfo?: outputs.recoveryservices.DPMProtectedItemExtendedInfoResponse; /** * Friendly name of the managed item */ friendlyName?: string; /** * Flag to identify whether datasource is protected in archive */ isArchiveEnabled?: boolean; /** * Flag to identify whether the deferred deleted DS is to be purged soon */ isDeferredDeleteScheduleUpcoming?: boolean; /** * Flag to identify that deferred deleted DS is to be moved into Pause state */ isRehydrate?: boolean; /** * Flag to identify whether the DS is scheduled for deferred delete */ isScheduledForDeferredDelete?: boolean; /** * Timestamp when the last (latest) backup copy was created for this backup item. */ lastRecoveryPoint?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * Name of the policy used for protection */ policyName?: string; /** * backup item type. * Expected value is 'DPMProtectedItem'. */ protectedItemType: "DPMProtectedItem"; /** * Protection state of the backup engine */ protectionState?: string; /** * ResourceGuardOperationRequests on which LAC check will be performed */ resourceGuardOperationRequests?: string[]; /** * Soft delete retention period in days */ softDeleteRetentionPeriodInDays?: number; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; /** * ID of the vault which protects this item */ vaultId: string; /** * Type of workload this item represents. */ workloadType: string; } /** * Daily retention format. */ interface DailyRetentionFormatResponse { /** * List of days of the month. */ daysOfTheMonth?: outputs.recoveryservices.DayResponse[]; } /** * Daily retention schedule. */ interface DailyRetentionScheduleResponse { /** * Retention duration of retention Policy. */ retentionDuration?: outputs.recoveryservices.RetentionDurationResponse; /** * Retention times of retention policy. */ retentionTimes?: string[]; } interface DailyScheduleResponse { /** * List of times of day this schedule has to be run. */ scheduleRunTimes?: string[]; } /** * The datastore details of the MT. */ interface DataStoreResponse { /** * The capacity of data store in GBs. */ capacity?: string; /** * The free space of data store in GBs. */ freeSpace?: string; /** * The symbolic name of data store. */ symbolicName?: string; /** * The type of data store. */ type?: string; /** * The uuid of data store. */ uuid?: string; } /** * Details of the appliance resource. */ interface DataStoreUtilizationDetailsResponse { /** * The datastore name. */ dataStoreName: string; /** * The total snapshots created for server migration in the datastore. */ totalSnapshotsCreated: number; /** * The total count of snapshots supported by the datastore. */ totalSnapshotsSupported: number; } /** * Day of the week. */ interface DayResponse { /** * Date of the month */ date?: number; /** * Whether Date is last date of month */ isLast?: boolean; } /** * Onprem disk details data. */ interface DiskDetailsResponse { /** * The hard disk max size in MB. */ maxSizeMB?: number; /** * The VHD Id. */ vhdId?: string; /** * The VHD name. */ vhdName?: string; /** * The type of the volume. */ vhdType?: string; } interface DiskExclusionPropertiesResponse { /** * List of Disks' Logical Unit Numbers (LUN) to be used for VM Protection. */ diskLunList?: number[]; /** * Flag to indicate whether DiskLunList is to be included/ excluded from backup. */ isInclusionList?: boolean; } /** * This is used to represent the various nodes of the distributed container. */ interface DistributedNodesInfoResponse { /** * Error Details if the Status is non-success. */ errorDetail?: outputs.recoveryservices.ErrorDetailResponse; /** * Name of the node under a distributed container. */ nodeName?: string; /** * ARM resource id of the node */ sourceResourceId?: string; /** * Status of this Node. * Failed | Succeeded */ status?: string; } /** * DPM workload-specific protection container. */ interface DpmContainerResponse { /** * Type of backup management for the container. */ backupManagementType?: string; /** * Specifies whether the container is re-registrable. */ canReRegister?: boolean; /** * ID of container. */ containerId?: string; /** * Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. * Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is * Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload * Backup is VMAppContainer * Expected value is 'DPMContainer'. */ containerType: "DPMContainer"; /** * Backup engine Agent version */ dpmAgentVersion?: string; /** * List of BackupEngines protecting the container */ dpmServers?: string[]; /** * Extended Info of the container. */ extendedInfo?: outputs.recoveryservices.DPMContainerExtendedInfoResponse; /** * Friendly name of the container. */ friendlyName?: string; /** * Status of health of the container. */ healthStatus?: string; /** * Type of the protectable object associated with this container */ protectableObjectType?: string; /** * Number of protected items in the BackupEngine */ protectedItemCount?: number; /** * Protection status of the container. */ protectionStatus?: string; /** * Status of registration of the container with the Recovery Services Vault. */ registrationStatus?: string; /** * To check if upgrade available */ upgradeAvailable?: boolean; } /** * DRA details. */ interface DraDetailsResponse { /** * The DRA Bios Id. */ biosId: string; /** * The count of protected items which are protected in forward direction. */ forwardProtectedItemCount: number; /** * The health. */ health: string; /** * The health errors. */ healthErrors: outputs.recoveryservices.HealthErrorResponse[]; /** * The DRA Id. */ id: string; /** * The last heartbeat received from the DRA. */ lastHeartbeatUtc: string; /** * The DRA name. */ name: string; /** * The count of protected items which are protected in reverse direction. */ reverseProtectedItemCount: number; /** * The version. */ version: string; } /** * Encryption details for the fabric. */ interface EncryptionDetailsResponse { /** * The key encryption key certificate expiry date. */ kekCertExpiryDate?: string; /** * The key encryption key certificate thumbprint. */ kekCertThumbprint?: string; /** * The key encryption key state for the Vmm. */ kekState?: string; } /** * Error Detail class which encapsulates Code, Message and Recommendations. */ interface ErrorDetailResponse { /** * Error code. */ code: string; /** * Error Message related to the Code. */ message: string; /** * List of recommendation strings. */ recommendations: string[]; } /** * Extended location of the resource. */ interface ExtendedLocationResponse { /** * The name of the extended location. */ name: string; /** * The extended location type. */ type: string; } /** * Extended Properties for Azure IaasVM Backup. */ interface ExtendedPropertiesResponse { /** * Extended Properties for Disk Exclusion. */ diskExclusionProperties?: outputs.recoveryservices.DiskExclusionPropertiesResponse; /** * Linux VM name */ linuxVmApplicationName?: string; } /** * Fabric properties. */ interface FabricPropertiesResponse { /** * BCDR state of the fabric. */ bcdrState?: string; /** * Fabric specific settings. */ customDetails?: outputs.recoveryservices.AzureFabricSpecificDetailsResponse | outputs.recoveryservices.HyperVSiteDetailsResponse | outputs.recoveryservices.InMageRcmFabricSpecificDetailsResponse | outputs.recoveryservices.VMwareDetailsResponse | outputs.recoveryservices.VMwareV2FabricSpecificDetailsResponse | outputs.recoveryservices.VmmDetailsResponse; /** * Encryption details for the fabric. */ encryptionDetails?: outputs.recoveryservices.EncryptionDetailsResponse; /** * Friendly name of the fabric. */ friendlyName?: string; /** * Health of fabric. */ health?: string; /** * Fabric health error details. */ healthErrorDetails?: outputs.recoveryservices.HealthErrorResponse[]; /** * Dra Registration Id. */ internalIdentifier?: string; /** * Rollover encryption details for the fabric. */ rolloverEncryptionDetails?: outputs.recoveryservices.EncryptionDetailsResponse; } /** * Details of the gateway operation. */ interface GatewayOperationDetailsResponse { /** * A value indicating the datastore collection. */ dataStores: string[]; /** * A value indicating the ESXi host name. */ hostName: string; /** * A value indicating the progress percentage of gateway operation. */ progressPercentage: number; /** * A value indicating the state of gateway operation. */ state: string; /** * A value indicating the time elapsed for the operation in milliseconds. */ timeElapsed: number; /** * A value indicating the time remaining for the operation in milliseconds. */ timeRemaining: number; /** * A value indicating the upload speed in bytes per second. */ uploadSpeed: number; /** * A value indicating the VMware read throughput in bytes per second. */ vmwareReadThroughput: number; } /** * Container extended information */ interface GenericContainerExtendedInfoResponse { /** * Container identity information */ containerIdentityInfo?: outputs.recoveryservices.ContainerIdentityInfoResponse; /** * Public key of container cert */ rawCertData?: string; /** * Azure Backup Service Endpoints for the container */ serviceEndpoints?: { [key: string]: string; }; } /** * Base class for generic container of backup items */ interface GenericContainerResponse { /** * Type of backup management for the container. */ backupManagementType?: string; /** * Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. * Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is * Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload * Backup is VMAppContainer * Expected value is 'GenericContainer'. */ containerType: "GenericContainer"; /** * Extended information (not returned in List container API calls) */ extendedInformation?: outputs.recoveryservices.GenericContainerExtendedInfoResponse; /** * Name of the container's fabric */ fabricName?: string; /** * Friendly name of the container. */ friendlyName?: string; /** * Status of health of the container. */ healthStatus?: string; /** * Type of the protectable object associated with this container */ protectableObjectType?: string; /** * Status of registration of the container with the Recovery Services Vault. */ registrationStatus?: string; } /** * Base class for backup items. */ interface GenericProtectedItemResponse { /** * Type of backup management for the backed up item. */ backupManagementType: string; /** * Name of the backup set the backup item belongs to */ backupSetName?: string; /** * Unique name of container */ containerName?: string; /** * Create mode to indicate recovery of existing soft deleted data source or creation of new data source. */ createMode?: string; /** * Time for deferred deletion in UTC */ deferredDeleteTimeInUTC?: string; /** * Time remaining before the DS marked for deferred delete is permanently deleted */ deferredDeleteTimeRemaining?: string; /** * Name of this backup item's fabric. */ fabricName?: string; /** * Friendly name of the container. */ friendlyName?: string; /** * Flag to identify whether datasource is protected in archive */ isArchiveEnabled?: boolean; /** * Flag to identify whether the deferred deleted DS is to be purged soon */ isDeferredDeleteScheduleUpcoming?: boolean; /** * Flag to identify that deferred deleted DS is to be moved into Pause state */ isRehydrate?: boolean; /** * Flag to identify whether the DS is scheduled for deferred delete */ isScheduledForDeferredDelete?: boolean; /** * Timestamp when the last (latest) backup copy was created for this backup item. */ lastRecoveryPoint?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * Name of the policy used for protection */ policyName?: string; /** * Indicates consistency of policy object and policy applied to this backup item. */ policyState?: string; /** * Data Plane Service ID of the protected item. */ protectedItemId?: number; /** * backup item type. * Expected value is 'GenericProtectedItem'. */ protectedItemType: "GenericProtectedItem"; /** * Backup state of this backup item. */ protectionState?: string; /** * ResourceGuardOperationRequests on which LAC check will be performed */ resourceGuardOperationRequests?: string[]; /** * Soft delete retention period in days */ softDeleteRetentionPeriodInDays?: number; /** * Loosely coupled (type, value) associations (example - parent of a protected item) */ sourceAssociations?: { [key: string]: string; }; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; /** * ID of the vault which protects this item */ vaultId: string; /** * Type of workload this item represents. */ workloadType: string; } /** * Azure VM (Mercury) workload-specific backup policy. */ interface GenericProtectionPolicyResponse { /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'GenericProtectionPolicy'. */ backupManagementType: "GenericProtectionPolicy"; /** * Name of this policy's fabric. */ fabricName?: string; /** * Number of items associated with this policy. */ protectedItemsCount?: number; /** * ResourceGuard Operation Requests */ resourceGuardOperationRequests?: string[]; /** * List of sub-protection policies which includes schedule and retention */ subProtectionPolicy?: outputs.recoveryservices.SubProtectionPolicyResponse[]; /** * TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time". */ timeZone?: string; } /** * Health Error. */ interface HealthErrorResponse { /** * Error creation time (UTC). */ creationTimeUtc?: string; /** * Value indicating whether the health error is customer resolvable. */ customerResolvability?: string; /** * ID of the entity. */ entityId?: string; /** * Category of error. */ errorCategory?: string; /** * Error code. */ errorCode?: string; /** * The health error unique id. */ errorId?: string; /** * Level of error. */ errorLevel?: string; /** * Error message. */ errorMessage?: string; /** * Source of error. */ errorSource?: string; /** * Type of error. */ errorType?: string; /** * The inner health errors. HealthError having a list of HealthError as child errors is problematic. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. */ innerHealthErrors?: outputs.recoveryservices.InnerHealthErrorResponse[]; /** * Possible causes of error. */ possibleCauses?: string; /** * Recommended action to resolve error. */ recommendedAction?: string; /** * DRA error message. */ recoveryProviderErrorMessage?: string; /** * Summary message of the entity. */ summaryMessage?: string; } interface HourlyScheduleResponse { /** * Interval at which backup needs to be triggered. For hourly the value * can be 4/6/8/12 */ interval?: number; /** * To specify duration of the backup window */ scheduleWindowDuration?: number; /** * To specify start time of the backup window */ scheduleWindowStartTime?: string; } /** * Hyper-V host details. */ interface HyperVHostDetailsResponse { /** * The Hyper-V host Id. */ id: string; /** * The Mars agent version. */ marsAgentVersion: string; /** * The Hyper-V host name. */ name: string; } /** * Hyper-V Managed disk details. */ interface HyperVReplicaAzureManagedDiskDetailsResponse { /** * The disk encryption set ARM Id. */ diskEncryptionSetId?: string; /** * The disk Id. */ diskId?: string; /** * The replica disk type. */ replicaDiskType?: string; /** * The logical sector size (in bytes), 512 by default. */ sectorSizeInBytes?: number; /** * Seed managed disk Id. */ seedManagedDiskId?: string; /** * The disk type. */ targetDiskAccountType?: string; } /** * Hyper-V Replica Azure specific protection profile details. */ interface HyperVReplicaAzurePolicyDetailsResponse { /** * The active storage account Id. */ activeStorageAccountId?: string; /** * The interval (in hours) at which Hyper-V Replica should create an application consistent snapshot within the VM. */ applicationConsistentSnapshotFrequencyInHours?: number; /** * A value indicating whether encryption is enabled for virtual machines in this cloud. */ encryption?: string; /** * Gets the class type. Overridden in derived classes. * Expected value is 'HyperVReplicaAzure'. */ instanceType: "HyperVReplicaAzure"; /** * The scheduled start time for the initial replication. If this parameter is Null, the initial replication starts immediately. */ onlineReplicationStartTime?: string; /** * The duration (in hours) to which point the recovery history needs to be maintained. */ recoveryPointHistoryDurationInHours?: number; /** * The replication interval. */ replicationInterval?: number; } /** * Hyper V Replica Azure provider specific settings. */ interface HyperVReplicaAzureReplicationDetailsResponse { /** * A value indicating all available inplace OS Upgrade configurations. */ allAvailableOSUpgradeConfigurations?: outputs.recoveryservices.OSUpgradeSupportedVersionsResponse[]; /** * Azure VM Disk details. */ azureVmDiskDetails?: outputs.recoveryservices.AzureVmDiskDetailsResponse[]; /** * The selected option to enable RDP\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum. */ enableRdpOnTargetOption?: string; /** * The encryption info. */ encryption?: string; /** * Initial replication details. */ initialReplicationDetails?: outputs.recoveryservices.InitialReplicationDetailsResponse; /** * Gets the Instance type. * Expected value is 'HyperVReplicaAzure'. */ instanceType: "HyperVReplicaAzure"; /** * The last recovery point received time. */ lastRecoveryPointReceived: string; /** * The Last replication time. */ lastReplicatedTime?: string; /** * The last RPO calculated time. */ lastRpoCalculatedTime?: string; /** * License Type of the VM to be used. */ licenseType?: string; /** * The license type for Linux VM's. */ linuxLicenseType?: string; /** * The operating system info. */ oSDetails?: outputs.recoveryservices.OSDetailsResponse; /** * The list of protected managed disks. */ protectedManagedDisks?: outputs.recoveryservices.HyperVReplicaAzureManagedDiskDetailsResponse[]; /** * The recovery availability set Id. */ recoveryAvailabilitySetId?: string; /** * The ARM id of the log storage account used for replication. This will be set to null if no log storage account was provided during enable protection. */ recoveryAzureLogStorageAccountId?: string; /** * The target resource group Id. */ recoveryAzureResourceGroupId?: string; /** * The recovery Azure storage account. */ recoveryAzureStorageAccount?: string; /** * The Recovery Azure VM size. */ recoveryAzureVMSize?: string; /** * Recovery Azure given name. */ recoveryAzureVmName?: string; /** * Last RPO value. */ rpoInSeconds?: number; /** * The tags for the seed managed disks. */ seedManagedDiskTags?: { [key: string]: string; }; /** * The selected recovery azure network Id. */ selectedRecoveryAzureNetworkId?: string; /** * The selected source nic Id which will be used as the primary nic during failover. */ selectedSourceNicId?: string; /** * The CPU count of the VM on the primary side. */ sourceVmCpuCount?: number; /** * The RAM size of the VM on the primary side. */ sourceVmRamSizeInMB?: number; /** * The SQL Server license type. */ sqlServerLicenseType?: string; /** * The target availability zone. */ targetAvailabilityZone?: string; /** * The tags for the target managed disks. */ targetManagedDiskTags?: { [key: string]: string; }; /** * The tags for the target NICs. */ targetNicTags?: { [key: string]: string; }; /** * The target proximity placement group Id. */ targetProximityPlacementGroupId?: string; /** * The target VM security profile. */ targetVmSecurityProfile?: outputs.recoveryservices.SecurityProfilePropertiesResponse; /** * The target VM tags. */ targetVmTags?: { [key: string]: string; }; /** * A value indicating whether managed disks should be used during failover. */ useManagedDisks?: string; /** * The virtual machine Id. */ vmId?: string; /** * The PE Network details. */ vmNics?: outputs.recoveryservices.VMNicDetailsResponse[]; /** * The protection state for the vm. */ vmProtectionState?: string; /** * The protection state description for the vm. */ vmProtectionStateDescription?: string; } /** * Base class for HyperVReplica policy details. */ interface HyperVReplicaBasePolicyDetailsResponse { /** * A value indicating the authentication type. */ allowedAuthenticationType?: number; /** * A value indicating the application consistent frequency. */ applicationConsistentSnapshotFrequencyInHours?: number; /** * A value indicating whether compression has to be enabled. */ compression?: string; /** * A value indicating whether IR is online. */ initialReplicationMethod?: string; /** * Gets the class type. Overridden in derived classes. * Expected value is 'HyperVReplicaBasePolicyDetails'. */ instanceType: "HyperVReplicaBasePolicyDetails"; /** * A value indicating the offline IR export path. */ offlineReplicationExportPath?: string; /** * A value indicating the offline IR import path. */ offlineReplicationImportPath?: string; /** * A value indicating the online IR start time. */ onlineReplicationStartTime?: string; /** * A value indicating the number of recovery points. */ recoveryPoints?: number; /** * A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud. */ replicaDeletionOption?: string; /** * A value indicating the recovery HTTPS port. */ replicationPort?: number; } /** * Hyper V replica provider specific settings base class. */ interface HyperVReplicaBaseReplicationDetailsResponse { /** * Initial replication details. */ initialReplicationDetails?: outputs.recoveryservices.InitialReplicationDetailsResponse; /** * Gets the Instance type. * Expected value is 'HyperVReplicaBaseReplicationDetails'. */ instanceType: "HyperVReplicaBaseReplicationDetails"; /** * The Last replication time. */ lastReplicatedTime?: string; /** * VM disk details. */ vMDiskDetails?: outputs.recoveryservices.DiskDetailsResponse[]; /** * The virtual machine Id. */ vmId?: string; /** * The PE Network details. */ vmNics?: outputs.recoveryservices.VMNicDetailsResponse[]; /** * The protection state for the vm. */ vmProtectionState?: string; /** * The protection state description for the vm. */ vmProtectionStateDescription?: string; } /** * Hyper-V Replica Blue specific protection profile details. */ interface HyperVReplicaBluePolicyDetailsResponse { /** * A value indicating the authentication type. */ allowedAuthenticationType?: number; /** * A value indicating the application consistent frequency. */ applicationConsistentSnapshotFrequencyInHours?: number; /** * A value indicating whether compression has to be enabled. */ compression?: string; /** * A value indicating whether IR is online. */ initialReplicationMethod?: string; /** * Gets the class type. Overridden in derived classes. * Expected value is 'HyperVReplica2012R2'. */ instanceType: "HyperVReplica2012R2"; /** * A value indicating the offline IR export path. */ offlineReplicationExportPath?: string; /** * A value indicating the offline IR import path. */ offlineReplicationImportPath?: string; /** * A value indicating the online IR start time. */ onlineReplicationStartTime?: string; /** * A value indicating the number of recovery points. */ recoveryPoints?: number; /** * A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud */ replicaDeletionOption?: string; /** * A value indicating the replication interval. */ replicationFrequencyInSeconds?: number; /** * A value indicating the recovery HTTPS port. */ replicationPort?: number; } /** * HyperV replica 2012 R2 (Blue) replication details. */ interface HyperVReplicaBlueReplicationDetailsResponse { /** * Initial replication details. */ initialReplicationDetails?: outputs.recoveryservices.InitialReplicationDetailsResponse; /** * Gets the Instance type. * Expected value is 'HyperVReplica2012R2'. */ instanceType: "HyperVReplica2012R2"; /** * The Last replication time. */ lastReplicatedTime?: string; /** * VM disk details. */ vMDiskDetails?: outputs.recoveryservices.DiskDetailsResponse[]; /** * The virtual machine Id. */ vmId?: string; /** * The PE Network details. */ vmNics?: outputs.recoveryservices.VMNicDetailsResponse[]; /** * The protection state for the vm. */ vmProtectionState?: string; /** * The protection state description for the vm. */ vmProtectionStateDescription?: string; } /** * Hyper-V Replica Blue specific protection profile details. */ interface HyperVReplicaPolicyDetailsResponse { /** * A value indicating the authentication type. */ allowedAuthenticationType?: number; /** * A value indicating the application consistent frequency. */ applicationConsistentSnapshotFrequencyInHours?: number; /** * A value indicating whether compression has to be enabled. */ compression?: string; /** * A value indicating whether IR is online. */ initialReplicationMethod?: string; /** * Gets the class type. Overridden in derived classes. * Expected value is 'HyperVReplica2012'. */ instanceType: "HyperVReplica2012"; /** * A value indicating the offline IR export path. */ offlineReplicationExportPath?: string; /** * A value indicating the offline IR import path. */ offlineReplicationImportPath?: string; /** * A value indicating the online IR start time. */ onlineReplicationStartTime?: string; /** * A value indicating the number of recovery points. */ recoveryPoints?: number; /** * A value indicating whether the VM has to be auto deleted. Supported Values: String.Empty, None, OnRecoveryCloud */ replicaDeletionOption?: string; /** * A value indicating the recovery HTTPS port. */ replicationPort?: number; } /** * HyperV replica 2012 replication details. */ interface HyperVReplicaReplicationDetailsResponse { /** * Initial replication details. */ initialReplicationDetails?: outputs.recoveryservices.InitialReplicationDetailsResponse; /** * Gets the Instance type. * Expected value is 'HyperVReplica2012'. */ instanceType: "HyperVReplica2012"; /** * The Last replication time. */ lastReplicatedTime?: string; /** * VM disk details. */ vMDiskDetails?: outputs.recoveryservices.DiskDetailsResponse[]; /** * The virtual machine Id. */ vmId?: string; /** * The PE Network details. */ vmNics?: outputs.recoveryservices.VMNicDetailsResponse[]; /** * The protection state for the vm. */ vmProtectionState?: string; /** * The protection state description for the vm. */ vmProtectionStateDescription?: string; } /** * HyperVSite fabric specific details. */ interface HyperVSiteDetailsResponse { /** * The list of Hyper-V hosts associated with the fabric. */ hyperVHosts?: outputs.recoveryservices.HyperVHostDetailsResponse[]; /** * Gets the class type. Overridden in derived classes. * Expected value is 'HyperVSite'. */ instanceType: "HyperVSite"; } interface IPConfigDetailsResponse { ipAddressType?: string; isPrimary?: boolean; isSeletedForFailover?: boolean; name?: string; recoveryIPAddressType?: string; recoveryLBBackendAddressPoolIds?: string[]; recoveryPublicIPAddressId?: string; recoveryStaticIPAddress?: string; recoverySubnetName?: string; staticIPAddress?: string; subnetName?: string; tfoLBBackendAddressPoolIds?: string[]; tfoPublicIPAddressId?: string; tfoStaticIPAddress?: string; tfoSubnetName?: string; } /** * IaaS VM workload-specific container. */ interface IaaSVMContainerResponse { /** * Type of backup management for the container. */ backupManagementType?: string; /** * Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. * Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is * Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload * Backup is VMAppContainer * Expected value is 'IaasVMContainer'. */ containerType: "IaasVMContainer"; /** * Friendly name of the container. */ friendlyName?: string; /** * Status of health of the container. */ healthStatus?: string; /** * Type of the protectable object associated with this container */ protectableObjectType?: string; /** * Status of registration of the container with the Recovery Services Vault. */ registrationStatus?: string; /** * Resource group name of Recovery Services Vault. */ resourceGroup?: string; /** * Fully qualified ARM url of the virtual machine represented by this Azure IaaS VM container. */ virtualMachineId?: string; /** * Specifies whether the container represents a Classic or an Azure Resource Manager VM. */ virtualMachineVersion?: string; } /** * Identity for the resource. */ interface IdentityDataResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. */ type: string; /** * The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.recoveryservices.UserIdentityResponse; }; } /** * Identity provider details. */ interface IdentityProviderDetailsResponse { /** * The base authority for Azure Active Directory authentication. */ aadAuthority?: string; /** * The application/client Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. */ applicationId?: string; /** * The intended Audience of the service principal with which the on-premise management/data plane components would communicate with our Azure services. */ audience?: string; /** * The object Id of the service principal with which the on-premise management/data plane components would communicate with our Azure services. */ objectId?: string; /** * The tenant Id for the service principal with which the on-premise management/data plane components would communicate with our Azure services. */ tenantId?: string; } /** * Immutability Settings of vault */ interface ImmutabilitySettingsResponse { state?: string; } /** * The details of the InMage agent. */ interface InMageAgentDetailsResponse { /** * Agent expiry date. */ agentExpiryDate?: string; /** * A value indicating whether installed agent needs to be updated. */ agentUpdateStatus?: string; /** * The agent version. */ agentVersion?: string; /** * A value indicating whether reboot is required after update is applied. */ postUpdateRebootStatus?: string; } /** * InMageAzureV2 Managed disk details. */ interface InMageAzureV2ManagedDiskDetailsResponse { /** * The DiskEncryptionSet ARM ID. */ diskEncryptionSetId?: string; /** * The disk id. */ diskId?: string; /** * The replica disk type. */ replicaDiskType?: string; /** * Seed managed disk Id. */ seedManagedDiskId?: string; /** * The target disk name. */ targetDiskName?: string; } /** * InMage Azure v2 specific protection profile details. */ interface InMageAzureV2PolicyDetailsResponse { /** * The app consistent snapshot frequency in minutes. */ appConsistentFrequencyInMinutes?: number; /** * The crash consistent snapshot frequency in minutes. */ crashConsistentFrequencyInMinutes?: number; /** * Gets the class type. Overridden in derived classes. * Expected value is 'InMageAzureV2'. */ instanceType: "InMageAzureV2"; /** * A value indicating whether multi-VM sync has to be enabled. */ multiVmSyncStatus?: string; /** * The duration in minutes until which the recovery points need to be stored. */ recoveryPointHistory?: number; /** * The recovery point threshold in minutes. */ recoveryPointThresholdInMinutes?: number; } /** * InMageAzureV2 protected disk details. */ interface InMageAzureV2ProtectedDiskDetailsResponse { /** * The disk capacity in bytes. */ diskCapacityInBytes?: number; /** * The disk id. */ diskId?: string; /** * The disk name. */ diskName?: string; /** * A value indicating whether disk is resized. */ diskResized?: string; /** * The disk file system capacity in bytes. */ fileSystemCapacityInBytes?: number; /** * The health error code for the disk. */ healthErrorCode?: string; /** * The last RPO calculated time. */ lastRpoCalculatedTime?: string; /** * The Progress Health. */ progressHealth?: string; /** * The Progress Status. */ progressStatus?: string; /** * The protection stage. */ protectionStage?: string; /** * The PS data transit in MB. */ psDataInMegaBytes?: number; /** * The resync duration in seconds. */ resyncDurationInSeconds?: number; /** * The resync last 15 minutes transferred bytes. */ resyncLast15MinutesTransferredBytes?: number; /** * The last data transfer time in UTC. */ resyncLastDataTransferTimeUTC?: string; /** * The resync processed bytes. */ resyncProcessedBytes?: number; /** * The resync progress percentage. */ resyncProgressPercentage?: number; /** * A value indicating whether resync is required for this disk. */ resyncRequired?: string; /** * The resync start time. */ resyncStartTime?: string; /** * The resync total transferred bytes. */ resyncTotalTransferredBytes?: number; /** * The RPO in seconds. */ rpoInSeconds?: number; /** * The seconds to take for switch provider. */ secondsToTakeSwitchProvider?: number; /** * The source data transit in MB. */ sourceDataInMegaBytes?: number; /** * The target data transit in MB. */ targetDataInMegaBytes?: number; } /** * InMageAzureV2 provider specific settings. */ interface InMageAzureV2ReplicationDetailsResponse { /** * Agent expiry date. */ agentExpiryDate?: string; /** * The agent version. */ agentVersion?: string; /** * A value indicating all available inplace OS Upgrade configurations. */ allAvailableOSUpgradeConfigurations?: outputs.recoveryservices.OSUpgradeSupportedVersionsResponse[]; /** * Azure VM Disk details. */ azureVMDiskDetails?: outputs.recoveryservices.AzureVmDiskDetailsResponse[]; /** * The target generation for this protected item. */ azureVmGeneration?: string; /** * The compressed data change rate in MB. */ compressedDataRateInMB?: number; /** * The datastores of the on-premise machine. Value can be list of strings that contain datastore names. */ datastores?: string[]; /** * A value indicating the discovery type of the machine. Value can be vCenter or physical. */ discoveryType?: string; /** * A value indicating whether any disk is resized for this VM. */ diskResized?: string; /** * The selected option to enable RDP\SSH on target vm after failover. String value of SrsDataContract.EnableRDPOnTargetOption enum. */ enableRdpOnTargetOption?: string; /** * The firmware type of this protected item. */ firmwareType?: string; /** * The infrastructure VM Id. */ infrastructureVmId?: string; /** * Gets the Instance type. * Expected value is 'InMageAzureV2'. */ instanceType: "InMageAzureV2"; /** * The source IP address. */ ipAddress?: string; /** * A value indicating whether additional IR stats are available or not. */ isAdditionalStatsAvailable?: boolean; /** * A value indicating whether installed agent needs to be updated. */ isAgentUpdateRequired?: string; /** * A value indicating whether the source server requires a restart after update. */ isRebootAfterUpdateRequired?: string; /** * The last heartbeat received from the source server. */ lastHeartbeat?: string; /** * The last recovery point received time. */ lastRecoveryPointReceived: string; /** * The last RPO calculated time. */ lastRpoCalculatedTime?: string; /** * The last update time received from on-prem components. */ lastUpdateReceivedTime?: string; /** * License Type of the VM to be used. */ licenseType?: string; /** * The master target Id. */ masterTargetId?: string; /** * The multi vm group Id. */ multiVmGroupId?: string; /** * The multi vm group name. */ multiVmGroupName?: string; /** * A value indicating whether multi vm sync is enabled or disabled. */ multiVmSyncStatus?: string; /** * The id of the disk containing the OS. */ osDiskId?: string; /** * The name of the OS on the VM. */ osName: string; /** * The type of the OS on the VM. */ osType?: string; /** * The OS Version of the protected item. */ osVersion?: string; /** * The process server Id. */ processServerId?: string; /** * The process server name. */ processServerName?: string; /** * The list of protected disks. */ protectedDisks?: outputs.recoveryservices.InMageAzureV2ProtectedDiskDetailsResponse[]; /** * The list of protected managed disks. */ protectedManagedDisks?: outputs.recoveryservices.InMageAzureV2ManagedDiskDetailsResponse[]; /** * The protection stage. */ protectionStage?: string; /** * The recovery availability set Id. */ recoveryAvailabilitySetId?: string; /** * The ARM id of the log storage account used for replication. This will be set to null if no log storage account was provided during enable protection. */ recoveryAzureLogStorageAccountId?: string; /** * The target resource group Id. */ recoveryAzureResourceGroupId?: string; /** * The recovery Azure storage account. */ recoveryAzureStorageAccount?: string; /** * Recovery Azure given name. */ recoveryAzureVMName?: string; /** * The Recovery Azure VM size. */ recoveryAzureVMSize?: string; /** * The replica id of the protected item. */ replicaId?: string; /** * The resync progress percentage. */ resyncProgressPercentage?: number; /** * The RPO in seconds. */ rpoInSeconds?: number; /** * The tags for the seed managed disks. */ seedManagedDiskTags?: { [key: string]: string; }; /** * The selected recovery azure network Id. */ selectedRecoveryAzureNetworkId?: string; /** * The selected source nic Id which will be used as the primary nic during failover. */ selectedSourceNicId?: string; /** * The test failover virtual network. */ selectedTfoAzureNetworkId?: string; /** * The CPU count of the VM on the primary side. */ sourceVmCpuCount?: number; /** * The RAM size of the VM on the primary side. */ sourceVmRamSizeInMB?: number; /** * The SQL Server license type. */ sqlServerLicenseType?: string; /** * A value indicating the inplace OS Upgrade version. */ supportedOSVersions?: string[]; /** * The switch provider blocking error information. */ switchProviderBlockingErrorDetails?: outputs.recoveryservices.InMageAzureV2SwitchProviderBlockingErrorDetailsResponse[]; /** * The switch provider blocking error information. */ switchProviderDetails?: outputs.recoveryservices.InMageAzureV2SwitchProviderDetailsResponse; /** * The target availability zone. */ targetAvailabilityZone?: string; /** * The tags for the target managed disks. */ targetManagedDiskTags?: { [key: string]: string; }; /** * The tags for the target NICs. */ targetNicTags?: { [key: string]: string; }; /** * The target proximity placement group Id. */ targetProximityPlacementGroupId?: string; /** * The ARM Id of the target Azure VM. This value will be null until the VM is failed over. Only after failure it will be populated with the ARM Id of the Azure VM. */ targetVmId?: string; /** * The target VM tags. */ targetVmTags?: { [key: string]: string; }; /** * The total transferred data in bytes. */ totalDataTransferred?: number; /** * The progress health. */ totalProgressHealth?: string; /** * The uncompressed data change rate in MB. */ uncompressedDataRateInMB?: number; /** * A value indicating whether managed disks should be used during failover. */ useManagedDisks?: string; /** * The vCenter infrastructure Id. */ vCenterInfrastructureId?: string; /** * The validation errors of the on-premise machine Value can be list of validation errors. */ validationErrors?: outputs.recoveryservices.HealthErrorResponse[]; /** * The OS disk VHD name. */ vhdName?: string; /** * The virtual machine Id. */ vmId?: string; /** * The PE Network details. */ vmNics?: outputs.recoveryservices.VMNicDetailsResponse[]; /** * The protection state for the vm. */ vmProtectionState?: string; /** * The protection state description for the vm. */ vmProtectionStateDescription?: string; } /** * InMageAzureV2 switch provider blocking error details. */ interface InMageAzureV2SwitchProviderBlockingErrorDetailsResponse { /** * The error code. */ errorCode: string; /** * The error message. */ errorMessage: string; /** * The error message parameters. */ errorMessageParameters: { [key: string]: string; }; /** * The error tags. */ errorTags: { [key: string]: string; }; /** * The possible causes. */ possibleCauses: string; /** * The recommended action. */ recommendedAction: string; } /** * InMageAzureV2 switch provider details. */ interface InMageAzureV2SwitchProviderDetailsResponse { /** * The target appliance Id. */ targetApplianceId: string; /** * The target fabric Id. */ targetFabricId: string; /** * The target resource Id. */ targetResourceId: string; /** * The target vault Id. */ targetVaultId: string; } /** * Base class for the policies of providers using InMage replication. */ interface InMageBasePolicyDetailsResponse { /** * The app consistent snapshot frequency in minutes. */ appConsistentFrequencyInMinutes?: number; /** * Gets the class type. Overridden in derived classes. * Expected value is 'InMageBasePolicyDetails'. */ instanceType: "InMageBasePolicyDetails"; /** * A value indicating whether multi-VM sync has to be enabled. */ multiVmSyncStatus?: string; /** * The duration in minutes until which the recovery points need to be stored. */ recoveryPointHistory?: number; /** * The recovery point threshold in minutes. */ recoveryPointThresholdInMinutes?: number; } /** * InMageFabric switch provider blocking error details. */ interface InMageFabricSwitchProviderBlockingErrorDetailsResponse { /** * The error code. */ errorCode: string; /** * The error message. */ errorMessage: string; /** * The error message parameters. */ errorMessageParameters: { [key: string]: string; }; /** * The error tags. */ errorTags: { [key: string]: string; }; /** * The possible causes. */ possibleCauses: string; /** * The recommended action. */ recommendedAction: string; } /** * InMage specific protection profile details. */ interface InMagePolicyDetailsResponse { /** * The app consistent snapshot frequency in minutes. */ appConsistentFrequencyInMinutes?: number; /** * Gets the class type. Overridden in derived classes. * Expected value is 'InMage'. */ instanceType: "InMage"; /** * A value indicating whether multi-VM sync has to be enabled. */ multiVmSyncStatus?: string; /** * The duration in minutes until which the recovery points need to be stored. */ recoveryPointHistory?: number; /** * The recovery point threshold in minutes. */ recoveryPointThresholdInMinutes?: number; } /** * InMage protected disk details. */ interface InMageProtectedDiskDetailsResponse { /** * The disk capacity in bytes. */ diskCapacityInBytes?: number; /** * The disk id. */ diskId?: string; /** * The disk name. */ diskName?: string; /** * A value indicating whether disk is resized. */ diskResized?: string; /** * The file system capacity in bytes. */ fileSystemCapacityInBytes?: number; /** * The health error code for the disk. */ healthErrorCode?: string; /** * The last RPO calculated time. */ lastRpoCalculatedTime?: string; /** * The Progress Health. */ progressHealth?: string; /** * The Progress Status. */ progressStatus?: string; /** * The protection stage. */ protectionStage?: string; /** * The PS data transit in MB. */ psDataInMB?: number; /** * The resync duration in seconds. */ resyncDurationInSeconds?: number; /** * The resync last 15 minutes transferred bytes. */ resyncLast15MinutesTransferredBytes?: number; /** * The last data transfer time in UTC. */ resyncLastDataTransferTimeUTC?: string; /** * The resync processed bytes. */ resyncProcessedBytes?: number; /** * The resync progress percentage. */ resyncProgressPercentage?: number; /** * A value indicating whether resync is required for this disk. */ resyncRequired?: string; /** * The resync start time. */ resyncStartTime?: string; /** * The resync total transferred bytes. */ resyncTotalTransferredBytes?: number; /** * The RPO in seconds. */ rpoInSeconds?: number; /** * The source data transit in MB. */ sourceDataInMB?: number; /** * The target data transit in MB. */ targetDataInMB?: number; } /** * InMageRcm source agent upgrade blocking error details. */ interface InMageRcmAgentUpgradeBlockingErrorDetailsResponse { /** * The error code. */ errorCode: string; /** * The error message. */ errorMessage: string; /** * The error message parameters. */ errorMessageParameters: { [key: string]: string; }; /** * The error tags. */ errorTags: { [key: string]: string; }; /** * The possible causes. */ possibleCauses: string; /** * The recommended action. */ recommendedAction: string; } /** * InMageRcm discovered protected VM details. */ interface InMageRcmDiscoveredProtectedVmDetailsResponse { /** * The SDS created timestamp. */ createdTimestamp: string; /** * The list of datastores. */ datastores: string[]; /** * The list of IP addresses. */ ipAddresses: string[]; /** * A value indicating whether the VM is deleted. */ isDeleted: boolean; /** * The last time when SDS information discovered in SRS. */ lastDiscoveryTimeInUtc: string; /** * The VM's OS name. */ osName: string; /** * The VM power status. */ powerStatus: string; /** * The SDS updated timestamp. */ updatedTimestamp: string; /** * The VCenter fqdn. */ vCenterFqdn: string; /** * The VCenter Id. */ vCenterId: string; /** * The VM fqdn. */ vmFqdn: string; /** * The VMware tools status. */ vmwareToolsStatus: string; } /** * InMageRcm fabric specific details. */ interface InMageRcmFabricSpecificDetailsResponse { /** * The list of agent details. */ agentDetails: outputs.recoveryservices.AgentDetailsResponse[]; /** * The control plane Uri. */ controlPlaneUri: string; /** * The data plane Uri. */ dataPlaneUri: string; /** * The list of DRAs. */ dras: outputs.recoveryservices.DraDetailsResponse[]; /** * Gets the class type. Overridden in derived classes. * Expected value is 'InMageRcm'. */ instanceType: "InMageRcm"; /** * The list of Mars agents. */ marsAgents: outputs.recoveryservices.MarsAgentDetailsResponse[]; /** * The ARM Id of the physical site. */ physicalSiteId: string; /** * The list of process servers. */ processServers: outputs.recoveryservices.ProcessServerDetailsResponse[]; /** * The list of push installers. */ pushInstallers: outputs.recoveryservices.PushInstallerDetailsResponse[]; /** * The list of RCM proxies. */ rcmProxies: outputs.recoveryservices.RcmProxyDetailsResponse[]; /** * The list of replication agents. */ replicationAgents: outputs.recoveryservices.ReplicationAgentDetailsResponse[]; /** * The list of reprotect agents. */ reprotectAgents: outputs.recoveryservices.ReprotectAgentDetailsResponse[]; /** * The service container Id. */ serviceContainerId: string; /** * The service endpoint. */ serviceEndpoint: string; /** * The service resource Id. */ serviceResourceId: string; /** * The source agent identity details. */ sourceAgentIdentityDetails?: outputs.recoveryservices.IdentityProviderDetailsResponse; /** * The ARM Id of the VMware site. */ vmwareSiteId: string; } /** * InMageRcmFailback discovered VM details. */ interface InMageRcmFailbackDiscoveredProtectedVmDetailsResponse { /** * The SDS created timestamp. */ createdTimestamp: string; /** * The list of datastores. */ datastores: string[]; /** * The list of IP addresses. */ ipAddresses: string[]; /** * A value indicating whether the VM is deleted. */ isDeleted: boolean; /** * The last time when SDS information discovered in SRS. */ lastDiscoveryTimeInUtc: string; /** * The VM's OS name. */ osName: string; /** * The VM power status. */ powerStatus: string; /** * The SDS updated timestamp. */ updatedTimestamp: string; /** * The VCenter fqdn. */ vCenterFqdn: string; /** * The VCenter Id. */ vCenterId: string; /** * The VM fqdn. */ vmFqdn: string; /** * The VMware tools status. */ vmwareToolsStatus: string; } /** * InMageRcmFailback mobility agent details. */ interface InMageRcmFailbackMobilityAgentDetailsResponse { /** * The agent version expiry date. */ agentVersionExpiryDate: string; /** * The driver version. */ driverVersion: string; /** * The driver version expiry date. */ driverVersionExpiryDate: string; /** * A value indicating whether agent is upgradeable or not. */ isUpgradeable: string; /** * The time of the last heartbeat received from the agent. */ lastHeartbeatUtc: string; /** * The latest upgradeable version available without reboot. */ latestUpgradableVersionWithoutReboot: string; /** * The latest agent version available. */ latestVersion: string; /** * The whether update is possible or not. */ reasonsBlockingUpgrade: string[]; /** * The agent version. */ version: string; } /** * InMageRcmFailback NIC details. */ interface InMageRcmFailbackNicDetailsResponse { /** * The adapter type. */ adapterType: string; /** * The mac address. */ macAddress: string; /** * The network name. */ networkName: string; /** * The IP address. */ sourceIpAddress: string; } /** * InMageRcm failback specific policy details. */ interface InMageRcmFailbackPolicyDetailsResponse { /** * The app consistent snapshot frequency in minutes. */ appConsistentFrequencyInMinutes?: number; /** * The crash consistent snapshot frequency in minutes. */ crashConsistentFrequencyInMinutes?: number; /** * Gets the class type. Overridden in derived classes. * Expected value is 'InMageRcmFailback'. */ instanceType: "InMageRcmFailback"; } /** * InMageRcmFailback protected disk details. */ interface InMageRcmFailbackProtectedDiskDetailsResponse { /** * The disk capacity in bytes. */ capacityInBytes: number; /** * The data pending at source agent in MB. */ dataPendingAtSourceAgentInMB: number; /** * The data pending in log data store in MB. */ dataPendingInLogDataStoreInMB: number; /** * The disk Id (reported by source agent). */ diskId: string; /** * The disk name. */ diskName: string; /** * The disk Uuid (reported by vCenter). */ diskUuid: string; /** * The initial replication details. */ irDetails?: outputs.recoveryservices.InMageRcmFailbackSyncDetailsResponse; /** * A value indicating whether initial replication is complete or not. */ isInitialReplicationComplete: string; /** * A value indicating whether the disk is the OS disk. */ isOSDisk: string; /** * The last sync time. */ lastSyncTime: string; /** * The resync details. */ resyncDetails?: outputs.recoveryservices.InMageRcmFailbackSyncDetailsResponse; } /** * InMageRcmFailback provider specific details. */ interface InMageRcmFailbackReplicationDetailsResponse { /** * The ARM Id of the azure VM. */ azureVirtualMachineId: string; /** * The discovered VM information. */ discoveredVmDetails?: outputs.recoveryservices.InMageRcmFailbackDiscoveredProtectedVmDetailsResponse; /** * The initial replication processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM. */ initialReplicationProcessedBytes: number; /** * The initial replication progress health. */ initialReplicationProgressHealth: string; /** * The initial replication progress percentage. */ initialReplicationProgressPercentage: number; /** * The initial replication transferred bytes from source VM to target for all selected disks on source VM. */ initialReplicationTransferredBytes: number; /** * Gets the Instance type. * Expected value is 'InMageRcmFailback'. */ instanceType: "InMageRcmFailback"; /** * The virtual machine internal identifier. */ internalIdentifier: string; /** * A value indicating whether agent registration was successful after failover. */ isAgentRegistrationSuccessfulAfterFailover: boolean; /** * The last planned failover start time. */ lastPlannedFailoverStartTime: string; /** * The last planned failover status. */ lastPlannedFailoverStatus: string; /** * The policy friendly name used by the forward replication. */ lastUsedPolicyFriendlyName: string; /** * The policy Id used by the forward replication. */ lastUsedPolicyId: string; /** * The log storage account ARM Id. */ logStorageAccountId: string; /** * The mobility agent information. */ mobilityAgentDetails?: outputs.recoveryservices.InMageRcmFailbackMobilityAgentDetailsResponse; /** * The multi VM group name. */ multiVmGroupName: string; /** * The type of the OS on the VM. */ osType: string; /** * The list of protected disks. */ protectedDisks?: outputs.recoveryservices.InMageRcmFailbackProtectedDiskDetailsResponse[]; /** * The reprotect agent Id. */ reprotectAgentId: string; /** * The reprotect agent name. */ reprotectAgentName: string; /** * The resync processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM. */ resyncProcessedBytes: number; /** * The resync progress health. */ resyncProgressHealth: string; /** * The resync progress percentage. */ resyncProgressPercentage: number; /** * A value indicating whether resync is required. */ resyncRequired: string; /** * The resync state. */ resyncState: string; /** * The resync transferred bytes from source VM to target for all selected disks on source VM. */ resyncTransferredBytes: number; /** * The target datastore name. */ targetDataStoreName: string; /** * The target VM name. */ targetVmName: string; /** * The target vCenter Id. */ targetvCenterId: string; /** * The network details. */ vmNics?: outputs.recoveryservices.InMageRcmFailbackNicDetailsResponse[]; } /** * InMageRcmFailback disk level sync details. */ interface InMageRcmFailbackSyncDetailsResponse { /** * The bytes transferred in last 15 minutes from source VM to target. */ last15MinutesTransferredBytes: number; /** * The time of the last data transfer from source VM to target. */ lastDataTransferTimeUtc: string; /** * The last refresh time. */ lastRefreshTime: string; /** * The total processed bytes. This includes bytes that are transferred from source VM to target and matched bytes. */ processedBytes: number; /** * The progress health. */ progressHealth: string; /** * Progress in percentage. Progress percentage is calculated based on processed bytes. */ progressPercentage: number; /** * The start time. */ startTime: string; /** * The transferred bytes from source VM to azure for the disk. */ transferredBytes: number; } /** * InMageRcm last source agent upgrade error details. */ interface InMageRcmLastAgentUpgradeErrorDetailsResponse { /** * The error code. */ errorCode: string; /** * The error message. */ errorMessage: string; /** * The error message parameters. */ errorMessageParameters: { [key: string]: string; }; /** * The error tags. */ errorTags: { [key: string]: string; }; /** * The possible causes. */ possibleCauses: string; /** * The recommended action. */ recommendedAction: string; } /** * InMageRcm mobility agent details. */ interface InMageRcmMobilityAgentDetailsResponse { /** * The agent version expiry date. */ agentVersionExpiryDate: string; /** * The driver version. */ driverVersion: string; /** * The driver version expiry date. */ driverVersionExpiryDate: string; /** * A value indicating whether agent is upgradeable or not. */ isUpgradeable: string; /** * The time of the last heartbeat received from the agent. */ lastHeartbeatUtc: string; /** * The latest agent version release date. */ latestAgentReleaseDate: string; /** * The latest upgradeable version available without reboot. */ latestUpgradableVersionWithoutReboot: string; /** * The latest agent version available. */ latestVersion: string; /** * The whether update is possible or not. */ reasonsBlockingUpgrade: string[]; /** * The agent version. */ version: string; } /** * InMageRcm NIC details. */ interface InMageRcmNicDetailsResponse { /** * A value indicating whether this is the primary NIC. */ isPrimaryNic?: string; /** * A value indicating whether this NIC is selected for failover. */ isSelectedForFailover?: string; /** * The NIC Id. */ nicId: string; /** * The source IP address. */ sourceIPAddress: string; /** * The source IP address type. */ sourceIPAddressType: string; /** * Source network Id. */ sourceNetworkId: string; /** * Source subnet name. */ sourceSubnetName: string; /** * The target IP address. */ targetIPAddress?: string; /** * The target IP address type. */ targetIPAddressType?: string; /** * The target NIC name. */ targetNicName?: string; /** * Target subnet name. */ targetSubnetName?: string; /** * The test IP address. */ testIPAddress?: string; /** * The test IP address type. */ testIPAddressType?: string; /** * Test subnet name. */ testSubnetName?: string; } /** * InMageRcm specific policy details. */ interface InMageRcmPolicyDetailsResponse { /** * The app consistent snapshot frequency in minutes. */ appConsistentFrequencyInMinutes?: number; /** * The crash consistent snapshot frequency in minutes. */ crashConsistentFrequencyInMinutes?: number; /** * A value indicating whether multi-VM sync has to be enabled. */ enableMultiVmSync?: string; /** * Gets the class type. Overridden in derived classes. * Expected value is 'InMageRcm'. */ instanceType: "InMageRcm"; /** * The duration in minutes until which the recovery points need to be stored. */ recoveryPointHistoryInMinutes?: number; } /** * InMageRcm protected disk details. */ interface InMageRcmProtectedDiskDetailsResponse { /** * The disk capacity in bytes. */ capacityInBytes: number; /** * The custom target Azure disk name. */ customTargetDiskName?: string; /** * The data pending at source agent in MB. */ dataPendingAtSourceAgentInMB: number; /** * The data pending in log data store in MB. */ dataPendingInLogDataStoreInMB: number; /** * The DiskEncryptionSet ARM Id. */ diskEncryptionSetId: string; /** * The disk Id. */ diskId: string; /** * The disk name. */ diskName: string; /** * The disk state. */ diskState: string; /** * The disk type. */ diskType?: string; /** * The initial replication details. */ irDetails?: outputs.recoveryservices.InMageRcmSyncDetailsResponse; /** * A value indicating whether initial replication is complete or not. */ isInitialReplicationComplete: string; /** * A value indicating whether the disk is the OS disk. */ isOSDisk: string; /** * The log storage account ARM Id. */ logStorageAccountId: string; /** * The resync details. */ resyncDetails?: outputs.recoveryservices.InMageRcmSyncDetailsResponse; /** * The logical sector size (in bytes), 512 by default. */ sectorSizeInBytes?: number; /** * The uri of the seed blob. */ seedBlobUri: string; /** * The ARM Id of the seed managed disk. */ seedManagedDiskId: string; /** * The ARM Id of the target managed disk. */ targetManagedDiskId: string; } /** * InMageRcm provider specific container mapping details. */ interface InMageRcmProtectionContainerMappingDetailsResponse { /** * A value indicating whether the flag for enable agent auto upgrade. */ enableAgentAutoUpgrade: string; /** * Gets the class type. Overridden in derived classes. * Expected value is 'InMageRcm'. */ instanceType: "InMageRcm"; } /** * InMageRcm provider specific details. */ interface InMageRcmReplicationDetailsResponse { /** * The agent version to which last agent upgrade was attempted. */ agentUpgradeAttemptToVersion: string; /** * The agent upgrade blocking error information. */ agentUpgradeBlockingErrorDetails?: outputs.recoveryservices.InMageRcmAgentUpgradeBlockingErrorDetailsResponse[]; /** * The agent upgrade job Id. */ agentUpgradeJobId: string; /** * The agent auto upgrade state. */ agentUpgradeState: string; /** * The allocated memory in MB. */ allocatedMemoryInMB: number; /** * The discovered VM details. */ discoveredVmDetails?: outputs.recoveryservices.InMageRcmDiscoveredProtectedVmDetailsResponse; /** * The type of the discovered VM. */ discoveryType: string; /** * The ARM Id of the discovered VM. */ fabricDiscoveryMachineId: string; /** * The recovery point Id to which the VM was failed over. */ failoverRecoveryPointId: string; /** * The firmware type. */ firmwareType: string; /** * The initial replication processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM. */ initialReplicationProcessedBytes: number; /** * The initial replication progress health. */ initialReplicationProgressHealth: string; /** * The initial replication progress percentage. This is calculated based on total bytes processed for all disks in the source VM. */ initialReplicationProgressPercentage: number; /** * The initial replication transferred bytes from source VM to azure for all selected disks on source VM. */ initialReplicationTransferredBytes: number; /** * Gets the Instance type. * Expected value is 'InMageRcm'. */ instanceType: "InMageRcm"; /** * The virtual machine internal identifier. */ internalIdentifier: string; /** * A value indicating whether agent registration was successful after failover. */ isAgentRegistrationSuccessfulAfterFailover: boolean; /** * A value indicating whether last agent upgrade was successful or not. */ isLastUpgradeSuccessful: string; /** * The last agent upgrade error information. */ lastAgentUpgradeErrorDetails?: outputs.recoveryservices.InMageRcmLastAgentUpgradeErrorDetailsResponse[]; /** * The last agent upgrade type. */ lastAgentUpgradeType: string; /** * The last recovery point Id. */ lastRecoveryPointId: string; /** * The last recovery point received time. */ lastRecoveryPointReceived: string; /** * The last recovery point objective calculated time. */ lastRpoCalculatedTime: string; /** * The last recovery point objective value. */ lastRpoInSeconds: number; /** * License Type of the VM to be used. */ licenseType?: string; /** * The license type for Linux VM's. */ linuxLicenseType?: string; /** * The mobility agent information. */ mobilityAgentDetails?: outputs.recoveryservices.InMageRcmMobilityAgentDetailsResponse; /** * The multi VM group name. */ multiVmGroupName: string; /** * The OS name associated with VM. */ osName?: string; /** * The type of the OS on the VM. */ osType: string; /** * The IP address of the primary network interface. */ primaryNicIpAddress: string; /** * The process server Id. */ processServerId: string; /** * The process server name. */ processServerName: string; /** * The processor core count. */ processorCoreCount: number; /** * The list of protected disks. */ protectedDisks?: outputs.recoveryservices.InMageRcmProtectedDiskDetailsResponse[]; /** * The resync processed bytes. This includes sum of total bytes transferred and matched bytes on all selected disks in source VM. */ resyncProcessedBytes: number; /** * The resync progress health. */ resyncProgressHealth: string; /** * The resync progress percentage. This is calculated based on total bytes processed for all disks in the source VM. */ resyncProgressPercentage: number; /** * A value indicating whether resync is required. */ resyncRequired: string; /** * The resync state. */ resyncState: string; /** * The resync transferred bytes from source VM to azure for all selected disks on source VM. */ resyncTransferredBytes: number; /** * The run-as account Id. */ runAsAccountId: string; /** * The tags for the seed managed disks. */ seedManagedDiskTags?: outputs.recoveryservices.UserCreatedResourceTagResponse[]; /** * The SQL Server license type. */ sqlServerLicenseType?: string; /** * The replication storage account ARM Id. This is applicable only for the blob based replication test hook. */ storageAccountId: string; /** * A value indicating the inplace OS Upgrade version. */ supportedOSVersions?: string[]; /** * The target availability set Id. */ targetAvailabilitySetId?: string; /** * The target availability zone. */ targetAvailabilityZone?: string; /** * The target boot diagnostics storage account ARM Id. */ targetBootDiagnosticsStorageAccountId?: string; /** * The target generation. */ targetGeneration: string; /** * The target location. */ targetLocation?: string; /** * The tags for the target managed disks. */ targetManagedDiskTags?: outputs.recoveryservices.UserCreatedResourceTagResponse[]; /** * The target network Id. */ targetNetworkId?: string; /** * The tags for the target NICs. */ targetNicTags?: outputs.recoveryservices.UserCreatedResourceTagResponse[]; /** * The target proximity placement group Id. */ targetProximityPlacementGroupId?: string; /** * The target resource group Id. */ targetResourceGroupId?: string; /** * Target VM name. */ targetVmName?: string; /** * The target VM security profile. */ targetVmSecurityProfile?: outputs.recoveryservices.SecurityProfilePropertiesResponse; /** * The target VM size. */ targetVmSize?: string; /** * The target VM tags. */ targetVmTags?: outputs.recoveryservices.UserCreatedResourceTagResponse[]; /** * The test network Id. */ testNetworkId?: string; /** * The list of unprotected disks. */ unprotectedDisks?: outputs.recoveryservices.InMageRcmUnProtectedDiskDetailsResponse[]; /** * The network details. */ vmNics?: outputs.recoveryservices.InMageRcmNicDetailsResponse[]; } /** * InMageRcm disk level sync details. */ interface InMageRcmSyncDetailsResponse { /** * The bytes transferred in last 15 minutes from source VM to azure. */ last15MinutesTransferredBytes: number; /** * The time of the last data transfer from source VM to azure. */ lastDataTransferTimeUtc: string; /** * The last refresh time. */ lastRefreshTime: string; /** * The total processed bytes. This includes bytes that are transferred from source VM to azure and matched bytes. */ processedBytes: number; /** * The progress health. */ progressHealth: string; /** * Progress in percentage. Progress percentage is calculated based on processed bytes. */ progressPercentage: number; /** * The start time. */ startTime: string; /** * The transferred bytes from source VM to azure for the disk. */ transferredBytes: number; } /** * InMageRcm un-protected disk details. */ interface InMageRcmUnProtectedDiskDetailsResponse { /** * The disk capacity in bytes. */ capacityInBytes: number; /** * The disk Id. */ diskId: string; /** * The disk name. */ diskName: string; } /** * InMage provider specific settings. */ interface InMageReplicationDetailsResponse { /** * The active location of the VM. If the VM is being protected from Azure, this field will take values from { Azure, OnPrem }. If the VM is being protected between two data-centers, this field will be OnPrem always. */ activeSiteType?: string; /** * The agent details. */ agentDetails?: outputs.recoveryservices.InMageAgentDetailsResponse; /** * A value indicating the underlying Azure storage account. If the VM is not running in Azure, this value shall be set to null. */ azureStorageAccountId?: string; /** * The compressed data change rate in MB. */ compressedDataRateInMB?: number; /** * The collection of Consistency points. */ consistencyPoints?: { [key: string]: string; }; /** * The datastores of the on-premise machine Value can be list of strings that contain datastore names. */ datastores?: string[]; /** * A value indicating the discovery type of the machine. */ discoveryType?: string; /** * A value indicating whether any disk is resized for this VM. */ diskResized?: string; /** * The infrastructure VM Id. */ infrastructureVmId?: string; /** * Gets the Instance type. * Expected value is 'InMage'. */ instanceType: "InMage"; /** * The source IP address. */ ipAddress?: string; /** * A value indicating whether additional IR stats are available or not. */ isAdditionalStatsAvailable?: boolean; /** * The last heartbeat received from the source server. */ lastHeartbeat?: string; /** * The last RPO calculated time. */ lastRpoCalculatedTime?: string; /** * The last update time received from on-prem components. */ lastUpdateReceivedTime?: string; /** * The master target Id. */ masterTargetId?: string; /** * The multi vm group Id, if any. */ multiVmGroupId?: string; /** * The multi vm group name, if any. */ multiVmGroupName?: string; /** * A value indicating whether the multi vm sync is enabled or disabled. */ multiVmSyncStatus?: string; /** * The OS details. */ osDetails?: outputs.recoveryservices.OSDiskDetailsResponse; /** * The OS Version of the protected item. */ osVersion?: string; /** * The process server Id. */ processServerId?: string; /** * The list of protected disks. */ protectedDisks?: outputs.recoveryservices.InMageProtectedDiskDetailsResponse[]; /** * The protection stage. */ protectionStage?: string; /** * A value indicating whether the source server requires a restart after update. */ rebootAfterUpdateStatus?: string; /** * The replica id of the protected item. */ replicaId?: string; /** * The resync details of the machine. */ resyncDetails?: outputs.recoveryservices.InitialReplicationDetailsResponse; /** * The retention window end time. */ retentionWindowEnd?: string; /** * The retention window start time. */ retentionWindowStart?: string; /** * The RPO in seconds. */ rpoInSeconds?: number; /** * The CPU count of the VM on the primary side. */ sourceVmCpuCount?: number; /** * The RAM size of the VM on the primary side. */ sourceVmRamSizeInMB?: number; /** * The total transferred data in bytes. */ totalDataTransferred?: number; /** * The progress health. */ totalProgressHealth?: string; /** * The uncompressed data change rate in MB. */ uncompressedDataRateInMB?: number; /** * The vCenter infrastructure Id. */ vCenterInfrastructureId?: string; /** * The validation errors of the on-premise machine Value can be list of validation errors. */ validationErrors?: outputs.recoveryservices.HealthErrorResponse[]; /** * The virtual machine Id. */ vmId?: string; /** * The PE Network details. */ vmNics?: outputs.recoveryservices.VMNicDetailsResponse[]; /** * The protection state for the vm. */ vmProtectionState?: string; /** * The protection state description for the vm. */ vmProtectionStateDescription?: string; } /** * Initial replication details. */ interface InitialReplicationDetailsResponse { /** * The initial replication progress percentage. */ initialReplicationProgressPercentage?: string; /** * Initial replication type. */ initialReplicationType?: string; } /** * Implements InnerHealthError class. HealthError object has a list of InnerHealthErrors as child errors. InnerHealthError is used because this will prevent an infinite loop of structures when Hydra tries to auto-generate the contract. We are exposing the related health errors as inner health errors and all API consumers can utilize this in the same fashion as Exception -> InnerException. */ interface InnerHealthErrorResponse { /** * Error creation time (UTC). */ creationTimeUtc?: string; /** * Value indicating whether the health error is customer resolvable. */ customerResolvability?: string; /** * ID of the entity. */ entityId?: string; /** * Category of error. */ errorCategory?: string; /** * Error code. */ errorCode?: string; /** * The health error unique id. */ errorId?: string; /** * Level of error. */ errorLevel?: string; /** * Error message. */ errorMessage?: string; /** * Source of error. */ errorSource?: string; /** * Type of error. */ errorType?: string; /** * Possible causes of error. */ possibleCauses?: string; /** * Recommended action to resolve error. */ recommendedAction?: string; /** * DRA error message. */ recoveryProviderErrorMessage?: string; /** * Summary message of the entity. */ summaryMessage?: string; } interface InputEndpointResponse { endpointName?: string; privatePort?: number; protocol?: string; publicPort?: number; } /** * Details about inquired protectable items under a given container. */ interface InquiryInfoResponse { /** * Error Details if the Status is non-success. */ errorDetail?: outputs.recoveryservices.ErrorDetailResponse; /** * Inquiry Details which will have workload specific details. * For e.g. - For SQL and oracle this will contain different details. */ inquiryDetails?: outputs.recoveryservices.WorkloadInquiryDetailsResponse[]; /** * Inquiry Status for this container such as * InProgress | Failed | Succeeded */ status?: string; } /** * Validation for inquired protectable items under a given container. */ interface InquiryValidationResponse { /** * Error Additional Detail in case the status is non-success. */ additionalDetail: string; /** * Error Detail in case the status is non-success. */ errorDetail?: outputs.recoveryservices.ErrorDetailResponse; /** * Dictionary to store the count of ProtectableItems with key POType. */ protectableItemCount: any; /** * Status for the Inquiry Validation. */ status?: string; } interface InstantRPAdditionalDetailsResponse { azureBackupRGNamePrefix?: string; azureBackupRGNameSuffix?: string; } /** * KPI Resource Health Details */ interface KPIResourceHealthDetailsResponse { /** * Resource Health Status */ resourceHealthDetails?: outputs.recoveryservices.ResourceHealthDetailsResponse[]; /** * Resource Health Status */ resourceHealthStatus?: string; } /** * Log policy schedule. */ interface LogSchedulePolicyResponse { /** * Frequency of the log schedule operation of this policy in minutes. */ scheduleFrequencyInMins?: number; /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'LogSchedulePolicy'. */ schedulePolicyType: "LogSchedulePolicy"; } /** * Long term retention policy. */ interface LongTermRetentionPolicyResponse { /** * Daily retention schedule of the protection policy. */ dailySchedule?: outputs.recoveryservices.DailyRetentionScheduleResponse; /** * Monthly retention schedule of the protection policy. */ monthlySchedule?: outputs.recoveryservices.MonthlyRetentionScheduleResponse; /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'LongTermRetentionPolicy'. */ retentionPolicyType: "LongTermRetentionPolicy"; /** * Weekly retention schedule of the protection policy. */ weeklySchedule?: outputs.recoveryservices.WeeklyRetentionScheduleResponse; /** * Yearly retention schedule of the protection policy. */ yearlySchedule?: outputs.recoveryservices.YearlyRetentionScheduleResponse; } /** * Long term policy schedule. */ interface LongTermSchedulePolicyResponse { /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'LongTermSchedulePolicy'. */ schedulePolicyType: "LongTermSchedulePolicy"; } /** * MAB workload-specific Health Details. */ interface MABContainerHealthDetailsResponse { /** * Health Code */ code?: number; /** * Health Message */ message?: string; /** * Health Recommended Actions */ recommendations?: string[]; /** * Health Title */ title?: string; } /** * Additional information of the container. */ interface MabContainerExtendedInfoResponse { /** * Type of backup items associated with this container. */ backupItemType?: string; /** * List of backup items associated with this container. */ backupItems?: string[]; /** * Latest backup status of this container. */ lastBackupStatus?: string; /** * Time stamp when this container was refreshed. */ lastRefreshedAt?: string; /** * Backup policy associated with this container. */ policyName?: string; } /** * Container with items backed up using MAB backup engine. */ interface MabContainerResponse { /** * Agent version of this container. */ agentVersion?: string; /** * Type of backup management for the container. */ backupManagementType?: string; /** * Can the container be registered one more time. */ canReRegister?: boolean; /** * Health state of mab container. */ containerHealthState?: string; /** * ContainerID represents the container. */ containerId?: number; /** * Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. * Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is * Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload * Backup is VMAppContainer * Expected value is 'Windows'. */ containerType: "Windows"; /** * Additional information for this container */ extendedInfo?: outputs.recoveryservices.MabContainerExtendedInfoResponse; /** * Friendly name of the container. */ friendlyName?: string; /** * Status of health of the container. */ healthStatus?: string; /** * Health details on this mab container. */ mabContainerHealthDetails?: outputs.recoveryservices.MABContainerHealthDetailsResponse[]; /** * Type of the protectable object associated with this container */ protectableObjectType?: string; /** * Number of items backed up in this container. */ protectedItemCount?: number; /** * Status of registration of the container with the Recovery Services Vault. */ registrationStatus?: string; } /** * Additional information on the backed up item. */ interface MabFileFolderProtectedItemExtendedInfoResponse { /** * Last time when the agent data synced to service. */ lastRefreshedAt?: string; /** * The oldest backup copy available. */ oldestRecoveryPoint?: string; /** * Number of backup copies associated with the backup item. */ recoveryPointCount?: number; } /** * MAB workload-specific backup item. */ interface MabFileFolderProtectedItemResponse { /** * Type of backup management for the backed up item. */ backupManagementType: string; /** * Name of the backup set the backup item belongs to */ backupSetName?: string; /** * Name of the computer associated with this backup item. */ computerName?: string; /** * Unique name of container */ containerName?: string; /** * Create mode to indicate recovery of existing soft deleted data source or creation of new data source. */ createMode?: string; /** * Sync time for deferred deletion in UTC */ deferredDeleteSyncTimeInUTC?: number; /** * Time for deferred deletion in UTC */ deferredDeleteTimeInUTC?: string; /** * Time remaining before the DS marked for deferred delete is permanently deleted */ deferredDeleteTimeRemaining?: string; /** * Additional information with this backup item. */ extendedInfo?: outputs.recoveryservices.MabFileFolderProtectedItemExtendedInfoResponse; /** * Friendly name of this backup item. */ friendlyName?: string; /** * Flag to identify whether datasource is protected in archive */ isArchiveEnabled?: boolean; /** * Flag to identify whether the deferred deleted DS is to be purged soon */ isDeferredDeleteScheduleUpcoming?: boolean; /** * Flag to identify that deferred deleted DS is to be moved into Pause state */ isRehydrate?: boolean; /** * Flag to identify whether the DS is scheduled for deferred delete */ isScheduledForDeferredDelete?: boolean; /** * Status of last backup operation. */ lastBackupStatus?: string; /** * Timestamp of the last backup operation on this backup item. */ lastBackupTime?: string; /** * Timestamp when the last (latest) backup copy was created for this backup item. */ lastRecoveryPoint?: string; /** * ID of the backup policy with which this item is backed up. */ policyId?: string; /** * Name of the policy used for protection */ policyName?: string; /** * backup item type. * Expected value is 'MabFileFolderProtectedItem'. */ protectedItemType: "MabFileFolderProtectedItem"; /** * Protected, ProtectionStopped, IRPending or ProtectionError */ protectionState?: string; /** * ResourceGuardOperationRequests on which LAC check will be performed */ resourceGuardOperationRequests?: string[]; /** * Soft delete retention period in days */ softDeleteRetentionPeriodInDays?: number; /** * ARM ID of the resource to be backed up. */ sourceResourceId?: string; /** * ID of the vault which protects this item */ vaultId: string; /** * Type of workload this item represents. */ workloadType: string; } /** * Mab container-specific backup policy. */ interface MabProtectionPolicyResponse { /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'MAB'. */ backupManagementType: "MAB"; /** * Number of items associated with this policy. */ protectedItemsCount?: number; /** * ResourceGuard Operation Requests */ resourceGuardOperationRequests?: string[]; /** * Retention policy details. */ retentionPolicy?: outputs.recoveryservices.LongTermRetentionPolicyResponse | outputs.recoveryservices.SimpleRetentionPolicyResponse; /** * Backup schedule of backup policy. */ schedulePolicy?: outputs.recoveryservices.LogSchedulePolicyResponse | outputs.recoveryservices.LongTermSchedulePolicyResponse | outputs.recoveryservices.SimpleSchedulePolicyResponse | outputs.recoveryservices.SimpleSchedulePolicyV2Response; } /** * Mars agent details. */ interface MarsAgentDetailsResponse { /** * The Mars agent Bios Id. */ biosId: string; /** * The fabric object Id. */ fabricObjectId: string; /** * The Mars agent Fqdn. */ fqdn: string; /** * The health of the Mars agent. */ health: string; /** * The health errors. */ healthErrors: outputs.recoveryservices.HealthErrorResponse[]; /** * The Mars agent Id. */ id: string; /** * The last heartbeat received from the Mars agent. */ lastHeartbeatUtc: string; /** * The Mars agent name. */ name: string; /** * The version. */ version: string; } /** * Details of a Master Target Server. */ interface MasterTargetServerResponse { /** * Agent expiry date. */ agentExpiryDate?: string; /** * The version of the scout component on the server. */ agentVersion?: string; /** * Agent version details. */ agentVersionDetails?: outputs.recoveryservices.VersionDetailsResponse; /** * The list of data stores in the fabric. */ dataStores?: outputs.recoveryservices.DataStoreResponse[]; /** * Disk count of the master target. */ diskCount?: number; /** * Health errors. */ healthErrors?: outputs.recoveryservices.HealthErrorResponse[]; /** * The server Id. */ id?: string; /** * The IP address of the server. */ ipAddress?: string; /** * The last heartbeat received from the server. */ lastHeartbeat?: string; /** * MARS agent expiry date. */ marsAgentExpiryDate?: string; /** * MARS agent version. */ marsAgentVersion?: string; /** * Mars agent version details. */ marsAgentVersionDetails?: outputs.recoveryservices.VersionDetailsResponse; /** * The server name. */ name?: string; /** * The OS type of the server. */ osType?: string; /** * OS Version of the master target. */ osVersion?: string; /** * The retention volumes of Master target Server. */ retentionVolumes?: outputs.recoveryservices.RetentionVolumeResponse[]; /** * Validation errors. */ validationErrors?: outputs.recoveryservices.HealthErrorResponse[]; /** * Version status. */ versionStatus?: string; } /** * Migration item properties. */ interface MigrationItemPropertiesResponse { /** * The allowed operations on the migration item based on the current migration state of the item. */ allowedOperations: string[]; /** * The critical past job details. */ criticalJobHistory: outputs.recoveryservices.CriticalJobHistoryDetailsResponse[]; /** * The current job details. */ currentJob: outputs.recoveryservices.CurrentJobDetailsResponse; /** * The correlation Id for events associated with this migration item. */ eventCorrelationId: string; /** * The consolidated health. */ health: string; /** * The list of health errors. */ healthErrors: outputs.recoveryservices.HealthErrorResponse[]; /** * The status of the last migration. */ lastMigrationStatus: string; /** * The last migration time. */ lastMigrationTime: string; /** * The status of the last test migration. */ lastTestMigrationStatus: string; /** * The last test migration time. */ lastTestMigrationTime: string; /** * The on-premise virtual machine name. */ machineName: string; /** * The migration status. */ migrationState: string; /** * The migration state description. */ migrationStateDescription: string; /** * The name of policy governing this item. */ policyFriendlyName: string; /** * The ARM Id of policy governing this item. */ policyId: string; /** * The migration provider custom settings. */ providerSpecificDetails?: outputs.recoveryservices.VMwareCbtMigrationDetailsResponse; /** * The recovery services provider ARM Id. */ recoveryServicesProviderId: string; /** * The replication status. */ replicationStatus: string; /** * The test migrate state. */ testMigrateState: string; /** * The test migrate state description. */ testMigrateStateDescription: string; } /** * The Mobility Service update details. */ interface MobilityServiceUpdateResponse { /** * The OS type. */ osType?: string; /** * The reboot status of the update - whether it is required or not. */ rebootStatus?: string; /** * The version of the latest update. */ version?: string; } /** * Monitoring Settings of the vault */ interface MonitoringSettingsResponse { /** * Settings for Azure Monitor based alerts */ azureMonitorAlertSettings?: outputs.recoveryservices.AzureMonitorAlertSettingsResponse; /** * Settings for classic alerts */ classicAlertSettings?: outputs.recoveryservices.ClassicAlertSettingsResponse; } /** * Monthly retention schedule. */ interface MonthlyRetentionScheduleResponse { /** * Retention duration of retention Policy. */ retentionDuration?: outputs.recoveryservices.RetentionDurationResponse; /** * Daily retention format for monthly retention policy. */ retentionScheduleDaily?: outputs.recoveryservices.DailyRetentionFormatResponse; /** * Retention schedule format type for monthly retention policy. */ retentionScheduleFormatType?: string; /** * Weekly retention format for monthly retention policy. */ retentionScheduleWeekly?: outputs.recoveryservices.WeeklyRetentionFormatResponse; /** * Retention times of retention policy. */ retentionTimes?: string[]; } /** * Network Mapping Properties. */ interface NetworkMappingPropertiesResponse { /** * The fabric specific settings. */ fabricSpecificSettings?: outputs.recoveryservices.AzureToAzureNetworkMappingSettingsResponse | outputs.recoveryservices.VmmToAzureNetworkMappingSettingsResponse | outputs.recoveryservices.VmmToVmmNetworkMappingSettingsResponse; /** * The primary fabric friendly name. */ primaryFabricFriendlyName?: string; /** * The primary network friendly name. */ primaryNetworkFriendlyName?: string; /** * The primary network id for network mapping. */ primaryNetworkId?: string; /** * The recovery fabric ARM id. */ recoveryFabricArmId?: string; /** * The recovery fabric friendly name. */ recoveryFabricFriendlyName?: string; /** * The recovery network friendly name. */ recoveryNetworkFriendlyName?: string; /** * The recovery network id for network mapping. */ recoveryNetworkId?: string; /** * The pairing state for network mapping. */ state?: string; } /** * Disk Details. */ interface OSDetailsResponse { /** * The OS Major Version. */ oSMajorVersion?: string; /** * The OS Minor Version. */ oSMinorVersion?: string; /** * The OS Version. */ oSVersion?: string; /** * The OSEdition. */ osEdition?: string; /** * VM Disk details. */ osType?: string; /** * Product type. */ productType?: string; /** * The OS name selected by user. */ userSelectedOSName?: string; } /** * Details of the OS Disk. */ interface OSDiskDetailsResponse { /** * The type of the OS on the VM. */ osType?: string; /** * The id of the disk containing the OS. */ osVhdId?: string; /** * The OS disk VHD name. */ vhdName?: string; } /** * Supported OS upgrade versions. */ interface OSUpgradeSupportedVersionsResponse { /** * The source OS version name. */ supportedSourceOsVersion: string; /** * The target OS version names. */ supportedTargetOsVersions: string[]; } /** * Protection profile custom data details. */ interface PolicyPropertiesResponse { /** * The FriendlyName. */ friendlyName?: string; /** * The ReplicationChannelSetting. */ providerSpecificDetails?: outputs.recoveryservices.A2APolicyDetailsResponse | outputs.recoveryservices.HyperVReplicaAzurePolicyDetailsResponse | outputs.recoveryservices.HyperVReplicaBasePolicyDetailsResponse | outputs.recoveryservices.HyperVReplicaBluePolicyDetailsResponse | outputs.recoveryservices.HyperVReplicaPolicyDetailsResponse | outputs.recoveryservices.InMageAzureV2PolicyDetailsResponse | outputs.recoveryservices.InMageBasePolicyDetailsResponse | outputs.recoveryservices.InMagePolicyDetailsResponse | outputs.recoveryservices.InMageRcmFailbackPolicyDetailsResponse | outputs.recoveryservices.InMageRcmPolicyDetailsResponse | outputs.recoveryservices.VmwareCbtPolicyDetailsResponse; } /** * Private Endpoint Connection Response Properties */ interface PrivateEndpointConnectionResponse { /** * Group Ids for the Private Endpoint */ groupIds?: string[]; /** * Gets or sets private endpoint associated with the private endpoint connection */ privateEndpoint?: outputs.recoveryservices.PrivateEndpointResponse; /** * Gets or sets private link service connection state */ privateLinkServiceConnectionState?: outputs.recoveryservices.PrivateLinkServiceConnectionStateResponse; /** * Gets or sets provisioning state of the private endpoint connection */ provisioningState?: string; } /** * Information to be stored in Vault properties as an element of privateEndpointConnections List. */ interface PrivateEndpointConnectionVaultPropertiesResponse { /** * Format of id subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.[Service]/{resource}/{resourceName}/privateEndpointConnections/{connectionName}. */ id: string; /** * The location of the private Endpoint connection */ location: string; /** * The name of the private Endpoint Connection */ name: string; /** * Private Endpoint Connection Response Properties. */ properties: outputs.recoveryservices.VaultPrivateEndpointConnectionResponse; /** * The type, which will be of the format, Microsoft.RecoveryServices/vaults/privateEndpointConnections */ type: string; } /** * The Private Endpoint network resource that is linked to the Private Endpoint connection */ interface PrivateEndpointResponse { /** * Gets or sets id */ id?: string; } /** * The Private Endpoint network resource that is linked to the Private Endpoint connection. */ interface PrivateEndpointVaultResponse { /** * Gets or sets id. */ id: string; } /** * Private Link Service Connection State */ interface PrivateLinkServiceConnectionStateResponse { /** * Gets or sets actions required */ actionsRequired?: string; /** * Gets or sets description */ description?: string; /** * Gets or sets the status */ status?: string; } /** * Process server details. */ interface ProcessServerDetailsResponse { /** * The available memory. */ availableMemoryInBytes: number; /** * The available disk space. */ availableSpaceInBytes: number; /** * The process server Bios Id. */ biosId: string; /** * The disk usage status. */ diskUsageStatus: string; /** * The fabric object Id. */ fabricObjectId: string; /** * The process server Fqdn. */ fqdn: string; /** * The free disk space percentage. */ freeSpacePercentage: number; /** * The health of the process server. */ health: string; /** * The health errors. */ healthErrors: outputs.recoveryservices.HealthErrorResponse[]; /** * The historic health of the process server based on the health in last 24 hours. */ historicHealth: string; /** * The process server Id. */ id: string; /** * The list of IP addresses for communicating with the RCM component. */ ipAddresses: string[]; /** * The last heartbeat received from the process server. */ lastHeartbeatUtc: string; /** * The memory usage percentage. */ memoryUsagePercentage: number; /** * The memory usage status. */ memoryUsageStatus: string; /** * The process server name. */ name: string; /** * The processor usage percentage. */ processorUsagePercentage: number; /** * The processor usage status. */ processorUsageStatus: string; /** * The protected item count. */ protectedItemCount: number; /** * The system load. */ systemLoad: number; /** * The system load status. */ systemLoadStatus: string; /** * The throughput in bytes. */ throughputInBytes: number; /** * The throughput status. */ throughputStatus: string; /** * The uploading pending data in bytes. */ throughputUploadPendingDataInBytes: number; /** * The total memory. */ totalMemoryInBytes: number; /** * The total disk space. */ totalSpaceInBytes: number; /** * The used memory. */ usedMemoryInBytes: number; /** * The used disk space. */ usedSpaceInBytes: number; /** * The version. */ version: string; } /** * Details of the Process Server. */ interface ProcessServerResponse { /** * Agent expiry date. */ agentExpiryDate?: string; /** * The version of the scout component on the server. */ agentVersion?: string; /** * The agent version details. */ agentVersionDetails?: outputs.recoveryservices.VersionDetailsResponse; /** * The available memory. */ availableMemoryInBytes?: number; /** * The available space. */ availableSpaceInBytes?: number; /** * The percentage of the CPU load. */ cpuLoad?: string; /** * The CPU load status. */ cpuLoadStatus?: string; /** * The Process Server's friendly name. */ friendlyName?: string; /** * The health of Process Server. */ health: string; /** * Health errors. */ healthErrors?: outputs.recoveryservices.HealthErrorResponse[]; /** * The agent generated Id. */ hostId?: string; /** * The Process Server Id. */ id?: string; /** * The IP address of the server. */ ipAddress?: string; /** * The last heartbeat received from the server. */ lastHeartbeat?: string; /** * The servers configured with this PS. */ machineCount?: string; /** * The MARS communication status. */ marsCommunicationStatus: string; /** * The MARS registration status. */ marsRegistrationStatus: string; /** * The memory usage status. */ memoryUsageStatus?: string; /** * The list of the mobility service updates available on the Process Server. */ mobilityServiceUpdates?: outputs.recoveryservices.MobilityServiceUpdateResponse[]; /** * The OS type of the server. */ osType?: string; /** * OS Version of the process server. Note: This will get populated if user has CS version greater than 9.12.0.0. */ osVersion?: string; /** * The PS service status. */ psServiceStatus?: string; /** * The process server stats refresh time. */ psStatsRefreshTime: string; /** * The number of replication pairs configured in this PS. */ replicationPairCount?: string; /** * The space usage status. */ spaceUsageStatus?: string; /** * The PS SSL cert expiry date. */ sslCertExpiryDate?: string; /** * CS SSL cert expiry date. */ sslCertExpiryRemainingDays?: number; /** * The percentage of the system load. */ systemLoad?: string; /** * The system load status. */ systemLoadStatus?: string; /** * The throughput in bytes. */ throughputInBytes: number; /** * The throughput in MBps. */ throughputInMBps: number; /** * The throughput status. */ throughputStatus: string; /** * The uploading pending data in bytes. */ throughputUploadPendingDataInBytes: number; /** * The total memory. */ totalMemoryInBytes?: number; /** * The total space. */ totalSpaceInBytes?: number; /** * Version status. */ versionStatus?: string; } /** * Protection container mapping properties. */ interface ProtectionContainerMappingPropertiesResponse { /** * Health of pairing. */ health?: string; /** * Health error. */ healthErrorDetails?: outputs.recoveryservices.HealthErrorResponse[]; /** * Friendly name of replication policy. */ policyFriendlyName?: string; /** * Policy ARM Id. */ policyId?: string; /** * Provider specific provider details. */ providerSpecificDetails?: outputs.recoveryservices.A2AProtectionContainerMappingDetailsResponse | outputs.recoveryservices.InMageRcmProtectionContainerMappingDetailsResponse | outputs.recoveryservices.VMwareCbtProtectionContainerMappingDetailsResponse; /** * Friendly name of source fabric. */ sourceFabricFriendlyName?: string; /** * Friendly name of source protection container. */ sourceProtectionContainerFriendlyName?: string; /** * Association Status. */ state?: string; /** * Friendly name of target fabric. */ targetFabricFriendlyName?: string; /** * Friendly name of paired container. */ targetProtectionContainerFriendlyName?: string; /** * Paired protection container ARM ID. */ targetProtectionContainerId?: string; } /** * Push installer details. */ interface PushInstallerDetailsResponse { /** * The push installer Bios Id. */ biosId: string; /** * The fabric object Id. */ fabricObjectId: string; /** * The push installer Fqdn. */ fqdn: string; /** * The health of the push installer. */ health: string; /** * The health errors. */ healthErrors: outputs.recoveryservices.HealthErrorResponse[]; /** * The push installer Id. */ id: string; /** * The last heartbeat received from the push installer. */ lastHeartbeatUtc: string; /** * The push installer name. */ name: string; /** * The version. */ version: string; } /** * RCM proxy details. */ interface RcmProxyDetailsResponse { /** * The RCM proxy Bios Id. */ biosId: string; /** * The client authentication type. */ clientAuthenticationType: string; /** * The fabric object Id. */ fabricObjectId: string; /** * The RCM proxy Fqdn. */ fqdn: string; /** * The health of the RCM proxy. */ health: string; /** * The health errors. */ healthErrors: outputs.recoveryservices.HealthErrorResponse[]; /** * The RCM proxy Id. */ id: string; /** * The last heartbeat received from the RCM proxy. */ lastHeartbeatUtc: string; /** * The RCM proxy name. */ name: string; /** * The version. */ version: string; } /** * Recovery plan A2A specific details. */ interface RecoveryPlanA2ADetailsResponse { /** * Gets the Instance type. * Expected value is 'A2A'. */ instanceType: "A2A"; /** * The primary extended location. */ primaryExtendedLocation?: outputs.recoveryservices.ExtendedLocationResponse; /** * The primary zone. */ primaryZone?: string; /** * The recovery extended location. */ recoveryExtendedLocation?: outputs.recoveryservices.ExtendedLocationResponse; /** * The recovery zone. */ recoveryZone?: string; } /** * Recovery plan action details. */ interface RecoveryPlanActionResponse { /** * The action name. */ actionName: string; /** * The custom details. */ customDetails: outputs.recoveryservices.RecoveryPlanAutomationRunbookActionDetailsResponse | outputs.recoveryservices.RecoveryPlanManualActionDetailsResponse | outputs.recoveryservices.RecoveryPlanScriptActionDetailsResponse; /** * The list of failover directions. */ failoverDirections: string[]; /** * The list of failover types. */ failoverTypes: string[]; } /** * Recovery plan Automation runbook action details. */ interface RecoveryPlanAutomationRunbookActionDetailsResponse { /** * The fabric location. */ fabricLocation: string; /** * Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). * Expected value is 'AutomationRunbookActionDetails'. */ instanceType: "AutomationRunbookActionDetails"; /** * The runbook ARM Id. */ runbookId?: string; /** * The runbook timeout. */ timeout?: string; } /** * Recovery plan group details. */ interface RecoveryPlanGroupResponse { /** * The end group actions. */ endGroupActions?: outputs.recoveryservices.RecoveryPlanActionResponse[]; /** * The group type. */ groupType: string; /** * The list of protected items. */ replicationProtectedItems?: outputs.recoveryservices.RecoveryPlanProtectedItemResponse[]; /** * The start group actions. */ startGroupActions?: outputs.recoveryservices.RecoveryPlanActionResponse[]; } /** * Recovery plan manual action details. */ interface RecoveryPlanManualActionDetailsResponse { /** * The manual action description. */ description?: string; /** * Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). * Expected value is 'ManualActionDetails'. */ instanceType: "ManualActionDetails"; } /** * Recovery plan properties. */ interface RecoveryPlanPropertiesResponse { /** * The list of allowed operations. */ allowedOperations?: string[]; /** * The current scenario details. */ currentScenario?: outputs.recoveryservices.CurrentScenarioDetailsResponse; /** * The recovery plan status. */ currentScenarioStatus?: string; /** * The recovery plan status description. */ currentScenarioStatusDescription?: string; /** * The failover deployment model. */ failoverDeploymentModel?: string; /** * The friendly name. */ friendlyName?: string; /** * The recovery plan groups. */ groups?: outputs.recoveryservices.RecoveryPlanGroupResponse[]; /** * The start time of the last planned failover. */ lastPlannedFailoverTime?: string; /** * The start time of the last test failover. */ lastTestFailoverTime?: string; /** * The start time of the last unplanned failover. */ lastUnplannedFailoverTime?: string; /** * The primary fabric friendly name. */ primaryFabricFriendlyName?: string; /** * The primary fabric Id. */ primaryFabricId?: string; /** * The provider id and provider specific details. */ providerSpecificDetails?: outputs.recoveryservices.RecoveryPlanA2ADetailsResponse[]; /** * The recovery fabric friendly name. */ recoveryFabricFriendlyName?: string; /** * The recovery fabric Id. */ recoveryFabricId?: string; /** * The list of replication providers. */ replicationProviders?: string[]; } /** * Recovery plan protected item. */ interface RecoveryPlanProtectedItemResponse { /** * The ARM Id of the recovery plan protected item. */ id?: string; /** * The virtual machine Id. */ virtualMachineId?: string; } /** * Recovery plan script action details. */ interface RecoveryPlanScriptActionDetailsResponse { /** * The fabric location. */ fabricLocation: string; /** * Gets the type of action details (see RecoveryPlanActionDetailsTypes enum for possible values). * Expected value is 'ScriptActionDetails'. */ instanceType: "ScriptActionDetails"; /** * The script path. */ path: string; /** * The script timeout. */ timeout?: string; } /** * Recovery services provider properties. */ interface RecoveryServicesProviderPropertiesResponse { /** * The scenarios allowed on this provider. */ allowedScenarios?: string[]; /** * The authentication identity details. */ authenticationIdentityDetails?: outputs.recoveryservices.IdentityProviderDetailsResponse; /** * The Bios Id. */ biosId?: string; /** * A value indicating whether DRA is responsive. */ connectionStatus?: string; /** * The data plane authentication identity details. */ dataPlaneAuthenticationIdentityDetails?: outputs.recoveryservices.IdentityProviderDetailsResponse; /** * The DRA Id. */ draIdentifier?: string; /** * The fabric friendly name. */ fabricFriendlyName?: string; /** * Type of the site. */ fabricType?: string; /** * Friendly name of the DRA. */ friendlyName?: string; /** * The recovery services provider health error details. */ healthErrorDetails?: outputs.recoveryservices.HealthErrorResponse[]; /** * Time when last heartbeat was sent by the DRA. */ lastHeartBeat?: string; /** * The machine Id. */ machineId?: string; /** * The machine name. */ machineName?: string; /** * Number of protected VMs currently managed by the DRA. */ protectedItemCount?: number; /** * The provider version. */ providerVersion?: string; /** * The provider version details. */ providerVersionDetails?: outputs.recoveryservices.VersionDetailsResponse; /** * Expiry date of the version. */ providerVersionExpiryDate?: string; /** * DRA version status. */ providerVersionState?: string; /** * The resource access identity details. */ resourceAccessIdentityDetails?: outputs.recoveryservices.IdentityProviderDetailsResponse; /** * The fabric provider. */ serverVersion?: string; } /** * Extended location of the resource. */ interface RegisteredClusterNodesResponse { /** * The BIOS ID. */ biosId?: string; /** * The cluster node name. */ clusterNodeFqdn?: string; /** * A value indicating whether this represents virtual entity hosting all the shared disks. */ isSharedDiskVirtualNode?: boolean; /** * The machine ID. */ machineId?: string; } /** * Replication agent details. */ interface ReplicationAgentDetailsResponse { /** * The replication agent Bios Id. */ biosId: string; /** * The fabric object Id. */ fabricObjectId: string; /** * The replication agent Fqdn. */ fqdn: string; /** * The health of the replication agent. */ health: string; /** * The health errors. */ healthErrors: outputs.recoveryservices.HealthErrorResponse[]; /** * The replication agent Id. */ id: string; /** * The last heartbeat received from the replication agent. */ lastHeartbeatUtc: string; /** * The replication agent name. */ name: string; /** * The version. */ version: string; } /** * Replication protected item custom data details. */ interface ReplicationProtectedItemPropertiesResponse { /** * The Current active location of the PE. */ activeLocation?: string; /** * The allowed operations on the Replication protected item. */ allowedOperations?: string[]; /** * The current scenario. */ currentScenario?: outputs.recoveryservices.CurrentScenarioDetailsResponse; /** * The correlation Id for events associated with this protected item. */ eventCorrelationId?: string; /** * The consolidated failover health for the VM. */ failoverHealth?: string; /** * The recovery point ARM Id to which the Vm was failed over. */ failoverRecoveryPointId?: string; /** * The name. */ friendlyName?: string; /** * List of health errors. */ healthErrors?: outputs.recoveryservices.HealthErrorResponse[]; /** * The Last successful failover time. */ lastSuccessfulFailoverTime?: string; /** * The Last successful test failover time. */ lastSuccessfulTestFailoverTime?: string; /** * The name of Policy governing this PE. */ policyFriendlyName?: string; /** * The ID of Policy governing this PE. */ policyId?: string; /** * The friendly name of the primary fabric. */ primaryFabricFriendlyName?: string; /** * The fabric provider of the primary fabric. */ primaryFabricProvider?: string; /** * The name of primary protection container friendly name. */ primaryProtectionContainerFriendlyName?: string; /** * The protected item ARM Id. */ protectableItemId?: string; /** * The type of protected item type. */ protectedItemType?: string; /** * The protection status. */ protectionState?: string; /** * The protection state description. */ protectionStateDescription?: string; /** * The Replication provider custom settings. */ providerSpecificDetails?: outputs.recoveryservices.A2ACrossClusterMigrationReplicationDetailsResponse | outputs.recoveryservices.A2AReplicationDetailsResponse | outputs.recoveryservices.HyperVReplicaAzureReplicationDetailsResponse | outputs.recoveryservices.HyperVReplicaBaseReplicationDetailsResponse | outputs.recoveryservices.HyperVReplicaBlueReplicationDetailsResponse | outputs.recoveryservices.HyperVReplicaReplicationDetailsResponse | outputs.recoveryservices.InMageAzureV2ReplicationDetailsResponse | outputs.recoveryservices.InMageRcmFailbackReplicationDetailsResponse | outputs.recoveryservices.InMageRcmReplicationDetailsResponse | outputs.recoveryservices.InMageReplicationDetailsResponse; /** * The recovery container Id. */ recoveryContainerId?: string; /** * The friendly name of recovery fabric. */ recoveryFabricFriendlyName?: string; /** * The Arm Id of recovery fabric. */ recoveryFabricId?: string; /** * The name of recovery container friendly name. */ recoveryProtectionContainerFriendlyName?: string; /** * The recovery provider ARM Id. */ recoveryServicesProviderId?: string; /** * The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration. */ replicationHealth?: string; /** * The switch provider state. */ switchProviderState?: string; /** * The switch provider state description. */ switchProviderStateDescription?: string; /** * The Test failover state. */ testFailoverState?: string; /** * The Test failover state description. */ testFailoverStateDescription?: string; } /** * Replication protection cluster custom data details. */ interface ReplicationProtectionClusterPropertiesResponse { /** * The Current active location of the Protection cluster. */ activeLocation?: string; /** * The Agent cluster Id. */ agentClusterId?: string; /** * The allowed operations on the Replication protection cluster. */ allowedOperations?: string[]; /** * A value indicating whether all nodes of the cluster are registered or not. */ areAllClusterNodesRegistered?: boolean; /** * The cluster FQDN. */ clusterFqdn?: string; /** * The List of cluster Node FQDNs. */ clusterNodeFqdns?: string[]; /** * The List of Protected Item Id's. */ clusterProtectedItemIds?: string[]; /** * The registered node details. */ clusterRegisteredNodes?: outputs.recoveryservices.RegisteredClusterNodesResponse[]; /** * The current scenario. */ currentScenario?: outputs.recoveryservices.CurrentScenarioDetailsResponse; /** * List of health errors. */ healthErrors?: outputs.recoveryservices.HealthErrorResponse[]; /** * The last successful failover time. */ lastSuccessfulFailoverTime?: string; /** * The last successful test failover time. */ lastSuccessfulTestFailoverTime?: string; /** * The name of Policy governing this PE. */ policyFriendlyName?: string; /** * The Policy Id. */ policyId?: string; /** * The friendly name of the primary fabric. */ primaryFabricFriendlyName?: string; /** * The fabric provider of the primary fabric. */ primaryFabricProvider?: string; /** * The name of primary protection container friendly name. */ primaryProtectionContainerFriendlyName?: string; /** * The type of protection cluster type. */ protectionClusterType?: string; /** * The protection status. */ protectionState?: string; /** * The protection state description. */ protectionStateDescription?: string; /** * The Replication cluster provider custom settings. */ providerSpecificDetails?: outputs.recoveryservices.A2AReplicationProtectionClusterDetailsResponse; /** * The provisioning state of the cluster. */ provisioningState: string; /** * The recovery container Id. */ recoveryContainerId?: string; /** * The friendly name of recovery fabric. */ recoveryFabricFriendlyName?: string; /** * The Arm Id of recovery fabric. */ recoveryFabricId?: string; /** * The name of recovery container friendly name. */ recoveryProtectionContainerFriendlyName?: string; /** * The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration. */ replicationHealth?: string; /** * The shared disk properties. */ sharedDiskProperties?: outputs.recoveryservices.SharedDiskReplicationItemPropertiesResponse; /** * The Test failover state. */ testFailoverState?: string; /** * The Test failover state description. */ testFailoverStateDescription?: string; } /** * Reprotect agent details. */ interface ReprotectAgentDetailsResponse { /** * The list of accessible datastores fetched from discovery. */ accessibleDatastores: string[]; /** * The reprotect agent Bios Id. */ biosId: string; /** * The fabric object Id. */ fabricObjectId: string; /** * The reprotect agent Fqdn. */ fqdn: string; /** * The health of the reprotect agent. */ health: string; /** * The health errors. */ healthErrors: outputs.recoveryservices.HealthErrorResponse[]; /** * The reprotect agent Id. */ id: string; /** * The last time when SDS information discovered in SRS. */ lastDiscoveryInUtc: string; /** * The last heartbeat received from the reprotect agent. */ lastHeartbeatUtc: string; /** * The reprotect agent name. */ name: string; /** * The protected item count. */ protectedItemCount: number; /** * The Vcenter Id. */ vcenterId: string; /** * The version. */ version: string; } interface ResourceGuardOperationDetailResponse { defaultResourceRequest?: string; vaultCriticalOperation?: string; } interface ResourceGuardProxyBaseResponse { description?: string; lastUpdatedTime?: string; resourceGuardOperationDetails?: outputs.recoveryservices.ResourceGuardOperationDetailResponse[]; resourceGuardResourceId: string; } /** * Health Details for backup items. */ interface ResourceHealthDetailsResponse { /** * Health Code */ code: number; /** * Health Message */ message: string; /** * Health Recommended Actions */ recommendations: string[]; /** * Health Title */ title: string; } /** * Restore Settings of the vault */ interface RestoreSettingsResponse { /** * Settings for CrossSubscriptionRestore */ crossSubscriptionRestoreSettings?: outputs.recoveryservices.CrossSubscriptionRestoreSettingsResponse; } /** * Retention duration. */ interface RetentionDurationResponse { /** * Count of duration types. Retention duration is obtained by the counting the duration type Count times. * For example, when Count = 3 and DurationType = Weeks, retention duration will be three weeks. */ count?: number; /** * Retention duration type of retention policy. */ durationType?: string; } /** * The retention details of the MT. */ interface RetentionVolumeResponse { /** * The volume capacity. */ capacityInBytes?: number; /** * The free space available in this volume. */ freeSpaceInBytes?: number; /** * The threshold percentage. */ thresholdPercentage?: number; /** * The volume name. */ volumeName?: string; } /** * CS Accounts Details. */ interface RunAsAccountResponse { /** * The CS RunAs account Id. */ accountId?: string; /** * The CS RunAs account name. */ accountName?: string; } /** * Security profile input. */ interface SecurityProfilePropertiesResponse { /** * A value indicating whether confidential compute encryption to be enabled. */ targetVmConfidentialEncryption?: string; /** * A value indicating whether integrity monitoring to be enabled. */ targetVmMonitoring?: string; /** * A value indicating whether secure boot to be enabled. */ targetVmSecureBoot?: string; /** * The target VM security type. */ targetVmSecurityType?: string; /** * A value indicating whether trusted platform module to be enabled. */ targetVmTpm?: string; } /** * Security Settings of the vault */ interface SecuritySettingsResponse { /** * Immutability Settings of a vault */ immutabilitySettings?: outputs.recoveryservices.ImmutabilitySettingsResponse; /** * MUA Settings of a vault */ multiUserAuthorization: string; /** * Soft delete Settings of a vault */ softDeleteSettings?: outputs.recoveryservices.SoftDeleteSettingsResponse; } /** * Common settings field for backup management */ interface SettingsResponse { /** * Workload compression flag. This has been added so that 'isSqlCompression' * will be deprecated once clients upgrade to consider this flag. */ isCompression?: boolean; /** * SQL compression flag */ issqlcompression?: boolean; /** * TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time". */ timeZone?: string; } /** * Shared Disk Replication item custom data details. */ interface SharedDiskReplicationItemPropertiesResponse { /** * The Current active location of the PE. */ activeLocation?: string; /** * The allowed operations on the Replication protected item. */ allowedOperations?: string[]; /** * The current scenario. */ currentScenario?: outputs.recoveryservices.CurrentScenarioDetailsResponse; /** * List of health errors. */ healthErrors?: outputs.recoveryservices.HealthErrorResponse[]; /** * The protection state of shared disk. */ protectionState?: string; /** * The consolidated protection health for the VM taking any issues with SRS as well as all the replication units associated with the VM's replication group into account. This is a string representation of the ProtectionHealth enumeration. */ replicationHealth?: string; /** * The Replication provider custom settings. */ sharedDiskProviderSpecificDetails?: outputs.recoveryservices.A2ASharedDiskReplicationDetailsResponse; /** * The tfo state of shared disk. */ testFailoverState?: string; } /** * Simple policy retention. */ interface SimpleRetentionPolicyResponse { /** * Retention duration of the protection policy. */ retentionDuration?: outputs.recoveryservices.RetentionDurationResponse; /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'SimpleRetentionPolicy'. */ retentionPolicyType: "SimpleRetentionPolicy"; } /** * Simple policy schedule. */ interface SimpleSchedulePolicyResponse { /** * Hourly Schedule of this Policy */ hourlySchedule?: outputs.recoveryservices.HourlyScheduleResponse; /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'SimpleSchedulePolicy'. */ schedulePolicyType: "SimpleSchedulePolicy"; /** * List of days of week this schedule has to be run. */ scheduleRunDays?: string[]; /** * Frequency of the schedule operation of this policy. */ scheduleRunFrequency?: string; /** * List of times of day this schedule has to be run. */ scheduleRunTimes?: string[]; /** * At every number weeks this schedule has to be run. */ scheduleWeeklyFrequency?: number; } /** * The V2 policy schedule for IaaS that supports hourly backups. */ interface SimpleSchedulePolicyV2Response { /** * Daily schedule of this policy */ dailySchedule?: outputs.recoveryservices.DailyScheduleResponse; /** * hourly schedule of this policy */ hourlySchedule?: outputs.recoveryservices.HourlyScheduleResponse; /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'SimpleSchedulePolicyV2'. */ schedulePolicyType: "SimpleSchedulePolicyV2"; /** * Frequency of the schedule operation of this policy. */ scheduleRunFrequency?: string; /** * Weekly schedule of this policy */ weeklySchedule?: outputs.recoveryservices.WeeklyScheduleResponse; } /** * Identifies the unique system identifier for each Azure resource. */ interface SkuResponse { /** * The sku capacity */ capacity?: string; /** * The sku family */ family?: string; /** * Name of SKU is RS0 (Recovery Services 0th version) and the tier is standard tier. They do not have affect on backend storage redundancy or any other vault settings. To manage storage redundancy, use the backupstorageconfig */ name: string; /** * The sku size */ size?: string; /** * The Sku tier. */ tier?: string; } /** * Snapshot Backup related fields for WorkloadType SaPHanaSystem */ interface SnapshotBackupAdditionalDetailsResponse { instantRPDetails?: string; instantRpRetentionRangeInDays?: number; /** * User assigned managed identity details */ userAssignedManagedIdentityDetails?: outputs.recoveryservices.UserAssignedManagedIdentityDetailsResponse; } /** * Soft delete Settings of vault */ interface SoftDeleteSettingsResponse { enhancedSecurityState?: string; /** * Soft delete retention period in days */ softDeleteRetentionPeriodInDays?: number; softDeleteState?: string; } /** * Storage mapping properties. */ interface StorageClassificationMappingPropertiesResponse { /** * Target storage object Id. */ targetStorageClassificationId?: string; } /** * Sub-protection policy which includes schedule and retention */ interface SubProtectionPolicyResponse { /** * Type of backup policy type */ policyType?: string; /** * Retention policy with the details on backup copy retention ranges. */ retentionPolicy?: outputs.recoveryservices.LongTermRetentionPolicyResponse | outputs.recoveryservices.SimpleRetentionPolicyResponse; /** * Backup schedule specified as part of backup policy. */ schedulePolicy?: outputs.recoveryservices.LogSchedulePolicyResponse | outputs.recoveryservices.LongTermSchedulePolicyResponse | outputs.recoveryservices.SimpleSchedulePolicyResponse | outputs.recoveryservices.SimpleSchedulePolicyV2Response; /** * Snapshot Backup related fields for WorkloadType SaPHanaSystem */ snapshotBackupAdditionalDetails?: outputs.recoveryservices.SnapshotBackupAdditionalDetailsResponse; /** * Tiering policy to automatically move RPs to another tier. * Key is Target Tier, defined in RecoveryPointTierType enum. * Tiering policy specifies the criteria to move RP to the target tier. */ tieringPolicy?: { [key: string]: outputs.recoveryservices.TieringPolicyResponse; }; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The type of identity that last modified the resource. */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Tiering Policy for a target tier. * If the policy is not specified for a given target tier, service retains the existing configured tiering policy for that tier */ interface TieringPolicyResponse { /** * Number of days/weeks/months/years to retain backups in current tier before tiering. * Used only if TieringMode is set to TierAfter */ duration?: number; /** * Retention duration type: days/weeks/months/years * Used only if TieringMode is set to TierAfter */ durationType?: string; /** * Tiering Mode to control automatic tiering of recovery points. Supported values are: * 1. TierRecommended: Tier all recovery points recommended to be tiered * 2. TierAfter: Tier all recovery points after a fixed period, as specified in duration + durationType below. * 3. DoNotTier: Do not tier any recovery points */ tieringMode?: string; } /** * Details for upgrading vault. */ interface UpgradeDetailsResponse { /** * UTC time at which the upgrade operation has ended. */ endTimeUtc: string; /** * UTC time at which the upgrade operation status was last updated. */ lastUpdatedTimeUtc: string; /** * Message to the user containing information about the upgrade operation. */ message: string; /** * ID of the vault upgrade operation. */ operationId: string; /** * Resource ID of the vault before the upgrade. */ previousResourceId: string; /** * UTC time at which the upgrade operation has started. */ startTimeUtc: string; /** * Status of the vault upgrade operation. */ status: string; /** * The way the vault upgrade was triggered. */ triggerType: string; /** * Resource ID of the upgraded vault. */ upgradedResourceId: string; } /** * User assigned managed identity properties */ interface UserAssignedIdentityPropertiesResponse { /** * The client ID of the assigned identity. */ clientId?: string; /** * The principal ID of the assigned identity. */ principalId?: string; } /** * User assigned managed identity details */ interface UserAssignedManagedIdentityDetailsResponse { /** * The ARM id of the assigned identity. */ identityArmId?: string; /** * The name of the assigned identity. */ identityName?: string; /** * User assigned managed identity properties */ userAssignedIdentityProperties?: outputs.recoveryservices.UserAssignedIdentityPropertiesResponse; } /** * Resource tag input. */ interface UserCreatedResourceTagResponse { /** * The tag name. Please read for more information: https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/tag-resources#limitations */ tagName?: string; /** * The tag value. Please read her for more information: https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/tag-resources#limitations */ tagValue?: string; } /** * A resource identity that is managed by the user of the service. */ interface UserIdentityResponse { /** * The client ID of the user-assigned identity. */ clientId: string; /** * The principal ID of the user-assigned identity. */ principalId: string; } /** * vCenter properties. */ interface VCenterPropertiesResponse { /** * The VCenter discovery status. */ discoveryStatus?: string; /** * The ARM resource name of the fabric containing this VCenter. */ fabricArmResourceName?: string; /** * Friendly name of the vCenter. */ friendlyName?: string; /** * The health errors for this VCenter. */ healthErrors?: outputs.recoveryservices.HealthErrorResponse[]; /** * The infrastructure Id of vCenter. */ infrastructureId?: string; /** * VCenter internal ID. */ internalId?: string; /** * The IP address of the vCenter. */ ipAddress?: string; /** * The time when the last heartbeat was received by vCenter. */ lastHeartbeat?: string; /** * The port number for discovery. */ port?: string; /** * The process server Id. */ processServerId?: string; /** * The account Id which has privileges to discover the vCenter. */ runAsAccountId?: string; } /** * Hyper V VM network details. */ interface VMNicDetailsResponse { /** * A value indicating whether the NIC has accelerated networking enabled. */ enableAcceleratedNetworkingOnRecovery?: boolean; /** * Whether the TFO NIC has accelerated networking enabled. */ enableAcceleratedNetworkingOnTfo?: boolean; /** * The IP configurations of the NIC. */ ipConfigs?: outputs.recoveryservices.IPConfigDetailsResponse[]; /** * The nic Id. */ nicId?: string; /** * The id of the NSG associated with the NIC. */ recoveryNetworkSecurityGroupId?: string; /** * The name of the NIC to be used when creating target NICs. */ recoveryNicName?: string; /** * The resource group of the NIC to be used when creating target NICs. */ recoveryNicResourceGroupName?: string; /** * Recovery VM network Id. */ recoveryVMNetworkId?: string; /** * The replica nic Id. */ replicaNicId?: string; /** * A value indicating whether an existing NIC is allowed to be reused during failover subject to availability. */ reuseExistingNic?: boolean; /** * Selection type for failover. */ selectionType?: string; /** * The source nic ARM Id. */ sourceNicArmId?: string; /** * Target NIC name. */ targetNicName?: string; /** * The NSG to be used by NIC during test failover. */ tfoNetworkSecurityGroupId?: string; /** * The name of the NIC to be used when creating target NICs in TFO. */ tfoRecoveryNicName?: string; /** * The resource group of the NIC to be used when creating target NICs in TFO. */ tfoRecoveryNicResourceGroupName?: string; /** * A value indicating whether an existing NIC is allowed to be reused during test failover subject to availability. */ tfoReuseExistingNic?: boolean; /** * The network to be used by NIC during test failover. */ tfoVMNetworkId?: string; /** * VM network name. */ vMNetworkName?: string; } /** * vmnicDetailsResponseProvideDefaults sets the appropriate defaults for VMNicDetailsResponse */ function vmnicDetailsResponseProvideDefaults(val: VMNicDetailsResponse): VMNicDetailsResponse; /** * VMwareCbt provider specific settings. */ interface VMwareCbtMigrationDetailsResponse { /** * A value indicating the appliance monitoring details. */ applianceMonitoringDetails: outputs.recoveryservices.ApplianceMonitoringDetailsResponse; /** * The confidential VM key vault Id for ADE installation. */ confidentialVmKeyVaultId?: string; /** * The data mover run as account Id. */ dataMoverRunAsAccountId: string; /** * The delta sync progress percentage. */ deltaSyncProgressPercentage: number; /** * The delta sync retry count. */ deltaSyncRetryCount: number; /** * The firmware type. */ firmwareType: string; /** * A value indicating the gateway operation details. */ gatewayOperationDetails: outputs.recoveryservices.GatewayOperationDetailsResponse; /** * The initial seeding progress percentage. */ initialSeedingProgressPercentage: number; /** * The initial seeding retry count. */ initialSeedingRetryCount: number; /** * Gets the instance type. * Expected value is 'VMwareCbt'. */ instanceType: "VMwareCbt"; /** * A value indicating whether checksum resync cycle is in progress. */ isCheckSumResyncCycle: string; /** * The last recovery point Id. */ lastRecoveryPointId: string; /** * The last recovery point received time. */ lastRecoveryPointReceived: string; /** * License Type of the VM to be used. */ licenseType?: string; /** * The license type for Linux VM's. */ linuxLicenseType?: string; /** * The migration progress percentage. */ migrationProgressPercentage: number; /** * The recovery point Id to which the VM was migrated. */ migrationRecoveryPointId: string; /** * A value indicating the SRS operation name. */ operationName: string; /** * The name of the OS on the VM. */ osName: string; /** * The type of the OS on the VM. */ osType: string; /** * A value indicating whether auto resync is to be done. */ performAutoResync?: string; /** * The list of protected disks. */ protectedDisks?: outputs.recoveryservices.VMwareCbtProtectedDiskDetailsResponse[]; /** * The resume progress percentage. */ resumeProgressPercentage: number; /** * The resume retry count. */ resumeRetryCount: number; /** * The resync progress percentage. */ resyncProgressPercentage: number; /** * A value indicating whether resync is required. */ resyncRequired: string; /** * The resync retry count. */ resyncRetryCount: number; /** * The resync state. */ resyncState: string; /** * The tags for the seed disks. */ seedDiskTags?: { [key: string]: string; }; /** * The snapshot run as account Id. */ snapshotRunAsAccountId: string; /** * The SQL Server license type. */ sqlServerLicenseType?: string; /** * The replication storage account ARM Id. This is applicable only for the blob based replication test hook. */ storageAccountId: string; /** * A value indicating the inplace OS Upgrade version. */ supportedOSVersions?: string[]; /** * The target availability set Id. */ targetAvailabilitySetId?: string; /** * The target availability zone. */ targetAvailabilityZone?: string; /** * The target boot diagnostics storage account ARM Id. */ targetBootDiagnosticsStorageAccountId?: string; /** * The tags for the target disks. */ targetDiskTags?: { [key: string]: string; }; /** * The target generation. */ targetGeneration: string; /** * The target location. */ targetLocation: string; /** * The target network Id. */ targetNetworkId?: string; /** * The tags for the target NICs. */ targetNicTags?: { [key: string]: string; }; /** * The target proximity placement group Id. */ targetProximityPlacementGroupId?: string; /** * The target resource group Id. */ targetResourceGroupId?: string; /** * Target VM name. */ targetVmName?: string; /** * The target VM security profile. */ targetVmSecurityProfile?: outputs.recoveryservices.VMwareCbtSecurityProfilePropertiesResponse; /** * The target VM size. */ targetVmSize?: string; /** * The target VM tags. */ targetVmTags?: { [key: string]: string; }; /** * The test network Id. */ testNetworkId?: string; /** * The network details. */ vmNics?: outputs.recoveryservices.VMwareCbtNicDetailsResponse[]; /** * The ARM Id of the VM discovered in VMware. */ vmwareMachineId: string; } /** * VMwareCbt NIC details. */ interface VMwareCbtNicDetailsResponse { /** * A value indicating whether this is the primary NIC. */ isPrimaryNic?: string; /** * A value indicating whether this NIC is selected for migration. */ isSelectedForMigration?: string; /** * The NIC Id. */ nicId: string; /** * The source IP address. */ sourceIPAddress: string; /** * The source IP address type. */ sourceIPAddressType: string; /** * Source network Id. */ sourceNetworkId: string; /** * The target IP address. */ targetIPAddress?: string; /** * The target IP address type. */ targetIPAddressType?: string; /** * Target NIC name. */ targetNicName?: string; /** * Target subnet name. */ targetSubnetName?: string; /** * The test IP address. */ testIPAddress?: string; /** * The test IP address type. */ testIPAddressType?: string; /** * Source network Id. */ testNetworkId?: string; /** * Test subnet name. */ testSubnetName?: string; } /** * VMwareCbt protected disk details. */ interface VMwareCbtProtectedDiskDetailsResponse { /** * The disk capacity in bytes. */ capacityInBytes: number; /** * The DiskEncryptionSet ARM Id. */ diskEncryptionSetId: string; /** * The disk id. */ diskId: string; /** * The disk name. */ diskName: string; /** * The disk path. */ diskPath: string; /** * The disk type. */ diskType?: string; /** * A value indicating the gateway operation details. */ gatewayOperationDetails: outputs.recoveryservices.GatewayOperationDetailsResponse; /** * A value indicating whether the disk is the OS disk. */ isOSDisk: string; /** * The log storage account ARM Id. */ logStorageAccountId: string; /** * The key vault secret name of the log storage account. */ logStorageAccountSasSecretName: string; /** * The logical sector size (in bytes), 512 by default. */ sectorSizeInBytes?: number; /** * The uri of the seed blob. */ seedBlobUri: string; /** * The ARM Id of the seed managed disk. */ seedManagedDiskId: string; /** * The uri of the target blob. */ targetBlobUri: string; /** * The name for the target managed disk. */ targetDiskName?: string; /** * The ARM Id of the target managed disk. */ targetManagedDiskId: string; } /** * VMwareCbt provider specific container mapping details. */ interface VMwareCbtProtectionContainerMappingDetailsResponse { /** * The SKUs to be excluded. */ excludedSkus?: string[]; /** * Gets the class type. Overridden in derived classes. * Expected value is 'VMwareCbt'. */ instanceType: "VMwareCbt"; /** * The target key vault ARM Id. */ keyVaultId: string; /** * The target key vault URI. */ keyVaultUri: string; /** * The role size to NIC count map. */ roleSizeToNicCountMap: { [key: string]: number; }; /** * The secret name of the service bus connection string. */ serviceBusConnectionStringSecretName: string; /** * The storage account ARM Id. */ storageAccountId: string; /** * The secret name of the storage account. */ storageAccountSasSecretName: string; /** * The target location. */ targetLocation: string; } /** * VMwareCbt security profile input. */ interface VMwareCbtSecurityProfilePropertiesResponse { /** * A value indicating whether confidential compute encryption to be enabled. */ isTargetVmConfidentialEncryptionEnabled?: string; /** * A value indicating whether integrity monitoring to be enabled. */ isTargetVmIntegrityMonitoringEnabled?: string; /** * A value indicating whether secure boot to be enabled. */ isTargetVmSecureBootEnabled?: string; /** * A value indicating whether trusted platform module to be enabled. */ isTargetVmTpmEnabled?: string; /** * The target VM security type. */ targetVmSecurityType?: string; } /** * Store the fabric details specific to the VMware fabric. */ interface VMwareDetailsResponse { /** * The number of source and target servers configured to talk to this CS. */ agentCount?: string; /** * Agent expiry date. */ agentExpiryDate?: string; /** * The agent Version. */ agentVersion?: string; /** * The agent version details. */ agentVersionDetails?: outputs.recoveryservices.VersionDetailsResponse; /** * The available memory. */ availableMemoryInBytes?: number; /** * The available space. */ availableSpaceInBytes?: number; /** * The percentage of the CPU load. */ cpuLoad?: string; /** * The CPU load status. */ cpuLoadStatus?: string; /** * The CS service status. */ csServiceStatus?: string; /** * The database server load. */ databaseServerLoad?: string; /** * The database server load status. */ databaseServerLoadStatus?: string; /** * The host name. */ hostName?: string; /** * Gets the class type. Overridden in derived classes. * Expected value is 'VMware'. */ instanceType: "VMware"; /** * The IP address. */ ipAddress?: string; /** * The last heartbeat received from CS server. */ lastHeartbeat?: string; /** * The list of Master Target servers associated with the fabric. */ masterTargetServers?: outputs.recoveryservices.MasterTargetServerResponse[]; /** * The memory usage status. */ memoryUsageStatus?: string; /** * The number of process servers. */ processServerCount?: string; /** * The list of Process Servers associated with the fabric. */ processServers?: outputs.recoveryservices.ProcessServerResponse[]; /** * The number of protected servers. */ protectedServers?: string; /** * PS template version. */ psTemplateVersion?: string; /** * The number of replication pairs configured in this CS. */ replicationPairCount?: string; /** * The list of run as accounts created on the server. */ runAsAccounts?: outputs.recoveryservices.RunAsAccountResponse[]; /** * The space usage status. */ spaceUsageStatus?: string; /** * CS SSL cert expiry date. */ sslCertExpiryDate?: string; /** * CS SSL cert expiry date. */ sslCertExpiryRemainingDays?: number; /** * The switch provider blocking error information. */ switchProviderBlockingErrorDetails?: outputs.recoveryservices.InMageFabricSwitchProviderBlockingErrorDetailsResponse[]; /** * The percentage of the system load. */ systemLoad?: string; /** * The system load status. */ systemLoadStatus?: string; /** * The total memory. */ totalMemoryInBytes?: number; /** * The total space. */ totalSpaceInBytes?: number; /** * Version status. */ versionStatus?: string; /** * The web load. */ webLoad?: string; /** * The web load status. */ webLoadStatus?: string; } /** * VMwareV2 fabric specific details. */ interface VMwareV2FabricSpecificDetailsResponse { /** * Gets the class type. Overridden in derived classes. * Expected value is 'VMwareV2'. */ instanceType: "VMwareV2"; /** * The Migration solution ARM Id. */ migrationSolutionId: string; /** * The ARM Id of the physical site. */ physicalSiteId: string; /** * The list of process servers. */ processServers: outputs.recoveryservices.ProcessServerDetailsResponse[]; /** * The service container Id. */ serviceContainerId: string; /** * The service endpoint. */ serviceEndpoint: string; /** * The service resource Id. */ serviceResourceId: string; /** * The ARM Id of the VMware site. */ vmwareSiteId: string; } /** * Private Endpoint Connection Response Properties. */ interface VaultPrivateEndpointConnectionResponse { /** * Group Ids for the Private Endpoint */ groupIds?: string[]; /** * The Private Endpoint network resource that is linked to the Private Endpoint connection. */ privateEndpoint: outputs.recoveryservices.PrivateEndpointVaultResponse; /** * Gets or sets private link service connection state. */ privateLinkServiceConnectionState: outputs.recoveryservices.VaultPrivateLinkServiceConnectionStateResponse; /** * Gets or sets provisioning state of the private endpoint connection. */ provisioningState: string; } /** * Gets or sets private link service connection state. */ interface VaultPrivateLinkServiceConnectionStateResponse { /** * Gets or sets actions required. */ actionsRequired: string; /** * Gets or sets description. */ description: string; /** * Gets or sets the status. */ status: string; } /** * Properties of the vault. */ interface VaultPropertiesResponse { /** * Backup storage version */ backupStorageVersion: string; /** * Security levels of Recovery Services Vault for business continuity and disaster recovery */ bcdrSecurityLevel: string; /** * Customer Managed Key details of the resource. */ encryption?: outputs.recoveryservices.VaultPropertiesResponseEncryption; /** * Monitoring Settings of the vault */ monitoringSettings?: outputs.recoveryservices.MonitoringSettingsResponse; /** * The details of the latest move operation performed on the Azure Resource */ moveDetails?: outputs.recoveryservices.VaultPropertiesResponseMoveDetails; /** * The State of the Resource after the move operation */ moveState: string; /** * List of private endpoint connection. */ privateEndpointConnections: outputs.recoveryservices.PrivateEndpointConnectionVaultPropertiesResponse[]; /** * Private endpoint state for backup. */ privateEndpointStateForBackup: string; /** * Private endpoint state for site recovery. */ privateEndpointStateForSiteRecovery: string; /** * Provisioning State. */ provisioningState: string; /** * property to enable or disable resource provider inbound network traffic from public clients */ publicNetworkAccess?: string; /** * The redundancy Settings of a Vault */ redundancySettings?: outputs.recoveryservices.VaultPropertiesResponseRedundancySettings; /** * ResourceGuardOperationRequests on which LAC check will be performed */ resourceGuardOperationRequests?: string[]; /** * Restore Settings of the vault */ restoreSettings?: outputs.recoveryservices.RestoreSettingsResponse; /** * Secure Score of Recovery Services Vault */ secureScore: string; /** * Security Settings of the vault */ securitySettings?: outputs.recoveryservices.SecuritySettingsResponse; /** * Details for upgrading vault. */ upgradeDetails?: outputs.recoveryservices.UpgradeDetailsResponse; } /** * Customer Managed Key details of the resource. */ interface VaultPropertiesResponseEncryption { /** * Enabling/Disabling the Double Encryption state */ infrastructureEncryption?: string; /** * The details of the identity used for CMK */ kekIdentity?: outputs.recoveryservices.CmkKekIdentityResponse; /** * The properties of the Key Vault which hosts CMK */ keyVaultProperties?: outputs.recoveryservices.CmkKeyVaultPropertiesResponse; } /** * The details of the latest move operation performed on the Azure Resource */ interface VaultPropertiesResponseMoveDetails { /** * End Time of the Resource Move Operation */ completionTimeUtc: string; /** * OperationId of the Resource Move Operation */ operationId: string; /** * Source Resource of the Resource Move Operation */ sourceResourceId: string; /** * Start Time of the Resource Move Operation */ startTimeUtc: string; /** * Target Resource of the Resource Move Operation */ targetResourceId: string; } /** * The redundancy Settings of a Vault */ interface VaultPropertiesResponseRedundancySettings { /** * Flag to show if Cross Region Restore is enabled on the Vault or not */ crossRegionRestore?: string; /** * The storage redundancy setting of a vault */ standardTierStorageRedundancy?: string; } /** * Vault retention policy for AzureFileShare */ interface VaultRetentionPolicyResponse { snapshotRetentionInDays: number; /** * Base class for retention policy. */ vaultRetention: outputs.recoveryservices.LongTermRetentionPolicyResponse | outputs.recoveryservices.SimpleRetentionPolicyResponse; } /** * Version related details. */ interface VersionDetailsResponse { /** * Version expiry date. */ expiryDate?: string; /** * A value indicating whether security update required. */ status?: string; /** * The agent version. */ version?: string; } /** * VMM fabric specific details. */ interface VmmDetailsResponse { /** * Gets the class type. Overridden in derived classes. * Expected value is 'VMM'. */ instanceType: "VMM"; } /** * E2A Network Mapping fabric specific settings. */ interface VmmToAzureNetworkMappingSettingsResponse { /** * Gets the Instance type. * Expected value is 'VmmToAzure'. */ instanceType: "VmmToAzure"; } /** * E2E Network Mapping fabric specific settings. */ interface VmmToVmmNetworkMappingSettingsResponse { /** * Gets the Instance type. * Expected value is 'VmmToVmm'. */ instanceType: "VmmToVmm"; } /** * VMware Cbt specific policy details. */ interface VmwareCbtPolicyDetailsResponse { /** * The app consistent snapshot frequency in minutes. */ appConsistentFrequencyInMinutes?: number; /** * The crash consistent snapshot frequency in minutes. */ crashConsistentFrequencyInMinutes?: number; /** * Gets the class type. Overridden in derived classes. * Expected value is 'VMwareCbt'. */ instanceType: "VMwareCbt"; /** * The duration in minutes until which the recovery points need to be stored. */ recoveryPointHistoryInMinutes?: number; } /** * Weekly retention format. */ interface WeeklyRetentionFormatResponse { /** * List of days of the week. */ daysOfTheWeek?: string[]; /** * List of weeks of month. */ weeksOfTheMonth?: string[]; } /** * Weekly retention schedule. */ interface WeeklyRetentionScheduleResponse { /** * List of days of week for weekly retention policy. */ daysOfTheWeek?: string[]; /** * Retention duration of retention Policy. */ retentionDuration?: outputs.recoveryservices.RetentionDurationResponse; /** * Retention times of retention policy. */ retentionTimes?: string[]; } interface WeeklyScheduleResponse { scheduleRunDays?: string[]; /** * List of times of day this schedule has to be run. */ scheduleRunTimes?: string[]; } interface WorkloadCrrAccessTokenResponse { /** * Access token used for authentication */ accessTokenString?: string; /** * Active region name of BMS Stamp */ bMSActiveRegion?: string; /** * Backup Management Type */ backupManagementType?: string; /** * Container Id */ containerId?: string; /** * Container Unique name */ containerName?: string; /** * Container Type */ containerType?: string; /** * CoordinatorServiceStampId to be used by BCM in restore call */ coordinatorServiceStampId?: string; /** * CoordinatorServiceStampUri to be used by BCM in restore call */ coordinatorServiceStampUri?: string; /** * Datasource Container Unique Name */ datasourceContainerName?: string; /** * Datasource Id */ datasourceId?: string; /** * Datasource Friendly Name */ datasourceName?: string; /** * Datasource Type */ datasourceType?: string; /** * Type of the specific object - used for deserializing * Expected value is 'WorkloadCrrAccessToken'. */ objectType: "WorkloadCrrAccessToken"; /** * Policy Id */ policyId?: string; /** * Policy Name */ policyName?: string; protectableObjectContainerHostOsName?: string; protectableObjectFriendlyName?: string; protectableObjectParentLogicalContainerName?: string; protectableObjectProtectionState?: string; protectableObjectUniqueName?: string; protectableObjectWorkloadType?: string; /** * Protected item container id */ protectionContainerId?: number; /** * ProtectionServiceStampId to be used by BCM in restore call */ protectionServiceStampId?: string; /** * ProtectionServiceStampUri to be used by BCM in restore call */ protectionServiceStampUri?: string; /** * Recovery Point Id */ recoveryPointId?: string; /** * Recovery Point Time */ recoveryPointTime?: string; /** * Resource Group name of the source vault */ resourceGroupName?: string; /** * Resource Id of the source vault */ resourceId?: string; /** * Resource Name of the source vault */ resourceName?: string; /** * Recovery point information: Managed virtual machine */ rpIsManagedVirtualMachine?: boolean; /** * Recovery point information: Original SA option */ rpOriginalSAOption?: boolean; /** * Recovery point Tier Information */ rpTierInformation?: { [key: string]: string; }; /** * Recovery point information: VM size description */ rpVMSizeDescription?: string; /** * Subscription Id of the source vault */ subscriptionId?: string; /** * Extended Information about the token like FileSpec etc. */ tokenExtendedInformation?: string; } /** * Details of an inquired protectable item. */ interface WorkloadInquiryDetailsResponse { /** * Inquiry validation such as permissions and other backup validations. */ inquiryValidation?: outputs.recoveryservices.InquiryValidationResponse; /** * Contains the protectable item Count inside this Container. */ itemCount?: number; /** * Type of the Workload such as SQL, Oracle etc. */ type?: string; } /** * Yearly retention schedule. */ interface YearlyRetentionScheduleResponse { /** * List of months of year of yearly retention policy. */ monthsOfYear?: string[]; /** * Retention duration of retention Policy. */ retentionDuration?: outputs.recoveryservices.RetentionDurationResponse; /** * Daily retention format for yearly retention policy. */ retentionScheduleDaily?: outputs.recoveryservices.DailyRetentionFormatResponse; /** * Retention schedule format for yearly retention policy. */ retentionScheduleFormatType?: string; /** * Weekly retention format for yearly retention policy. */ retentionScheduleWeekly?: outputs.recoveryservices.WeeklyRetentionFormatResponse; /** * Retention times of retention policy. */ retentionTimes?: string[]; } } export declare namespace redhatopenshift { /** * APIServerProfile represents an API server profile. */ interface APIServerProfileResponse { /** * The IP of the cluster API server. */ ip: string; /** * The URL to access the cluster API server. */ url: string; /** * API server visibility. */ visibility?: string; } /** * ClusterProfile represents a cluster profile. */ interface ClusterProfileResponse { /** * The domain for the cluster. */ domain?: string; /** * If FIPS validated crypto modules are used */ fipsValidatedModules?: string; /** * The pull secret for the cluster. */ pullSecret?: string; /** * The ID of the cluster resource group. */ resourceGroupId?: string; /** * The version of the cluster. */ version?: string; } /** * ConsoleProfile represents a console profile. */ interface ConsoleProfileResponse { /** * The URL to access the cluster console. */ url: string; } /** * EffectiveOutboundIP represents an effective outbound IP resource of the cluster public load balancer. */ interface EffectiveOutboundIPResponse { /** * The fully qualified Azure resource id of an IP address resource. */ id?: string; } /** * IngressProfile represents an ingress profile. */ interface IngressProfileResponse { /** * The IP of the ingress. */ ip: string; /** * The ingress profile name. */ name?: string; /** * Ingress visibility. */ visibility?: string; } /** * LoadBalancerProfile represents the profile of the cluster public load balancer. */ interface LoadBalancerProfileResponse { /** * The list of effective outbound IP addresses of the public load balancer. */ effectiveOutboundIps: outputs.redhatopenshift.EffectiveOutboundIPResponse[]; /** * The desired managed outbound IPs for the cluster public load balancer. */ managedOutboundIps?: outputs.redhatopenshift.ManagedOutboundIPsResponse; } /** * ManagedOutboundIPs represents the desired managed outbound IPs for the cluster public load balancer. */ interface ManagedOutboundIPsResponse { /** * Count represents the desired number of IPv4 outbound IPs created and managed by Azure for the cluster public load balancer. Allowed values are in the range of 1 - 20. The default value is 1. */ count?: number; } /** * MasterProfile represents a master profile. */ interface MasterProfileResponse { /** * The resource ID of an associated DiskEncryptionSet, if applicable. */ diskEncryptionSetId?: string; /** * Whether master virtual machines are encrypted at host. */ encryptionAtHost?: string; /** * The Azure resource ID of the master subnet. */ subnetId?: string; /** * The size of the master VMs. */ vmSize?: string; } /** * NetworkProfile represents a network profile. */ interface NetworkProfileResponse { /** * The cluster load balancer profile. */ loadBalancerProfile?: outputs.redhatopenshift.LoadBalancerProfileResponse; /** * The OutboundType used for egress traffic. */ outboundType?: string; /** * The CIDR used for OpenShift/Kubernetes Pods. */ podCidr?: string; /** * Specifies whether subnets are pre-attached with an NSG */ preconfiguredNSG?: string; /** * The CIDR used for OpenShift/Kubernetes Services. */ serviceCidr?: string; } /** * ServicePrincipalProfile represents a service principal profile. */ interface ServicePrincipalProfileResponse { /** * The client ID used for the cluster. */ clientId?: string; /** * The client secret used for the cluster. */ clientSecret?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * WorkerProfile represents a worker profile. */ interface WorkerProfileResponse { /** * The number of worker VMs. */ count?: number; /** * The resource ID of an associated DiskEncryptionSet, if applicable. */ diskEncryptionSetId?: string; /** * The disk size of the worker VMs. */ diskSizeGB?: number; /** * Whether master virtual machines are encrypted at host. */ encryptionAtHost?: string; /** * The worker profile name. */ name?: string; /** * The Azure resource ID of the worker subnet. */ subnetId?: string; /** * The size of the worker VMs. */ vmSize?: string; } } export declare namespace redis { /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.redis.UserAssignedIdentityResponse; }; } /** * The private endpoint connection resource. */ interface PrivateEndpointConnectionResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint resource. */ privateEndpoint?: outputs.redis.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.redis.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.redis.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Redis cache access keys. */ interface RedisAccessKeysResponse { /** * The current primary key that clients can use to authenticate with Redis cache. */ primaryKey: string; /** * The current secondary key that clients can use to authenticate with Redis cache. */ secondaryKey: string; } /** * All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta, maxmemory-policy,notify-keyspace-events, aof-backup-enabled, aof-storage-connection-string-0, aof-storage-connection-string-1 etc. */ interface RedisCommonPropertiesRedisConfigurationResponse { /** * Specifies whether AAD based authentication has been enabled or disabled for the cache */ aadEnabled?: string; /** * Specifies whether the aof backup is enabled */ aofBackupEnabled?: string; /** * First storage account connection string */ aofStorageConnectionString0?: string; /** * Second storage account connection string */ aofStorageConnectionString1?: string; /** * Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view; you should never disable authentication using this property! */ authnotrequired?: string; /** * The max clients config */ maxclients: string; /** * Value in megabytes reserved for fragmentation per shard */ maxfragmentationmemoryReserved?: string; /** * Value in megabytes reserved for non-cache usage per shard e.g. failover. */ maxmemoryDelta?: string; /** * The eviction strategy used when your data won't fit within its memory limit. */ maxmemoryPolicy?: string; /** * Value in megabytes reserved for non-cache usage per shard e.g. failover. */ maxmemoryReserved?: string; /** * The keyspace events which should be monitored. */ notifyKeyspaceEvents?: string; /** * Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS */ preferredDataArchiveAuthMethod: string; /** * Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS */ preferredDataPersistenceAuthMethod?: string; /** * Specifies whether the RDB backup is enabled */ rdbBackupEnabled?: string; /** * Specifies the frequency for creating rdb backup in minutes. Valid values: (15, 30, 60, 360, 720, 1440) */ rdbBackupFrequency?: string; /** * Specifies the maximum number of snapshots for rdb backup */ rdbBackupMaxSnapshotCount?: string; /** * The storage account connection string for storing rdb file */ rdbStorageConnectionString?: string; /** * SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity. */ storageSubscriptionId?: string; /** * Zonal Configuration */ zonalConfiguration: string; } /** * Details of single instance of redis. */ interface RedisInstanceDetailsResponse { /** * Specifies whether the instance is a primary node. */ isMaster: boolean; /** * Specifies whether the instance is a primary node. */ isPrimary: boolean; /** * If enableNonSslPort is true, provides Redis instance Non-SSL port. */ nonSslPort: number; /** * If clustering is enabled, the Shard ID of Redis Instance */ shardId: number; /** * Redis instance SSL port. */ sslPort: number; /** * If the Cache uses availability zones, specifies availability zone where this instance is located. */ zone: string; } /** * Linked server Id */ interface RedisLinkedServerResponse { /** * Linked server Id. */ id: string; } /** * Patch schedule entry for a Premium Redis Cache. */ interface ScheduleEntryResponse { /** * Day of the week when a cache can be patched. */ dayOfWeek: string; /** * ISO8601 timespan specifying how much time cache patching can take. */ maintenanceWindow?: string; /** * Start hour after which cache patching can start. */ startHourUtc: number; } /** * SKU parameters supplied to the create Redis operation. */ interface SkuResponse { /** * The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4). */ capacity: number; /** * The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium). */ family: string; /** * The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium) */ name: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace redisenterprise { /** * The user associated with the access policy. */ interface AccessPolicyAssignmentPropertiesResponseUser { /** * The object ID of the user. */ objectId?: string; } /** * All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption. */ interface ClusterPropertiesResponseCustomerManagedKeyEncryption { /** * All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. */ keyEncryptionKeyIdentity?: outputs.redisenterprise.ClusterPropertiesResponseKeyEncryptionKeyIdentity; /** * Key encryption key Url, versioned only. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 */ keyEncryptionKeyUrl?: string; } /** * Encryption-at-rest configuration for the cluster. */ interface ClusterPropertiesResponseEncryption { /** * All Customer-managed key encryption properties for the resource. Set this to an empty object to use Microsoft-managed key encryption. */ customerManagedKeyEncryption?: outputs.redisenterprise.ClusterPropertiesResponseCustomerManagedKeyEncryption; } /** * All identity configuration for Customer-managed key settings defining which identity should be used to auth to Key Vault. */ interface ClusterPropertiesResponseKeyEncryptionKeyIdentity { /** * Only userAssignedIdentity is supported in this API version; other types may be supported in the future */ identityType?: string; /** * User assigned identity to use for accessing key encryption key Url. Ex: /subscriptions//resourceGroups//providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId. */ userAssignedIdentityResourceId?: string; } /** * Optional set of properties to configure geo replication for this database. */ interface DatabasePropertiesResponseGeoReplication { /** * Name for the group of linked database resources */ groupNickname?: string; /** * List of database resources to link with this database */ linkedDatabases?: outputs.redisenterprise.LinkedDatabaseResponse[]; } /** * Specifies details of a linked database resource. */ interface LinkedDatabaseResponse { /** * Resource ID of a database resource to link with this database. */ id?: string; /** * State of the link between the database resources. */ state: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.redisenterprise.UserAssignedIdentityResponse; }; } /** * Specifies configuration of a redis module */ interface ModuleResponse { /** * Configuration options for the module, e.g. 'ERROR_RATE 0.01 INITIAL_SIZE 400'. */ args?: string; /** * The name of the module, e.g. 'RedisBloom', 'RediSearch', 'RedisTimeSeries' */ name: string; /** * The version of the module, e.g. '1.0'. */ version: string; } /** * Persistence-related configuration for the Redis Enterprise database */ interface PersistenceResponse { /** * Sets whether AOF is enabled. Note that at most one of AOF or RDB persistence may be enabled. */ aofEnabled?: boolean; /** * Sets the frequency at which data is written to disk. Defaults to '1s', meaning 'every second'. Note that the 'always' setting is deprecated, because of its performance impact. */ aofFrequency?: string; /** * Sets whether RDB is enabled. Note that at most one of AOF or RDB persistence may be enabled. */ rdbEnabled?: boolean; /** * Sets the frequency at which a snapshot of the database is created. */ rdbFrequency?: string; } /** * The Private Endpoint Connection resource. */ interface PrivateEndpointConnectionResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * The resource of private end point. */ privateEndpoint?: outputs.redisenterprise.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.redisenterprise.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The Private Endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Details of a Redis Enterprise cluster SKU. */ interface SkuDetailsResponse { /** * The name of the SKU. */ name: string; /** * The cache size in GB. */ sizeInGB: number; } /** * SKU parameters supplied to the create Redis Enterprise cluster operation. */ interface SkuResponse { /** * This property is only used with Enterprise and EnterpriseFlash SKUs. Determines the size of the cluster. Valid values are (2, 4, 6, ...) for Enterprise SKUs and (3, 9, 15, ...) for EnterpriseFlash SKUs. */ capacity?: number; /** * The level of Redis Enterprise cluster to deploy. Possible values: ('Balanced_B5', 'MemoryOptimized_M10', 'ComputeOptimized_X5', etc.). For more information on SKUs see the latest pricing documentation. Note that additional SKUs may become supported in the future. */ name: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace relationships { /** * dependencyOf relationship properties. */ interface DependencyOfRelationshipPropertiesResponse { /** * Metadata about the relationship. */ metadata: outputs.relationships.RelationshipMetadataResponse; /** * Information about the origin of the relationship. */ originInformation: outputs.relationships.RelationshipOriginInformationResponse; /** * The provisioning state of the relationship. */ provisioningState: string; /** * The relationship source resource id. */ sourceId: string; /** * The relationship target resource id. */ targetId: string; /** * The relationship target tenant id. */ targetTenant?: string; } /** * Provides information about the relationship properties. */ interface RelationshipMetadataResponse { /** * The type of the relationship source resource. */ sourceType: string; /** * The type of the relationship target resource. */ targetType: string; } /** * Provides information about the origin of a relationship. */ interface RelationshipOriginInformationResponse { /** * The name of the discovery engine that created the relationship. */ discoveryEngine: string; /** * Identifies the origin type of the relationship. */ relationshipOriginType: string; } /** * ServiceGroupMember relationship properties. */ interface ServiceGroupMemberRelationshipPropertiesResponse { /** * Metadata about the relationship. */ metadata: outputs.relationships.RelationshipMetadataResponse; /** * Information about the origin of the relationship. */ originInformation: outputs.relationships.RelationshipOriginInformationResponse; /** * The provisioning state of the relationship. */ provisioningState: string; /** * The relationship source resource id. */ sourceId: string; /** * The relationship target resource id. */ targetId: string; /** * The relationship target tenant id. */ targetTenant?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace relay { /** * ConnectionState information. */ interface ConnectionStateResponse { /** * Description of the connection state. */ description?: string; /** * Status of the connection. */ status?: string; } /** * Properties of the PrivateEndpointConnection. */ interface PrivateEndpointConnectionResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The geo-location where the resource lives */ location: string; /** * The name of the resource */ name: string; /** * The Private Endpoint resource for this Connection. */ privateEndpoint?: outputs.relay.PrivateEndpointResponse; /** * Details about the state of the connection. */ privateLinkServiceConnectionState?: outputs.relay.ConnectionStateResponse; /** * Provisioning state of the Private Endpoint Connection. */ provisioningState?: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.relay.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * PrivateEndpoint information. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint. */ id?: string; } /** * SKU of the namespace. */ interface SkuResponse { /** * Name of this SKU. */ name: string; /** * The tier of this SKU. */ tier?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace resourceconnector { /** * Cluster User Credential appliance. */ interface ApplianceCredentialKubeconfigResponse { /** * Name which contains the role of the kubeconfig. */ name: string; /** * Contains the kubeconfig value. */ value: string; } /** * Contains infrastructure information about the Appliance */ interface AppliancePropertiesInfrastructureConfigResponse { /** * Information about the connected appliance. */ provider?: string; } /** * Appliance ArtifactProfile definition. */ interface ArtifactProfileResponse { /** * Endpoint is the URL to upload artifacts to. */ endpoint: string; } /** * Contains the REP (rendezvous endpoint) and “Listener” access token from notification service (NS). */ interface HybridConnectionConfigResponse { /** * Timestamp when this token will be expired. */ expirationTime: number; /** * Name of the connection */ hybridConnectionName: string; /** * Name of the notification service. */ relay: string; /** * Listener access token */ token: string; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The identity type. */ type?: string; } /** * Appliance SSHKey definition. */ interface SSHKeyResponse { /** * User Private Key. */ privateKey?: string; /** * User Public Key. */ publicKey?: string; } /** * Appliance SSHKey definition. */ interface SSHKeylistApplianceKeysResponse { /** * Certificate associated with the public key if the key is signed. */ certificate: string; /** * Certificate creation timestamp (Unix). */ creationTimeStamp: number; /** * Certificate expiration timestamp (Unix). */ expirationTimeStamp: number; /** * Private Key. */ privateKey: string; /** * Public Key. */ publicKey: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace resourcegraph { /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace resourcehealth { /** * Impacted resource for an event. */ interface EventImpactedResourceResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * Additional information. */ info?: outputs.resourcehealth.KeyValueItemResponse[]; /** * The name of the resource */ name: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.resourcehealth.SystemDataResponse; /** * Impacted resource region name. */ targetRegion: string; /** * Identity for resource within Microsoft cloud. */ targetResourceId: string; /** * Resource type within Microsoft cloud. */ targetResourceType: string; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Key value tuple. */ interface KeyValueItemResponse { /** * Key of tuple. */ key: string; /** * Value of tuple. */ value: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace resources { /** * Defines the behavior of resources that are no longer managed after the stack is updated or deleted. */ interface ActionOnUnmanageDeploymentStacksWhatIfResultsAtManagementGroupResponse { /** * Specifies an action for a newly unmanaged resource management group. */ managementGroups?: string; /** * Specifies an action for a newly unmanaged resource group. */ resourceGroups?: string; /** * Specifies an action for a newly unmanaged resource. */ resources: string; /** * Some resources do not support deletion. This flag will denote how the stack should handle those resources. */ resourcesWithoutDeleteSupport?: string; } /** * Defines the behavior of resources that are no longer managed after the stack is updated or deleted. */ interface ActionOnUnmanageDeploymentStacksWhatIfResultsAtResourceGroupResponse { /** * Specifies an action for a newly unmanaged resource management group. */ managementGroups?: string; /** * Specifies an action for a newly unmanaged resource group. */ resourceGroups?: string; /** * Specifies an action for a newly unmanaged resource. */ resources: string; /** * Some resources do not support deletion. This flag will denote how the stack should handle those resources. */ resourcesWithoutDeleteSupport?: string; } /** * Defines the behavior of resources that are no longer managed after the stack is updated or deleted. */ interface ActionOnUnmanageDeploymentStacksWhatIfResultsAtSubscriptionResponse { /** * Specifies an action for a newly unmanaged resource management group. */ managementGroups?: string; /** * Specifies an action for a newly unmanaged resource group. */ resourceGroups?: string; /** * Specifies an action for a newly unmanaged resource. */ resources: string; /** * Some resources do not support deletion. This flag will denote how the stack should handle those resources. */ resourcesWithoutDeleteSupport?: string; } /** * Defines the behavior of resources that are no longer managed after the stack is updated or deleted. */ interface ActionOnUnmanageResponse { /** * Specifies an action for a newly unmanaged resource management group. */ managementGroups?: string; /** * Specifies an action for a newly unmanaged resource group. */ resourceGroups?: string; /** * Specifies an action for a newly unmanaged resource. */ resources: string; } interface AliasPathMetadataResponse { /** * The attributes of the token that the alias path is referring to. */ attributes: string; /** * The type of the token that the alias path is referring to. */ type: string; } /** * The type of the paths for alias. */ interface AliasPathResponse { /** * The API versions. */ apiVersions?: string[]; /** * The metadata of the alias path. If missing, fall back to the default metadata of the alias. */ metadata: outputs.resources.AliasPathMetadataResponse; /** * The path of an alias. */ path?: string; /** * The pattern for an alias path. */ pattern?: outputs.resources.AliasPatternResponse; } /** * The type of the pattern for an alias path. */ interface AliasPatternResponse { /** * The alias pattern phrase. */ phrase?: string; /** * The type of alias pattern */ type?: string; /** * The alias pattern variable. */ variable?: string; } /** * The alias type. */ interface AliasResponse { /** * The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata */ defaultMetadata: outputs.resources.AliasPathMetadataResponse; /** * The default path for an alias. */ defaultPath?: string; /** * The default pattern for an alias. */ defaultPattern?: outputs.resources.AliasPatternResponse; /** * The alias name. */ name?: string; /** * The paths for an alias. */ paths?: outputs.resources.AliasPathResponse[]; /** * The type of the alias. */ type?: string; } interface ApiProfileResponse { /** * The API version. */ apiVersion: string; /** * The profile version. */ profileVersion: string; } /** * Deployment dependency information. */ interface BasicDependencyResponse { /** * The ID of the dependency. */ id?: string; /** * The dependency resource name. */ resourceName?: string; /** * The dependency resource type. */ resourceType?: string; } /** * Settings to customize ACI container instance. */ interface ContainerConfigurationResponse { /** * Container group name, if not specified then the name will get auto-generated. Not specifying a 'containerGroupName' indicates the system to generate a unique name which might end up flagging an Azure Policy as non-compliant. Use 'containerGroupName' when you have an Azure Policy that expects a specific naming convention or when you want to fully control the name. 'containerGroupName' property must be between 1 and 63 characters long, must contain only lowercase letters, numbers, and dashes and it cannot start or end with a dash and consecutive dashes are not allowed. To specify a 'containerGroupName', add the following object to properties: { "containerSettings": { "containerGroupName": "contoso-container" } }. If you do not want to specify a 'containerGroupName' then do not add 'containerSettings' property. */ containerGroupName?: string; /** * The subnet resource IDs for a container group. */ subnetIds?: outputs.resources.ContainerGroupSubnetIdResponse[]; } /** * Container group subnet information. */ interface ContainerGroupSubnetIdResponse { /** * Resource ID of subnet. */ id: string; /** * Friendly name for the subnet. */ name?: string; } /** * The debug setting. */ interface DebugSettingResponse { /** * Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations. */ detailLevel?: string; } /** * Defines how resources deployed by the Deployment stack are locked. */ interface DenySettingsResponse { /** * DenySettings will be applied to child resource scopes of every managed resource with a deny assignment. */ applyToChildScopes?: boolean; /** * List of role-based management operations that are excluded from the denySettings. Up to 200 actions are permitted. If the denySetting mode is set to 'denyWriteAndDelete', then the following actions are automatically appended to 'excludedActions': '*\/read' and 'Microsoft.Authorization/locks/delete'. If the denySetting mode is set to 'denyDelete', then the following actions are automatically appended to 'excludedActions': 'Microsoft.Authorization/locks/delete'. Duplicate actions will be removed. */ excludedActions?: string[]; /** * List of AAD principal IDs excluded from the lock. Up to 5 principals are permitted. */ excludedPrincipals?: string[]; /** * denySettings Mode that defines denied actions. */ mode: string; } /** * Deployment dependency information. */ interface DependencyResponse { /** * The list of dependencies. */ dependsOn?: outputs.resources.BasicDependencyResponse[]; /** * The ID of the dependency. */ id?: string; /** * The dependency resource name. */ resourceName?: string; /** * The dependency resource type. */ resourceType?: string; } /** * The value or how to get a value for an extension config property. */ interface DeploymentExtensionConfigItemResponse { /** * The key vault reference of the config item. */ keyVaultReference?: outputs.resources.KeyVaultParameterReferenceResponse; /** * The type of the value. */ type: string; /** * The value of the config item. The type is determined by the extension config schema. */ value?: any; } /** * Details about the usage of a deployment extension. */ interface DeploymentExtensionResponse { /** * The configuration used for deployment. The keys of this object should align with the extension config schema. */ config?: { [key: string]: outputs.resources.DeploymentExtensionConfigItemResponse; }; /** * The configuration ID of the extension usage. It uniquely identifies a target the extension deploys to. */ configId?: string; /** * The extension name. */ name: string; /** * The extension version. */ version: string; } /** * Deployment parameter for the template. */ interface DeploymentParameterResponse { /** * Azure Key Vault parameter reference. */ reference?: outputs.resources.KeyVaultParameterReferenceResponse; /** * Type of the value. */ type?: string; /** * Input value to the parameter. */ value?: any; } /** * Deployment properties with additional details. */ interface DeploymentPropertiesExtendedResponse { /** * The correlation ID of the deployment. */ correlationId: string; /** * The debug setting of the deployment. */ debugSetting: outputs.resources.DebugSettingResponse; /** * The list of deployment dependencies. */ dependencies: outputs.resources.DependencyResponse[]; /** * The duration of the template deployment. */ duration: string; /** * The deployment error. */ error: outputs.resources.ErrorResponseResponse; /** * The deployment mode. Possible values are Incremental and Complete. */ mode: string; /** * The deployment on error behavior. */ onErrorDeployment: outputs.resources.OnErrorDeploymentExtendedResponse; /** * Array of provisioned resources. */ outputResources: outputs.resources.ResourceReferenceResponse[]; /** * Key/value pairs that represent deployment output. */ outputs: any; /** * Deployment parameters. */ parameters: any; /** * The URI referencing the parameters. */ parametersLink: outputs.resources.ParametersLinkResponse; /** * The list of resource providers needed for the deployment. */ providers: outputs.resources.ProviderResponse[]; /** * Denotes the state of provisioning. */ provisioningState: string; /** * The hash produced for the template. */ templateHash: string; /** * The URI referencing the template. */ templateLink: outputs.resources.TemplateLinkResponse; /** * The timestamp of the template deployment. */ timestamp: string; /** * Array of validated resources. */ validatedResources: outputs.resources.ResourceReferenceResponse[]; } /** * The debug setting. */ interface DeploymentStacksDebugSettingResponse { /** * Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information that is being passed in during deployment. By logging information about the request or response, sensitive data that is retrieved through the deployment operations could potentially be exposed. */ detailLevel?: string; } /** * The error additional info */ interface DeploymentStacksDiagnosticResponse { /** * Additional error information. */ additionalInfo?: outputs.resources.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * Denotes the additional response level. */ level: string; /** * The error message. */ message: string; /** * The error target. */ target?: string; } /** * Entity representing the reference to the deployment parameters. */ interface DeploymentStacksParametersLinkResponse { /** * If included, must match the ContentVersion in the template. */ contentVersion?: string; /** * The URI of the parameters file. */ uri: string; } /** * Changes predicted to the deployment stack as a result of the what-if operation. */ interface DeploymentStacksWhatIfChangeResponse { /** * Predicted changes to the deployment stack deny settings. */ denySettingsChange: outputs.resources.DeploymentStacksWhatIfChangeResponseDenySettingsChange; /** * Predicted changes to the deployment scope for the deployment stack. */ deploymentScopeChange?: outputs.resources.DeploymentStacksWhatIfChangeResponseDeploymentScopeChange; /** * List of resource changes predicted by What-If operation. */ resourceChanges: outputs.resources.DeploymentStacksWhatIfResourceChangeResponse[]; } /** * Predicted changes to the deployment stack deny settings. */ interface DeploymentStacksWhatIfChangeResponseDenySettingsChange { /** * The predicted value after the deployment is executed. */ after?: outputs.resources.DenySettingsResponse; /** * The predicted value before the deployment is executed. */ before?: outputs.resources.DenySettingsResponse; /** * The predicted changes to the properties." */ delta?: outputs.resources.DeploymentStacksWhatIfPropertyChangeResponse[]; } /** * Predicted changes to the deployment scope for the deployment stack. */ interface DeploymentStacksWhatIfChangeResponseDeploymentScopeChange { /** * The predicted value after the deployment is executed. */ after?: string; /** * The predicted value before the deployment is executed. */ before?: string; } /** * The predicted change to the resource property. */ interface DeploymentStacksWhatIfPropertyChangeResponse { /** * The predicted value after the deployment is executed. */ after?: any; /** * The predicted value before the deployment is executed. */ before?: any; /** * Type of change that will be made to the resource when the deployment is executed. */ changeType: string; /** * Nested property changes. */ children?: outputs.resources.DeploymentStacksWhatIfPropertyChangeResponse[]; /** * Type of change that will be made to the resource when the deployment is executed. */ path: string; } /** * Information about a single resource change predicted by What-If operation. */ interface DeploymentStacksWhatIfResourceChangeResponse { /** * The API version the resource was deployed with */ apiVersion: string; /** * The confidence level of the predicted change. */ changeCertainty: string; /** * Type of change that will be made to the resource when the deployment is executed. */ changeType: string; /** * The predicted changes to the deployment stack deny status of the resource. */ denyStatusChange?: outputs.resources.DeploymentStacksWhatIfResourceChangeResponseDenyStatusChange; /** * The resource id of the Deployment responsible for this change. */ deploymentId?: string; /** * The extension the resource was deployed with. */ extension: outputs.resources.DeploymentExtensionResponse; /** * The ARM Resource ID of a resource managed by the deployment stack. */ id: string; /** * The extensible resource identifiers. */ identifiers: any; /** * The predicted changes to the deployment stack management status of the resource. */ managementStatusChange?: outputs.resources.DeploymentStacksWhatIfResourceChangeResponseManagementStatusChange; /** * The predicted changes to the resource configuration. */ resourceConfigurationChanges?: outputs.resources.DeploymentStacksWhatIfResourceChangeResponseResourceConfigurationChanges; /** * The symbolic name of the resource being changed. */ symbolicName?: string; /** * The resource type. */ type: string; /** * The explanation about why the resource is unsupported by What-If. */ unsupportedReason?: string; } /** * The predicted changes to the deployment stack deny status of the resource. */ interface DeploymentStacksWhatIfResourceChangeResponseDenyStatusChange { /** * The predicted value after the deployment is executed. */ after?: string; /** * The predicted value before the deployment is executed. */ before?: string; } /** * The predicted changes to the deployment stack management status of the resource. */ interface DeploymentStacksWhatIfResourceChangeResponseManagementStatusChange { /** * The predicted value after the deployment is executed. */ after?: string; /** * The predicted value before the deployment is executed. */ before?: string; } /** * The predicted changes to the resource configuration. */ interface DeploymentStacksWhatIfResourceChangeResponseResourceConfigurationChanges { /** * The predicted value after the deployment is executed. */ after?: any; /** * The predicted value before the deployment is executed. */ before?: any; /** * The predicted changes to the properties." */ delta?: outputs.resources.DeploymentStacksWhatIfPropertyChangeResponse[]; } /** * DeploymentStack WhatIfResult Properties */ interface DeploymentStacksWhatIfResultPropertiesDeploymentStacksWhatIfResultsAtResourceGroupResponse { /** * Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. */ actionOnUnmanage: outputs.resources.ActionOnUnmanageDeploymentStacksWhatIfResultsAtResourceGroupResponse; /** * All of the changes predicted by the deployment stack what-if operation. */ changes: outputs.resources.DeploymentStacksWhatIfChangeResponse; /** * The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. */ correlationId: string; /** * The debug setting of the deployment. */ debugSetting?: outputs.resources.DeploymentStacksDebugSettingResponse; /** * Defines how resources deployed by the stack are locked. */ denySettings: outputs.resources.DenySettingsResponse; /** * The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). */ deploymentScope?: string; /** * The timestamp for when the deployment stack was last modified. This can be used to determine if the what-if data is still current. */ deploymentStackLastModified: string; /** * The deployment stack id to use as the basis for comparison. */ deploymentStackResourceId: string; /** * Deployment stack description. Max length of 4096 characters. */ description?: string; /** * List of resource diagnostics detected by What-If operation. */ diagnostics: outputs.resources.DeploymentStacksDiagnosticResponse[]; /** * The error detail. */ error: outputs.resources.ErrorDetailResponse; /** * Name and value pairs that define the deployment parameters for the template. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. */ parameters?: { [key: string]: outputs.resources.DeploymentParameterResponse; }; /** * The URI of parameters file. Use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. */ parametersLink?: outputs.resources.DeploymentStacksParametersLinkResponse; /** * State of the deployment stack. */ provisioningState: string; /** * The interval to persist the deployment stack what-if result in ISO 8601 format. */ retentionInterval: string; /** * The validation level of the deployment stack */ validationLevel?: string; } /** * DeploymentStack WhatIfResult Properties */ interface DeploymentStacksWhatIfResultPropertiesDeploymentStacksWhatIfResultsAtSubscriptionResponse { /** * Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. */ actionOnUnmanage: outputs.resources.ActionOnUnmanageDeploymentStacksWhatIfResultsAtSubscriptionResponse; /** * All of the changes predicted by the deployment stack what-if operation. */ changes: outputs.resources.DeploymentStacksWhatIfChangeResponse; /** * The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. */ correlationId: string; /** * The debug setting of the deployment. */ debugSetting?: outputs.resources.DeploymentStacksDebugSettingResponse; /** * Defines how resources deployed by the stack are locked. */ denySettings: outputs.resources.DenySettingsResponse; /** * The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). */ deploymentScope?: string; /** * The timestamp for when the deployment stack was last modified. This can be used to determine if the what-if data is still current. */ deploymentStackLastModified: string; /** * The deployment stack id to use as the basis for comparison. */ deploymentStackResourceId: string; /** * Deployment stack description. Max length of 4096 characters. */ description?: string; /** * List of resource diagnostics detected by What-If operation. */ diagnostics: outputs.resources.DeploymentStacksDiagnosticResponse[]; /** * The error detail. */ error: outputs.resources.ErrorDetailResponse; /** * Name and value pairs that define the deployment parameters for the template. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. */ parameters?: { [key: string]: outputs.resources.DeploymentParameterResponse; }; /** * The URI of parameters file. Use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. */ parametersLink?: outputs.resources.DeploymentStacksParametersLinkResponse; /** * State of the deployment stack. */ provisioningState: string; /** * The interval to persist the deployment stack what-if result in ISO 8601 format. */ retentionInterval: string; /** * The validation level of the deployment stack */ validationLevel?: string; } /** * DeploymentStack WhatIfResult Properties */ interface DeploymentStacksWhatIfResultPropertiesResponse { /** * Defines the behavior of resources that are no longer managed after the Deployment stack is updated or deleted. */ actionOnUnmanage: outputs.resources.ActionOnUnmanageDeploymentStacksWhatIfResultsAtManagementGroupResponse; /** * All of the changes predicted by the deployment stack what-if operation. */ changes: outputs.resources.DeploymentStacksWhatIfChangeResponse; /** * The correlation id of the last Deployment stack upsert or delete operation. It is in GUID format and is used for tracing. */ correlationId: string; /** * The debug setting of the deployment. */ debugSetting?: outputs.resources.DeploymentStacksDebugSettingResponse; /** * Defines how resources deployed by the stack are locked. */ denySettings: outputs.resources.DenySettingsResponse; /** * The scope at which the initial deployment should be created. If a scope is not specified, it will default to the scope of the deployment stack. Valid scopes are: management group (format: '/providers/Microsoft.Management/managementGroups/{managementGroupId}'), subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}'). */ deploymentScope?: string; /** * The timestamp for when the deployment stack was last modified. This can be used to determine if the what-if data is still current. */ deploymentStackLastModified: string; /** * The deployment stack id to use as the basis for comparison. */ deploymentStackResourceId: string; /** * Deployment stack description. Max length of 4096 characters. */ description?: string; /** * List of resource diagnostics detected by What-If operation. */ diagnostics: outputs.resources.DeploymentStacksDiagnosticResponse[]; /** * The error detail. */ error: outputs.resources.ErrorDetailResponse; /** * Name and value pairs that define the deployment parameters for the template. Use this element when providing the parameter values directly in the request, rather than linking to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. */ parameters?: { [key: string]: outputs.resources.DeploymentParameterResponse; }; /** * The URI of parameters file. Use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both. */ parametersLink?: outputs.resources.DeploymentStacksParametersLinkResponse; /** * State of the deployment stack. */ provisioningState: string; /** * The interval to persist the deployment stack what-if result in ISO 8601 format. */ retentionInterval: string; /** * The validation level of the deployment stack */ validationLevel?: string; } /** * The environment variable to pass to the script in the container instance. */ interface EnvironmentVariableResponse { /** * The name of the environment variable. */ name: string; /** * The value of the secure environment variable. */ secureValue?: string; /** * The value of the environment variable. */ value?: string; } /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.resources.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.resources.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.) */ interface ErrorResponseResponse { /** * The error additional info. */ additionalInfo: outputs.resources.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.resources.ErrorResponseResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * Resource extended location. */ interface ExtendedLocationResponse { /** * The extended location name. */ name?: string; /** * The extended location type. */ type?: string; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The identity type. */ type?: string; /** * The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.resources.IdentityResponseUserAssignedIdentities; }; } interface IdentityResponseUserAssignedIdentities { /** * The client id of user assigned identity. */ clientId: string; /** * The principal id of user assigned identity. */ principalId: string; } /** * Azure Key Vault parameter reference. */ interface KeyVaultParameterReferenceResponse { /** * Azure Key Vault reference. */ keyVault: outputs.resources.KeyVaultReferenceResponse; /** * Azure Key Vault secret name. */ secretName: string; /** * Azure Key Vault secret version. */ secretVersion?: string; } /** * Azure Key Vault reference. */ interface KeyVaultReferenceResponse { /** * Azure Key Vault resourceId. */ id: string; } /** * Represents a Template Spec artifact containing an embedded Azure Resource Manager template for use as a linked template. */ interface LinkedTemplateArtifactResponse { /** * A filesystem safe relative path of the artifact. */ path: string; /** * The Azure Resource Manager template. */ template: any; } /** * The managed resource model. */ interface ManagedResourceReferenceResponse { /** * denyAssignment settings applied to the resource. */ denyStatus?: string; /** * The ARM Resource ID of a resource managed by the deployment stack. */ id: string; /** * Current management state of the resource in the deployment stack. */ status?: string; } /** * managedResourceReferenceResponseProvideDefaults sets the appropriate defaults for ManagedResourceReferenceResponse */ function managedResourceReferenceResponseProvideDefaults(val: ManagedResourceReferenceResponse): ManagedResourceReferenceResponse; /** * Describes the managed identities for an Azure resource. */ interface ManagedServiceIdentityResponse { /** * The tenant id of the managed identity. */ tenantId: string; /** * Type of the managed identity. */ type?: string; /** * The list of user-assigned managed identities associated with the resource. Key is the Azure resource Id of the managed identity. */ userAssignedIdentities?: { [key: string]: outputs.resources.UserAssignedIdentityResponse; }; } /** * Deployment on error behavior with additional details. */ interface OnErrorDeploymentExtendedResponse { /** * The deployment to be used on error case. */ deploymentName?: string; /** * The state of the provisioning for the on error deployment. */ provisioningState: string; /** * The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment. */ type?: string; } /** * Entity representing the reference to the deployment parameters. */ interface ParametersLinkResponse { /** * If included, must match the ContentVersion in the template. */ contentVersion?: string; /** * The URI of the parameters file. */ uri: string; } /** * Plan for the resource. */ interface PlanResponse { /** * The plan ID. */ name?: string; /** * The offer ID. */ product?: string; /** * The promotion code. */ promotionCode?: string; /** * The publisher ID. */ publisher?: string; /** * The plan's version. */ version?: string; } /** * The provider extended location. */ interface ProviderExtendedLocationResponse { /** * The extended locations for the azure location. */ extendedLocations?: string[]; /** * The azure location. */ location?: string; /** * The extended location type. */ type?: string; } /** * Resource type managed by the resource provider. */ interface ProviderResourceTypeResponse { /** * The aliases that are supported by this resource type. */ aliases?: outputs.resources.AliasResponse[]; /** * The API profiles for the resource provider. */ apiProfiles: outputs.resources.ApiProfileResponse[]; /** * The API version. */ apiVersions?: string[]; /** * The additional capabilities offered by this resource type. */ capabilities?: string; /** * The default API version. */ defaultApiVersion: string; /** * The location mappings that are supported by this resource type. */ locationMappings?: outputs.resources.ProviderExtendedLocationResponse[]; /** * The collection of locations where this resource type can be created. */ locations?: string[]; /** * The properties. */ properties?: { [key: string]: string; }; /** * The resource type. */ resourceType?: string; zoneMappings?: outputs.resources.ZoneMappingResponse[]; } /** * Resource provider information. */ interface ProviderResponse { /** * The provider ID. */ id: string; /** * The namespace of the resource provider. */ namespace?: string; /** * The provider authorization consent state. */ providerAuthorizationConsentState?: string; /** * The registration policy of the resource provider. */ registrationPolicy: string; /** * The registration state of the resource provider. */ registrationState: string; /** * The collection of provider resource types. */ resourceTypes: outputs.resources.ProviderResourceTypeResponse[]; } /** * The resource group properties. */ interface ResourceGroupPropertiesResponse { /** * The provisioning state. */ provisioningState: string; } /** * The resourceId extended model. This is used to document failed resources with a resourceId and a corresponding error. */ interface ResourceReferenceExtendedResponse { /** * The error detail. */ error: outputs.resources.ErrorDetailResponse; /** * The ARM Resource ID of a resource managed by the deployment stack. */ id: string; } /** * The resourceId model. */ interface ResourceReferenceResponse { /** * The ARM Resource ID of a resource managed by the deployment stack. */ id: string; } /** * Generic object modeling results of script execution. */ interface ScriptStatusResponse { /** * ACI resource Id. */ containerInstanceId: string; /** * End time of the script execution. */ endTime: string; /** * Error that is relayed from the script execution. */ error?: outputs.resources.ErrorDetailResponse; /** * Time the deployment script resource will expire. */ expirationTime: string; /** * Start time of the script execution. */ startTime: string; /** * Storage account resource Id. */ storageAccountId: string; } /** * SKU for the resource. */ interface SkuResponse { /** * The SKU capacity. */ capacity?: number; /** * The SKU family. */ family?: string; /** * The SKU model. */ model?: string; /** * The SKU name. */ name?: string; /** * The SKU size. */ size?: string; /** * The SKU tier. */ tier?: string; } /** * Settings to use an existing storage account. Valid storage account kinds are: Storage, StorageV2 and FileStorage */ interface StorageAccountConfigurationResponse { /** * The storage account access key. */ storageAccountKey?: string; /** * The storage account name. */ storageAccountName?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * A dictionary of name and value pairs. */ interface TagsResponse { tags?: { [key: string]: string; }; } /** * Entity representing the reference to the template. */ interface TemplateLinkResponse { /** * If included, must match the ContentVersion in the template. */ contentVersion?: string; /** * The resource id of a Template Spec. Use either the id or uri property, but not both. */ id?: string; /** * The query string (for example, a SAS token) to be used with the templateLink URI. */ queryString?: string; /** * The relativePath property can be used to deploy a linked template at a location relative to the parent. If the parent template was linked with a TemplateSpec, this will reference an artifact in the TemplateSpec. If the parent was linked with a URI, the child deployment will be a combination of the parent and relativePath URIs */ relativePath?: string; /** * The URI of the template to deploy. Use either the uri or id property, but not both. */ uri?: string; } /** * High-level information about a Template Spec version. */ interface TemplateSpecVersionInfoResponse { /** * Template Spec version description. */ description: string; /** * The timestamp of when the version was created. */ timeCreated: string; /** * The timestamp of when the version was last modified. */ timeModified: string; } /** * User-assigned managed identity. */ interface UserAssignedIdentityResponse { /** * Client App Id associated with this identity. */ clientId: string; /** * Azure Active Directory principal ID associated with this identity. */ principalId: string; } interface ZoneMappingResponse { /** * The location of the zone mapping. */ location?: string; zones?: string[]; } } export declare namespace saas { /** * The current Term object. */ interface SaasPropertiesResponseTerm { /** * The end date of the current term */ endDate?: string; /** * The start date of the current term */ startDate?: string; /** * The unit indicating Monthly / Yearly */ termUnit?: string; } /** * saas properties */ interface SaasResourceResponseProperties { /** * Whether the SaaS subscription will auto renew upon term end. */ autoRenew?: boolean; /** * The created date of this resource. */ created: string; /** * Whether the current term is a Free Trial term */ isFreeTrial?: boolean; /** * The last modifier date if this resource. */ lastModified?: string; /** * The offer id. */ offerId?: string; /** * The metadata about the SaaS subscription such as the AzureSubscriptionId and ResourceUri. */ paymentChannelMetadata?: { [key: string]: string; }; /** * The Payment channel for the SaasSubscription. */ paymentChannelType?: string; /** * The publisher id. */ publisherId?: string; /** * The environment in the publisher side for this resource. */ publisherTestEnvironment?: string; /** * The seat count. */ quantity?: number; /** * The SaaS resource name. */ saasResourceName?: string; /** * The saas session id used for dev service migration request. */ saasSessionId?: string; /** * The saas subscription id used for tenant to subscription level migration request. */ saasSubscriptionId?: string; /** * The plan id. */ skuId?: string; /** * The SaaS Subscription Status. */ status?: string; /** * The current Term object. */ term?: outputs.saas.SaasPropertiesResponseTerm; /** * The current Term id. */ termId?: string; } } export declare namespace scheduler { interface BasicAuthenticationResponse { /** * Gets or sets the password, return value will always be empty. */ password?: string; /** * Gets or sets the HTTP authentication type. * Expected value is 'Basic'. */ type: "Basic"; /** * Gets or sets the username. */ username?: string; } interface ClientCertAuthenticationResponse { /** * Gets or sets the certificate expiration date. */ certificateExpirationDate?: string; /** * Gets or sets the certificate subject name. */ certificateSubjectName?: string; /** * Gets or sets the certificate thumbprint. */ certificateThumbprint?: string; /** * Gets or sets the certificate password, return value will always be empty. */ password?: string; /** * Gets or sets the pfx certificate. Accepts certification in base64 encoding, return value will always be empty. */ pfx?: string; /** * Gets or sets the HTTP authentication type. * Expected value is 'ClientCertificate'. */ type: "ClientCertificate"; } interface HttpRequestResponse { /** * Gets or sets the authentication method of the request. */ authentication?: outputs.scheduler.BasicAuthenticationResponse | outputs.scheduler.ClientCertAuthenticationResponse | outputs.scheduler.OAuthAuthenticationResponse; /** * Gets or sets the request body. */ body?: string; /** * Gets or sets the headers. */ headers?: { [key: string]: string; }; /** * Gets or sets the method of the request. */ method?: string; /** * Gets or sets the URI of the request. */ uri?: string; } interface JobActionResponse { /** * Gets or sets the error action. */ errorAction?: outputs.scheduler.JobErrorActionResponse; /** * Gets or sets the storage queue message. */ queueMessage?: outputs.scheduler.StorageQueueMessageResponse; /** * Gets or sets the http requests. */ request?: outputs.scheduler.HttpRequestResponse; /** * Gets or sets the retry policy. */ retryPolicy?: outputs.scheduler.RetryPolicyResponse; /** * Gets or sets the service bus queue message. */ serviceBusQueueMessage?: outputs.scheduler.ServiceBusQueueMessageResponse; /** * Gets or sets the service bus topic message. */ serviceBusTopicMessage?: outputs.scheduler.ServiceBusTopicMessageResponse; /** * Gets or sets the job action type. */ type?: string; } interface JobCollectionPropertiesResponse { /** * Gets or sets the job collection quota. */ quota?: outputs.scheduler.JobCollectionQuotaResponse; /** * Gets or sets the SKU. */ sku?: outputs.scheduler.SkuResponse; /** * Gets or sets the state. */ state?: string; } interface JobCollectionQuotaResponse { /** * Gets or set the maximum job count. */ maxJobCount?: number; /** * Gets or sets the maximum job occurrence. */ maxJobOccurrence?: number; /** * Gets or set the maximum recurrence. */ maxRecurrence?: outputs.scheduler.JobMaxRecurrenceResponse; } interface JobErrorActionResponse { /** * Gets or sets the storage queue message. */ queueMessage?: outputs.scheduler.StorageQueueMessageResponse; /** * Gets or sets the http requests. */ request?: outputs.scheduler.HttpRequestResponse; /** * Gets or sets the retry policy. */ retryPolicy?: outputs.scheduler.RetryPolicyResponse; /** * Gets or sets the service bus queue message. */ serviceBusQueueMessage?: outputs.scheduler.ServiceBusQueueMessageResponse; /** * Gets or sets the service bus topic message. */ serviceBusTopicMessage?: outputs.scheduler.ServiceBusTopicMessageResponse; /** * Gets or sets the job error action type. */ type?: string; } interface JobMaxRecurrenceResponse { /** * Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). */ frequency?: string; /** * Gets or sets the interval between retries. */ interval?: number; } interface JobPropertiesResponse { /** * Gets or sets the job action. */ action?: outputs.scheduler.JobActionResponse; /** * Gets or sets the job recurrence. */ recurrence?: outputs.scheduler.JobRecurrenceResponse; /** * Gets or sets the job start time. */ startTime?: string; /** * Gets or set the job state. */ state?: string; /** * Gets the job status. */ status: outputs.scheduler.JobStatusResponse; } interface JobRecurrenceResponse { /** * Gets or sets the maximum number of times that the job should run. */ count?: number; /** * Gets or sets the time at which the job will complete. */ endTime?: string; /** * Gets or sets the frequency of recurrence (second, minute, hour, day, week, month). */ frequency?: string; /** * Gets or sets the interval between retries. */ interval?: number; schedule?: outputs.scheduler.JobRecurrenceScheduleResponse; } interface JobRecurrenceScheduleMonthlyOccurrenceResponse { /** * Gets or sets the day. Must be one of monday, tuesday, wednesday, thursday, friday, saturday, sunday. */ day?: string; /** * Gets or sets the occurrence. Must be between -5 and 5. */ occurrence?: number; } interface JobRecurrenceScheduleResponse { /** * Gets or sets the hours of the day that the job should execute at. */ hours?: number[]; /** * Gets or sets the minutes of the hour that the job should execute at. */ minutes?: number[]; /** * Gets or sets the days of the month that the job should execute on. Must be between 1 and 31. */ monthDays?: number[]; /** * Gets or sets the occurrences of days within a month. */ monthlyOccurrences?: outputs.scheduler.JobRecurrenceScheduleMonthlyOccurrenceResponse[]; /** * Gets or sets the days of the week that the job should execute on. */ weekDays?: string[]; } interface JobStatusResponse { /** * Gets the number of times this job has executed. */ executionCount: number; /** * Gets the number of times this job has failed. */ failureCount: number; /** * Gets the number of faulted occurrences (occurrences that were retried and failed as many times as the retry policy states). */ faultedCount: number; /** * Gets the time the last occurrence executed in ISO-8601 format. Could be empty if job has not run yet. */ lastExecutionTime: string; /** * Gets the time of the next occurrence in ISO-8601 format. Could be empty if the job is completed. */ nextExecutionTime: string; } interface OAuthAuthenticationResponse { /** * Gets or sets the audience. */ audience?: string; /** * Gets or sets the client identifier. */ clientId?: string; /** * Gets or sets the secret, return value will always be empty. */ secret?: string; /** * Gets or sets the tenant. */ tenant?: string; /** * Gets or sets the HTTP authentication type. * Expected value is 'ActiveDirectoryOAuth'. */ type: "ActiveDirectoryOAuth"; } interface RetryPolicyResponse { /** * Gets or sets the number of times a retry should be attempted. */ retryCount?: number; /** * Gets or sets the retry interval between retries, specify duration in ISO 8601 format. */ retryInterval?: string; /** * Gets or sets the retry strategy to be used. */ retryType?: string; } interface ServiceBusAuthenticationResponse { /** * Gets or sets the SAS key. */ sasKey?: string; /** * Gets or sets the SAS key name. */ sasKeyName?: string; /** * Gets or sets the authentication type. */ type?: string; } interface ServiceBusBrokeredMessagePropertiesResponse { /** * Gets or sets the content type. */ contentType?: string; /** * Gets or sets the correlation ID. */ correlationId?: string; /** * Gets or sets the force persistence. */ forcePersistence?: boolean; /** * Gets or sets the label. */ label?: string; /** * Gets or sets the message ID. */ messageId?: string; /** * Gets or sets the partition key. */ partitionKey?: string; /** * Gets or sets the reply to. */ replyTo?: string; /** * Gets or sets the reply to session ID. */ replyToSessionId?: string; /** * Gets or sets the scheduled enqueue time UTC. */ scheduledEnqueueTimeUtc?: string; /** * Gets or sets the session ID. */ sessionId?: string; /** * Gets or sets the time to live. */ timeToLive?: string; /** * Gets or sets the to. */ to?: string; /** * Gets or sets the via partition key. */ viaPartitionKey?: string; } interface ServiceBusQueueMessageResponse { /** * Gets or sets the Service Bus authentication. */ authentication?: outputs.scheduler.ServiceBusAuthenticationResponse; /** * Gets or sets the brokered message properties. */ brokeredMessageProperties?: outputs.scheduler.ServiceBusBrokeredMessagePropertiesResponse; /** * Gets or sets the custom message properties. */ customMessageProperties?: { [key: string]: string; }; /** * Gets or sets the message. */ message?: string; /** * Gets or sets the namespace. */ namespace?: string; /** * Gets or sets the queue name. */ queueName?: string; /** * Gets or sets the transport type. */ transportType?: string; } interface ServiceBusTopicMessageResponse { /** * Gets or sets the Service Bus authentication. */ authentication?: outputs.scheduler.ServiceBusAuthenticationResponse; /** * Gets or sets the brokered message properties. */ brokeredMessageProperties?: outputs.scheduler.ServiceBusBrokeredMessagePropertiesResponse; /** * Gets or sets the custom message properties. */ customMessageProperties?: { [key: string]: string; }; /** * Gets or sets the message. */ message?: string; /** * Gets or sets the namespace. */ namespace?: string; /** * Gets or sets the topic path. */ topicPath?: string; /** * Gets or sets the transport type. */ transportType?: string; } interface SkuResponse { /** * Gets or set the SKU. */ name?: string; } interface StorageQueueMessageResponse { /** * Gets or sets the message. */ message?: string; /** * Gets or sets the queue name. */ queueName?: string; /** * Gets or sets the SAS key. */ sasToken?: string; /** * Gets or sets the storage account name. */ storageAccount?: string; } } export declare namespace scom { /** * The properties to maximize savings by using Azure Hybrid Benefit */ interface AzureHybridBenefitPropertiesResponse { /** * SCOM license type. Maximize savings by using license you already own */ scomLicenseType?: string; /** * SQL Server license type. Maximize savings by using Azure Hybrid Benefit for SQL Server with license you already own */ sqlServerLicenseType?: string; /** * Specifies that the image or disk that is being used was licensed on-premises.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json) */ windowsServerLicenseType?: string; } /** * The properties of database instance */ interface DatabaseInstancePropertiesResponse { /** * Fully qualified domain name of existing database instance */ databaseFqdn: string; /** * Resource Id of existing database instance */ databaseInstanceId?: string; /** * Resource Id of warehouse database on database instance */ dwDatabaseId: string; /** * Name of warehouse database on database instance */ dwDatabaseName: string; /** * Resource Id of operational database on database instance */ operationalDatabaseId: string; } /** * The properties of domain controller to which SCOM and SQL servers join for AuthN/AuthZ. */ interface DomainControllerPropertiesResponse { /** * IP address of DNS server */ dnsServer?: string; /** * Fully qualified domain name */ domainName?: string; /** * Organizational Unit path in which the SCOM servers will be present */ ouPath?: string; } /** * domainControllerPropertiesResponseProvideDefaults sets the appropriate defaults for DomainControllerPropertiesResponse */ function domainControllerPropertiesResponseProvideDefaults(val: DomainControllerPropertiesResponse): DomainControllerPropertiesResponse; /** * Get Domain user name and password from key vault */ interface DomainUserCredentialsResponse { /** * Key vault url to get the domain username and password */ keyVaultUrl?: string; /** * Domain Password secret */ passwordSecret?: string; /** * Domain user name secret */ userNameSecret?: string; } /** * Gmsa Details */ interface GmsaDetailsResponse { /** * Frontend DNS name for Load Balancer which will be used by Agents to initiate communication */ dnsName?: string; /** * gMSA account under which context all Management Server services will run */ gmsaAccount?: string; /** * Frontend IP configuration for Load Balancer, which should be an available IP in customer VNet */ loadBalancerIP?: string; /** * OnPrem AD Computer Group where we will join VMs for ease of management */ managementServerGroupName?: string; } /** * Configuration for Log Analytics linking to SCOM managed instance. */ interface LogAnalyticsConfigurationResponse { /** * The types of data to be ingested to Log Analytics workspace. */ dataTypes?: string[]; /** * A one-time optional parameter to import data of last 7 days. */ importData?: boolean; /** * The resource ID of the Log Analytics workspace to be used. */ workspaceId?: string; } /** * logAnalyticsConfigurationResponseProvideDefaults sets the appropriate defaults for LogAnalyticsConfigurationResponse */ function logAnalyticsConfigurationResponseProvideDefaults(val: LogAnalyticsConfigurationResponse): LogAnalyticsConfigurationResponse; /** * The properties of a gateway resource. */ interface ManagedGatewayPropertiesResponse { /** * ComputerName of the gateway to be monitored. */ computerName?: string; /** * The connection status of the gateway resource. */ connectionStatus: string; /** * The domain name associated with the gateway to be monitored. */ domainName?: string; /** * The health status of the gateway resource. */ healthStatus: string; /** * Install type of gateway resource. */ installType: string; /** * The management server endpoint to which the gateway is directed. */ managementServerEndpoint: string; provisioningState: string; /** * ArmId of the gateway to be monitored. */ resourceId?: string; /** * Location of the gateway to be monitored. */ resourceLocation?: string; /** * The version of the gateway resource. */ version: string; } /** * Azure Active Directory identity configuration for a resource. */ interface ManagedIdentityResponse { /** * System Assigned Identity ObjectId. */ principalId: string; /** * The Azure Active Directory tenant id. */ tenantId: string; /** * The identity type */ type?: string; /** * The resource ids of the user assigned identities to use */ userAssignedIdentities?: { [key: string]: outputs.scom.UserIdentityResponse; }; } /** * Gets status of current and latest SCOM managed instance operation. */ interface ManagedInstanceOperationStatusResponse { /** * Operation id */ id: string; /** * Operation Name */ operationName: string; /** * Operation status */ operationState: string; } /** * The properties of management server */ interface ManagementServerPropertiesResponse { /** * Management server Fully Qualified Domain Name. */ fqdn: string; /** * Management server health state. */ healthState: string; /** * Management server Name */ serverName: string; /** * Represent whether the Server is a Management Server and/or Web Console Server. */ serverRoles: string; /** * Azure VM Resource Id of the Management server. */ vmResId: string; } /** * The properties of a monitored resource. */ interface MonitoredResourcePropertiesResponse { /** * The version of the monitored resource agent version. */ agentVersion: string; /** * ComputerName of the monitored resource. */ computerName?: string; /** * The connection status of the monitored resource. */ connectionStatus: string; /** * The domain name associated with the monitored resource. */ domainName?: string; /** * The health status of the monitored resource. */ healthStatus: string; /** * Install type of monitored resource. */ installType: string; /** * The management server endpoint to which the monitored resource is directed. */ managementServerEndpoint: string; provisioningState: string; /** * ArmId of the monitored resource. */ resourceId?: string; /** * Location of the monitored resource. */ resourceLocation?: string; } /** * The properties of a SCOM instance resource */ interface MonitoringInstancePropertiesResponse { /** * The properties to enable Azure Hybrid benefit for various SCOM infrastructure license. */ azureHybridBenefit?: outputs.scom.AzureHybridBenefitPropertiesResponse; /** * The database instance where the SCOM Operational and Warehouse databases will be stored. */ databaseInstance?: outputs.scom.DatabaseInstancePropertiesResponse; /** * Domain controller details */ domainController?: outputs.scom.DomainControllerPropertiesResponse; /** * Domain user which will be used to join VMs to domain and login to VMs. */ domainUserCredentials?: outputs.scom.DomainUserCredentialsResponse; /** * Gmsa Details for load balancer and vmss */ gmsaDetails?: outputs.scom.GmsaDetailsResponse; /** * Details of Log Analytics workspace and data being ingested. */ logAnalyticsProperties: outputs.scom.LogAnalyticsConfigurationResponse; /** * List of management server endpoints */ managementEndpoints: outputs.scom.ManagementServerPropertiesResponse[]; /** * Gets status of current and latest SCOM managed instance operations. */ operationsStatus: outputs.scom.ManagedInstanceOperationStatusResponse[]; /** * SCOM product version to be installed on instance */ productVersion: string; /** * Gets or sets the provisioning state. */ provisioningState: string; /** * Virtual Network subnet id on which Aquila instance will be provisioned */ vNetSubnetId?: string; } /** * monitoringInstancePropertiesResponseProvideDefaults sets the appropriate defaults for MonitoringInstancePropertiesResponse */ function monitoringInstancePropertiesResponseProvideDefaults(val: MonitoringInstancePropertiesResponse): MonitoringInstancePropertiesResponse; /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Azure Active Directory identity configuration for a resource. */ interface UserIdentityResponse { /** * The Azure Active Directory client id. */ clientId: string; /** * The Azure Active Directory principal id. */ principalId: string; } } export declare namespace scvmm { /** * Defines the resource properties. */ interface CheckpointResponse { /** * Gets ID of the checkpoint. */ checkpointID?: string; /** * Gets description of the checkpoint. */ description?: string; /** * Gets name of the checkpoint. */ name?: string; /** * Gets ID of parent of the checkpoint. */ parentCheckpointID?: string; } /** * Cloud Capacity model */ interface CloudCapacityResponse { /** * CPUCount specifies the maximum number of CPUs that can be allocated in the cloud. */ cpuCount?: number; /** * MemoryMB specifies a memory usage limit in megabytes. */ memoryMB?: number; /** * VMCount gives the max number of VMs that can be deployed in the cloud. */ vmCount?: number; } /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.scvmm.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.scvmm.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * The extended location. */ interface ExtendedLocationResponse { /** * The extended location name. */ name?: string; /** * The extended location type. */ type?: string; } /** * Defines the resource properties. */ interface GuestAgentProfileResponse { /** * The hybrid machine agent full version. */ agentVersion: string; /** * Gets or sets the Public Key provided by the client for enabling guest management. */ clientPublicKey?: string; /** * Details about the error state. */ errorDetails: outputs.scvmm.ErrorDetailResponse[]; /** * The time of the last status change. */ lastStatusChange: string; /** * The status of the hybrid machine agent. */ status: string; /** * Specifies the VM's unique SMBIOS ID. */ vmUuid: string; } /** * Username / Password Credentials to connect to guest. */ interface GuestCredentialResponse { /** * Gets or sets username to connect with the guest. */ username: string; } /** * Defines the resource properties. */ interface HardwareProfileResponse { /** * Gets or sets the number of vCPUs for the vm. */ cpuCount?: number; /** * Gets or sets a value indicating whether to enable dynamic memory or not. */ dynamicMemoryEnabled?: string; /** * Gets or sets the max dynamic memory for the vm. */ dynamicMemoryMaxMB?: number; /** * Gets or sets the min dynamic memory for the vm. */ dynamicMemoryMinMB?: number; /** * Gets highly available property. */ isHighlyAvailable?: string; /** * Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs. */ limitCpuForMigration?: string; /** * MemoryMB is the size of a virtual machine's memory, in MB. */ memoryMB?: number; } /** * HTTP Proxy configuration for the VM. */ interface HttpProxyConfigurationResponse { /** * Gets or sets httpsProxy url. */ httpsProxy?: string; } /** * Managed service identity. */ interface IdentityResponse { /** * The principal id of managed service identity. */ principalId: string; /** * The tenant of managed service identity. */ tenantId: string; /** * The type of managed service identity. */ type: string; } /** * Specifies the vmmServer infrastructure specific settings for the virtual machine instance. */ interface InfrastructureProfileResponse { /** * Gets or sets the bios guid for the vm. */ biosGuid?: string; /** * Type of checkpoint supported for the vm. */ checkpointType?: string; /** * Checkpoints in the vm. */ checkpoints?: outputs.scvmm.CheckpointResponse[]; /** * ARM Id of the cloud resource to use for deploying the vm. */ cloudId?: string; /** * Gets or sets the generation for the vm. */ generation?: number; /** * Gets or sets the inventory Item ID for the resource. */ inventoryItemId?: string; /** * Last restored checkpoint in the vm. */ lastRestoredVMCheckpoint: outputs.scvmm.CheckpointResponse; /** * ARM Id of the template resource to use for deploying the vm. */ templateId?: string; /** * Unique ID of the virtual machine. */ uuid?: string; /** * VMName is the name of VM on the SCVMM server. */ vmName?: string; /** * ARM Id of the vmmServer resource in which this resource resides. */ vmmServerId?: string; } /** * Instance view status. */ interface MachineExtensionInstanceViewResponseStatus { /** * The status code. */ code: string; /** * The short localizable label for the status. */ displayStatus: string; /** * The level code. */ level: string; /** * The detailed status message, including for alerts and error messages. */ message: string; /** * The time of the status. */ time: string; } /** * The machine extension instance view. */ interface MachineExtensionPropertiesResponseInstanceView { /** * The machine extension name. */ name: string; /** * Instance view status. */ status?: outputs.scvmm.MachineExtensionInstanceViewResponseStatus; /** * Specifies the type of the extension; an example is "CustomScriptExtension". */ type: string; /** * Specifies the version of the script handler. */ typeHandlerVersion: string; } /** * Network Interface model */ interface NetworkInterfacesResponse { /** * Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set. */ displayName: string; /** * Gets or sets the ipv4 address type. */ ipv4AddressType?: string; /** * Gets or sets the nic ipv4 addresses. */ ipv4Addresses: string[]; /** * Gets or sets the ipv6 address type. */ ipv6AddressType?: string; /** * Gets or sets the nic ipv6 addresses. */ ipv6Addresses: string[]; /** * Gets or sets the nic MAC address. */ macAddress?: string; /** * Gets or sets the mac address type. */ macAddressType?: string; /** * Gets or sets the name of the network interface. */ name?: string; /** * Gets or sets the name of the virtual network in vmmServer that the nic is connected to. */ networkName: string; /** * Gets or sets the nic id. */ nicId?: string; /** * Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. */ virtualNetworkId?: string; } /** * Defines the resource properties. */ interface NetworkProfileResponse { /** * Gets or sets the list of network interfaces associated with the virtual machine. */ networkInterfaces?: outputs.scvmm.NetworkInterfacesResponse[]; } /** * Defines the resource properties. */ interface OsProfileForVMInstanceResponse { /** * Gets or sets computer name. */ computerName?: string; /** * Gets or sets os sku. */ osSku: string; /** * Gets or sets the type of the os. */ osType: string; /** * Gets os version. */ osVersion: string; } /** * Defines the resource properties. */ interface OsProfileResponse { /** * Gets or sets computer name. */ computerName?: string; /** * Gets or sets os name. */ osName: string; /** * Gets or sets the type of the os. */ osType: string; } /** * Defines the resource properties. */ interface StorageProfileResponse { /** * Gets or sets the list of virtual disks associated with the virtual machine. */ disks?: outputs.scvmm.VirtualDiskResponse[]; } /** * The StorageQoSPolicyDetails definition. */ interface StorageQoSPolicyDetailsResponse { /** * The ID of the QoS policy. */ id?: string; /** * The name of the policy. */ name?: string; } /** * The StorageQoSPolicy definition. */ interface StorageQoSPolicyResponse { /** * The Bandwidth Limit for internet traffic. */ bandwidthLimit?: number; /** * The ID of the QoS policy. */ id?: string; /** * The maximum IO operations per second. */ iopsMaximum?: number; /** * The minimum IO operations per second. */ iopsMinimum?: number; /** * The name of the policy. */ name?: string; /** * The underlying policy. */ policyId?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Credentials to connect to VMMServer. */ interface VMMServerPropertiesResponseCredentials { /** * Username to use to connect to VMMServer. */ username?: string; } /** * Virtual disk model */ interface VirtualDiskResponse { /** * Gets or sets the disk bus. */ bus?: number; /** * Gets or sets the disk bus type. */ busType?: string; /** * Gets or sets a value indicating diff disk. */ createDiffDisk?: string; /** * Gets or sets the disk id. */ diskId?: string; /** * Gets or sets the disk total size. */ diskSizeGB?: number; /** * Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set. */ displayName: string; /** * Gets or sets the disk lun. */ lun?: number; /** * Gets or sets the max disk size. */ maxDiskSizeGB: number; /** * Gets or sets the name of the disk. */ name?: string; /** * The QoS policy for the disk. */ storageQoSPolicy?: outputs.scvmm.StorageQoSPolicyDetailsResponse; /** * Gets or sets the disk id in the template. */ templateDiskId?: string; /** * Gets the disk vhd format type. */ vhdFormatType: string; /** * Gets or sets the disk vhd type. */ vhdType?: string; /** * Gets or sets the disk volume type. */ volumeType: string; } /** * Availability Set model */ interface VirtualMachineInstancePropertiesResponseAvailabilitySets { /** * Gets the ARM Id of the microsoft.scvmm/availabilitySets resource. */ id?: string; /** * Gets or sets the name of the availability set. */ name?: string; } /** * Availability Set model */ interface VirtualMachinePropertiesResponseAvailabilitySets { /** * Gets the ARM Id of the microsoft.scvmm/availabilitySets resource. */ id?: string; /** * Gets or sets the name of the availability set. */ name?: string; } } export declare namespace search { /** * Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. */ interface DataPlaneAadOrApiKeyAuthOptionResponse { /** * Describes what response the data plane API of a search service would send for requests that failed authentication. */ aadAuthFailureMode?: string; } /** * Defines the options for how the search service authenticates a data plane request. This cannot be set if 'disableLocalAuth' is set to true. */ interface DataPlaneAuthOptionsResponse { /** * Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be used for authentication. */ aadOrApiKey?: outputs.search.DataPlaneAadOrApiKeyAuthOptionResponse; /** * Indicates that only the API key can be used for authentication. */ apiKeyOnly?: any; } /** * Describes a policy that determines how resources within the search service are to be encrypted with customer managed keys. */ interface EncryptionWithCmkResponse { /** * Returns the status of search service compliance with respect to non-CMK-encrypted objects. If a service has more than one unencrypted object, and enforcement is enabled, the service is marked as noncompliant. */ encryptionComplianceStatus: string; /** * Describes how a search service should enforce compliance if it finds objects that aren't encrypted with the customer-managed key. */ enforcement?: string; } /** * Details about the search service identity. A null value indicates that the search service has no identity assigned. */ interface IdentityResponse { /** * The principal ID of the system-assigned identity of the search service. */ principalId: string; /** * The tenant ID of the system-assigned identity of the search service. */ tenantId: string; /** * The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an identity created by the system and a set of user assigned identities. The type 'None' will remove all identities from the service. */ type: string; /** * The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource IDs in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.search.UserAssignedIdentityResponse; }; } /** * The IP restriction rule of the Azure AI Search service. */ interface IpRuleResponse { /** * Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in CIDR format (eg., 123.1.2.3/24) to be allowed. */ value?: string; } /** * Network specific rules that determine how the Azure AI Search service may be reached. */ interface NetworkRuleSetResponse { /** * Possible origins of inbound traffic that can bypass the rules defined in the 'ipRules' section. */ bypass?: string; /** * A list of IP restriction rules that defines the inbound network(s) with allowing access to the search service endpoint. At the meantime, all other public IP networks are blocked by the firewall. These restriction rules are applied only when the 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public interface is not allowed even with any public IP rules, and private endpoint connections would be the exclusive access method. */ ipRules?: outputs.search.IpRuleResponse[]; } /** * The private endpoint resource from Microsoft.Network provider. */ interface PrivateEndpointConnectionPropertiesPrivateEndpointResponse { /** * The resource ID of the private endpoint resource from Microsoft.Network provider. */ id?: string; } /** * Describes the current state of an existing Azure Private Link service connection to the private endpoint. */ interface PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateResponse { /** * A description of any extra actions that may be required. */ actionsRequired?: string; /** * The description for the private link service connection state. */ description?: string; /** * Status of the the private link service connection. Valid values are Pending, Approved, Rejected, or Disconnected. */ status?: string; } /** * privateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateResponseProvideDefaults sets the appropriate defaults for PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateResponse */ function privateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateResponseProvideDefaults(val: PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateResponse): PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateResponse; /** * Describes the properties of an existing private endpoint connection to the search service. */ interface PrivateEndpointConnectionPropertiesResponse { /** * The group ID of the Azure resource for which the private link service is for. */ groupId?: string; /** * The private endpoint resource from Microsoft.Network provider. */ privateEndpoint?: outputs.search.PrivateEndpointConnectionPropertiesPrivateEndpointResponse; /** * Describes the current state of an existing Azure Private Link service connection to the private endpoint. */ privateLinkServiceConnectionState?: outputs.search.PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private link service connection. Valid values are Updating, Deleting, Failed, Succeeded, Incomplete, or Canceled. */ provisioningState?: string; } /** * privateEndpointConnectionPropertiesResponseProvideDefaults sets the appropriate defaults for PrivateEndpointConnectionPropertiesResponse */ function privateEndpointConnectionPropertiesResponseProvideDefaults(val: PrivateEndpointConnectionPropertiesResponse): PrivateEndpointConnectionPropertiesResponse; /** * Describes an existing private endpoint connection to the Azure AI Search service. */ interface PrivateEndpointConnectionResponse { /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * Describes the properties of an existing private endpoint connection to the Azure AI Search service. */ properties?: outputs.search.PrivateEndpointConnectionPropertiesResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.search.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * privateEndpointConnectionResponseProvideDefaults sets the appropriate defaults for PrivateEndpointConnectionResponse */ function privateEndpointConnectionResponseProvideDefaults(val: PrivateEndpointConnectionResponse): PrivateEndpointConnectionResponse; /** * Describes an API key for a given Azure AI Search service that conveys read-only permissions on the docs collection of an index. */ interface QueryKeyResponse { /** * The value of the query API key. */ key: string; /** * The name of the query API key. Query names are optional, but assigning a name can help you remember how it's used. */ name: string; } /** * Describes the properties of an existing shared private link resource managed by the Azure AI Search service. */ interface SharedPrivateLinkResourcePropertiesResponse { /** * The group ID from the provider of resource the shared private link resource is for. */ groupId?: string; /** * The resource ID of the resource the shared private link resource is for. */ privateLinkResourceId?: string; /** * The provisioning state of the shared private link resource. Valid values are Updating, Deleting, Failed, Succeeded or Incomplete. */ provisioningState?: string; /** * The message for requesting approval of the shared private link resource. */ requestMessage?: string; /** * Optional. Can be used to specify the Azure Resource Manager location of the resource for which a shared private link is being created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service). */ resourceRegion?: string; /** * Status of the shared private link resource. Valid values are Pending, Approved, Rejected or Disconnected. */ status?: string; } /** * Describes a shared private link resource managed by the Azure AI Search service. */ interface SharedPrivateLinkResourceResponse { /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * Describes the properties of a shared private link resource managed by the Azure AI Search service. */ properties?: outputs.search.SharedPrivateLinkResourcePropertiesResponse; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.search.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Defines the SKU of a search service, which determines billing rate and capacity limits. */ interface SkuResponse { /** * The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 partitions and 12 replicas. 'standard2': Similar to standard, but with more capacity per search unit. 'standard3': The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions with more indexes if you also set the hostingMode property to 'highDensity'). 'storage_optimized_l1': Supports 1TB per partition, up to 12 partitions. 'storage_optimized_l2': Supports 2TB per partition, up to 12 partitions. 'serverless': Serverless tier with auto-scaling capabilities. */ name?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace secretsynccontroller { /** * The complex type of the extended location. */ interface ExtendedLocationResponse { /** * The name of the extended location. */ name: string; /** * The type of the extended location. */ type: string; } /** * Properties defining the mapping between a cloud secret store object and a Kubernetes Secret. */ interface KubernetesSecretObjectMappingResponse { /** * SourcePath is the identifier for the secret data as defined by the external secret provider. This is the key or path to the secret in the provider's system, which gets mounted to a specific path in the pod. The value should match the name of the secret as specified in the SecretProviderClass's objects array. */ sourcePath: string; /** * TargetKey is the key in the Kubernetes secret's data field where the secret value will be stored. This key is used to reference the secret data within Kubernetes, and it should be unique within the secret. */ targetKey: string; } /** * A condition represents the status of the secret create and update processes. */ interface SecretSyncConditionResponse { /** * LastTransitionTime is the last time the condition transitioned from one status to another. This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable. */ lastTransitionTime: string; /** * Message is a human readable message indicating details about the transition. This may be an empty string. */ message: string; /** * ObservedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance. */ observedGeneration: number; /** * Reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty. */ reason: string; /** * Status of the condition, one of True, False, Unknown. */ status: string; /** * Type of condition in CamelCase or in foo.example.com/CamelCase. Many .condition.type values are consistent across resources like Available, but because arbitrary conditions can be useful (see .node.status.conditions), the ability to de-conflict is important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt) */ type: string; } /** * SecretSyncStatus defines the observed state of the secret synchronization process. */ interface SecretSyncStatusResponse { /** * Conditions represent the status of the secret create and update processes. The status can be True, False, or Unknown with various reasons and messages explaining the state. Examples of reasons include CreateSucceeded, ProviderError, InvalidClusterSecretLabelError, InvalidClusterSecretAnnotationError, UnknownError, ValidatingAdmissionPolicyCheckFailed, UserInputValidationFailed, ControllerSpcError, ControllerInternalError, NoValueChange, and ValueChangeOrForceUpdateDetected. */ conditions: outputs.secretsynccontroller.SecretSyncConditionResponse[]; /** * LastSuccessfulSyncTime represents the last time the secret was retrieved from the Provider and updated. */ lastSuccessfulSyncTime: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace security { /** * The environment authentication details */ interface AccessTokenAuthenticationResponse { /** * The access token that will be used while authenticating with the onboarded environment */ accessToken?: string; /** * The authentication type * Expected value is 'AccessToken'. */ authenticationType: "AccessToken"; /** * The user name that will be used while authenticating with the onboarded environment */ username?: string; } /** * Configuration payload for PR Annotations. */ interface ActionableRemediationResponse { /** * Repository branch configuration for PR Annotations. */ branchConfiguration?: outputs.security.TargetBranchConfigurationResponse; /** * Gets or sets list of categories and severity levels. */ categoryConfigurations?: outputs.security.CategoryConfigurationResponse[]; /** * Update Settings. * * Enabled - Resource should inherit configurations from parent. * Disabled - Resource should not inherit configurations from parent. */ inheritFromParentState?: string; /** * ActionableRemediation Setting. * None - the setting was never set. * Enabled - ActionableRemediation is enabled. * Disabled - ActionableRemediation is disabled. */ state?: string; } /** * Properties of the additional workspaces. */ interface AdditionalWorkspacesPropertiesResponse { /** * List of data types sent to workspace */ dataTypes?: string[]; /** * Workspace type. */ type?: string; /** * Workspace resource id */ workspace?: string; } /** * additionalWorkspacesPropertiesResponseProvideDefaults sets the appropriate defaults for AdditionalWorkspacesPropertiesResponse */ function additionalWorkspacesPropertiesResponseProvideDefaults(val: AdditionalWorkspacesPropertiesResponse): AdditionalWorkspacesPropertiesResponse; /** * A custom alert rule that checks if a value (depends on the custom alert type) is allowed. */ interface AllowlistCustomAlertRuleResponse { /** * The values to allow. The format of the values depends on the rule type. */ allowlistValues: string[]; /** * The description of the custom alert. */ description: string; /** * The display name of the custom alert. */ displayName: string; /** * Status of the custom alert. */ isEnabled: boolean; /** * The type of the custom alert rule. * Expected value is 'AllowlistCustomAlertRule'. */ ruleType: "AllowlistCustomAlertRule"; /** * The value type of the items in the list. */ valueType: string; } /** * Configuration for servers Arc auto provisioning for a given environment */ interface ArcAutoProvisioningConfigurationResponse { /** * Optional Arc private link scope resource id to link the Arc agent */ privateLinkScope?: string; /** * Optional HTTP proxy endpoint to use for the Arc agent */ proxy?: string; } /** * Links relevant to the assessment */ interface AssessmentLinksResponse { /** * Link to assessment in Azure Portal */ azurePortalUri: string; } /** * The result of the assessment */ interface AssessmentStatusResponseResponse { /** * Programmatic code for the cause of the assessment status */ cause?: string; /** * Programmatic code for the status of the assessment */ code: string; /** * Human readable description of the assessment status */ description?: string; /** * The time that the assessment was created and first evaluated. Returned as UTC time in ISO 8601 format */ firstEvaluationDate: string; /** * The time that the status of the assessment last changed. Returned as UTC time in ISO 8601 format */ statusChangeDate: string; } /** * Describe the properties of a security assessment object reference (by key) */ interface AssignedAssessmentItemResponse { /** * Unique key to a security assessment object */ assessmentKey?: string; } /** * describe the properties of a security assessment object reference (by key) */ interface AssignedComponentItemResponse { /** * unique key to a security assessment object */ key?: string; } /** * Describe the properties of a of a standard assignments object reference */ interface AssignedStandardItemResponse { /** * Full resourceId of the Microsoft.Security/standard object */ id?: string; } /** * Additional data about the assignment */ interface AssignmentPropertiesAdditionalDataResponse { /** * Exemption category of this assignment */ exemptionCategory?: string; } /** * Describe the properties of a assignment attestation */ interface AttestationEvidenceResponse { /** * The description of the evidence */ description?: string; /** * The source url of the evidence */ sourceUrl?: string; } /** * Authorization payload. */ interface AuthorizationResponse { /** * Gets or sets one-time OAuth code to exchange for refresh and access tokens. * * Only used during PUT/PATCH operations. The secret is cleared during GET. */ code?: string; } /** * The target Event Hub to which event data will be exported. To learn more about Microsoft Defender for Cloud continuous export capabilities, visit https://aka.ms/ASCExportLearnMore */ interface AutomationActionEventHubResponse { /** * Enum. Indicates the action type. * Expected value is 'EventHub'. */ actionType: "EventHub"; /** * The target Event Hub connection string (it will not be included in any response). */ connectionString?: string; /** * The target Event Hub Azure Resource ID. */ eventHubResourceId?: string; /** * Indicates whether the trusted service is enabled or not. */ isTrustedServiceEnabled?: boolean; /** * The target Event Hub SAS policy name. */ sasPolicyName: string; } /** * The logic app action that should be triggered. To learn more about Microsoft Defender for Cloud's Workflow Automation capabilities, visit https://aka.ms/ASCWorkflowAutomationLearnMore */ interface AutomationActionLogicAppResponse { /** * Enum. Indicates the action type. * Expected value is 'LogicApp'. */ actionType: "LogicApp"; /** * The triggered Logic App Azure Resource ID. This can also reside on other subscriptions, given that you have permissions to trigger the Logic App */ logicAppResourceId?: string; /** * The Logic App trigger URI endpoint (it will not be included in any response). */ uri?: string; } /** * The Log Analytics Workspace to which event data will be exported. Security alerts data will reside in the 'SecurityAlert' table and the assessments data will reside in the 'SecurityRecommendation' table (under the 'Security'/'SecurityCenterFree' solutions). Note that in order to view the data in the workspace, the Security Center Log Analytics free/standard solution needs to be enabled on that workspace. To learn more about Microsoft Defender for Cloud continuous export capabilities, visit https://aka.ms/ASCExportLearnMore */ interface AutomationActionWorkspaceResponse { /** * Enum. Indicates the action type. * Expected value is 'Workspace'. */ actionType: "Workspace"; /** * The fully qualified Log Analytics Workspace Azure Resource ID. */ workspaceResourceId?: string; } /** * A rule set which evaluates all its rules upon an event interception. Only when all the included rules in the rule set will be evaluated as 'true', will the event trigger the defined actions. */ interface AutomationRuleSetResponse { rules?: outputs.security.AutomationTriggeringRuleResponse[]; } /** * A single automation scope. */ interface AutomationScopeResponse { /** * The resources scope description. */ description?: string; /** * The resources scope path. Can be the subscription on which the automation is defined on or a resource group under that subscription (fully qualified Azure resource IDs). */ scopePath?: string; } /** * The source event types which evaluate the security automation set of rules. For example - security alerts and security assessments. To learn more about the supported security events data models schemas - please visit https://aka.ms/ASCAutomationSchemas. */ interface AutomationSourceResponse { /** * A valid event source type. */ eventSource?: string; /** * A set of rules which evaluate upon event interception. A logical disjunction is applied between defined rule sets (logical 'or'). */ ruleSets?: outputs.security.AutomationRuleSetResponse[]; } /** * A rule which is evaluated upon event interception. The rule is configured by comparing a specific value from the event model to an expected value. This comparison is done by using one of the supported operators set. */ interface AutomationTriggeringRuleResponse { /** * The expected value. */ expectedValue?: string; /** * A valid comparer operator to use. A case-insensitive comparison will be applied for String PropertyType. */ operator?: string; /** * The JPath of the entity model property that should be checked. */ propertyJPath?: string; /** * The data type of the compared operands (string, integer, floating point number or a boolean [true/false]] */ propertyType?: string; } /** * The AWS connector environment data */ interface AwsEnvironmentDataResponse { /** * The AWS account name */ accountName: string; /** * The type of the environment data. * Expected value is 'AwsAccount'. */ environmentType: "AwsAccount"; /** * The AWS account's organizational data */ organizationalData?: outputs.security.AwsOrganizationalDataMasterResponse | outputs.security.AwsOrganizationalDataMemberResponse; /** * list of regions to scan */ regions?: string[]; /** * Scan interval in hours (value should be between 1-hour to 24-hours) */ scanInterval?: number; } /** * The AWS organization data for the master account */ interface AwsOrganizationalDataMasterResponse { /** * If the multi cloud account is of membership type organization, list of accounts excluded from offering */ excludedAccountIds?: string[]; /** * The multi cloud account's membership type in the organization * Expected value is 'Organization'. */ organizationMembershipType: "Organization"; /** * If the multi cloud account is of membership type organization, this will be the name of the onboarding stackset */ stacksetName?: string; } /** * The AWS organization data for the member account */ interface AwsOrganizationalDataMemberResponse { /** * The multi cloud account's membership type in the organization * Expected value is 'Member'. */ organizationMembershipType: "Member"; /** * If the multi cloud account is not of membership type organization, this will be the ID of the account's parent */ parentHierarchyId?: string; } /** * Azure DevOps Organization properties. */ interface AzureDevOpsOrgPropertiesResponse { /** * Configuration payload for PR Annotations. */ actionableRemediation?: outputs.security.ActionableRemediationResponse; /** * Details about resource onboarding status across all connectors. * * OnboardedByOtherConnector - this resource has already been onboarded to another connector. This is only applicable to top-level resources. * Onboarded - this resource has already been onboarded by the specified connector. * NotOnboarded - this resource has not been onboarded to any connector. * NotApplicable - the onboarding state is not applicable to the current endpoint. */ onboardingState?: string; /** * The provisioning state of the resource. * * Pending - Provisioning pending. * Failed - Provisioning failed. * Succeeded - Successful provisioning. * Canceled - Provisioning canceled. * PendingDeletion - Deletion pending. * DeletionSuccess - Deletion successful. * DeletionFailure - Deletion failure. */ provisioningState?: string; /** * Gets or sets resource status message. */ provisioningStatusMessage: string; /** * Gets or sets time when resource was last checked. */ provisioningStatusUpdateTimeUtc: string; } /** * Azure DevOps Organization resource. */ interface AzureDevOpsOrgResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * Azure DevOps Organization properties. */ properties?: outputs.security.AzureDevOpsOrgPropertiesResponse; /** * Metadata pertaining to creation and last modification of the resource. */ systemData: outputs.security.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The AzureDevOps scope connector's environment data */ interface AzureDevOpsScopeEnvironmentDataResponse { /** * The type of the environment data. * Expected value is 'AzureDevOpsScope'. */ environmentType: "AzureDevOpsScope"; } /** * Details of the Azure resource that was assessed */ interface AzureResourceDetailsResponse { /** * Azure resource Id of the assessed resource */ id: string; /** * The platform where the assessed resource resides * Expected value is 'Azure'. */ source: "Azure"; } /** * Severity level per category configuration for PR Annotations. */ interface CategoryConfigurationResponse { /** * Rule categories. * Code - code scanning results. * Artifact scanning results. * Dependencies scanning results. * IaC results. * Secrets scanning results. * Container scanning results. */ category?: string; /** * Gets or sets minimum severity level for a given category. */ minimumSeverityLevel?: string; } /** * The native cloud connection configuration */ interface CspmMonitorAwsOfferingNativeCloudConnectionResponse { /** * The cloud role ARN in AWS for this feature */ cloudRoleArn?: string; } /** * The CSPM monitoring for AWS offering */ interface CspmMonitorAwsOfferingResponse { /** * The offering description. */ description: string; /** * The native cloud connection configuration */ nativeCloudConnection?: outputs.security.CspmMonitorAwsOfferingNativeCloudConnectionResponse; /** * The type of the security offering. * Expected value is 'CspmMonitorAws'. */ offeringType: "CspmMonitorAws"; } /** * The CSPM monitoring for AzureDevOps offering */ interface CspmMonitorAzureDevOpsOfferingResponse { /** * The offering description. */ description: string; /** * The type of the security offering. * Expected value is 'CspmMonitorAzureDevOps'. */ offeringType: "CspmMonitorAzureDevOps"; } /** * The CSPM (Cloud security posture management) monitoring for Docker Hub offering */ interface CspmMonitorDockerHubOfferingResponse { /** * The offering description. */ description: string; /** * The type of the security offering. * Expected value is 'CspmMonitorDockerHub'. */ offeringType: "CspmMonitorDockerHub"; } /** * The native cloud connection configuration */ interface CspmMonitorGcpOfferingNativeCloudConnectionResponse { /** * The service account email address in GCP for this offering */ serviceAccountEmailAddress?: string; /** * The GCP workload identity provider id for the offering */ workloadIdentityProviderId?: string; } /** * The CSPM monitoring for GCP offering */ interface CspmMonitorGcpOfferingResponse { /** * The offering description. */ description: string; /** * The native cloud connection configuration */ nativeCloudConnection?: outputs.security.CspmMonitorGcpOfferingNativeCloudConnectionResponse; /** * The type of the security offering. * Expected value is 'CspmMonitorGcp'. */ offeringType: "CspmMonitorGcp"; } /** * The CSPM (Cloud security posture management) monitoring for gitlab offering */ interface CspmMonitorGitLabOfferingResponse { /** * The offering description. */ description: string; /** * The type of the security offering. * Expected value is 'CspmMonitorGitLab'. */ offeringType: "CspmMonitorGitLab"; } /** * The CSPM monitoring for github offering */ interface CspmMonitorGithubOfferingResponse { /** * The offering description. */ description: string; /** * The type of the security offering. * Expected value is 'CspmMonitorGithub'. */ offeringType: "CspmMonitorGithub"; } /** * The CSPM (Cloud security posture management) monitoring for JFrog Artifactory offering */ interface CspmMonitorJFrogOfferingResponse { /** * The offering description. */ description: string; /** * The type of the security offering. * Expected value is 'CspmMonitorJFrog'. */ offeringType: "CspmMonitorJFrog"; } /** * Defender CSPM Permissions Management discovery configuration */ interface DefenderCspmAwsOfferingCiemCiemDiscoveryResponse { /** * The cloud role ARN in AWS for Permissions Management discovery */ cloudRoleArn?: string; } /** * AWS Defender CSPM Permissions Management OIDC (open id connect) connection configurations */ interface DefenderCspmAwsOfferingCiemCiemOidcResponse { /** * the azure active directory app name used of authenticating against AWS */ azureActiveDirectoryAppName?: string; /** * The cloud role ARN in AWS for Permissions Management used for oidc connection */ cloudRoleArn?: string; } /** * Defenders CSPM Permissions Management offering configurations */ interface DefenderCspmAwsOfferingCiemResponse { /** * Defender CSPM Permissions Management discovery configuration */ ciemDiscovery?: outputs.security.DefenderCspmAwsOfferingCiemCiemDiscoveryResponse; /** * AWS Defender CSPM Permissions Management OIDC (open id connect) connection configurations */ ciemOidc?: outputs.security.DefenderCspmAwsOfferingCiemCiemOidcResponse; } /** * The Microsoft Defender Data Sensitivity discovery configuration */ interface DefenderCspmAwsOfferingDataSensitivityDiscoveryResponse { /** * The cloud role ARN in AWS for this feature */ cloudRoleArn?: string; /** * Is Microsoft Defender Data Sensitivity discovery enabled */ enabled?: boolean; } /** * The databases DSPM configuration */ interface DefenderCspmAwsOfferingDatabasesDspmResponse { /** * The cloud role ARN in AWS for this feature */ cloudRoleArn?: string; /** * Is databases DSPM protection enabled */ enabled?: boolean; } /** * The Microsoft Defender container agentless discovery K8s configuration */ interface DefenderCspmAwsOfferingMdcContainersAgentlessDiscoveryK8SResponse { /** * The cloud role ARN in AWS for this feature */ cloudRoleArn?: string; /** * Is Microsoft Defender container agentless discovery K8s enabled */ enabled?: boolean; } /** * The Microsoft Defender container image assessment configuration */ interface DefenderCspmAwsOfferingMdcContainersImageAssessmentResponse { /** * The cloud role ARN in AWS for this feature */ cloudRoleArn?: string; /** * Is Microsoft Defender container image assessment enabled */ enabled?: boolean; } /** * The CSPM P1 for AWS offering */ interface DefenderCspmAwsOfferingResponse { /** * Defenders CSPM Permissions Management offering configurations */ ciem?: outputs.security.DefenderCspmAwsOfferingCiemResponse; /** * The Microsoft Defender Data Sensitivity discovery configuration */ dataSensitivityDiscovery?: outputs.security.DefenderCspmAwsOfferingDataSensitivityDiscoveryResponse; /** * The databases DSPM configuration */ databasesDspm?: outputs.security.DefenderCspmAwsOfferingDatabasesDspmResponse; /** * The offering description. */ description: string; /** * The Microsoft Defender container agentless discovery K8s configuration */ mdcContainersAgentlessDiscoveryK8S?: outputs.security.DefenderCspmAwsOfferingMdcContainersAgentlessDiscoveryK8SResponse; /** * The Microsoft Defender container image assessment configuration */ mdcContainersImageAssessment?: outputs.security.DefenderCspmAwsOfferingMdcContainersImageAssessmentResponse; /** * The type of the security offering. * Expected value is 'DefenderCspmAws'. */ offeringType: "DefenderCspmAws"; /** * The Microsoft Defender for CSPM offering VM scanning configuration */ vmScanners?: outputs.security.DefenderCspmAwsOfferingVmScannersResponse; } /** * The Microsoft Defender for CSPM offering VM scanning configuration */ interface DefenderCspmAwsOfferingVmScannersResponse { /** * The cloud role ARN in AWS for this feature */ cloudRoleArn?: string; /** * Configuration for VM scanning */ configuration?: outputs.security.VmScannersBaseConfigurationResponse; /** * Is VM scanning enabled */ enabled?: boolean; } /** * The Defender for CSPM Docker Hub offering configurations */ interface DefenderCspmDockerHubOfferingResponse { /** * The offering description. */ description: string; /** * The type of the security offering. * Expected value is 'DefenderCspmDockerHub'. */ offeringType: "DefenderCspmDockerHub"; } /** * GCP Defenders CSPM Permissions Management OIDC (Open ID connect) connection configurations */ interface DefenderCspmGcpOfferingCiemDiscoveryResponse { /** * the azure active directory app name used of authenticating against GCP workload identity federation */ azureActiveDirectoryAppName?: string; /** * The service account email address in GCP for Permissions Management offering */ serviceAccountEmailAddress?: string; /** * The GCP workload identity provider id for Permissions Management offering */ workloadIdentityProviderId?: string; } /** * The Microsoft Defender Data Sensitivity discovery configuration */ interface DefenderCspmGcpOfferingDataSensitivityDiscoveryResponse { /** * Is Microsoft Defender Data Sensitivity discovery enabled */ enabled?: boolean; /** * The service account email address in GCP for this feature */ serviceAccountEmailAddress?: string; /** * The workload identity provider id in GCP for this feature */ workloadIdentityProviderId?: string; } /** * The Microsoft Defender Container agentless discovery configuration */ interface DefenderCspmGcpOfferingMdcContainersAgentlessDiscoveryK8SResponse { /** * Is Microsoft Defender container agentless discovery enabled */ enabled?: boolean; /** * The service account email address in GCP for this feature */ serviceAccountEmailAddress?: string; /** * The workload identity provider id in GCP for this feature */ workloadIdentityProviderId?: string; } /** * The Microsoft Defender Container image assessment configuration */ interface DefenderCspmGcpOfferingMdcContainersImageAssessmentResponse { /** * Is Microsoft Defender container image assessment enabled */ enabled?: boolean; /** * The service account email address in GCP for this feature */ serviceAccountEmailAddress?: string; /** * The workload identity provider id in GCP for this feature */ workloadIdentityProviderId?: string; } /** * The CSPM P1 for GCP offering */ interface DefenderCspmGcpOfferingResponse { /** * GCP Defenders CSPM Permissions Management OIDC (Open ID connect) connection configurations */ ciemDiscovery?: outputs.security.DefenderCspmGcpOfferingCiemDiscoveryResponse; /** * The Microsoft Defender Data Sensitivity discovery configuration */ dataSensitivityDiscovery?: outputs.security.DefenderCspmGcpOfferingDataSensitivityDiscoveryResponse; /** * The offering description. */ description: string; /** * The Microsoft Defender Container agentless discovery configuration */ mdcContainersAgentlessDiscoveryK8S?: outputs.security.DefenderCspmGcpOfferingMdcContainersAgentlessDiscoveryK8SResponse; /** * The Microsoft Defender Container image assessment configuration */ mdcContainersImageAssessment?: outputs.security.DefenderCspmGcpOfferingMdcContainersImageAssessmentResponse; /** * The type of the security offering. * Expected value is 'DefenderCspmGcp'. */ offeringType: "DefenderCspmGcp"; /** * The Microsoft Defender for CSPM VM scanning configuration */ vmScanners?: outputs.security.DefenderCspmGcpOfferingVmScannersResponse; } /** * The Microsoft Defender for CSPM VM scanning configuration */ interface DefenderCspmGcpOfferingVmScannersResponse { /** * Configuration for VM scanning */ configuration?: outputs.security.VmScannersBaseConfigurationResponse; /** * Is VM scanning enabled */ enabled?: boolean; } /** * The Microsoft Defender Container image assessment configuration */ interface DefenderCspmJFrogOfferingMdcContainersImageAssessmentResponse { /** * Is Microsoft Defender container image assessment enabled */ enabled?: boolean; } /** * The CSPM P1 for JFrog Artifactory offering */ interface DefenderCspmJFrogOfferingResponse { /** * The offering description. */ description: string; /** * The Microsoft Defender Container image assessment configuration */ mdcContainersImageAssessment?: outputs.security.DefenderCspmJFrogOfferingMdcContainersImageAssessmentResponse; /** * The type of the security offering. * Expected value is 'DefenderCspmJFrog'. */ offeringType: "DefenderCspmJFrog"; } /** * The ARC autoprovisioning configuration */ interface DefenderFoDatabasesAwsOfferingArcAutoProvisioningResponse { /** * The cloud role ARN in AWS for this feature */ cloudRoleArn?: string; /** * Configuration for servers Arc auto provisioning for a given environment */ configuration?: outputs.security.ArcAutoProvisioningConfigurationResponse; /** * Is arc auto provisioning enabled */ enabled?: boolean; } /** * The databases data security posture management (DSPM) configuration */ interface DefenderFoDatabasesAwsOfferingDatabasesDspmResponse { /** * The cloud role ARN in AWS for this feature */ cloudRoleArn?: string; /** * Is databases data security posture management (DSPM) protection enabled */ enabled?: boolean; } /** * The RDS configuration */ interface DefenderFoDatabasesAwsOfferingRdsResponse { /** * The cloud role ARN in AWS for this feature */ cloudRoleArn?: string; /** * Is RDS protection enabled */ enabled?: boolean; } /** * The Defender for Databases AWS offering */ interface DefenderFoDatabasesAwsOfferingResponse { /** * The ARC autoprovisioning configuration */ arcAutoProvisioning?: outputs.security.DefenderFoDatabasesAwsOfferingArcAutoProvisioningResponse; /** * The databases data security posture management (DSPM) configuration */ databasesDspm?: outputs.security.DefenderFoDatabasesAwsOfferingDatabasesDspmResponse; /** * The offering description. */ description: string; /** * The type of the security offering. * Expected value is 'DefenderForDatabasesAws'. */ offeringType: "DefenderForDatabasesAws"; /** * The RDS configuration */ rds?: outputs.security.DefenderFoDatabasesAwsOfferingRdsResponse; } /** * The cloudwatch to kinesis connection configuration */ interface DefenderForContainersAwsOfferingCloudWatchToKinesisResponse { /** * The cloud role ARN in AWS used by CloudWatch to transfer data into Kinesis */ cloudRoleArn?: string; } /** * The kinesis to s3 connection configuration */ interface DefenderForContainersAwsOfferingKinesisToS3Response { /** * The cloud role ARN in AWS used by Kinesis to transfer data into S3 */ cloudRoleArn?: string; } /** * The kubernetes data collection connection configuration */ interface DefenderForContainersAwsOfferingKubernetesDataCollectionResponse { /** * The cloud role ARN in AWS for this feature used for reading data */ cloudRoleArn?: string; } /** * The kubernetes service connection configuration */ interface DefenderForContainersAwsOfferingKubernetesServiceResponse { /** * The cloud role ARN in AWS for this feature used for provisioning resources */ cloudRoleArn?: string; } /** * The Microsoft Defender container agentless discovery K8s configuration */ interface DefenderForContainersAwsOfferingMdcContainersAgentlessDiscoveryK8SResponse { /** * The cloud role ARN in AWS for this feature */ cloudRoleArn?: string; /** * Is Microsoft Defender container agentless discovery K8s enabled */ enabled?: boolean; } /** * The Microsoft Defender container image assessment configuration */ interface DefenderForContainersAwsOfferingMdcContainersImageAssessmentResponse { /** * The cloud role ARN in AWS for this feature */ cloudRoleArn?: string; /** * Is Microsoft Defender container image assessment enabled */ enabled?: boolean; } /** * The Defender for Containers AWS offering */ interface DefenderForContainersAwsOfferingResponse { /** * The cloudwatch to kinesis connection configuration */ cloudWatchToKinesis?: outputs.security.DefenderForContainersAwsOfferingCloudWatchToKinesisResponse; /** * The externalId used by the data reader to prevent the confused deputy attack */ dataCollectionExternalId?: string; /** * The offering description. */ description: string; /** * Is audit logs data collection enabled */ enableAuditLogsAutoProvisioning?: boolean; /** * Is Microsoft Defender for Cloud Kubernetes agent auto provisioning enabled */ enableDefenderAgentAutoProvisioning?: boolean; /** * Is Policy Kubernetes agent auto provisioning enabled */ enablePolicyAgentAutoProvisioning?: boolean; /** * The kinesis to s3 connection configuration */ kinesisToS3?: outputs.security.DefenderForContainersAwsOfferingKinesisToS3Response; /** * The retention time in days of kube audit logs set on the CloudWatch log group */ kubeAuditRetentionTime?: number; /** * The kubernetes data collection connection configuration */ kubernetesDataCollection?: outputs.security.DefenderForContainersAwsOfferingKubernetesDataCollectionResponse; /** * The kubernetes service connection configuration */ kubernetesService?: outputs.security.DefenderForContainersAwsOfferingKubernetesServiceResponse; /** * The Microsoft Defender container agentless discovery K8s configuration */ mdcContainersAgentlessDiscoveryK8S?: outputs.security.DefenderForContainersAwsOfferingMdcContainersAgentlessDiscoveryK8SResponse; /** * The Microsoft Defender container image assessment configuration */ mdcContainersImageAssessment?: outputs.security.DefenderForContainersAwsOfferingMdcContainersImageAssessmentResponse; /** * The type of the security offering. * Expected value is 'DefenderForContainersAws'. */ offeringType: "DefenderForContainersAws"; /** * The Microsoft Defender for Container K8s VM host scanning configuration */ vmScanners?: outputs.security.DefenderForContainersAwsOfferingVmScannersResponse; } /** * The Microsoft Defender for Container K8s VM host scanning configuration */ interface DefenderForContainersAwsOfferingVmScannersResponse { /** * The cloud role ARN in AWS for this feature */ cloudRoleArn?: string; /** * Configuration for VM scanning */ configuration?: outputs.security.VmScannersBaseConfigurationResponse; /** * Is VM scanning enabled */ enabled?: boolean; } /** * The Defender for containers Docker Hub offering configurations */ interface DefenderForContainersDockerHubOfferingResponse { /** * The offering description. */ description: string; /** * The type of the security offering. * Expected value is 'DefenderForContainersDockerHub'. */ offeringType: "DefenderForContainersDockerHub"; } /** * The native cloud connection configuration */ interface DefenderForContainersGcpOfferingDataPipelineNativeCloudConnectionResponse { /** * The data collection service account email address in GCP for this offering */ serviceAccountEmailAddress?: string; /** * The data collection GCP workload identity provider id for this offering */ workloadIdentityProviderId?: string; } /** * The Microsoft Defender Container agentless discovery configuration */ interface DefenderForContainersGcpOfferingMdcContainersAgentlessDiscoveryK8SResponse { /** * Is Microsoft Defender container agentless discovery enabled */ enabled?: boolean; /** * The service account email address in GCP for this feature */ serviceAccountEmailAddress?: string; /** * The workload identity provider id in GCP for this feature */ workloadIdentityProviderId?: string; } /** * The Microsoft Defender Container image assessment configuration */ interface DefenderForContainersGcpOfferingMdcContainersImageAssessmentResponse { /** * Is Microsoft Defender container image assessment enabled */ enabled?: boolean; /** * The service account email address in GCP for this feature */ serviceAccountEmailAddress?: string; /** * The workload identity provider id in GCP for this feature */ workloadIdentityProviderId?: string; } /** * The native cloud connection configuration */ interface DefenderForContainersGcpOfferingNativeCloudConnectionResponse { /** * The service account email address in GCP for this offering */ serviceAccountEmailAddress?: string; /** * The GCP workload identity provider id for this offering */ workloadIdentityProviderId?: string; } /** * The containers GCP offering */ interface DefenderForContainersGcpOfferingResponse { /** * The native cloud connection configuration */ dataPipelineNativeCloudConnection?: outputs.security.DefenderForContainersGcpOfferingDataPipelineNativeCloudConnectionResponse; /** * The offering description. */ description: string; /** * Is audit logs data collection enabled */ enableAuditLogsAutoProvisioning?: boolean; /** * Is Microsoft Defender for Cloud Kubernetes agent auto provisioning enabled */ enableDefenderAgentAutoProvisioning?: boolean; /** * Is Policy Kubernetes agent auto provisioning enabled */ enablePolicyAgentAutoProvisioning?: boolean; /** * The Microsoft Defender Container agentless discovery configuration */ mdcContainersAgentlessDiscoveryK8S?: outputs.security.DefenderForContainersGcpOfferingMdcContainersAgentlessDiscoveryK8SResponse; /** * The Microsoft Defender Container image assessment configuration */ mdcContainersImageAssessment?: outputs.security.DefenderForContainersGcpOfferingMdcContainersImageAssessmentResponse; /** * The native cloud connection configuration */ nativeCloudConnection?: outputs.security.DefenderForContainersGcpOfferingNativeCloudConnectionResponse; /** * The type of the security offering. * Expected value is 'DefenderForContainersGcp'. */ offeringType: "DefenderForContainersGcp"; /** * The Microsoft Defender for Container K8s VM host scanning configuration */ vmScanners?: outputs.security.DefenderForContainersGcpOfferingVmScannersResponse; } /** * The Microsoft Defender for Container K8s VM host scanning configuration */ interface DefenderForContainersGcpOfferingVmScannersResponse { /** * Configuration for VM scanning */ configuration?: outputs.security.VmScannersBaseConfigurationResponse; /** * Is VM scanning enabled */ enabled?: boolean; } /** * The Defender for Containers for JFrog Artifactory offering */ interface DefenderForContainersJFrogOfferingResponse { /** * The offering description. */ description: string; /** * The type of the security offering. * Expected value is 'DefenderForContainersJFrog'. */ offeringType: "DefenderForContainersJFrog"; } /** * The ARC autoprovisioning configuration */ interface DefenderForDatabasesGcpOfferingArcAutoProvisioningResponse { /** * Configuration for servers Arc auto provisioning for a given environment */ configuration?: outputs.security.ArcAutoProvisioningConfigurationResponse; /** * Is arc auto provisioning enabled */ enabled?: boolean; } /** * The native cloud connection configuration */ interface DefenderForDatabasesGcpOfferingDefenderForDatabasesArcAutoProvisioningResponse { /** * The service account email address in GCP for this offering */ serviceAccountEmailAddress?: string; /** * The GCP workload identity provider id for this offering */ workloadIdentityProviderId?: string; } /** * The Defender for Databases GCP offering configurations */ interface DefenderForDatabasesGcpOfferingResponse { /** * The ARC autoprovisioning configuration */ arcAutoProvisioning?: outputs.security.DefenderForDatabasesGcpOfferingArcAutoProvisioningResponse; /** * The native cloud connection configuration */ defenderForDatabasesArcAutoProvisioning?: outputs.security.DefenderForDatabasesGcpOfferingDefenderForDatabasesArcAutoProvisioningResponse; /** * The offering description. */ description: string; /** * The type of the security offering. * Expected value is 'DefenderForDatabasesGcp'. */ offeringType: "DefenderForDatabasesGcp"; } /** * The ARC autoprovisioning configuration */ interface DefenderForServersAwsOfferingArcAutoProvisioningResponse { /** * The cloud role ARN in AWS for this feature */ cloudRoleArn?: string; /** * Configuration for servers Arc auto provisioning for a given environment */ configuration?: outputs.security.ArcAutoProvisioningConfigurationResponse; /** * Is arc auto provisioning enabled */ enabled?: boolean; } /** * The Defender for servers connection configuration */ interface DefenderForServersAwsOfferingDefenderForServersResponse { /** * The cloud role ARN in AWS for this feature */ cloudRoleArn?: string; } /** * The Microsoft Defender for Endpoint autoprovisioning configuration */ interface DefenderForServersAwsOfferingMdeAutoProvisioningResponse { /** * configuration for Microsoft Defender for Endpoint autoprovisioning */ configuration?: any; /** * Is Microsoft Defender for Endpoint auto provisioning enabled */ enabled?: boolean; } /** * The Defender for Servers AWS offering */ interface DefenderForServersAwsOfferingResponse { /** * The ARC autoprovisioning configuration */ arcAutoProvisioning?: outputs.security.DefenderForServersAwsOfferingArcAutoProvisioningResponse; /** * The Defender for servers connection configuration */ defenderForServers?: outputs.security.DefenderForServersAwsOfferingDefenderForServersResponse; /** * The offering description. */ description: string; /** * The Microsoft Defender for Endpoint autoprovisioning configuration */ mdeAutoProvisioning?: outputs.security.DefenderForServersAwsOfferingMdeAutoProvisioningResponse; /** * The type of the security offering. * Expected value is 'DefenderForServersAws'. */ offeringType: "DefenderForServersAws"; /** * configuration for the servers offering subPlan */ subPlan?: outputs.security.DefenderForServersAwsOfferingSubPlanResponse; /** * The Vulnerability Assessment autoprovisioning configuration */ vaAutoProvisioning?: outputs.security.DefenderForServersAwsOfferingVaAutoProvisioningResponse; /** * The Microsoft Defender for Server VM scanning configuration */ vmScanners?: outputs.security.DefenderForServersAwsOfferingVmScannersResponse; } /** * configuration for the servers offering subPlan */ interface DefenderForServersAwsOfferingSubPlanResponse { /** * The available sub plans */ type?: string; } /** * configuration for Vulnerability Assessment autoprovisioning */ interface DefenderForServersAwsOfferingVaAutoProvisioningConfigurationResponse { /** * The Vulnerability Assessment solution to be provisioned. Can be either 'TVM' or 'Qualys' */ type?: string; } /** * The Vulnerability Assessment autoprovisioning configuration */ interface DefenderForServersAwsOfferingVaAutoProvisioningResponse { /** * configuration for Vulnerability Assessment autoprovisioning */ configuration?: outputs.security.DefenderForServersAwsOfferingVaAutoProvisioningConfigurationResponse; /** * Is Vulnerability Assessment auto provisioning enabled */ enabled?: boolean; } /** * The Microsoft Defender for Server VM scanning configuration */ interface DefenderForServersAwsOfferingVmScannersResponse { /** * The cloud role ARN in AWS for this feature */ cloudRoleArn?: string; /** * Configuration for VM scanning */ configuration?: outputs.security.VmScannersBaseConfigurationResponse; /** * Is VM scanning enabled */ enabled?: boolean; } /** * The ARC autoprovisioning configuration */ interface DefenderForServersGcpOfferingArcAutoProvisioningResponse { /** * Configuration for servers Arc auto provisioning for a given environment */ configuration?: outputs.security.ArcAutoProvisioningConfigurationResponse; /** * Is arc auto provisioning enabled */ enabled?: boolean; } /** * The Defender for servers connection configuration */ interface DefenderForServersGcpOfferingDefenderForServersResponse { /** * The service account email address in GCP for this feature */ serviceAccountEmailAddress?: string; /** * The workload identity provider id in GCP for this feature */ workloadIdentityProviderId?: string; } /** * The Microsoft Defender for Endpoint autoprovisioning configuration */ interface DefenderForServersGcpOfferingMdeAutoProvisioningResponse { /** * configuration for Microsoft Defender for Endpoint autoprovisioning */ configuration?: any; /** * Is Microsoft Defender for Endpoint auto provisioning enabled */ enabled?: boolean; } /** * The Defender for Servers GCP offering configurations */ interface DefenderForServersGcpOfferingResponse { /** * The ARC autoprovisioning configuration */ arcAutoProvisioning?: outputs.security.DefenderForServersGcpOfferingArcAutoProvisioningResponse; /** * The Defender for servers connection configuration */ defenderForServers?: outputs.security.DefenderForServersGcpOfferingDefenderForServersResponse; /** * The offering description. */ description: string; /** * The Microsoft Defender for Endpoint autoprovisioning configuration */ mdeAutoProvisioning?: outputs.security.DefenderForServersGcpOfferingMdeAutoProvisioningResponse; /** * The type of the security offering. * Expected value is 'DefenderForServersGcp'. */ offeringType: "DefenderForServersGcp"; /** * configuration for the servers offering subPlan */ subPlan?: outputs.security.DefenderForServersGcpOfferingSubPlanResponse; /** * The Vulnerability Assessment autoprovisioning configuration */ vaAutoProvisioning?: outputs.security.DefenderForServersGcpOfferingVaAutoProvisioningResponse; /** * The Microsoft Defender for Server VM scanning configuration */ vmScanners?: outputs.security.DefenderForServersGcpOfferingVmScannersResponse; } /** * configuration for the servers offering subPlan */ interface DefenderForServersGcpOfferingSubPlanResponse { /** * The available sub plans */ type?: string; } /** * configuration for Vulnerability Assessment autoprovisioning */ interface DefenderForServersGcpOfferingVaAutoProvisioningConfigurationResponse { /** * The Vulnerability Assessment solution to be provisioned. Can be either 'TVM' or 'Qualys' */ type?: string; } /** * The Vulnerability Assessment autoprovisioning configuration */ interface DefenderForServersGcpOfferingVaAutoProvisioningResponse { /** * configuration for Vulnerability Assessment autoprovisioning */ configuration?: outputs.security.DefenderForServersGcpOfferingVaAutoProvisioningConfigurationResponse; /** * Is Vulnerability Assessment auto provisioning enabled */ enabled?: boolean; } /** * The Microsoft Defender for Server VM scanning configuration */ interface DefenderForServersGcpOfferingVmScannersResponse { /** * Configuration for VM scanning */ configuration?: outputs.security.VmScannersBaseConfigurationResponse; /** * Is VM scanning enabled */ enabled?: boolean; } /** * Defender for Storage resource properties. */ interface DefenderForStorageSettingPropertiesResponse { /** * Indicates whether Defender for Storage is enabled on this storage account. */ isEnabled?: boolean; /** * Properties of Malware Scanning. */ malwareScanning?: outputs.security.MalwareScanningPropertiesResponse; /** * Indicates whether the settings defined for this storage account should override the settings defined for the subscription. */ overrideSubscriptionLevelSettings?: boolean; /** * Properties of Sensitive Data Discovery. */ sensitiveDataDiscovery?: outputs.security.SensitiveDataDiscoveryPropertiesResponse; } /** * A custom alert rule that checks if a value (depends on the custom alert type) is denied. */ interface DenylistCustomAlertRuleResponse { /** * The values to deny. The format of the values depends on the rule type. */ denylistValues: string[]; /** * The description of the custom alert. */ description: string; /** * The display name of the custom alert. */ displayName: string; /** * Status of the custom alert. */ isEnabled: boolean; /** * The type of the custom alert rule. * Expected value is 'DenylistCustomAlertRule'. */ ruleType: "DenylistCustomAlertRule"; /** * The value type of the items in the list. */ valueType: string; } /** * Details about DevOps capability. */ interface DevOpsCapabilityResponse { /** * Gets the name of the DevOps capability. */ name: string; /** * Gets the value of the DevOps capability. */ value: string; } /** * DevOps Configuration properties. */ interface DevOpsConfigurationPropertiesResponse { /** * Authorization payload. */ authorization?: outputs.security.AuthorizationResponse; /** * AutoDiscovery states. */ autoDiscovery?: string; /** * List of capabilities assigned to the DevOps configuration during the discovery process. */ capabilities: outputs.security.DevOpsCapabilityResponse[]; /** * The provisioning state of the resource. * * Pending - Provisioning pending. * Failed - Provisioning failed. * Succeeded - Successful provisioning. * Canceled - Provisioning canceled. * PendingDeletion - Deletion pending. * DeletionSuccess - Deletion successful. * DeletionFailure - Deletion failure. */ provisioningState?: string; /** * Gets or sets resource status message. */ provisioningStatusMessage: string; /** * Gets or sets time when resource was last checked. */ provisioningStatusUpdateTimeUtc: string; /** * List of top-level inventory to select when AutoDiscovery is disabled. * This field is ignored when AutoDiscovery is enabled. */ topLevelInventoryList?: string[]; } /** * The Docker Hub connector environment data */ interface DockerHubEnvironmentDataResponse { /** * The Docker Hub organization authentication details */ authentication?: outputs.security.AccessTokenAuthenticationResponse; /** * The type of the environment data. * Expected value is 'DockerHubOrganization'. */ environmentType: "DockerHubOrganization"; /** * Scan interval in hours (value should be between 1-hour to 24-hours) */ scanInterval?: number; } /** * A plan's extension properties */ interface ExtensionResponse { /** * Property values associated with the extension. */ additionalExtensionProperties?: any; /** * Indicates whether the extension is enabled. */ isEnabled: string; /** * The extension name. Supported values are:

    **AgentlessDiscoveryForKubernetes** - Provides zero footprint, API-based discovery of Kubernetes clusters, their configurations and deployments. The collected data is used to create a contextualized security graph for Kubernetes clusters, provide risk hunting capabilities, and visualize risks and threats to Kubernetes environments and workloads.
    Available for CloudPosture plan and Containers plan.

    **OnUploadMalwareScanning** - Limits the GB to be scanned per month for each storage account within the subscription. Once this limit reached on a given storage account, Blobs won't be scanned during current calendar month.
    Available for StorageAccounts plan (DefenderForStorageV2 sub plans).

    **SensitiveDataDiscovery** - Sensitive data discovery identifies Blob storage container with sensitive data such as credentials, credit cards, and more, to help prioritize and investigate security events.
    Available for StorageAccounts plan (DefenderForStorageV2 sub plan) and CloudPosture plan.

    **ContainerRegistriesVulnerabilityAssessments** - Provides vulnerability management for images stored in your container registries.
    Available for CloudPosture plan and Containers plan.

    **MdeDesignatedSubscription** - Direct onboarding is a seamless integration between Defender for Endpoint and Defender for Cloud that doesn't require extra software deployment on your servers. The onboarded resources will be presented under a designated Azure Subscription you configure
    Available for VirtualMachines plan (P1 and P2 sub plans).

    **AgentlessVmScanning** - Scans your machines for installed software, vulnerabilities, malware and secret scanning without relying on agents or impacting machine performance. Learn more here https://learn.microsoft.com/en-us/azure/defender-for-cloud/concept-agentless-data-collection.
    Available for CloudPosture plan, VirtualMachines plan (P2 sub plan) and Containers plan.

    **EntraPermissionsManagement** - Permissions Management provides Cloud Infrastructure Entitlement Management (CIEM) capabilities that helps organizations to manage and control user access and entitlements in their cloud infrastructure - important attack vector for cloud environments.
    Permissions Management analyzes all permissions and active usage, and suggests recommendations to reduce permissions to enforce the principle of least privilege. Learn more here https://learn.microsoft.com/en-us/azure/defender-for-cloud/permissions-management.
    Available for CloudPosture plan.

    **FileIntegrityMonitoring** - File integrity monitoring (FIM), examines operating system files.
    Windows registries, Linux system files, in real time, for changes that might indicate an attack.
    Available for VirtualMachines plan (P2 sub plan).

    **ContainerSensor** - The sensor is based on IG and provides a rich threat detection suite for Kubernetes clusters, nodes, and workloads, powered by Microsoft leading threat intelligence, provides mapping to MITRE ATT&CK framework.
    Available for Containers plan.

    **AIPromptEvidence** - Exposes the prompts passed between the user and the AI model as alert evidence. This helps classify and triage the alerts with relevant user context. The prompt snippets will include only segments of the user prompt or model response that were deemed suspicious and relevant for security classifications. The prompt evidence will be available through Defender portal as part of each alert.
    Available for AI plan.

    */ name: string; /** * Optional. A status describing the success/failure of the extension's enablement/disablement operation. */ operationStatus: outputs.security.OperationStatusResponse; } /** * The gcpOrganization data for the member account */ interface GcpOrganizationalDataMemberResponse { /** * The GCP management project number from organizational onboarding */ managementProjectNumber?: string; /** * The multi cloud account's membership type in the organization * Expected value is 'Member'. */ organizationMembershipType: "Member"; /** * If the multi cloud account is not of membership type organization, this will be the ID of the project's parent */ parentHierarchyId?: string; } /** * The gcpOrganization data for the parent account */ interface GcpOrganizationalDataOrganizationResponse { /** * If the multi cloud account is of membership type organization, list of accounts excluded from offering */ excludedProjectNumbers?: string[]; /** * The multi cloud account's membership type in the organization * Expected value is 'Organization'. */ organizationMembershipType: "Organization"; /** * GCP organization name */ organizationName: string; /** * The service account email address which represents the organization level permissions container. */ serviceAccountEmailAddress?: string; /** * The GCP workload identity provider id which represents the permissions required to auto provision security connectors */ workloadIdentityProviderId?: string; } /** * The details about the project represented by the security connector */ interface GcpProjectDetailsResponse { /** * The GCP Project id */ projectId?: string; /** * GCP project name */ projectName: string; /** * The unique GCP Project number */ projectNumber?: string; /** * The GCP workload identity federation pool id */ workloadIdentityPoolId: string; } /** * The GCP project connector environment data */ interface GcpProjectEnvironmentDataResponse { /** * The type of the environment data. * Expected value is 'GcpProject'. */ environmentType: "GcpProject"; /** * The Gcp project's organizational data */ organizationalData?: outputs.security.GcpOrganizationalDataMemberResponse | outputs.security.GcpOrganizationalDataOrganizationResponse; /** * The Gcp project's details */ projectDetails?: outputs.security.GcpProjectDetailsResponse; /** * Scan interval in hours (value should be between 1-hour to 24-hours) */ scanInterval?: number; } /** * GitHub Owner properties. */ interface GitHubOwnerPropertiesResponse { /** * Gets or sets internal GitHub id. */ gitHubInternalId: string; /** * Details about resource onboarding status across all connectors. * * OnboardedByOtherConnector - this resource has already been onboarded to another connector. This is only applicable to top-level resources. * Onboarded - this resource has already been onboarded by the specified connector. * NotOnboarded - this resource has not been onboarded to any connector. * NotApplicable - the onboarding state is not applicable to the current endpoint. */ onboardingState?: string; /** * Gets or sets GitHub Owner url. */ ownerUrl: string; /** * The provisioning state of the resource. * * Pending - Provisioning pending. * Failed - Provisioning failed. * Succeeded - Successful provisioning. * Canceled - Provisioning canceled. * PendingDeletion - Deletion pending. * DeletionSuccess - Deletion successful. * DeletionFailure - Deletion failure. */ provisioningState?: string; /** * Gets or sets resource status message. */ provisioningStatusMessage: string; /** * Gets or sets time when resource was last checked. */ provisioningStatusUpdateTimeUtc: string; } /** * GitHub Owner resource. */ interface GitHubOwnerResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * GitHub Owner properties. */ properties?: outputs.security.GitHubOwnerPropertiesResponse; /** * Metadata pertaining to creation and last modification of the resource. */ systemData: outputs.security.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * GitLab Group properties. */ interface GitLabGroupPropertiesResponse { /** * Gets or sets the human readable fully-qualified name of the Group object. * * This contains the entire namespace hierarchy as seen on GitLab UI where namespaces are separated by the '/' character. */ fullyQualifiedFriendlyName: string; /** * Gets or sets the fully-qualified name of the Group object. * * This contains the entire namespace hierarchy where namespaces are separated by the '$' character. */ fullyQualifiedName: string; /** * Details about resource onboarding status across all connectors. * * OnboardedByOtherConnector - this resource has already been onboarded to another connector. This is only applicable to top-level resources. * Onboarded - this resource has already been onboarded by the specified connector. * NotOnboarded - this resource has not been onboarded to any connector. * NotApplicable - the onboarding state is not applicable to the current endpoint. */ onboardingState?: string; /** * The provisioning state of the resource. * * Pending - Provisioning pending. * Failed - Provisioning failed. * Succeeded - Successful provisioning. * Canceled - Provisioning canceled. * PendingDeletion - Deletion pending. * DeletionSuccess - Deletion successful. * DeletionFailure - Deletion failure. */ provisioningState?: string; /** * Gets or sets resource status message. */ provisioningStatusMessage: string; /** * Gets or sets time when resource was last checked. */ provisioningStatusUpdateTimeUtc: string; /** * Gets or sets the url of the GitLab Group. */ url: string; } /** * GitLab Group resource. */ interface GitLabGroupResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * GitLab Group properties. */ properties?: outputs.security.GitLabGroupPropertiesResponse; /** * Metadata pertaining to creation and last modification of the resource. */ systemData: outputs.security.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The github scope connector's environment data */ interface GithubScopeEnvironmentDataResponse { /** * The type of the environment data. * Expected value is 'GithubScope'. */ environmentType: "GithubScope"; } /** * The GitLab scope connector's environment data */ interface GitlabScopeEnvironmentDataResponse { /** * The type of the environment data. * Expected value is 'GitlabScope'. */ environmentType: "GitlabScope"; } /** * Describe the additional data of governance assignment - optional */ interface GovernanceAssignmentAdditionalDataResponse { /** * Ticket link associated with this governance assignment - for example: https://snow.com */ ticketLink?: string; /** * Ticket number associated with this governance assignment */ ticketNumber?: number; /** * The ticket status associated with this governance assignment - for example: Active */ ticketStatus?: string; } /** * The governance email weekly notification configuration. */ interface GovernanceEmailNotificationResponse { /** * Exclude manager from weekly email notification. */ disableManagerEmailNotification?: boolean; /** * Exclude owner from weekly email notification. */ disableOwnerEmailNotification?: boolean; } /** * The governance email weekly notification configuration */ interface GovernanceRuleEmailNotificationResponse { /** * Defines whether manager email notifications are disabled */ disableManagerEmailNotification?: boolean; /** * Defines whether owner email notifications are disabled */ disableOwnerEmailNotification?: boolean; } /** * The governance rule metadata */ interface GovernanceRuleMetadataResponse { /** * Governance rule Created by object id (GUID) */ createdBy: string; /** * Governance rule creation date */ createdOn: string; /** * Governance rule last updated by object id (GUID) */ updatedBy: string; /** * Governance rule last update date */ updatedOn: string; } /** * Describe the owner source of governance rule */ interface GovernanceRuleOwnerSourceResponse { /** * The owner type for the governance rule owner source */ type?: string; /** * The source value e.g. tag key like owner name or email address */ value?: string; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. The value must be an UUID. */ principalId: string; /** * The tenant ID of resource. The value must be an UUID. */ tenantId: string; /** * The identity type. */ type?: string; } /** * The JFrog Artifactory connector environment data */ interface JFrogEnvironmentDataResponse { /** * The type of the environment data. * Expected value is 'JFrogArtifactory'. */ environmentType: "JFrogArtifactory"; /** * Scan interval in hours (value should be between 1-hour to 24-hours) */ scanInterval?: number; } interface JitNetworkAccessPolicyVirtualMachineResponse { /** * Resource ID of the virtual machine that is linked to this policy */ id: string; /** * Port configurations for the virtual machine */ ports: outputs.security.JitNetworkAccessPortRuleResponse[]; /** * Public IP address of the Azure Firewall that is linked to this policy, if applicable */ publicIpAddress?: string; } interface JitNetworkAccessPortRuleResponse { /** * Mutually exclusive with the "allowedSourceAddressPrefixes" parameter. Should be an IP address or CIDR, for example "192.168.0.3" or "192.168.0.0/16". */ allowedSourceAddressPrefix?: string; /** * Mutually exclusive with the "allowedSourceAddressPrefix" parameter. */ allowedSourceAddressPrefixes?: string[]; /** * Maximum duration requests can be made for. In ISO 8601 duration format. Minimum 5 minutes, maximum 1 day */ maxRequestAccessDuration: string; number: number; protocol: string; } interface JitNetworkAccessRequestPortResponse { /** * Mutually exclusive with the "allowedSourceAddressPrefixes" parameter. Should be an IP address or CIDR, for example "192.168.0.3" or "192.168.0.0/16". */ allowedSourceAddressPrefix?: string; /** * Mutually exclusive with the "allowedSourceAddressPrefix" parameter. */ allowedSourceAddressPrefixes?: string[]; /** * The date & time at which the request ends in UTC */ endTimeUtc: string; /** * The port which is mapped to this port's `number` in the Azure Firewall, if applicable */ mappedPort?: number; number: number; /** * The status of the port */ status: string; /** * A description of why the `status` has its value */ statusReason: string; } interface JitNetworkAccessRequestResponse { /** * The justification for making the initiate request */ justification?: string; /** * The identity of the person who made the request */ requestor: string; /** * The start time of the request in UTC */ startTimeUtc: string; virtualMachines: outputs.security.JitNetworkAccessRequestVirtualMachineResponse[]; } interface JitNetworkAccessRequestVirtualMachineResponse { /** * Resource ID of the virtual machine that is linked to this policy */ id: string; /** * The ports that were opened for the virtual machine */ ports: outputs.security.JitNetworkAccessRequestPortResponse[]; } /** * Properties of Malware Scanning. */ interface MalwareScanningPropertiesResponse { /** * Properties of On Upload malware scanning. */ onUpload?: outputs.security.OnUploadPropertiesResponse; /** * Upon failure or partial success. Additional data describing Malware Scanning enable/disable operation. */ operationStatus: outputs.security.OperationStatusResponse; /** * Optional. Resource id of an Event Grid Topic to send scan results to. */ scanResultsEventGridTopicResourceId?: string; } /** * Alert notification source */ interface NotificationsSourceAlertResponse { /** * Defines the minimal alert severity which will be sent as email notifications */ minimalSeverity?: string; /** * The source type that will trigger the notification * Expected value is 'Alert'. */ sourceType: "Alert"; } /** * Attack path notification source */ interface NotificationsSourceAttackPathResponse { /** * Defines the minimal attach path risk level which will be sent as email notifications */ minimalRiskLevel?: string; /** * The source type that will trigger the notification * Expected value is 'AttackPath'. */ sourceType: "AttackPath"; } /** * Details of the On Premise resource that was assessed */ interface OnPremiseResourceDetailsResponse { /** * The name of the machine */ machineName: string; /** * The platform where the assessed resource resides * Expected value is 'OnPremise'. */ source: "OnPremise"; /** * The oms agent Id installed on the machine */ sourceComputerId: string; /** * The unique Id of the machine */ vmuuid: string; /** * Azure resource Id of the workspace the machine is attached to */ workspaceId: string; } /** * Details of the On Premise Sql resource that was assessed */ interface OnPremiseSqlResourceDetailsResponse { /** * The Sql database name installed on the machine */ databaseName: string; /** * The name of the machine */ machineName: string; /** * The Sql server name installed on the machine */ serverName: string; /** * The platform where the assessed resource resides * Expected value is 'OnPremiseSql'. */ source: "OnPremiseSql"; /** * The oms agent Id installed on the machine */ sourceComputerId: string; /** * The unique Id of the machine */ vmuuid: string; /** * Azure resource Id of the workspace the machine is attached to */ workspaceId: string; } /** * Properties of On Upload malware scanning. */ interface OnUploadPropertiesResponse { /** * Defines the max GB to be scanned per Month. Set to -1 if no capping is needed. */ capGBPerMonth?: number; /** * Indicates whether On Upload malware scanning should be enabled. */ isEnabled?: boolean; } /** * A status describing the success/failure of the enablement/disablement operation. */ interface OperationStatusResponse { /** * The operation status code. */ code?: string; /** * Additional information regarding the success/failure of the operation. */ message?: string; } /** * Describes properties of an assessment as related to the standard */ interface PartialAssessmentPropertiesResponse { /** * The assessment key */ assessmentKey?: string; } /** * The private endpoint connection resource. */ interface PrivateEndpointConnectionResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint resource. */ privateEndpoint?: outputs.security.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.security.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.security.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A private link resource. */ interface PrivateLinkResourceResponse { /** * The private link resource group id. */ groupId: string; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private link resource required member names. */ requiredMembers: string[]; /** * The private link resource private link DNS zone name. */ requiredZoneNames?: string[]; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.security.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * The type of IoT Security recommendation. */ interface RecommendationConfigurationPropertiesResponse { name: string; /** * The type of IoT Security recommendation. */ recommendationType: string; /** * Recommendation status. When the recommendation status is disabled recommendations are not generated. */ status: string; } /** * recommendationConfigurationPropertiesResponseProvideDefaults sets the appropriate defaults for RecommendationConfigurationPropertiesResponse */ function recommendationConfigurationPropertiesResponseProvideDefaults(val: RecommendationConfigurationPropertiesResponse): RecommendationConfigurationPropertiesResponse; /** * The ETA (estimated time of arrival) for remediation */ interface RemediationEtaResponse { /** * ETA for remediation. */ eta: string; /** * Justification for change of Eta. */ justification: string; } /** * Rule results properties. */ interface RuleResultsPropertiesResponse { /** * Expected results in the baseline. */ results?: string[][]; } /** * A more specific scope used to identify the alerts to suppress. */ interface ScopeElementResponse { /** * The alert entity type to suppress by. */ field?: string; } /** * Describes the partner that created the assessment */ interface SecurityAssessmentMetadataPartnerDataResponse { /** * Name of the company of the partner */ partnerName: string; /** * Name of the product of the partner that created the assessment */ productName?: string; /** * Secret to authenticate the partner and verify it created the assessment - write only */ secret: string; } /** * Describes properties of an assessment metadata. */ interface SecurityAssessmentMetadataPropertiesResponse { /** * BuiltIn if the assessment based on built-in Azure Policy definition, Custom if the assessment based on custom Azure Policy definition */ assessmentType: string; categories?: string[]; /** * Human readable description of the assessment */ description?: string; /** * User friendly display name of the assessment */ displayName: string; /** * The implementation effort required to remediate this assessment */ implementationEffort?: string; /** * Describes the partner that created the assessment */ partnerData?: outputs.security.SecurityAssessmentMetadataPartnerDataResponse; /** * Azure resource ID of the policy definition that turns this assessment calculation on */ policyDefinitionId: string; /** * True if this assessment is in preview release status */ preview?: boolean; /** * Human readable description of what you should do to mitigate this security issue */ remediationDescription?: string; /** * The severity level of the assessment */ severity: string; threats?: string[]; /** * The user impact of the assessment */ userImpact?: string; } interface SecurityAssessmentMetadataPropertiesResponseResponsePublishDates { gA?: string; public: string; } /** * Data regarding 3rd party partner integration */ interface SecurityAssessmentPartnerDataResponse { /** * Name of the company of the partner */ partnerName: string; /** * secret to authenticate the partner - write only */ secret: string; } /** * Defines whether to send email notifications from Microsoft Defender for Cloud to persons with specific RBAC roles on the subscription. */ interface SecurityContactPropertiesNotificationsByRoleResponse { /** * Defines which RBAC roles will get email notifications from Microsoft Defender for Cloud. List of allowed RBAC roles: */ roles?: string[]; /** * Defines whether to send email notifications from AMicrosoft Defender for Cloud to persons with specific RBAC roles on the subscription. */ state?: string; } /** * Properties of Sensitive Data Discovery. */ interface SensitiveDataDiscoveryPropertiesResponse { /** * Indicates whether Sensitive Data Discovery should be enabled. */ isEnabled?: boolean; /** * Upon failure or partial success. Additional data describing Sensitive Data Discovery enable/disable operation. */ operationStatus: outputs.security.OperationStatusResponse; } /** * The standard assignment metadata */ interface StandardAssignmentMetadataResponse { /** * Standard assignment Created by object id (GUID) */ createdBy: string; /** * Standard assignment creation date */ createdOn: string; /** * Standard assignment last updated by object id (GUID) */ lastUpdatedBy: string; /** * Standard assignment last update date */ lastUpdatedOn: string; } /** * Additional data about assignment that has Attest effect */ interface StandardAssignmentPropertiesAttestationDataResponse { /** * Component item with key as applied to this standard assignment over the given scope */ assignedAssessment?: outputs.security.AssignedAssessmentItemResponse; /** * Attestation compliance date */ complianceDate: string; /** * Attest category of this assignment */ complianceState?: string; /** * Array of links to attestation evidence */ evidence?: outputs.security.AttestationEvidenceResponse[]; } /** * Additional data about assignment that has Exempt effect */ interface StandardAssignmentPropertiesExemptionDataResponse { /** * Component item with key as applied to this standard assignment over the given scope */ assignedAssessment?: outputs.security.AssignedAssessmentItemResponse; /** * Exemption category of this assignment */ exemptionCategory?: string; } /** * Describes properties of an component as related to the standard */ interface StandardComponentPropertiesResponse { /** * Component Key matching componentMetadata */ key?: string; } /** * The standard metadata */ interface StandardMetadataResponse { /** * Standard Created by object id (GUID) */ createdBy: string; /** * Standard creation date */ createdOn: string; /** * Standard last updated by object id (GUID) */ lastUpdatedBy: string; /** * Standard last update date */ lastUpdatedOn: string; } interface SuppressionAlertsScopeResponse { /** * All the conditions inside need to be true in order to suppress the alert */ allOf: outputs.security.ScopeElementResponse[]; } /** * Managed service identity (either system assigned, or none) */ interface SystemAssignedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (either system assigned, or none). */ type: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Repository branch configuration for PR Annotations. */ interface TargetBranchConfigurationResponse { /** * Configuration of PR Annotations on default branch. * * Enabled - PR Annotations are enabled on the resource's default branch. * Disabled - PR Annotations are disabled on the resource's default branch. */ annotateDefaultBranch?: string; /** * Gets or sets branches that should have annotations. */ branchNames?: string[]; } /** * A custom alert rule that checks if a value (depends on the custom alert type) is within the given range. */ interface ThresholdCustomAlertRuleResponse { /** * The description of the custom alert. */ description: string; /** * The display name of the custom alert. */ displayName: string; /** * Status of the custom alert. */ isEnabled: boolean; /** * The maximum threshold. */ maxThreshold: number; /** * The minimum threshold. */ minThreshold: number; /** * The type of the custom alert rule. * Expected value is 'ThresholdCustomAlertRule'. */ ruleType: "ThresholdCustomAlertRule"; } /** * A custom alert rule that checks if the number of activities (depends on the custom alert type) in a time window is within the given range. */ interface TimeWindowCustomAlertRuleResponse { /** * The description of the custom alert. */ description: string; /** * The display name of the custom alert. */ displayName: string; /** * Status of the custom alert. */ isEnabled: boolean; /** * The maximum threshold. */ maxThreshold: number; /** * The minimum threshold. */ minThreshold: number; /** * The type of the custom alert rule. * Expected value is 'TimeWindowCustomAlertRule'. */ ruleType: "TimeWindowCustomAlertRule"; /** * The time window size in iso8601 format. */ timeWindowSize: string; } /** * Properties of the IoT Security solution's user defined resources. */ interface UserDefinedResourcesPropertiesResponse { /** * Azure Resource Graph query which represents the security solution's user defined resources. Required to start with "where type != "Microsoft.Devices/IotHubs"" */ query: string; /** * List of Azure subscription ids on which the user defined resources query should be executed. */ querySubscriptions: string[]; } /** * Configuration for VM scanning */ interface VmScannersBaseConfigurationResponse { /** * Tags that indicates that a resource should not be scanned */ exclusionTags?: { [key: string]: string; }; /** * The scanning mode for the VM scan. */ scanningMode?: string; } } export declare namespace securityandcompliance { /** * The Private Endpoint Connection resource. */ interface PrivateEndpointConnectionResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * The resource of private end point. */ privateEndpoint?: outputs.securityandcompliance.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.securityandcompliance.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Required property for system data */ systemData: outputs.securityandcompliance.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The Private Endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * An access policy entry. */ interface ServiceAccessPolicyEntryResponse { /** * An Azure AD object ID (User or Apps) that is allowed access to the FHIR service. */ objectId: string; } /** * Authentication configuration information */ interface ServiceAuthenticationConfigurationInfoResponse { /** * The audience url for the service */ audience?: string; /** * The authority url for the service */ authority?: string; /** * If the SMART on FHIR proxy is enabled */ smartProxyEnabled?: boolean; } /** * The settings for the CORS configuration of the service instance. */ interface ServiceCorsConfigurationInfoResponse { /** * If credentials are allowed via CORS. */ allowCredentials?: boolean; /** * The headers to be allowed via CORS. */ headers?: string[]; /** * The max age to be allowed via CORS. */ maxAge?: number; /** * The methods to be allowed via CORS. */ methods?: string[]; /** * The origins to be allowed via CORS. */ origins?: string[]; } /** * The settings for the Cosmos DB database backing the service. */ interface ServiceCosmosDbConfigurationInfoResponse { /** * The URI of the customer-managed key for the backing database. */ keyVaultKeyUri?: string; /** * The provisioned throughput for the backing database. */ offerThroughput?: number; } /** * Export operation configuration information */ interface ServiceExportConfigurationInfoResponse { /** * The name of the default export storage account. */ storageAccountName?: string; } /** * The properties of a service instance. */ interface ServicesPropertiesResponse { /** * The access policies of the service instance. */ accessPolicies?: outputs.securityandcompliance.ServiceAccessPolicyEntryResponse[]; /** * The authentication configuration for the service instance. */ authenticationConfiguration?: outputs.securityandcompliance.ServiceAuthenticationConfigurationInfoResponse; /** * The settings for the CORS configuration of the service instance. */ corsConfiguration?: outputs.securityandcompliance.ServiceCorsConfigurationInfoResponse; /** * The settings for the Cosmos DB database backing the service. */ cosmosDbConfiguration?: outputs.securityandcompliance.ServiceCosmosDbConfigurationInfoResponse; /** * The settings for the export operation of the service instance. */ exportConfiguration?: outputs.securityandcompliance.ServiceExportConfigurationInfoResponse; /** * The list of private endpoint connections that are set up for this resource. */ privateEndpointConnections?: outputs.securityandcompliance.PrivateEndpointConnectionResponse[]; /** * The provisioning state. */ provisioningState: string; /** * Control permission for data plane traffic coming from public networks while private endpoint is enabled. */ publicNetworkAccess?: string; } /** * Setting indicating whether the service has a managed identity associated with it. */ interface ServicesResourceResponseIdentity { /** * The principal ID of the resource identity. */ principalId: string; /** * The tenant ID of the resource. */ tenantId: string; /** * Type of identity being specified, currently SystemAssigned and None are allowed. */ type?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace securityinsights { /** * Model for API authentication with AWS. */ interface AWSAuthModelResponse { /** * AWS STS assume role external ID. This is used to prevent the confused deputy problem: 'https://docs.aws.amazon.com/IAM/latest/UserGuide/confused-deputy.html' */ externalId?: string; /** * AWS STS assume role ARN */ roleArn: string; /** * Type of paging * Expected value is 'AWS'. */ type: "AWS"; } /** * The Activity query definitions */ interface ActivityEntityQueriesPropertiesResponseQueryDefinitions { /** * The Activity query to run on a given entity */ query?: string; } /** * Represents Activity timeline item. */ interface ActivityTimelineItemResponse { /** * The grouping bucket end time. */ bucketEndTimeUTC: string; /** * The grouping bucket start time. */ bucketStartTimeUTC: string; /** * The activity timeline content. */ content: string; /** * The time of the first activity in the grouping bucket. */ firstActivityTimeUTC: string; /** * The entity query kind * Expected value is 'Activity'. */ kind: "Activity"; /** * The time of the last activity in the grouping bucket. */ lastActivityTimeUTC: string; /** * The activity query id. */ queryId: string; /** * The activity timeline title. */ title: string; } /** * Describes an automation rule action to add a task to an incident. */ interface AddIncidentTaskActionPropertiesResponse { /** * The description of the task. */ description?: string; /** * The title of the task. */ title: string; } /** * Settings for how to dynamically override alert static details */ interface AlertDetailsOverrideResponse { /** * the format containing columns name(s) to override the alert description */ alertDescriptionFormat?: string; /** * the format containing columns name(s) to override the alert name */ alertDisplayNameFormat?: string; /** * List of additional dynamic properties to override */ alertDynamicProperties?: outputs.securityinsights.AlertPropertyMappingResponse[]; /** * the column name to take the alert severity from */ alertSeverityColumnName?: string; /** * the column name to take the alert tactics from */ alertTacticsColumnName?: string; } /** * A single alert property mapping to override */ interface AlertPropertyMappingResponse { /** * The V3 alert property */ alertProperty?: string; /** * the column name to use to override this property */ value?: string; } /** * Alerts data type for data connectors. */ interface AlertsDataTypeOfDataConnectorResponse { /** * Alerts data type connection. */ alerts: outputs.securityinsights.DataConnectorDataTypeCommonResponse; } /** * Represents anomaly timeline item. */ interface AnomalyTimelineItemResponse { /** * The anomaly azure resource id. */ azureResourceId: string; /** * The anomaly description. */ description?: string; /** * The anomaly name. */ displayName: string; /** * The anomaly end time. */ endTimeUtc: string; /** * The intent of the anomaly. */ intent?: string; /** * The entity query kind * Expected value is 'Anomaly'. */ kind: "Anomaly"; /** * The anomaly product name. */ productName?: string; /** * The reasons that cause the anomaly. */ reasons?: string[]; /** * The anomaly start time. */ startTimeUtc: string; /** * The techniques of the anomaly. */ techniques?: string[]; /** * The anomaly generated time. */ timeGenerated: string; /** * The name of the anomaly vendor. */ vendor?: string; } /** * Model for authentication with the API Key. Will result in additional header on the request (default behavior) to the remote server: 'ApiKeyName: ApiKeyIdentifier ApiKey'. If 'IsApiKeyInPostPayload' is true it will send it in the body of the request and not the header. */ interface ApiKeyAuthModelResponse { /** * API Key for the user secret key credential */ apiKey: string; /** * API Key Identifier */ apiKeyIdentifier?: string; /** * API Key name */ apiKeyName: string; /** * Flag to indicate if API key is set in HTTP POST payload */ isApiKeyInPostPayload?: boolean; /** * Type of paging * Expected value is 'APIKey'. */ type: "APIKey"; } /** * An entity describing a content item. */ interface AssignmentItemResponse { /** * The resource id of the content item */ resourceId?: string; } /** * Describes an automation rule action to add a task to an incident */ interface AutomationRuleAddIncidentTaskActionResponse { /** * Describes an automation rule action to add a task to an incident. */ actionConfiguration?: outputs.securityinsights.AddIncidentTaskActionPropertiesResponse; /** * The type of the automation rule action. * Expected value is 'AddIncidentTask'. */ actionType: "AddIncidentTask"; order: number; } /** * Describes an automation rule condition with boolean operators. */ interface AutomationRuleBooleanConditionResponse { innerConditions?: (outputs.securityinsights.BooleanConditionPropertiesResponse | outputs.securityinsights.PropertyArrayChangedConditionPropertiesResponse | outputs.securityinsights.PropertyArrayConditionPropertiesResponse | outputs.securityinsights.PropertyChangedConditionPropertiesResponse | outputs.securityinsights.PropertyConditionPropertiesResponse)[]; /** * Describes a boolean condition operator. */ operator?: string; } /** * Describes an automation rule action to modify an object's properties */ interface AutomationRuleModifyPropertiesActionResponse { actionConfiguration?: outputs.securityinsights.IncidentPropertiesActionResponse; /** * The type of the automation rule action. * Expected value is 'ModifyProperties'. */ actionType: "ModifyProperties"; order: number; } interface AutomationRulePropertyArrayChangedValuesConditionResponse { arrayType?: string; changeType?: string; } /** * Describes an automation rule condition on array properties. */ interface AutomationRulePropertyArrayValuesConditionResponse { /** * Describes an array condition evaluation type. */ arrayConditionType?: string; /** * Describes an array condition evaluated array type. */ arrayType?: string; itemConditions?: (outputs.securityinsights.BooleanConditionPropertiesResponse | outputs.securityinsights.PropertyArrayChangedConditionPropertiesResponse | outputs.securityinsights.PropertyArrayConditionPropertiesResponse | outputs.securityinsights.PropertyChangedConditionPropertiesResponse | outputs.securityinsights.PropertyConditionPropertiesResponse)[]; } interface AutomationRulePropertyValuesChangedConditionResponse { changeType?: string; operator?: string; propertyName?: string; propertyValues?: string[]; } interface AutomationRulePropertyValuesConditionResponse { operator?: string; /** * The property to evaluate in an automation rule property condition. */ propertyName?: string; propertyValues?: string[]; } /** * Describes an automation rule action to run a playbook */ interface AutomationRuleRunPlaybookActionResponse { actionConfiguration?: outputs.securityinsights.PlaybookActionPropertiesResponse; /** * The type of the automation rule action. * Expected value is 'RunPlaybook'. */ actionType: "RunPlaybook"; order: number; } /** * Describes automation rule triggering logic. */ interface AutomationRuleTriggeringLogicResponse { /** * The conditions to evaluate to determine if the automation rule should be triggered on a given object. */ conditions?: (outputs.securityinsights.BooleanConditionPropertiesResponse | outputs.securityinsights.PropertyArrayChangedConditionPropertiesResponse | outputs.securityinsights.PropertyArrayConditionPropertiesResponse | outputs.securityinsights.PropertyChangedConditionPropertiesResponse | outputs.securityinsights.PropertyConditionPropertiesResponse)[]; /** * Determines when the automation rule should automatically expire and be disabled. */ expirationTimeUtc?: string; /** * Determines whether the automation rule is enabled or disabled. */ isEnabled: boolean; triggersOn: string; triggersWhen: string; } /** * The available data types for Amazon Web Services CloudTrail data connector. */ interface AwsCloudTrailDataConnectorDataTypesResponse { /** * Logs data type. */ logs: outputs.securityinsights.AwsCloudTrailDataConnectorDataTypesResponseLogs; } /** * Logs data type. */ interface AwsCloudTrailDataConnectorDataTypesResponseLogs { /** * Describe whether this data type connection is enabled or not. */ state: string; } /** * Resources created in Azure DevOps repository. */ interface AzureDevOpsResourceInfoResponse { /** * Id of the pipeline created for the source-control. */ pipelineId?: string; /** * Id of the service-connection created for the source-control. */ serviceConnectionId?: string; } /** * Model for API authentication with basic flow - user name + password. */ interface BasicAuthModelResponse { /** * The password */ password: string; /** * Type of paging * Expected value is 'Basic'. */ type: "Basic"; /** * The user name. */ userName: string; } /** * Represents bookmark timeline item. */ interface BookmarkTimelineItemResponse { /** * The bookmark azure resource id. */ azureResourceId: string; /** * Describes a user that created the bookmark */ createdBy?: outputs.securityinsights.UserInfoResponse; /** * The bookmark display name. */ displayName?: string; /** * The bookmark end time. */ endTimeUtc?: string; /** * The bookmark event time. */ eventTime?: string; /** * The entity query kind * Expected value is 'Bookmark'. */ kind: "Bookmark"; /** * List of labels relevant to this bookmark */ labels?: string[]; /** * The notes of the bookmark */ notes?: string; /** * The bookmark start time. */ startTimeUtc?: string; } /** * Describes an automation rule condition that applies a boolean operator (e.g AND, OR) to conditions */ interface BooleanConditionPropertiesResponse { /** * Describes an automation rule condition with boolean operators. */ conditionProperties?: outputs.securityinsights.AutomationRuleBooleanConditionResponse; /** * Expected value is 'Boolean'. */ conditionType: "Boolean"; } /** * A custom response configuration for a rule. */ interface CcpResponseConfigResponse { /** * The compression algorithm. For Example: 'gzip', 'multi-gzip', 'deflate'. */ compressionAlgo?: string; /** * The value indicating whether the response isn't an array of events / logs. By setting this flag to true it means the remote server will response with an object which each property has as a value an array of events / logs. */ convertChildPropertiesToArray?: boolean; /** * The csv delimiter, in case the response format is CSV. */ csvDelimiter?: string; /** * The character used to escape characters in CSV. */ csvEscape?: string; /** * The json paths, '$' char is the json root. */ eventsJsonPaths: string[]; /** * The response format. possible values are json,csv,xml */ format?: string; /** * The value indicating whether the response has CSV boundary in case the response in CSV format. */ hasCsvBoundary?: boolean; /** * The value indicating whether the response has headers in case the response in CSV format. */ hasCsvHeader?: boolean; /** * The value indicating whether the remote server support Gzip and we should expect Gzip response. */ isGzipCompressed?: boolean; /** * The value where the status message/code should appear in the response. */ successStatusJsonPath?: string; /** * The status value. */ successStatusValue?: string; } /** * ccpResponseConfigResponseProvideDefaults sets the appropriate defaults for CcpResponseConfigResponse */ function ccpResponseConfigResponseProvideDefaults(val: CcpResponseConfigResponse): CcpResponseConfigResponse; /** * Information on the client (user or application) that made some action */ interface ClientInfoResponse { /** * The email of the client. */ email?: string; /** * The name of the client. */ name?: string; /** * The object id of the client. */ objectId?: string; /** * The user principal name of the client. */ userPrincipalName?: string; } /** * The criteria by which we determine whether the connector is connected or not. * For Example, use a KQL query to check if the expected data type is flowing). */ interface ConnectivityCriterionResponse { /** * Gets or sets the type of connectivity. */ type: string; /** * Gets or sets the queries for checking connectivity. */ value?: string[]; } /** * The data type which is created by the connector, * including a query indicated when was the last time that data type was received in the workspace. */ interface ConnectorDataTypeResponse { /** * Gets or sets the query to indicate when relevant data was last received in the workspace. */ lastDataReceivedQuery: string; /** * Gets or sets the name of the data type to show in the graph. */ name: string; } /** * The exposure status of the connector to the customers. */ interface ConnectorDefinitionsAvailabilityResponse { /** * Gets or sets a value indicating whether the connector is preview. */ isPreview?: boolean; /** * The exposure status of the connector to the customers. Available values are 0-4 (0=None, 1=Available, 2=FeatureFlag, 3=Internal). */ status?: number; } /** * The required Permissions for the connector. */ interface ConnectorDefinitionsPermissionsResponse { /** * Gets or sets the customs permissions required for the user to create connections. */ customs?: outputs.securityinsights.CustomPermissionDetailsResponse[]; /** * Gets or sets the required licenses for the user to create connections. */ licenses?: string[]; /** * Gets or sets the resource provider permissions required for the user to create connections. */ resourceProvider?: outputs.securityinsights.ConnectorDefinitionsResourceProviderResponse[]; /** * Gets or sets the required tenant permissions for the connector. */ tenant?: string[]; } /** * The resource provider details include the required permissions for the user to create connections. * The user should have the required permissions(Read\Write, ..) in the specified scope ProviderPermissionsScope against the specified resource provider. */ interface ConnectorDefinitionsResourceProviderResponse { /** * Gets or sets the permissions description text. */ permissionsDisplayText: string; /** * Gets or sets the provider name. */ provider: string; /** * Gets or sets the permissions provider display name. */ providerDisplayName: string; /** * Required permissions for the connector resource provider that define in ResourceProviders. * For more information about the permissions see here. */ requiredPermissions: outputs.securityinsights.ResourceProviderRequiredPermissionsResponse; /** * The scope on which the user should have permissions, in order to be able to create connections. */ scope: string; } /** * The Custom permissions required for the connector. */ interface CustomPermissionDetailsResponse { /** * Gets or sets the custom permissions description. */ description: string; /** * Gets or sets the custom permissions name. */ name: string; } /** * The UiConfig for 'Customizable' connector definition kind. */ interface CustomizableConnectionsConfigResponse { /** * Gets or sets the template name. The template includes ARM templates that can be created by the connector, usually it will be the dataConnectors ARM templates. */ templateSpecName: string; /** * Gets or sets the template version. */ templateSpecVersion: string; } /** * The UiConfig for 'Customizable' connector definition kind. */ interface CustomizableConnectorUiConfigResponse { /** * The exposure status of the connector to the customers. */ availability?: outputs.securityinsights.ConnectorDefinitionsAvailabilityResponse; /** * Gets or sets the way the connector checks whether the connector is connected. */ connectivityCriteria: outputs.securityinsights.ConnectivityCriterionResponse[]; /** * Gets or sets the data types to check for last data received. */ dataTypes: outputs.securityinsights.ConnectorDataTypeResponse[]; /** * Gets or sets the connector description in markdown format. */ descriptionMarkdown: string; /** * Gets or sets the graph queries to show the current data volume over time. */ graphQueries: outputs.securityinsights.GraphQueryResponse[]; /** * Gets or sets custom connector id. optional field. */ id?: string; /** * Gets or sets the instruction steps to enable the connector. */ instructionSteps: outputs.securityinsights.InstructionStepResponse[]; /** * Gets or sets a value indicating whether to use 'OR'(SOME) or 'AND' between ConnectivityCriteria items. */ isConnectivityCriteriasMatchSome?: boolean; /** * Gets or sets the connector logo to be used when displaying the connector within Azure Sentinel's connector's gallery. * The logo value should be in SVG format. */ logo?: string; /** * The required Permissions for the connector. */ permissions: outputs.securityinsights.ConnectorDefinitionsPermissionsResponse; /** * Gets or sets the connector publisher name. */ publisher: string; /** * Gets or sets the connector blade title. */ title: string; } /** * The configuration of the destination of the data. */ interface DCRConfigurationResponse { /** * Represents the data collection ingestion endpoint in log analytics. */ dataCollectionEndpoint: string; /** * The data collection rule immutable id, the rule defines the transformation and data destination. */ dataCollectionRuleImmutableId: string; /** * The stream we are sending the data to. */ streamName: string; } /** * Common field for data type in data connectors. */ interface DataConnectorDataTypeCommonResponse { /** * Describe whether this data type connection is enabled or not. */ state: string; } /** * Information regarding a deployment. */ interface DeploymentInfoResponse { /** * Deployment information. */ deployment?: outputs.securityinsights.DeploymentResponse; /** * Status while fetching the last deployment. */ deploymentFetchStatus?: string; /** * Additional details about the deployment that can be shown to the user. */ message?: string; } /** * Description about a deployment. */ interface DeploymentResponse { /** * Deployment identifier. */ deploymentId?: string; /** * Url to access repository action logs. */ deploymentLogsUrl?: string; /** * The outcome of the deployment. */ deploymentResult?: string; /** * Current status of the deployment. */ deploymentState?: string; /** * The time when the deployment finished. */ deploymentTime?: string; } /** * An individual contact associated with this domain */ interface EnrichmentDomainWhoisContactResponse { /** * The city for this contact */ city?: string; /** * The country for this contact */ country?: string; /** * The email address for this contact */ email?: string; /** * The fax number for this contact */ fax?: string; /** * The name of this contact */ name?: string; /** * The organization for this contact */ org?: string; /** * The phone number for this contact */ phone?: string; /** * The postal code for this contact */ postal?: string; /** * The state for this contact */ state?: string; /** * A list describing the street address for this contact */ street?: string[]; } /** * The set of contacts associated with this domain */ interface EnrichmentDomainWhoisContactsResponse { /** * The admin contact for this whois record */ admin?: outputs.securityinsights.EnrichmentDomainWhoisContactResponse; /** * The billing contact for this whois record */ billing?: outputs.securityinsights.EnrichmentDomainWhoisContactResponse; /** * The registrant contact for this whois record */ registrant?: outputs.securityinsights.EnrichmentDomainWhoisContactResponse; /** * The technical contact for this whois record */ tech?: outputs.securityinsights.EnrichmentDomainWhoisContactResponse; } /** * The whois record for a given domain */ interface EnrichmentDomainWhoisDetailsResponse { /** * The set of contacts associated with this domain */ contacts?: outputs.securityinsights.EnrichmentDomainWhoisContactsResponse; /** * A list of name servers associated with this domain */ nameServers?: string[]; /** * The registrar associated with this domain */ registrar?: outputs.securityinsights.EnrichmentDomainWhoisRegistrarDetailsResponse; /** * The set of status flags for this whois record */ statuses?: string[]; } /** * The registrar associated with this domain */ interface EnrichmentDomainWhoisRegistrarDetailsResponse { /** * This registrar's abuse contact email */ abuseContactEmail?: string; /** * This registrar's abuse contact phone number */ abuseContactPhone?: string; /** * This registrar's Internet Assigned Numbers Authority id */ ianaId?: string; /** * The name of this registrar */ name?: string; /** * This registrar's URL */ url?: string; /** * The hostname of this registrar's whois server */ whoisServer?: string; } /** * Entity insight Item. */ interface EntityInsightItemResponse { /** * Query results for table insights query. */ chartQueryResults?: outputs.securityinsights.InsightsTableResultResponse[]; /** * The query id of the insight */ queryId?: string; /** * The Time interval that the query actually executed on. */ queryTimeInterval?: outputs.securityinsights.EntityInsightItemResponseQueryTimeInterval; /** * Query results for table insights query. */ tableQueryResults?: outputs.securityinsights.InsightsTableResultResponse; } /** * The Time interval that the query actually executed on. */ interface EntityInsightItemResponseQueryTimeInterval { /** * Insight query end time */ endTime?: string; /** * Insight query start time */ startTime?: string; } /** * Single entity mapping for the alert rule */ interface EntityMappingResponse { /** * The V3 type of the mapped entity */ entityType?: string; /** * array of field mappings for the given entity mapping */ fieldMappings?: outputs.securityinsights.FieldMappingResponse[]; } /** * Event grouping settings property bag. */ interface EventGroupingSettingsResponse { /** * The event grouping aggregation kinds */ aggregationKind?: string; } /** * A single field mapping of the mapped entity */ interface FieldMappingResponse { /** * the column name to be mapped to the identifier */ columnName?: string; /** * the V3 identifier of the entity */ identifier?: string; } /** * Represents a file. */ interface FileMetadataResponse { /** * Indicates whether the file was deleted from the storage account. */ deleteStatus: string; /** * A URI with a valid SAS token to allow uploading / downloading the file. */ fileContentUri: string; /** * The format of the file */ fileFormat?: string; /** * The name of the file. */ fileName?: string; /** * The size of the file. */ fileSize?: number; } /** * Model for API authentication for all GCP kind connectors. */ interface GCPAuthModelResponse { /** * GCP Project Number */ projectNumber: string; /** * GCP Service Account Email */ serviceAccountEmail: string; /** * Type of paging * Expected value is 'GCP'. */ type: "GCP"; /** * GCP Workload Identity Provider ID */ workloadIdentityProviderId: string; } /** * Model for API authentication for working with service bus or storage account. */ interface GenericBlobSbsAuthModelResponse { /** * Credentials for service bus namespace, keyvault uri for access key */ credentialsConfig?: { [key: string]: string; }; /** * Credentials for storage account, keyvault uri for access key */ storageAccountCredentialsConfig?: { [key: string]: string; }; /** * Type of paging * Expected value is 'ServiceBus'. */ type: "ServiceBus"; } /** * GetInsights Query Errors. */ interface GetInsightsErrorKindResponse { /** * the error message */ errorMessage: string; /** * the query kind */ kind: string; /** * the query id */ queryId?: string; } /** * Get Insights result metadata. */ interface GetInsightsResultsMetadataResponse { /** * information about the failed queries */ errors?: outputs.securityinsights.GetInsightsErrorKindResponse[]; /** * the total items found for the insights request */ totalCount: number; } /** * Model for API authentication for GitHub. For this authentication first we need to approve the Router app (Microsoft Security DevOps) to access the GitHub account, Then we only need the InstallationId to get the access token from https://api.github.com/app/installations/{installId}/access_tokens. */ interface GitHubAuthModelResponse { /** * The GitHubApp auth installation id. */ installationId?: string; /** * Type of paging * Expected value is 'GitHub'. */ type: "GitHub"; } /** * Resources created in GitHub repository. */ interface GitHubResourceInfoResponse { /** * GitHub application installation id. */ appInstallationId?: string; } /** * The graph query to show the volume of data arriving into the workspace over time. */ interface GraphQueryResponse { /** * Gets or sets the base query for the graph. * The base query is wrapped by Sentinel UI infra with a KQL query, that measures the volume over time. */ baseQuery: string; /** * Gets or sets the legend for the graph. */ legend: string; /** * Gets or sets the metric name that the query is checking. For example: 'Total data receive'. */ metricName: string; } /** * Grouping configuration property bag. */ interface GroupingConfigurationResponse { /** * Grouping enabled */ enabled: boolean; /** * A list of alert details to group by (when matchingMethod is Selected) */ groupByAlertDetails?: string[]; /** * A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used. */ groupByCustomDetails?: string[]; /** * A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used. */ groupByEntities?: string[]; /** * Limit the group to alerts created within the lookback duration (in ISO 8601 duration format) */ lookbackDuration: string; /** * Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty. */ matchingMethod: string; /** * Re-open closed matching incidents */ reopenClosedIncident: boolean; } /** * Describes a user that the hunt is assigned to */ interface HuntOwnerResponse { /** * The name of the user the hunt is assigned to. */ assignedTo?: string; /** * The email of the user the hunt is assigned to. */ email?: string; /** * The object id of the user the hunt is assigned to. */ objectId?: string; /** * The type of the owner the hunt is assigned to. */ ownerType?: string; /** * The user principal name of the user the hunt is assigned to. */ userPrincipalName?: string; } /** * Incident additional data property bag. */ interface IncidentAdditionalDataResponse { /** * List of product names of alerts in the incident */ alertProductNames: string[]; /** * The number of alerts in the incident */ alertsCount: number; /** * The number of bookmarks in the incident */ bookmarksCount: number; /** * The number of comments in the incident */ commentsCount: number; /** * The provider incident url to the incident in Microsoft 365 Defender portal */ providerIncidentUrl: string; /** * The tactics associated with incident */ tactics: string[]; } /** * Incident Configuration property bag. */ interface IncidentConfigurationResponse { /** * Create incidents from alerts triggered by this analytics rule */ createIncident: boolean; /** * Set how the alerts that are triggered by this analytics rule, are grouped into incidents */ groupingConfiguration?: outputs.securityinsights.GroupingConfigurationResponse; } /** * Describes related incident information for the bookmark */ interface IncidentInfoResponse { /** * Incident Id */ incidentId?: string; /** * Relation Name */ relationName?: string; /** * The severity of the incident */ severity?: string; /** * The title of the incident */ title?: string; } /** * Represents an incident label */ interface IncidentLabelResponse { /** * The name of the label */ labelName: string; /** * The type of the label */ labelType: string; } /** * Information on the user an incident is assigned to */ interface IncidentOwnerInfoResponse { /** * The name of the user the incident is assigned to. */ assignedTo?: string; /** * The email of the user the incident is assigned to. */ email?: string; /** * The object id of the user the incident is assigned to. */ objectId?: string; /** * The type of the owner the incident is assigned to. */ ownerType?: string; /** * The user principal name of the user the incident is assigned to. */ userPrincipalName?: string; } interface IncidentPropertiesActionResponse { /** * The reason the incident was closed */ classification?: string; /** * Describes the reason the incident was closed. */ classificationComment?: string; /** * The classification reason the incident was closed with */ classificationReason?: string; /** * List of labels to add to the incident. */ labels?: outputs.securityinsights.IncidentLabelResponse[]; /** * Information on the user an incident is assigned to */ owner?: outputs.securityinsights.IncidentOwnerInfoResponse; /** * The severity of the incident */ severity?: string; /** * The status of the incident */ status?: string; } /** * Query results for table insights query. */ interface InsightsTableResultResponse { /** * Columns Metadata of the table */ columns?: outputs.securityinsights.InsightsTableResultResponseColumns[]; /** * Rows data of the table */ rows?: string[][]; } interface InsightsTableResultResponseColumns { /** * the name of the column */ name?: string; /** * the type of the column */ type?: string; } /** * Instruction step details, to be displayed in the Instructions steps section in the connector's page in Sentinel Portal. */ interface InstructionStepDetailsResponse { /** * Gets or sets the instruction type parameters settings. */ parameters: any; /** * Gets or sets the instruction type name. */ type: string; } /** * Instruction steps to enable the connector. */ interface InstructionStepResponse { /** * Gets or sets the instruction step description. */ description?: string; /** * Gets or sets the inner instruction steps details. * For Example: instruction step 1 might contain inner instruction steps: [instruction step 1.1, instruction step 1.2]. */ innerSteps?: outputs.securityinsights.InstructionStepResponse[]; /** * Gets or sets the instruction step details. */ instructions?: outputs.securityinsights.InstructionStepDetailsResponse[]; /** * Gets or sets the instruction step title. */ title?: string; } /** * Model for API authentication with JWT. Simple exchange between user name + password to access token. */ interface JwtAuthModelResponse { /** * The custom headers we want to add once we send request to token endpoint. */ headers?: { [key: string]: string; }; /** * Flag indicating whether we want to send the user name and password to token endpoint in the headers. */ isCredentialsInHeaders?: boolean; /** * Flag indicating whether the body request is JSON (header Content-Type = application/json), meaning its a Form URL encoded request (header Content-Type = application/x-www-form-urlencoded). */ isJsonRequest?: boolean; /** * The password */ password: { [key: string]: string; }; /** * The custom query parameter we want to add once we send request to token endpoint. */ queryParameters?: { [key: string]: string; }; /** * Request timeout in seconds. */ requestTimeoutInSeconds?: number; /** * Token endpoint to request JWT */ tokenEndpoint: string; /** * Type of paging * Expected value is 'JwtToken'. */ type: "JwtToken"; /** * The user name. If user name and password sent in header request we only need to populate the `value` property with the user name (Same as basic auth). If user name and password sent in body request we need to specify the `Key` and `Value`. */ userName: { [key: string]: string; }; } /** * jwtAuthModelResponseProvideDefaults sets the appropriate defaults for JwtAuthModelResponse */ function jwtAuthModelResponseProvideDefaults(val: JwtAuthModelResponse): JwtAuthModelResponse; /** * The available data types for MCAS (Microsoft Cloud App Security) data connector. */ interface MCASDataConnectorDataTypesResponse { /** * Alerts data type connection. */ alerts: outputs.securityinsights.DataConnectorDataTypeCommonResponse; /** * Discovery log data type connection. */ discoveryLogs?: outputs.securityinsights.DataConnectorDataTypeCommonResponse; } /** * The available data types for Microsoft Threat Intelligence data connector. */ interface MSTIDataConnectorDataTypesResponse { /** * Data type for Microsoft Threat Intelligence data connector. */ microsoftEmergingThreatFeed: outputs.securityinsights.MSTIDataConnectorDataTypesResponseMicrosoftEmergingThreatFeed; } /** * Data type for Microsoft Threat Intelligence data connector. */ interface MSTIDataConnectorDataTypesResponseMicrosoftEmergingThreatFeed { /** * The lookback period for the feed to be imported. The date-time to begin importing the feed from, for example: 2024-01-01T00:00:00.000Z. */ lookbackPeriod: string; /** * Describe whether this data type connection is enabled or not. */ state: string; } /** * Publisher or creator of the content item. */ interface MetadataAuthorResponse { /** * Email of author contact */ email?: string; /** * Link for author/vendor page */ link?: string; /** * Name of the author. Company or person. */ name?: string; } /** * ies for the solution content item */ interface MetadataCategoriesResponse { /** * domain for the solution content item */ domains?: string[]; /** * Industry verticals for the solution content item */ verticals?: string[]; } /** * Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies. */ interface MetadataDependenciesResponse { /** * Id of the content item we depend on */ contentId?: string; /** * This is the list of dependencies we must fulfill, according to the AND/OR operator */ criteria?: outputs.securityinsights.MetadataDependenciesResponse[]; /** * Type of the content item we depend on */ kind?: string; /** * Name of the content item */ name?: string; /** * Operator used for list of dependencies in criteria array. */ operator?: string; /** * Version of the the content item we depend on. Can be blank, * or missing to indicate any version fulfills the dependency. If version does not match our defined numeric format then an exact match is required. */ version?: string; } /** * The original source of the content item, where it comes from. */ interface MetadataSourceResponse { /** * Source type of the content */ kind: string; /** * Name of the content source. The repo name, solution name, LA workspace name etc. */ name?: string; /** * ID of the content source. The solution ID, workspace ID, etc */ sourceId?: string; } /** * Support information for the content item. */ interface MetadataSupportResponse { /** * Email of support contact */ email?: string; /** * Link for support help, like to support page to open a ticket etc. */ link?: string; /** * Name of the support contact. Company or person. */ name?: string; /** * Type of support for content item */ tier: string; } /** * Model for API authentication with no authentication method - public API. */ interface NoneAuthModelResponse { /** * Type of paging * Expected value is 'None'. */ type: "None"; } /** * Model for API authentication with OAuth2. */ interface OAuthModelResponse { /** * Access token prepend. Default is 'Bearer'. */ accessTokenPrepend?: string; /** * The user's authorization code. */ authorizationCode?: string; /** * The authorization endpoint. */ authorizationEndpoint?: string; /** * The authorization endpoint headers. */ authorizationEndpointHeaders?: { [key: string]: string; }; /** * The authorization endpoint query parameters. */ authorizationEndpointQueryParameters?: { [key: string]: string; }; /** * The Application (client) ID that the OAuth provider assigned to your app. */ clientId: string; /** * The Application (client) secret that the OAuth provider assigned to your app. */ clientSecret: string; /** * The grant type, usually will be 'authorization code'. */ grantType: string; /** * Indicating whether we want to send the clientId and clientSecret to token endpoint in the headers. */ isCredentialsInHeaders?: boolean; /** * A value indicating whether it's a JWT flow. */ isJwtBearerFlow?: boolean; /** * The Application redirect url that the user config in the OAuth provider. */ redirectUri?: string; /** * The Application (client) Scope that the OAuth provider assigned to your app. */ scope?: string; /** * The token endpoint. Defines the OAuth2 refresh token. */ tokenEndpoint: string; /** * The token endpoint headers. */ tokenEndpointHeaders?: { [key: string]: string; }; /** * The token endpoint query parameters. */ tokenEndpointQueryParameters?: { [key: string]: string; }; /** * Type of paging * Expected value is 'OAuth2'. */ type: "OAuth2"; } /** * oauthModelResponseProvideDefaults sets the appropriate defaults for OAuthModelResponse */ function oauthModelResponseProvideDefaults(val: OAuthModelResponse): OAuthModelResponse; /** * The available data types for office data connector. */ interface OfficeDataConnectorDataTypesResponse { /** * Exchange data type connection. */ exchange: outputs.securityinsights.OfficeDataConnectorDataTypesResponseExchange; /** * SharePoint data type connection. */ sharePoint: outputs.securityinsights.OfficeDataConnectorDataTypesResponseSharePoint; /** * Teams data type connection. */ teams: outputs.securityinsights.OfficeDataConnectorDataTypesResponseTeams; } /** * Exchange data type connection. */ interface OfficeDataConnectorDataTypesResponseExchange { /** * Describe whether this data type connection is enabled or not. */ state: string; } /** * SharePoint data type connection. */ interface OfficeDataConnectorDataTypesResponseSharePoint { /** * Describe whether this data type connection is enabled or not. */ state: string; } /** * Teams data type connection. */ interface OfficeDataConnectorDataTypesResponseTeams { /** * Describe whether this data type connection is enabled or not. */ state: string; } /** * Model for API authentication for Oracle. */ interface OracleAuthModelResponse { /** * Content of the PRM file */ pemFile: string; /** * Public Fingerprint */ publicFingerprint: string; /** * Oracle tenant ID */ tenantId: string; /** * Type of paging * Expected value is 'Oracle'. */ type: "Oracle"; /** * Oracle user ID */ userId: string; } interface PlaybookActionPropertiesResponse { /** * The resource id of the playbook resource. */ logicAppResourceId: string; /** * The tenant id of the playbook resource. */ tenantId?: string; } /** * The available data types for Microsoft Defender for Threat Intelligence Premium data connector. */ interface PremiumMdtiDataConnectorDataTypesResponse { /** * Data type for Microsoft Defender for Threat Intelligence Premium data connector. */ connector: outputs.securityinsights.PremiumMdtiDataConnectorDataTypesResponseConnector; } /** * Data type for Microsoft Defender for Threat Intelligence Premium data connector. */ interface PremiumMdtiDataConnectorDataTypesResponseConnector { /** * Describe whether this data type connection is enabled or not. */ state: string; } /** * Describes an automation rule condition that evaluates an array property's value change */ interface PropertyArrayChangedConditionPropertiesResponse { conditionProperties?: outputs.securityinsights.AutomationRulePropertyArrayChangedValuesConditionResponse; /** * Expected value is 'PropertyArrayChanged'. */ conditionType: "PropertyArrayChanged"; } /** * Describes an automation rule condition that evaluates an array property's value */ interface PropertyArrayConditionPropertiesResponse { /** * Describes an automation rule condition on array properties. */ conditionProperties?: outputs.securityinsights.AutomationRulePropertyArrayValuesConditionResponse; /** * Expected value is 'PropertyArray'. */ conditionType: "PropertyArray"; } /** * Describes an automation rule condition that evaluates a property's value change */ interface PropertyChangedConditionPropertiesResponse { conditionProperties?: outputs.securityinsights.AutomationRulePropertyValuesChangedConditionResponse; /** * Expected value is 'PropertyChanged'. */ conditionType: "PropertyChanged"; } /** * Describes an automation rule condition that evaluates a property's value */ interface PropertyConditionPropertiesResponse { conditionProperties?: outputs.securityinsights.AutomationRulePropertyValuesConditionResponse; /** * Expected value is 'Property'. */ conditionType: "Property"; } /** * Information regarding pull request for protected branches. */ interface PullRequestResponse { /** * State of the pull request */ state: string; /** * URL of pull request */ url: string; } /** * Represents a repository. */ interface RepoResponse { /** * Array of branches. */ branches?: string[]; /** * The name of the repository. */ fullName?: string; /** * The installation id of the repository. */ installationId?: number; /** * The url to access the repository. */ url?: string; } /** * Resources created in user's repository for the source-control. */ interface RepositoryResourceInfoResponse { /** * Resources created in Azure DevOps for this source-control. */ azureDevOpsResourceInfo: outputs.securityinsights.AzureDevOpsResourceInfoResponse; /** * Resources created in GitHub for this source-control. */ gitHubResourceInfo: outputs.securityinsights.GitHubResourceInfoResponse; /** * The webhook object created for the source-control. */ webhook?: outputs.securityinsights.WebhookResponse; } /** * metadata of a repository. */ interface RepositoryResponse { /** * Branch name of repository. */ branch: string; /** * Url to access repository action logs. */ deploymentLogsUrl: string; /** * Display url of repository. */ displayUrl?: string; /** * Url of repository. */ url: string; } /** * Required permissions for the connector resource provider that define in ResourceProviders. * For more information about the permissions see here. */ interface ResourceProviderRequiredPermissionsResponse { /** * Gets or sets a value indicating whether the permission is custom actions (POST). */ action?: boolean; /** * Gets or sets a value indicating whether the permission is delete action (DELETE). */ delete?: boolean; /** * Gets or sets a value indicating whether the permission is read action (GET). */ read?: boolean; /** * Gets or sets a value indicating whether the permission is write action (PUT or PATCH). */ write?: boolean; } /** * The request configuration. */ interface RestApiPollerRequestConfigResponse { /** * The API endpoint. */ apiEndpoint: string; /** * The query parameter name which the remote server expect to end query. This property goes hand to hand with `startTimeAttributeName` */ endTimeAttributeName?: string; /** * The header for the request for the remote server. */ headers?: { [key: string]: string; }; /** * The HTTP method, default value GET. */ httpMethod?: string; /** * Flag to indicate if HTTP POST payload is in JSON format (vs form-urlencoded). */ isPostPayloadJson?: boolean; /** * The HTTP query parameters to RESTful API. */ queryParameters?: any; /** * the query parameters template. Defines the query parameters template to use when passing query parameters in advanced scenarios. */ queryParametersTemplate?: string; /** * The query time format. A remote server can have a query to pull data from range 'start' to 'end'. This property indicate what is the expected time format the remote server know to parse. */ queryTimeFormat?: string; /** * The query parameter name which we need to send the server for query logs in time interval. Should be defined with `queryTimeIntervalPrepend` and `queryTimeIntervalDelimiter` */ queryTimeIntervalAttributeName?: string; /** * The delimiter string between 2 QueryTimeFormat in the query parameter `queryTimeIntervalAttributeName`. */ queryTimeIntervalDelimiter?: string; /** * The string prepend to the value of the query parameter in `queryTimeIntervalAttributeName`. */ queryTimeIntervalPrepend?: string; /** * The query window in minutes for the request. */ queryWindowInMin?: number; /** * The Rate limit queries per second for the request.. */ rateLimitQPS?: number; /** * The retry count. */ retryCount?: number; /** * The query parameter name which the remote server expect to start query. This property goes hand to hand with `endTimeAttributeName`. */ startTimeAttributeName?: string; /** * The timeout in seconds. */ timeoutInSeconds?: number; } /** * The request paging configuration. */ interface RestApiPollerRequestPagingConfigResponse { /** * Page size */ pageSize?: number; /** * Page size parameter name */ pageSizeParameterName?: string; /** * Type of paging */ pagingType: string; } /** * Represents security alert timeline item. */ interface SecurityAlertTimelineItemResponse { /** * The name of the alert type. */ alertType: string; /** * The alert azure resource id. */ azureResourceId: string; /** * The alert description. */ description?: string; /** * The alert name. */ displayName: string; /** * The alert end time. */ endTimeUtc: string; /** * The intent of the alert. */ intent: string; /** * The entity query kind * Expected value is 'SecurityAlert'. */ kind: "SecurityAlert"; /** * The alert product name. */ productName?: string; /** * The alert severity. */ severity: string; /** * The alert start time. */ startTimeUtc: string; /** * The techniques of the alert. */ techniques?: string[]; /** * The alert generated time. */ timeGenerated: string; } /** * security ml analytics settings data sources */ interface SecurityMLAnalyticsSettingsDataSourceResponse { /** * The connector id that provides the following data types */ connectorId?: string; /** * The data types used by the security ml analytics settings */ dataTypes?: string[]; } /** * Service principal metadata. */ interface ServicePrincipalResponse { /** * App id of service principal. */ appId: string; /** * Expiration time of service principal credentials. */ credentialsExpireOn?: string; /** * Id of service principal. */ id: string; /** * Tenant id of service principal. */ tenantId: string; } /** * Model for API authentication with session cookie. */ interface SessionAuthModelResponse { /** * HTTP request headers to session service endpoint. */ headers?: { [key: string]: string; }; /** * Indicating whether API key is set in HTTP POST payload. */ isPostPayloadJson?: boolean; /** * The password attribute name. */ password: { [key: string]: string; }; /** * Query parameters to session service endpoint. */ queryParameters?: any; /** * Session id attribute name from HTTP response header. */ sessionIdName?: string; /** * HTTP request URL to session service endpoint. */ sessionLoginRequestUri?: string; /** * Session timeout in minutes. */ sessionTimeoutInMinutes?: number; /** * Type of paging * Expected value is 'Session'. */ type: "Session"; /** * The user name attribute key value. */ userName: { [key: string]: string; }; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The available data types for TI (Threat Intelligence) data connector. */ interface TIDataConnectorDataTypesResponse { /** * Data type for indicators connection. */ indicators: outputs.securityinsights.TIDataConnectorDataTypesResponseIndicators; } /** * Data type for indicators connection. */ interface TIDataConnectorDataTypesResponseIndicators { /** * Describe whether this data type connection is enabled or not. */ state: string; } /** * Template property bag. */ interface TemplatePropertiesResponse { /** * The creator of the content item. */ author?: outputs.securityinsights.MetadataAuthorResponse; /** * Categories for the item */ categories?: outputs.securityinsights.MetadataCategoriesResponse; /** * Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Dynamic for user-created. This is the resource name */ contentId: string; /** * The kind of content the template is for. */ contentKind: string; /** * Unique ID for the content. It should be generated based on the contentId of the package, contentId of the template, contentKind of the template and the contentVersion of the template */ contentProductId: string; /** * Schema version of the content. Can be used to distinguish between different flow based on the schema version */ contentSchemaVersion?: string; /** * The custom version of the content. A optional free text */ customVersion?: string; /** * Dependant templates. Expandable. */ dependantTemplates: outputs.securityinsights.TemplatePropertiesResponse[]; /** * Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats. */ dependencies?: outputs.securityinsights.MetadataDependenciesResponse; /** * The display name of the template */ displayName: string; /** * first publish date content item */ firstPublishDate?: string; /** * the icon identifier. this id can later be fetched from the content metadata */ icon?: string; /** * Flag indicates if this template is deprecated */ isDeprecated: string; /** * last publish date for the content item */ lastPublishDate?: string; /** * The JSON of the ARM template to deploy active content. Expandable. */ mainTemplate?: any; /** * the package Id contains this template */ packageId: string; /** * the packageKind of the package contains this template */ packageKind?: string; /** * the name of the package contains this template */ packageName?: string; /** * Version of the package. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM metadata best practices. Can also be any string, but then we cannot guarantee any version checks */ packageVersion: string; /** * preview image file names. These will be taken from the solution artifacts */ previewImages?: string[]; /** * preview image file names. These will be taken from the solution artifacts. used for dark theme support */ previewImagesDark?: string[]; /** * Providers for the content item */ providers?: string[]; /** * Source of the content. This is where/how it was created. */ source: outputs.securityinsights.MetadataSourceResponse; /** * Support information for the template - type, name, contact information */ support?: outputs.securityinsights.MetadataSupportResponse; /** * the tactics the resource covers */ threatAnalysisTactics?: string[]; /** * the techniques the resource covers, these have to be aligned with the tactics being used */ threatAnalysisTechniques?: string[]; /** * Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM metadata best practices. Can also be any string, but then we cannot guarantee any version checks */ version: string; } /** * timeline aggregation information per kind */ interface TimelineAggregationResponse { /** * the total items found for a kind */ count: number; /** * the query kind */ kind: string; } /** * Timeline Query Errors. */ interface TimelineErrorResponse { /** * the error message */ errorMessage: string; /** * the query kind */ kind: string; /** * the query id */ queryId?: string; } /** * Expansion result metadata. */ interface TimelineResultsMetadataResponse { /** * timeline aggregation per kind */ aggregations: outputs.securityinsights.TimelineAggregationResponse[]; /** * information about the failure queries */ errors?: outputs.securityinsights.TimelineErrorResponse[]; /** * the total items found for the timeline request */ totalCount: number; } /** * User information that made some action */ interface UserInfoResponse { /** * The email of the user. */ email: string; /** * The name of the user. */ name: string; /** * The object id of the user. */ objectId?: string; } /** * Describes an error encountered in the file during validation. */ interface ValidationErrorResponse { /** * A list of descriptions of the error. */ errorMessages: string[]; /** * The number of the record that has the error. */ recordIndex?: number; } /** * User information that made some action */ interface WatchlistUserInfoResponse { /** * The email of the user. */ email: string; /** * The name of the user. */ name: string; /** * The object id of the user. */ objectId?: string; } /** * Detail about the webhook object. */ interface WebhookResponse { /** * A flag to instruct the backend service to rotate webhook secret. */ rotateWebhookSecret?: boolean; /** * Unique identifier for the webhook. */ webhookId: string; /** * Time when the webhook secret was updated. */ webhookSecretUpdateTime: string; /** * URL that gets invoked by the webhook. */ webhookUrl: string; } /** * Workload Identity Federation metadata. */ interface WorkloadIdentityFederationResponse { /** * App id of Workload Identity Federation. */ appId: string; /** * Id of Workload Identity Federation. */ id: string; /** * Issuer of Workload Identity Federation. */ issuer: string; /** * Subject of Workload Identity Federation. */ subject: string; /** * Tenant id of Workload Identity Federation. */ tenantId: string; } } export declare namespace servicebus { /** * Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter expression. */ interface ActionResponse { /** * This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. */ compatibilityLevel?: number; /** * Value that indicates whether the rule action requires preprocessing. */ requiresPreprocessing?: boolean; /** * SQL expression. e.g. MyProperty='ABC' */ sqlExpression?: string; } /** * actionResponseProvideDefaults sets the appropriate defaults for ActionResponse */ function actionResponseProvideDefaults(val: ActionResponse): ActionResponse; interface ConfidentialComputeResponse { /** * Setting to Enable or Disable Confidential Compute */ mode?: string; } /** * ConnectionState information. */ interface ConnectionStateResponse { /** * Description of the connection state. */ description?: string; /** * Status of the connection. */ status?: string; } /** * Represents the correlation filter expression. */ interface CorrelationFilterResponse { /** * Content type of the message. */ contentType?: string; /** * Identifier of the correlation. */ correlationId?: string; /** * Application specific label. */ label?: string; /** * Identifier of the message. */ messageId?: string; /** * dictionary object for custom filters */ properties?: { [key: string]: string; }; /** * Address of the queue to reply to. */ replyTo?: string; /** * Session identifier to reply to. */ replyToSessionId?: string; /** * Value that indicates whether the rule action requires preprocessing. */ requiresPreprocessing?: boolean; /** * Session identifier. */ sessionId?: string; /** * Address to send to. */ to?: string; } /** * correlationFilterResponseProvideDefaults sets the appropriate defaults for CorrelationFilterResponse */ function correlationFilterResponseProvideDefaults(val: CorrelationFilterResponse): CorrelationFilterResponse; /** * Properties to configure Encryption */ interface EncryptionResponse { /** * Enumerates the possible value of keySource for Encryption */ keySource?: string; /** * Properties of KeyVault */ keyVaultProperties?: outputs.servicebus.KeyVaultPropertiesResponse[]; /** * Enable Infrastructure Encryption (Double Encryption) */ requireInfrastructureEncryption?: boolean; } /** * encryptionResponseProvideDefaults sets the appropriate defaults for EncryptionResponse */ function encryptionResponseProvideDefaults(val: EncryptionResponse): EncryptionResponse; /** * GeoDR Replication properties */ interface GeoDataReplicationPropertiesResponse { /** * A list of regions where replicas of the namespace are maintained. */ locations?: outputs.servicebus.NamespaceReplicaLocationResponse[]; /** * The maximum acceptable lag for data replication operations from the primary replica to a quorum of secondary replicas. When the lag exceeds the configured amount, operations on the primary replica will be failed. The allowed values are 0 and 5 minutes to 1 day. */ maxReplicationLagDurationInSeconds?: number; } /** * Properties to configure User Assigned Identities for Bring your Own Keys */ interface IdentityResponse { /** * ObjectId from the KeyVault */ principalId: string; /** * TenantId from the KeyVault */ tenantId: string; /** * Type of managed service identity. */ type?: string; /** * Properties for User Assigned Identities */ userAssignedIdentities?: { [key: string]: outputs.servicebus.UserAssignedIdentityResponse; }; } /** * Properties to configure keyVault Properties */ interface KeyVaultPropertiesResponse { identity?: outputs.servicebus.UserAssignedIdentityPropertiesResponse; /** * Name of the Key from KeyVault */ keyName?: string; /** * Uri of KeyVault */ keyVaultUri?: string; /** * Version of KeyVault */ keyVersion?: string; } /** * Message Count Details. */ interface MessageCountDetailsResponse { /** * Number of active messages in the queue, topic, or subscription. */ activeMessageCount: number; /** * Number of messages that are dead lettered. */ deadLetterMessageCount: number; /** * Number of scheduled messages. */ scheduledMessageCount: number; /** * Number of messages transferred into dead letters. */ transferDeadLetterMessageCount: number; /** * Number of messages transferred to another queue, topic, or subscription. */ transferMessageCount: number; } /** * Description of NetWorkRuleSet - IpRules resource. */ interface NWRuleSetIpRulesResponse { /** * The IP Filter Action */ action?: string; /** * IP Mask */ ipMask?: string; } /** * nwruleSetIpRulesResponseProvideDefaults sets the appropriate defaults for NWRuleSetIpRulesResponse */ function nwruleSetIpRulesResponseProvideDefaults(val: NWRuleSetIpRulesResponse): NWRuleSetIpRulesResponse; /** * Description of VirtualNetworkRules - NetworkRules resource. */ interface NWRuleSetVirtualNetworkRulesResponse { /** * Value that indicates whether to ignore missing VNet Service Endpoint */ ignoreMissingVnetServiceEndpoint?: boolean; /** * Subnet properties */ subnet?: outputs.servicebus.SubnetResponse; } /** * Namespace replication properties */ interface NamespaceReplicaLocationResponse { /** * Azure regions where a replica of the namespace is maintained */ locationName?: string; /** * GeoDR Role Types */ roleType?: string; } interface PlatformCapabilitiesResponse { confidentialCompute?: outputs.servicebus.ConfidentialComputeResponse; } /** * Properties of the PrivateEndpointConnection. */ interface PrivateEndpointConnectionResponse { /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The geo-location where the resource lives */ location: string; /** * The name of the resource */ name: string; /** * The Private Endpoint resource for this Connection. */ privateEndpoint?: outputs.servicebus.PrivateEndpointResponse; /** * Details about the state of the connection. */ privateLinkServiceConnectionState?: outputs.servicebus.ConnectionStateResponse; /** * Provisioning state of the Private Endpoint Connection. */ provisioningState?: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.servicebus.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * PrivateEndpoint information. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint. */ id?: string; } /** * Properties specific to client affine subscriptions. */ interface SBClientAffinePropertiesResponse { /** * Indicates the Client ID of the application that created the client-affine subscription. */ clientId?: string; /** * For client-affine subscriptions, this value indicates whether the subscription is durable or not. */ isDurable?: boolean; /** * For client-affine subscriptions, this value indicates whether the subscription is shared or not. */ isShared?: boolean; } /** * SKU of the namespace. */ interface SBSkuResponse { /** * Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity values are 4, 8, 16, 32 and 64 */ capacity?: number; /** * Name of this SKU. */ name: string; /** * The billing tier of this particular SKU. */ tier?: string; } /** * Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline. */ interface SqlFilterResponse { /** * This property is reserved for future use. An integer value showing the compatibility level, currently hard-coded to 20. */ compatibilityLevel?: number; /** * Value that indicates whether the rule action requires preprocessing. */ requiresPreprocessing?: boolean; /** * The SQL expression. e.g. MyProperty='ABC' */ sqlExpression?: string; } /** * sqlFilterResponseProvideDefaults sets the appropriate defaults for SqlFilterResponse */ function sqlFilterResponseProvideDefaults(val: SqlFilterResponse): SqlFilterResponse; /** * Properties supplied for Subnet */ interface SubnetResponse { /** * Resource ID of Virtual Network Subnet */ id: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } interface UserAssignedIdentityPropertiesResponse { /** * ARM ID of user Identity selected for encryption */ userAssignedIdentity?: string; } /** * Recognized Dictionary value. */ interface UserAssignedIdentityResponse { /** * Client Id of user assigned identity */ clientId: string; /** * Principal Id of user assigned identity */ principalId: string; } } export declare namespace servicefabric { /** * Represents a scaling mechanism for adding or removing named partitions of a stateless service. Partition names are in the format '0','1'...'N-1'. */ interface AddRemoveIncrementalNamedPartitionScalingMechanismResponse { /** * Enumerates the ways that a service can be partitioned. * Expected value is 'AddRemoveIncrementalNamedPartition'. */ kind: "AddRemoveIncrementalNamedPartition"; /** * Maximum number of named partitions of the service. */ maxPartitionCount: number; /** * Minimum number of named partitions of the service. */ minPartitionCount: number; /** * The number of instances to add or remove during a scaling operation. */ scaleIncrement: number; } /** * Specifies the settings for a network interface to attach to the node type. */ interface AdditionalNetworkInterfaceConfigurationResponse { /** * Specifies the DSCP configuration to apply to the network interface. */ dscpConfiguration?: outputs.servicefabric.SubResourceResponse; /** * Specifies whether the network interface is accelerated networking-enabled. */ enableAcceleratedNetworking?: boolean; /** * Specifies the IP configurations of the network interface. */ ipConfigurations: outputs.servicefabric.IpConfigurationResponse[]; /** * Name of the network interface. */ name: string; } /** * Defines a health policy used to evaluate the health of an application or one of its children entities. */ interface ApplicationHealthPolicyResponse { /** * Indicates whether warnings are treated with the same severity as errors. */ considerWarningAsError: boolean; /** * The health policy used by default to evaluate the health of a service type. */ defaultServiceTypeHealthPolicy?: outputs.servicefabric.ServiceTypeHealthPolicyResponse; /** * The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. * The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. * This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. * The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. */ maxPercentUnhealthyDeployedApplications: number; /** * The map with service type health policy per service type name. The map is empty by default. */ serviceTypeHealthPolicyMap?: { [key: string]: outputs.servicefabric.ServiceTypeHealthPolicyResponse; }; } /** * The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3. */ interface ApplicationTypeVersionsCleanupPolicyResponse { /** * Number of unused versions per application type to keep. */ maxUnusedVersionsToKeep: number; } /** * Describes the policy for a monitored application upgrade. */ interface ApplicationUpgradePolicyResponse { /** * Defines a health policy used to evaluate the health of an application or one of its children entities. */ applicationHealthPolicy?: outputs.servicefabric.ApplicationHealthPolicyResponse; /** * If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). */ forceRestart?: boolean; /** * Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. */ instanceCloseDelayDuration?: number; /** * Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed. */ recreateApplication?: boolean; /** * The policy used for monitoring the application upgrade */ rollingUpgradeMonitoringPolicy?: outputs.servicefabric.RollingUpgradeMonitoringPolicyResponse; /** * The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto. */ upgradeMode?: string; /** * The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). */ upgradeReplicaSetCheckTimeout?: number; } interface ApplicationUserAssignedIdentityResponse { /** * The friendly name of user assigned identity. */ name: string; /** * The principal id of user assigned identity. */ principalId: string; } /** * Represents a scaling trigger related to an average load of a metric/resource of a partition. */ interface AveragePartitionLoadScalingTriggerResponse { /** * Enumerates the ways that a service can be partitioned. * Expected value is 'AveragePartitionLoadTrigger'. */ kind: "AveragePartitionLoadTrigger"; /** * The lower limit of the load below which a scale in operation should be performed. */ lowerLoadThreshold: number; /** * The name of the metric for which usage should be tracked. */ metricName: string; /** * The period in seconds on which a decision is made whether to scale or not. This property should come in ISO 8601 format "hh:mm:ss". */ scaleInterval: string; /** * The upper limit of the load beyond which a scale out operation should be performed. */ upperLoadThreshold: number; } /** * Represents a scaling policy related to an average load of a metric/resource of a service. */ interface AverageServiceLoadScalingTriggerResponse { /** * Enumerates the ways that a service can be partitioned. * Expected value is 'AverageServiceLoadTrigger'. */ kind: "AverageServiceLoadTrigger"; /** * The lower limit of the load below which a scale in operation should be performed. */ lowerLoadThreshold: number; /** * The name of the metric for which usage should be tracked. */ metricName: string; /** * The period in seconds on which a decision is made whether to scale or not. This property should come in ISO 8601 format "hh:mm:ss". */ scaleInterval: string; /** * The upper limit of the load beyond which a scale out operation should be performed. */ upperLoadThreshold: number; /** * Flag determines whether only the load of primary replica should be considered for scaling. If set to true, then trigger will only consider the load of primary replicas of stateful service. If set to false, trigger will consider load of all replicas. This parameter cannot be set to true for stateless service. */ useOnlyPrimaryLoad: boolean; } /** * The settings to enable AAD authentication on the cluster. */ interface AzureActiveDirectoryResponse { /** * Azure active directory client application id. */ clientApplication?: string; /** * Azure active directory cluster application id. */ clusterApplication?: string; /** * Azure active directory tenant id. */ tenantId?: string; } /** * Client certificate definition. */ interface ClientCertificateResponse { /** * Certificate common name. */ commonName?: string; /** * Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster. */ isAdmin: boolean; /** * Issuer thumbprint for the certificate. Only used together with CommonName. */ issuerThumbprint?: string; /** * Certificate thumbprint. */ thumbprint?: string; } /** * Defines a health policy used to evaluate the health of the cluster or of a cluster node. */ interface ClusterHealthPolicyResponse { /** * The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. * * The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. * If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. * This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. * The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. */ maxPercentUnhealthyApplications: number; /** * The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. * * The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. * If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. * The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. * The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. * * In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. */ maxPercentUnhealthyNodes: number; } /** * clusterHealthPolicyResponseProvideDefaults sets the appropriate defaults for ClusterHealthPolicyResponse */ function clusterHealthPolicyResponseProvideDefaults(val: ClusterHealthPolicyResponse): ClusterHealthPolicyResponse; /** * Describes the monitoring policies for the cluster upgrade. */ interface ClusterMonitoringPolicyResponse { /** * The amount of time to retry health evaluation when the application or cluster is unhealthy before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. */ healthCheckRetryTimeout: string; /** * The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. */ healthCheckStableDuration: string; /** * The length of time to wait after completing an upgrade domain before performing health checks. The duration can be in either hh:mm:ss or in d.hh:mm:ss.ms format. */ healthCheckWaitDuration: string; /** * The amount of time each upgrade domain has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. */ upgradeDomainTimeout: string; /** * The amount of time the overall upgrade has to complete before the upgrade rolls back. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. */ upgradeTimeout: string; } /** * Describes the delta health policies for the cluster upgrade. */ interface ClusterUpgradeDeltaHealthPolicyResponse { /** * The maximum allowed percentage of applications health degradation allowed during cluster upgrades. * The delta is measured between the state of the applications at the beginning of upgrade and the state of the applications at the time of the health evaluation. * The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. System services are not included in this. * NOTE: This value will overwrite the value specified in properties.UpgradeDescription.HealthPolicy.MaxPercentUnhealthyApplications */ maxPercentDeltaUnhealthyApplications?: number; /** * The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. * The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. * The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. */ maxPercentDeltaUnhealthyNodes: number; /** * The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. * The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. * The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. */ maxPercentUpgradeDomainDeltaUnhealthyNodes?: number; } /** * Describes the policy used when upgrading the cluster. */ interface ClusterUpgradePolicyResponse { /** * The cluster delta health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade. */ deltaHealthPolicy?: outputs.servicefabric.ClusterUpgradeDeltaHealthPolicyResponse; /** * If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). */ forceRestart?: boolean; /** * The cluster health policy defines a health policy used to evaluate the health of the cluster during a cluster upgrade. */ healthPolicy?: outputs.servicefabric.ClusterHealthPolicyResponse; /** * The cluster monitoring policy describes the parameters for monitoring an upgrade in Monitored mode. */ monitoringPolicy?: outputs.servicefabric.ClusterMonitoringPolicyResponse; /** * The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. * When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. * The timeout is reset at the start of each upgrade domain. The timeout can be in either hh:mm:ss or in d.hh:mm:ss.ms format. * This value must be between 00:00:00 and 49710.06:28:15 (unsigned 32 bit integer for seconds) */ upgradeReplicaSetCheckTimeout?: string; } /** * clusterUpgradePolicyResponseProvideDefaults sets the appropriate defaults for ClusterUpgradePolicyResponse */ function clusterUpgradePolicyResponseProvideDefaults(val: ClusterUpgradePolicyResponse): ClusterUpgradePolicyResponse; /** * Port range details */ interface EndpointRangeDescriptionResponse { /** * End port of a range of ports */ endPort: number; /** * Starting port of a range of ports */ startPort: number; } /** * Constraints for Fault Simulation action. */ interface FaultSimulationConstraintsResponse { /** * The absolute expiration timestamp (UTC) after which this fault simulation should be stopped if it's still active. */ expirationTime?: string; } /** * Details for Fault Simulation. */ interface FaultSimulationDetailsResponse { /** * unique identifier for the cluster resource. */ clusterId?: string; /** * List of node type simulations associated with the cluster fault simulation. */ nodeTypeFaultSimulation?: outputs.servicefabric.NodeTypeFaultSimulationResponse[]; /** * unique identifier for the operation associated with the fault simulation. */ operationId?: string; /** * Fault simulation parameters. */ parameters?: outputs.servicefabric.ZoneFaultSimulationContentResponse; } /** * Fault simulation object with status. */ interface FaultSimulationResponse { /** * Fault simulation details */ details?: outputs.servicefabric.FaultSimulationDetailsResponse; /** * The end time of the fault simulation. */ endTime?: string; /** * unique identifier for the fault simulation. */ simulationId?: string; /** * The start time of the fault simulation. */ startTime?: string; /** * Fault simulation status */ status?: string; } /** * Describes the frontend configurations for the node type. */ interface FrontendConfigurationResponse { /** * The resource Id of application gateway backend address pool. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/applicationGateways//backendAddressPools/'. */ applicationGatewayBackendAddressPoolId?: string; /** * The IP address type of this frontend configuration. If omitted the default value is IPv4. */ ipAddressType?: string; /** * The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'. */ loadBalancerBackendAddressPoolId?: string; /** * The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'. */ loadBalancerInboundNatPoolId?: string; } /** * Specifies an IP configuration of the network interface. */ interface IpConfigurationResponse { /** * Specifies an array of references to backend address pools of application gateways. A node type can reference backend address pools of multiple application gateways. Multiple node types cannot use the same application gateway. */ applicationGatewayBackendAddressPools?: outputs.servicefabric.SubResourceResponse[]; /** * Specifies an array of references to backend address pools of load balancers. A node type can reference backend address pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer. */ loadBalancerBackendAddressPools?: outputs.servicefabric.SubResourceResponse[]; /** * Specifies an array of references to inbound Nat pools of the load balancers. A node type can reference inbound nat pools of one public and one internal load balancer. Multiple node types cannot use the same basic sku load balancer. */ loadBalancerInboundNatPools?: outputs.servicefabric.SubResourceResponse[]; /** * Name of the network interface. */ name: string; /** * Specifies whether the IP configuration's private IP is IPv4 or IPv6. Default is IPv4. */ privateIPAddressVersion?: string; /** * The public IP address configuration of the network interface. */ publicIPAddressConfiguration?: outputs.servicefabric.IpConfigurationResponsePublicIPAddressConfiguration; /** * Specifies the subnet of the network interface. */ subnet?: outputs.servicefabric.SubResourceResponse; } /** * ipConfigurationResponseProvideDefaults sets the appropriate defaults for IpConfigurationResponse */ function ipConfigurationResponseProvideDefaults(val: IpConfigurationResponse): IpConfigurationResponse; /** * The public IP address configuration of the network interface. */ interface IpConfigurationResponsePublicIPAddressConfiguration { /** * Specifies the list of IP tags associated with the public IP address. */ ipTags?: outputs.servicefabric.IpTagResponse[]; /** * Name of the network interface. */ name: string; /** * Specifies whether the IP configuration's public IP is IPv4 or IPv6. Default is IPv4. */ publicIPAddressVersion?: string; } /** * ipConfigurationResponsePublicIPAddressConfigurationProvideDefaults sets the appropriate defaults for IpConfigurationResponsePublicIPAddressConfiguration */ function ipConfigurationResponsePublicIPAddressConfigurationProvideDefaults(val: IpConfigurationResponsePublicIPAddressConfiguration): IpConfigurationResponsePublicIPAddressConfiguration; /** * The IP tag associated with the public IP address. */ interface IpTagResponse { /** * IP tag type. Example: FirstPartyUsage. */ ipTagType: string; /** * IP tag associated with the public IP. Example: SQL, Storage etc. */ tag: string; } /** * Describes a load balancing rule. */ interface LoadBalancingRuleResponse { /** * The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535. */ backendPort: number; /** * The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534. */ frontendPort: number; /** * The load distribution policy for this rule. */ loadDistribution?: string; /** * The prob port used by the load balancing rule. Acceptable values are between 1 and 65535. */ probePort?: number; /** * the reference to the load balancer probe used by the load balancing rule. */ probeProtocol: string; /** * The probe request path. Only supported for HTTP/HTTPS probes. */ probeRequestPath?: string; /** * The reference to the transport protocol used by the load balancing rule. */ protocol: string; } /** * Describes the managed identities for an Azure resource. */ interface ManagedIdentityResponse { /** * The principal id of the managed identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant id of the managed identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * The type of managed identity for the resource. */ type?: string; /** * The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: * '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.servicefabric.UserAssignedIdentityResponse; }; } /** * Describes the named partition scheme of the service. */ interface NamedPartitionSchemeResponse { /** * Array for the names of the partitions. */ names: string[]; /** * Enumerates the ways that a service can be partitioned. * Expected value is 'Named'. */ partitionScheme: "Named"; } /** * Describes a network security rule. */ interface NetworkSecurityRuleResponse { /** * The network traffic is allowed or denied. */ access: string; /** * Network security rule description. */ description?: string; /** * The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. */ destinationAddressPrefix?: string; /** * The destination address prefixes. CIDR or destination IP ranges. */ destinationAddressPrefixes?: string[]; /** * he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. */ destinationPortRange?: string; /** * The destination port ranges. */ destinationPortRanges?: string[]; /** * Network security rule direction. */ direction: string; /** * Network security rule name. */ name: string; /** * The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule. */ priority: number; /** * Network protocol this rule applies to. */ protocol: string; /** * The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from. */ sourceAddressPrefix?: string; /** * The CIDR or source IP ranges. */ sourceAddressPrefixes?: string[]; /** * The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports. */ sourcePortRange?: string; /** * The source port ranges. */ sourcePortRanges?: string[]; } /** * Node type fault simulation object with status. */ interface NodeTypeFaultSimulationResponse { /** * Node type name. */ nodeTypeName?: string; /** * Current or latest asynchronous operation identifier on the node type. */ operationId?: string; /** * Current or latest asynchronous operation status on the node type */ operationStatus: string; /** * Fault simulation status */ status?: string; } /** * Provides information about NAT configuration on the default public Load Balancer for the node type. */ interface NodeTypeNatConfigResponse { /** * The internal port for the NAT configuration. */ backendPort?: number; /** * The port range end for the external endpoint. */ frontendPortRangeEnd?: number; /** * The port range start for the external endpoint. */ frontendPortRangeStart?: number; } /** * Describes a node type sku. */ interface NodeTypeSkuResponse { /** * The number of nodes in the node type.

    If present in request it will override properties.vmInstanceCount. */ capacity: number; /** * The sku name.

    Name is internally generated and is used in auto-scale scenarios.
    Property does not allow to be changed to other values than generated.
    To avoid deployment errors please omit the property. */ name?: string; /** * Specifies the tier of the node type.

    Possible Values:
    **Standard** */ tier?: string; } /** * Represents a scaling mechanism for adding or removing instances of stateless service partition. */ interface PartitionInstanceCountScaleMechanismResponse { /** * Enumerates the ways that a service can be partitioned. * Expected value is 'ScalePartitionInstanceCount'. */ kind: "ScalePartitionInstanceCount"; /** * Maximum number of instances of the partition. */ maxInstanceCount: number; /** * Minimum number of instances of the partition. */ minInstanceCount: number; /** * The number of instances to add or remove during a scaling operation. */ scaleIncrement: number; } /** * Describes Az Resiliency status of Base resources */ interface ResourceAzStatusResponse { /** * Zone resiliency status details for the resource. */ details: string; /** * VM Size name. */ isZoneResilient: boolean; /** * VM Size properties. */ resourceName: string; /** * VM Size id. */ resourceType: string; } /** * The policy used for monitoring the application upgrade */ interface RollingUpgradeMonitoringPolicyResponse { /** * The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. */ failureAction: string; /** * The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". */ healthCheckRetryTimeout: string; /** * The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". */ healthCheckStableDuration: string; /** * The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". */ healthCheckWaitDuration: string; /** * The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". */ upgradeDomainTimeout: string; /** * The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format "hh:mm:ss.fff". */ upgradeTimeout: string; } /** * Specifies a metric to load balance a service during runtime. */ interface ScalingPolicyResponse { /** * Specifies the mechanism associated with this scaling policy */ scalingMechanism: outputs.servicefabric.AddRemoveIncrementalNamedPartitionScalingMechanismResponse | outputs.servicefabric.PartitionInstanceCountScaleMechanismResponse; /** * Specifies the trigger associated with this scaling policy. */ scalingTrigger: outputs.servicefabric.AveragePartitionLoadScalingTriggerResponse | outputs.servicefabric.AverageServiceLoadScalingTriggerResponse; } /** * Creates a particular correlation between services. */ interface ServiceCorrelationResponse { /** * The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName. */ scheme: string; /** * The Arm Resource ID of the service that the correlation relationship is established with. */ serviceName: string; } /** * The service endpoint properties. */ interface ServiceEndpointResponse { /** * A list of locations. */ locations?: string[]; /** * The type of the endpoint service. */ service: string; } /** * Specifies a metric to load balance a service during runtime. */ interface ServiceLoadMetricResponse { /** * Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric. */ defaultLoad?: number; /** * The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive. */ name: string; /** * Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica. */ primaryDefaultLoad?: number; /** * Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica. */ secondaryDefaultLoad?: number; /** * The service load metric relative weight, compared to other metrics configured for this service, as a number. */ weight?: string; } /** * Describes the policy to be used for placement of a Service Fabric service where a particular fault or upgrade domain should not be used for placement of the instances or replicas of that service. */ interface ServicePlacementInvalidDomainPolicyResponse { /** * The name of the domain that should not be used for placement. */ domainName: string; /** * The type of placement policy for a service fabric service. Following are the possible values. * Expected value is 'InvalidDomain'. */ type: "InvalidDomain"; } /** * The name of the domain that should used for placement as per this policy. */ interface ServicePlacementNonPartiallyPlaceServicePolicyResponse { /** * The type of placement policy for a service fabric service. Following are the possible values. * Expected value is 'NonPartiallyPlaceService'. */ type: "NonPartiallyPlaceService"; } /** * Describes the policy to be used for placement of a Service Fabric service where the service's * Primary replicas should optimally be placed in a particular domain. * * This placement policy is usually used with fault domains in scenarios where the Service Fabric * cluster is geographically distributed in order to indicate that a service's primary replica should * be located in a particular fault domain, which in geo-distributed scenarios usually aligns with regional * or datacenter boundaries. Note that since this is an optimization it is possible that the Primary replica * may not end up located in this domain due to failures, capacity limits, or other constraints. */ interface ServicePlacementPreferPrimaryDomainPolicyResponse { /** * The name of the domain that should used for placement as per this policy. */ domainName: string; /** * The type of placement policy for a service fabric service. Following are the possible values. * Expected value is 'PreferredPrimaryDomain'. */ type: "PreferredPrimaryDomain"; } /** * Describes the policy to be used for placement of a Service Fabric service where two replicas * from the same partition should never be placed in the same fault or upgrade domain. * * While this is not common it can expose the service to an increased risk of concurrent failures * due to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider * a case where replicas are deployed across different data center, with one replica per location. * In the event that one of the datacenters goes offline, normally the replica that was placed in that * datacenter will be packed into one of the remaining datacenters. If this is not desirable then this * policy should be set. */ interface ServicePlacementRequireDomainDistributionPolicyResponse { /** * The name of the domain that should used for placement as per this policy. */ domainName: string; /** * The type of placement policy for a service fabric service. Following are the possible values. * Expected value is 'RequiredDomainDistribution'. */ type: "RequiredDomainDistribution"; } /** * Describes the policy to be used for placement of a Service Fabric service where the instances or replicas of that service must be placed in a particular domain. */ interface ServicePlacementRequiredDomainPolicyResponse { /** * The name of the domain that should used for placement as per this policy. */ domainName: string; /** * The type of placement policy for a service fabric service. Following are the possible values. * Expected value is 'RequiredDomain'. */ type: "RequiredDomain"; } /** * Represents the health policy used to evaluate the health of services belonging to a service type. */ interface ServiceTypeHealthPolicyResponse { /** * The maximum allowed percentage of unhealthy partitions per service. * * The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. * If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. * The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. * The computation rounds up to tolerate one failure on small numbers of partitions. */ maxPercentUnhealthyPartitionsPerService: number; /** * The maximum allowed percentage of unhealthy replicas per partition. * * The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. * If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. * The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. * The computation rounds up to tolerate one failure on small numbers of replicas. */ maxPercentUnhealthyReplicasPerPartition: number; /** * The maximum allowed percentage of unhealthy services. * * The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. * If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. * This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. * The computation rounds up to tolerate one failure on small numbers of services. */ maxPercentUnhealthyServices: number; } /** * Describes a parameter in fabric settings of the cluster. */ interface SettingsParameterDescriptionResponse { /** * The parameter name of fabric setting. */ name: string; /** * The parameter value of fabric setting. */ value: string; } /** * Describes a section in the fabric settings of the cluster. */ interface SettingsSectionDescriptionResponse { /** * The section name of the fabric settings. */ name: string; /** * The collection of parameters in the section. */ parameters: outputs.servicefabric.SettingsParameterDescriptionResponse[]; } /** * Describes the partition scheme of a singleton-partitioned, or non-partitioned service. */ interface SingletonPartitionSchemeResponse { /** * Enumerates the ways that a service can be partitioned. * Expected value is 'Singleton'. */ partitionScheme: "Singleton"; } /** * Service Fabric managed cluster Sku definition */ interface SkuResponse { /** * Sku Name. */ name: string; } /** * The properties of a stateful service resource. */ interface StatefulServicePropertiesResponse { /** * A list that describes the correlation of the service with other services. */ correlationScheme?: outputs.servicefabric.ServiceCorrelationResponse[]; /** * Specifies the move cost for the service. */ defaultMoveCost?: string; /** * A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false. */ hasPersistedState?: boolean; /** * The minimum replica set size as a number. */ minReplicaSetSize?: number; /** * Describes how the service is partitioned. */ partitionDescription: outputs.servicefabric.NamedPartitionSchemeResponse | outputs.servicefabric.SingletonPartitionSchemeResponse | outputs.servicefabric.UniformInt64RangePartitionSchemeResponse; /** * The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)". */ placementConstraints?: string; /** * The current deployment or provisioning state, which only appears in the response */ provisioningState: string; /** * The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format "hh:mm:ss". */ quorumLossWaitDuration?: string; /** * The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format "hh:mm:ss". */ replicaRestartWaitDuration?: string; /** * Scaling policies for this service. */ scalingPolicies?: outputs.servicefabric.ScalingPolicyResponse[]; /** * Dns name used for the service. If this is specified, then the DNS name can be used to return the IP addresses of service endpoints for application layer protocols (e.g., HTTP). * When updating serviceDnsName, old name may be temporarily resolvable. However, rely on new name. * When removing serviceDnsName, removed name may temporarily be resolvable. Do not rely on the name being unresolvable. */ serviceDnsName?: string; /** * The kind of service (Stateless or Stateful). * Expected value is 'Stateful'. */ serviceKind: "Stateful"; /** * The service load metrics is given as an array of ServiceLoadMetric objects. */ serviceLoadMetrics?: outputs.servicefabric.ServiceLoadMetricResponse[]; /** * The activation Mode of the service package */ servicePackageActivationMode?: string; /** * A list that describes the correlation of the service with other services. */ servicePlacementPolicies?: (outputs.servicefabric.ServicePlacementInvalidDomainPolicyResponse | outputs.servicefabric.ServicePlacementNonPartiallyPlaceServicePolicyResponse | outputs.servicefabric.ServicePlacementPreferPrimaryDomainPolicyResponse | outputs.servicefabric.ServicePlacementRequireDomainDistributionPolicyResponse | outputs.servicefabric.ServicePlacementRequiredDomainPolicyResponse)[]; /** * The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format "hh:mm:ss". */ servicePlacementTimeLimit?: string; /** * The name of the service type */ serviceTypeName: string; /** * The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format "hh:mm:ss". */ standByReplicaKeepDuration?: string; /** * The target replica set size as a number. */ targetReplicaSetSize?: number; } /** * The properties of a stateless service resource. */ interface StatelessServicePropertiesResponse { /** * A list that describes the correlation of the service with other services. */ correlationScheme?: outputs.servicefabric.ServiceCorrelationResponse[]; /** * Specifies the move cost for the service. */ defaultMoveCost?: string; /** * The instance count. */ instanceCount: number; /** * MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. */ minInstanceCount?: number; /** * MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service. */ minInstancePercentage?: number; /** * Describes how the service is partitioned. */ partitionDescription: outputs.servicefabric.NamedPartitionSchemeResponse | outputs.servicefabric.SingletonPartitionSchemeResponse | outputs.servicefabric.UniformInt64RangePartitionSchemeResponse; /** * The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)". */ placementConstraints?: string; /** * The current deployment or provisioning state, which only appears in the response */ provisioningState: string; /** * Scaling policies for this service. */ scalingPolicies?: outputs.servicefabric.ScalingPolicyResponse[]; /** * Dns name used for the service. If this is specified, then the DNS name can be used to return the IP addresses of service endpoints for application layer protocols (e.g., HTTP). * When updating serviceDnsName, old name may be temporarily resolvable. However, rely on new name. * When removing serviceDnsName, removed name may temporarily be resolvable. Do not rely on the name being unresolvable. */ serviceDnsName?: string; /** * The kind of service (Stateless or Stateful). * Expected value is 'Stateless'. */ serviceKind: "Stateless"; /** * The service load metrics is given as an array of ServiceLoadMetric objects. */ serviceLoadMetrics?: outputs.servicefabric.ServiceLoadMetricResponse[]; /** * The activation Mode of the service package */ servicePackageActivationMode?: string; /** * A list that describes the correlation of the service with other services. */ servicePlacementPolicies?: (outputs.servicefabric.ServicePlacementInvalidDomainPolicyResponse | outputs.servicefabric.ServicePlacementNonPartiallyPlaceServicePolicyResponse | outputs.servicefabric.ServicePlacementPreferPrimaryDomainPolicyResponse | outputs.servicefabric.ServicePlacementRequireDomainDistributionPolicyResponse | outputs.servicefabric.ServicePlacementRequiredDomainPolicyResponse)[]; /** * The name of the service type */ serviceTypeName: string; } /** * Azure resource identifier. */ interface SubResourceResponse { /** * Azure resource identifier. */ id?: string; } /** * Describes a Subnet. */ interface SubnetResponse { /** * Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster. */ enableIpv6?: boolean; /** * Subnet name. */ name: string; /** * Full resource id for the network security group. */ networkSecurityGroupId?: string; /** * Enable or Disable apply network policies on private end point in the subnet. */ privateEndpointNetworkPolicies?: string; /** * Enable or Disable apply network policies on private link service in the subnet. */ privateLinkServiceNetworkPolicies?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC). */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions. */ interface UniformInt64RangePartitionSchemeResponse { /** * The number of partitions. */ count: number; /** * The upper bound of the partition key range that * should be split between the partition ‘Count’ */ highKey: number; /** * The lower bound of the partition key range that * should be split between the partition ‘Count’ */ lowKey: number; /** * Enumerates the ways that a service can be partitioned. * Expected value is 'UniformInt64Range'. */ partitionScheme: "UniformInt64Range"; } interface UserAssignedIdentityResponse { /** * The client id of user assigned identity. */ clientId: string; /** * The principal id of user assigned identity. */ principalId: string; } /** * Specifies set of extensions that should be installed onto the virtual machines. */ interface VMSSExtensionResponse { /** * Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. */ autoUpgradeMinorVersion?: boolean; /** * Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available. */ enableAutomaticUpgrade?: boolean; /** * If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed. */ forceUpdateTag?: string; /** * The name of the extension. */ name: string; /** * The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. */ protectedSettings?: any; /** * Collection of extension names after which this extension needs to be provisioned. */ provisionAfterExtensions?: string[]; /** * The provisioning state, which only appears in the response. */ provisioningState: string; /** * The name of the extension handler publisher. */ publisher: string; /** * Json formatted public settings for the extension. */ settings?: any; /** * Indicates the setup order for the extension. */ setupOrder?: string[]; /** * Specifies the type of the extension; an example is "CustomScriptExtension". */ type: string; /** * Specifies the version of the script handler. */ typeHandlerVersion: string; } /** * Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM. */ interface VaultCertificateResponse { /** * For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

    For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted. */ certificateStore: string; /** * This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

    {
    "data":"",
    "dataType":"pfx",
    "password":""
    } */ certificateUrl: string; } /** * Specifies set of certificates that should be installed onto the virtual machines. */ interface VaultSecretGroupResponse { /** * The relative URL of the Key Vault containing all of the certificates in VaultCertificates. */ sourceVault: outputs.servicefabric.SubResourceResponse; /** * The list of key vault references in SourceVault which contain certificates. */ vaultCertificates: outputs.servicefabric.VaultCertificateResponse[]; } /** * Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save. */ interface VmImagePlanResponse { /** * The plan ID. */ name?: string; /** * Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element. */ product?: string; /** * The promotion code. */ promotionCode?: string; /** * The publisher ID. */ publisher?: string; } /** * Identities for the virtual machine scale set under the node type. */ interface VmManagedIdentityResponse { /** * The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: string[]; } /** * Managed data disk description. */ interface VmssDataDiskResponse { /** * Managed data disk letter. It can not use the reserved letter C or D and it can not change after created. */ diskLetter: string; /** * Disk size for each vm in the node type in GBs. */ diskSizeGB: number; /** * Managed data disk type. Specifies the storage account type for the managed disk */ diskType: string; /** * Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. Lun 0 is reserved for the service fabric data disk. */ lun: number; } /** * Parameters for Zone Fault Simulation action. */ interface ZoneFaultSimulationContentResponse { /** * Constraints for Fault Simulation action. */ constraints?: outputs.servicefabric.FaultSimulationConstraintsResponse; /** * The kind of fault simulation. * Expected value is 'Zone'. */ faultKind: "Zone"; /** * Force the action to go through without any check on the cluster. */ force?: boolean; /** * Indicates the zones of the fault simulation. */ zones?: string[]; } } export declare namespace servicefabricmesh { /** * Describes the horizontal auto scaling mechanism that adds or removes replicas (containers or container groups). */ interface AddRemoveReplicaScalingMechanismResponse { /** * Enumerates the mechanisms for auto scaling. * Expected value is 'AddRemoveReplica'. */ kind: "AddRemoveReplica"; /** * Maximum number of containers (scale up won't be performed above this number). */ maxCount: number; /** * Minimum number of containers (scale down won't be performed below this number). */ minCount: number; /** * Each time auto scaling is performed, this number of containers will be added or removed. */ scaleIncrement: number; } /** * Describes parameters for creating application-scoped volumes provided by Service Fabric Volume Disks */ interface ApplicationScopedVolumeCreationParametersServiceFabricVolumeDiskResponse { /** * User readable description of the volume. */ description?: string; /** * Specifies the application-scoped volume kind. * Expected value is 'ServiceFabricVolumeDisk'. */ kind: "ServiceFabricVolumeDisk"; /** * Volume size */ sizeDisk: string; } /** * Describes a volume whose lifetime is scoped to the application's lifetime. */ interface ApplicationScopedVolumeResponse { /** * Describes parameters for creating application-scoped volumes. */ creationParameters: outputs.servicefabricmesh.ApplicationScopedVolumeCreationParametersServiceFabricVolumeDiskResponse; /** * The path within the container at which the volume should be mounted. Only valid path characters are allowed. */ destinationPath: string; /** * Name of the volume being referenced. */ name: string; /** * The flag indicating whether the volume is read only. Default is 'false'. */ readOnly?: boolean; } /** * Describes the auto scaling policy */ interface AutoScalingPolicyResponse { /** * The mechanism that is used to scale when auto scaling operation is invoked. */ mechanism: outputs.servicefabricmesh.AddRemoveReplicaScalingMechanismResponse; /** * The name of the auto scaling policy. */ name: string; /** * Determines when auto scaling operation will be invoked. */ trigger: outputs.servicefabricmesh.AverageLoadScalingTriggerResponse; } /** * Describes the resource that is used for triggering auto scaling. */ interface AutoScalingResourceMetricResponse { /** * Enumerates the metrics that are used for triggering auto scaling. * Expected value is 'Resource'. */ kind: "Resource"; /** * Name of the resource. */ name: string; } /** * Describes the average load trigger used for auto scaling. */ interface AverageLoadScalingTriggerResponse { /** * Enumerates the triggers for auto scaling. * Expected value is 'AverageLoad'. */ kind: "AverageLoad"; /** * Lower load threshold (if average load is below this threshold, service will scale down). */ lowerLoadThreshold: number; /** * Description of the metric that is used for scaling. */ metric: outputs.servicefabricmesh.AutoScalingResourceMetricResponse; /** * Scale interval that indicates how often will this trigger be checked. */ scaleIntervalInSeconds: number; /** * Upper load threshold (if average load is above this threshold, service will scale up). */ upperLoadThreshold: number; } /** * Diagnostics settings for Geneva. */ interface AzureInternalMonitoringPipelineSinkDescriptionResponse { /** * Azure Internal monitoring pipeline account. */ accountName?: string; /** * Azure Internal monitoring pipeline autokey associated with the certificate. */ autoKeyConfigUrl?: string; /** * A description of the sink. */ description?: string; /** * Azure Internal monitoring agent fluentd configuration. */ fluentdConfigUrl?: any; /** * The kind of DiagnosticsSink. * Expected value is 'AzureInternalMonitoringPipeline'. */ kind: "AzureInternalMonitoringPipeline"; /** * Azure Internal monitoring agent configuration. */ maConfigUrl?: string; /** * Name of the sink. This value is referenced by DiagnosticsReferenceDescription */ name?: string; /** * Azure Internal monitoring pipeline account namespace. */ namespace?: string; } /** * Describes a container and its runtime properties. */ interface ContainerCodePackagePropertiesResponse { /** * Command array to execute within the container in exec form. */ commands?: string[]; /** * Reference to sinks in DiagnosticsDescription. */ diagnostics?: outputs.servicefabricmesh.DiagnosticsRefResponse; /** * The endpoints exposed by this container. */ endpoints?: outputs.servicefabricmesh.EndpointPropertiesResponse[]; /** * Override for the default entry point in the container. */ entrypoint?: string; /** * The environment variables to set in this container */ environmentVariables?: outputs.servicefabricmesh.EnvironmentVariableResponse[]; /** * The Container image to use. */ image: string; /** * Image registry credential. */ imageRegistryCredential?: outputs.servicefabricmesh.ImageRegistryCredentialResponse; /** * Runtime information of a container instance. */ instanceView: outputs.servicefabricmesh.ContainerInstanceViewResponse; /** * The labels to set in this container. */ labels?: outputs.servicefabricmesh.ContainerLabelResponse[]; /** * The name of the code package. */ name: string; /** * A list of ReliableCollection resources used by this particular code package. Please refer to ReliableCollectionsRef for more details. */ reliableCollectionsRefs?: outputs.servicefabricmesh.ReliableCollectionsRefResponse[]; /** * The resources required by this container. */ resources: outputs.servicefabricmesh.ResourceRequirementsResponse; /** * The settings to set in this container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\\secrets". The path for Linux container is "/var/secrets". */ settings?: outputs.servicefabricmesh.SettingResponse[]; /** * Volumes to be attached to the container. The lifetime of these volumes is independent of the application's lifetime. */ volumeRefs?: outputs.servicefabricmesh.VolumeReferenceResponse[]; /** * Volumes to be attached to the container. The lifetime of these volumes is scoped to the application's lifetime. */ volumes?: outputs.servicefabricmesh.ApplicationScopedVolumeResponse[]; } /** * A container event. */ interface ContainerEventResponse { /** * The count of the event. */ count?: number; /** * Date/time of the first event. */ firstTimestamp?: string; /** * Date/time of the last event. */ lastTimestamp?: string; /** * The event message */ message?: string; /** * The name of the container event. */ name?: string; /** * The event type. */ type?: string; } /** * Runtime information of a container instance. */ interface ContainerInstanceViewResponse { /** * Current container instance state. */ currentState?: outputs.servicefabricmesh.ContainerStateResponse; /** * The events of this container instance. */ events?: outputs.servicefabricmesh.ContainerEventResponse[]; /** * Previous container instance state. */ previousState?: outputs.servicefabricmesh.ContainerStateResponse; /** * The number of times the container has been restarted. */ restartCount?: number; } /** * Describes a container label. */ interface ContainerLabelResponse { /** * The name of the container label. */ name: string; /** * The value of the container label. */ value: string; } /** * The container state. */ interface ContainerStateResponse { /** * Human-readable status of this state. */ detailStatus?: string; /** * The container exit code. */ exitCode?: string; /** * Date/time when the container state finished. */ finishTime?: string; /** * Date/time when the container state started. */ startTime?: string; /** * The state of this container */ state?: string; } /** * Describes the diagnostics options available */ interface DiagnosticsDescriptionResponse { /** * The sinks to be used if diagnostics is enabled. Sink choices can be overridden at the service and code package level. */ defaultSinkRefs?: string[]; /** * Status of whether or not sinks are enabled. */ enabled?: boolean; /** * List of supported sinks that can be referenced. */ sinks?: outputs.servicefabricmesh.AzureInternalMonitoringPipelineSinkDescriptionResponse[]; } /** * Reference to sinks in DiagnosticsDescription. */ interface DiagnosticsRefResponse { /** * Status of whether or not sinks are enabled. */ enabled?: boolean; /** * List of sinks to be used if enabled. References the list of sinks in DiagnosticsDescription. */ sinkRefs?: string[]; } /** * Describes a container endpoint. */ interface EndpointPropertiesResponse { /** * The name of the endpoint. */ name: string; /** * Port used by the container. */ port?: number; } /** * Describes a reference to a service endpoint. */ interface EndpointRefResponse { /** * Name of the endpoint. */ name?: string; } /** * Describes an environment variable for the container. */ interface EnvironmentVariableResponse { /** * The name of the environment variable. */ name?: string; /** * The value of the environment variable. */ value?: string; } /** * Describes destination endpoint for routing traffic. */ interface GatewayDestinationResponse { /** * Name of the service fabric Mesh application. */ applicationName: string; /** * name of the endpoint in the service. */ endpointName: string; /** * service that contains the endpoint. */ serviceName: string; } /** * Describes the http configuration for external connectivity for this network. */ interface HttpConfigResponse { /** * description for routing. */ hosts: outputs.servicefabricmesh.HttpHostConfigResponse[]; /** * http gateway config name. */ name: string; /** * Specifies the port at which the service endpoint below needs to be exposed. */ port: number; } /** * Describes the hostname properties for http routing. */ interface HttpHostConfigResponse { /** * http hostname config name. */ name: string; /** * Route information to use for routing. Routes are processed in the order they are specified. Specify routes that are more specific before routes that can handle general cases. */ routes: outputs.servicefabricmesh.HttpRouteConfigResponse[]; } /** * Describes the hostname properties for http routing. */ interface HttpRouteConfigResponse { /** * Describes destination endpoint for routing traffic. */ destination: outputs.servicefabricmesh.GatewayDestinationResponse; /** * Describes a rule for http route matching. */ match: outputs.servicefabricmesh.HttpRouteMatchRuleResponse; /** * http route name. */ name: string; } /** * Describes header information for http route matching. */ interface HttpRouteMatchHeaderResponse { /** * Name of header to match in request. */ name: string; /** * how to match header value */ type?: string; /** * Value of header to match in request. */ value?: string; } /** * Path to match for routing. */ interface HttpRouteMatchPathResponse { /** * replacement string for matched part of the Uri. */ rewrite?: string; /** * how to match value in the Uri */ type: string; /** * Uri path to match for request. */ value: string; } /** * Describes a rule for http route matching. */ interface HttpRouteMatchRuleResponse { /** * headers and their values to match in request. */ headers?: outputs.servicefabricmesh.HttpRouteMatchHeaderResponse[]; /** * Path to match for routing. */ path: outputs.servicefabricmesh.HttpRouteMatchPathResponse; } /** * Image registry credential. */ interface ImageRegistryCredentialResponse { /** * The password for the private registry. The password is required for create or update operations, however it is not returned in the get or list operations. */ password?: string; /** * Docker image registry server, without protocol such as `http` and `https`. */ server: string; /** * The username for the private registry. */ username: string; } /** * Describes a network reference in a service. */ interface NetworkRefResponse { /** * A list of endpoints that are exposed on this network. */ endpointRefs?: outputs.servicefabricmesh.EndpointRefResponse[]; /** * Name of the network */ name?: string; } /** * Describes properties of a network resource. */ interface NetworkResourcePropertiesResponse { /** * User readable description of the network. */ description?: string; /** * The type of a Service Fabric container network. * Expected value is 'NetworkResourceProperties'. */ kind: "NetworkResourceProperties"; /** * State of the resource. */ provisioningState: string; /** * Status of the network. */ status: string; /** * Gives additional information about the current status of the network. */ statusDetails: string; } /** * Specifying this parameter adds support for reliable collections */ interface ReliableCollectionsRefResponse { /** * False (the default) if ReliableCollections state is persisted to disk as usual. True if you do not want to persist state, in which case replication is still enabled and you can use ReliableCollections as distributed cache. */ doNotPersistState?: boolean; /** * Name of ReliableCollection resource. Right now it's not used and you can use any string. */ name: string; } /** * This type describes the resource limits for a given container. It describes the most amount of resources a container is allowed to use before being restarted. */ interface ResourceLimitsResponse { /** * CPU limits in cores. At present, only full cores are supported. */ cpu?: number; /** * The memory limit in GB. */ memoryInGB?: number; } /** * This type describes the requested resources for a given container. It describes the least amount of resources required for the container. A container can consume more than requested resources up to the specified limits before being restarted. Currently, the requested resources are treated as limits. */ interface ResourceRequestsResponse { /** * Requested number of CPU cores. At present, only full cores are supported. */ cpu: number; /** * The memory request in GB for this container. */ memoryInGB: number; } /** * This type describes the resource requirements for a container or a service. */ interface ResourceRequirementsResponse { /** * Describes the maximum limits on the resources for a given container. */ limits?: outputs.servicefabricmesh.ResourceLimitsResponse; /** * Describes the requested resources for a given container. */ requests: outputs.servicefabricmesh.ResourceRequestsResponse; } /** * Describes the properties of a secret resource. */ interface SecretResourcePropertiesResponse { /** * The type of the content stored in the secret value. The value of this property is opaque to Service Fabric. Once set, the value of this property cannot be changed. */ contentType?: string; /** * User readable description of the secret. */ description?: string; /** * Describes the kind of secret. * Expected value is 'SecretResourceProperties'. */ kind: "SecretResourceProperties"; /** * State of the resource. */ provisioningState: string; /** * Status of the resource. */ status: string; /** * Gives additional information about the current status of the secret. */ statusDetails: string; } /** * This type describes a service resource. */ interface ServiceResourceDescriptionResponse { /** * Auto scaling policies */ autoScalingPolicies?: outputs.servicefabricmesh.AutoScalingPolicyResponse[]; /** * Describes the set of code packages that forms the service. A code package describes the container and the properties for running it. All the code packages are started together on the same host and share the same context (network, process etc.). */ codePackages: outputs.servicefabricmesh.ContainerCodePackagePropertiesResponse[]; /** * User readable description of the service. */ description?: string; /** * Reference to sinks in DiagnosticsDescription. */ diagnostics?: outputs.servicefabricmesh.DiagnosticsRefResponse; /** * Describes the health state of an application resource. */ healthState: string; /** * Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name?: string; /** * The names of the private networks that this service needs to be part of. */ networkRefs?: outputs.servicefabricmesh.NetworkRefResponse[]; /** * The operation system required by the code in service. */ osType: string; /** * State of the resource. */ provisioningState: string; /** * The number of replicas of the service to create. Defaults to 1 if not specified. */ replicaCount?: number; /** * Status of the service. */ status: string; /** * Gives additional information about the current status of the service. */ statusDetails: string; /** * The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. */ type: string; /** * When the service's health state is not 'Ok', this additional details from service fabric Health Manager for the user to know why the service is marked unhealthy. */ unhealthyEvaluation: string; } /** * Describes a setting for the container. The setting file path can be fetched from environment variable "Fabric_SettingPath". The path for Windows container is "C:\\secrets". The path for Linux container is "/var/secrets". */ interface SettingResponse { /** * The name of the setting. */ name?: string; /** * The value of the setting. */ value?: string; } /** * Describes the tcp configuration for external connectivity for this network. */ interface TcpConfigResponse { /** * Describes destination endpoint for routing traffic. */ destination: outputs.servicefabricmesh.GatewayDestinationResponse; /** * tcp gateway config name. */ name: string; /** * Specifies the port at which the service endpoint below needs to be exposed. */ port: number; } /** * This type describes a volume provided by an Azure Files file share. */ interface VolumeProviderParametersAzureFileResponse { /** * Access key of the Azure storage account for the File Share. */ accountKey?: string; /** * Name of the Azure storage account for the File Share. */ accountName: string; /** * Name of the Azure Files file share that provides storage for the volume. */ shareName: string; } /** * Describes a reference to a volume resource. */ interface VolumeReferenceResponse { /** * The path within the container at which the volume should be mounted. Only valid path characters are allowed. */ destinationPath: string; /** * Name of the volume being referenced. */ name: string; /** * The flag indicating whether the volume is read only. Default is 'false'. */ readOnly?: boolean; } } export declare namespace servicelinker { /** * The access key directly from target resource properties, which target service is Azure Resource, such as Microsoft.Storage */ interface AccessKeyInfoBaseResponse { /** * Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. */ authMode?: string; /** * The authentication type. * Expected value is 'accessKey'. */ authType: "accessKey"; /** * Permissions of the accessKey. `Read` and `Write` are for Azure Cosmos DB and Azure App Configuration, `Listen`, `Send` and `Manage` are for Azure Event Hub and Azure Service Bus. */ permissions?: string[]; } /** * The resource properties when type is Azure Key Vault */ interface AzureKeyVaultPropertiesResponse { /** * True if connect via Kubernetes CSI Driver. */ connectAsKubernetesCsiDriver?: boolean; /** * The azure resource type. * Expected value is 'KeyVault'. */ type: "KeyVault"; } /** * The azure resource info when target service type is AzureResource */ interface AzureResourceResponse { /** * The Id of azure resource. */ id?: string; /** * The azure resource connection related properties. */ resourceProperties?: outputs.servicelinker.AzureKeyVaultPropertiesResponse; /** * The target service type. * Expected value is 'AzureResource'. */ type: "AzureResource"; } /** * The represent of basic error */ interface BasicErrorDryrunPrerequisiteResultResponse { /** * The error code. */ code?: string; /** * The error message. */ message?: string; /** * The type of dryrun result. * Expected value is 'basicError'. */ type: "basicError"; } /** * The configuration information, used to generate configurations or save to applications */ interface ConfigurationInfoResponse { /** * Optional, indicate whether to apply configurations on source application. If enable, generate configurations and applied to the source application. Default is enable. If optOut, no configuration change will be made on source. */ action?: string; /** * A dictionary of additional configurations to be added. Service will auto generate a set of basic configurations and this property is to full fill more customized configurations */ additionalConfigurations?: { [key: string]: string; }; /** * A dictionary of additional properties to be added in the end of connection string. */ additionalConnectionStringProperties?: { [key: string]: string; }; /** * An option to store configuration into different place */ configurationStore?: outputs.servicelinker.ConfigurationStoreResponse; /** * Optional. A dictionary of default key name and customized key name mapping. If not specified, default key name will be used for generate configurations */ customizedKeys?: { [key: string]: string; }; /** * Indicates some additional properties for dapr client type */ daprProperties?: outputs.servicelinker.DaprPropertiesResponse; /** * Indicates whether to clean up previous operation when Linker is updating or deleting */ deleteOrUpdateBehavior?: string; } /** * An option to store configuration into different place */ interface ConfigurationStoreResponse { /** * The app configuration id to store configuration */ appConfigurationId?: string; } /** * The service properties when target service type is ConfluentBootstrapServer */ interface ConfluentBootstrapServerResponse { /** * The endpoint of service. */ endpoint?: string; /** * The target service type. * Expected value is 'ConfluentBootstrapServer'. */ type: "ConfluentBootstrapServer"; } /** * The service properties when target service type is ConfluentSchemaRegistry */ interface ConfluentSchemaRegistryResponse { /** * The endpoint of service. */ endpoint?: string; /** * The target service type. * Expected value is 'ConfluentSchemaRegistry'. */ type: "ConfluentSchemaRegistry"; } /** * The dryrun parameters for creation or update a linker */ interface CreateOrUpdateDryrunParametersResponse { /** * The name of action for you dryrun job. * Expected value is 'createOrUpdate'. */ actionName: "createOrUpdate"; /** * The authentication type. */ authInfo?: outputs.servicelinker.AccessKeyInfoBaseResponse | outputs.servicelinker.EasyAuthMicrosoftEntraIDAuthInfoResponse | outputs.servicelinker.SecretAuthInfoResponse | outputs.servicelinker.ServicePrincipalCertificateAuthInfoResponse | outputs.servicelinker.ServicePrincipalSecretAuthInfoResponse | outputs.servicelinker.SystemAssignedIdentityAuthInfoResponse | outputs.servicelinker.UserAccountAuthInfoResponse | outputs.servicelinker.UserAssignedIdentityAuthInfoResponse; /** * The application client type */ clientType?: string; /** * The connection information consumed by applications, including secrets, connection strings. */ configurationInfo?: outputs.servicelinker.ConfigurationInfoResponse; /** * The provisioning state. */ provisioningState: string; /** * The network solution. */ publicNetworkSolution?: outputs.servicelinker.PublicNetworkSolutionResponse; /** * connection scope in source service. */ scope?: string; /** * An option to store secret value in secure place */ secretStore?: outputs.servicelinker.SecretStoreResponse; /** * The target service properties */ targetService?: outputs.servicelinker.AzureResourceResponse | outputs.servicelinker.ConfluentBootstrapServerResponse | outputs.servicelinker.ConfluentSchemaRegistryResponse | outputs.servicelinker.SelfHostedServerResponse; /** * The VNet solution. */ vNetSolution?: outputs.servicelinker.VNetSolutionResponse; } /** * The dapr component metadata. */ interface DaprMetadataResponse { /** * The description of the metadata, returned from configuration api */ description?: string; /** * Metadata property name. */ name?: string; /** * The value indicating whether the metadata is required or not */ required?: string; /** * The secret name where dapr could get value */ secretRef?: string; /** * Metadata property value. */ value?: string; } /** * Indicates some additional properties for dapr client type */ interface DaprPropertiesResponse { /** * The direction supported by the dapr binding component */ bindingComponentDirection: string; /** * The dapr component type */ componentType?: string; /** * Additional dapr metadata */ metadata?: outputs.servicelinker.DaprMetadataResponse[]; /** * The runtime version supported by the properties */ runtimeVersion: string; /** * The dapr component scopes */ scopes?: string[]; /** * The name of a secret store dapr to retrieve secret */ secretStoreComponent?: string; /** * The dapr component version */ version?: string; } /** * The preview of the operations for creation */ interface DryrunOperationPreviewResponse { /** * The action defined by RBAC, refer https://docs.microsoft.com/azure/role-based-access-control/role-definitions#actions-format */ action?: string; /** * The description of the operation */ description?: string; /** * The operation name */ name?: string; /** * The operation type */ operationType?: string; /** * The scope of the operation, refer https://docs.microsoft.com/azure/role-based-access-control/scope-overview */ scope?: string; } /** * The authentication info when authType is EasyAuth Microsoft Entra ID */ interface EasyAuthMicrosoftEntraIDAuthInfoResponse { /** * Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. */ authMode?: string; /** * The authentication type. * Expected value is 'easyAuthMicrosoftEntraID'. */ authType: "easyAuthMicrosoftEntraID"; /** * Application clientId for EasyAuth Microsoft Entra ID. */ clientId?: string; /** * Indicates whether to clean up previous operation when Linker is updating or deleting */ deleteOrUpdateBehavior?: string; /** * Application Secret for EasyAuth Microsoft Entra ID. */ secret?: string; } /** * Target service's firewall rules. to allow connections from source service. */ interface FirewallRulesResponse { /** * Allow Azure services to access the target service if true. */ azureServices?: string; /** * Allow caller client IP to access the target service if true. the property is used when connecting local application to target service. */ callerClientIP?: string; /** * This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. */ ipRanges?: string[]; } /** * The secret info when type is keyVaultSecretReference. It's for scenario that user provides a secret stored in user's keyvault and source is Azure Kubernetes. The key Vault's resource id is linked to secretStore.keyVaultId. */ interface KeyVaultSecretReferenceSecretInfoResponse { /** * Name of the Key Vault secret. */ name?: string; /** * The secret type. * Expected value is 'keyVaultSecretReference'. */ secretType: "keyVaultSecretReference"; /** * Version of the Key Vault secret. */ version?: string; } /** * The secret info when type is keyVaultSecretUri. It's for scenario that user provides a secret stored in user's keyvault and source is Web App, Spring Cloud or Container App. */ interface KeyVaultSecretUriSecretInfoResponse { /** * The secret type. * Expected value is 'keyVaultSecretUri'. */ secretType: "keyVaultSecretUri"; /** * URI to the keyvault secret */ value?: string; } /** * The represent of missing permissions */ interface PermissionsMissingDryrunPrerequisiteResultResponse { /** * The permission list */ permissions?: string[]; /** * The recommended role to resolve permissions missing */ recommendedRole?: string; /** * The permission scope */ scope?: string; /** * The type of dryrun result. * Expected value is 'permissionsMissing'. */ type: "permissionsMissing"; } /** * Indicates public network solution, include firewall rules */ interface PublicNetworkSolutionResponse { /** * Optional. Indicates public network solution. If enable, enable public network access of target service with best try. Default is enable. If optOut, opt out public network access configuration. */ action?: string; /** * Indicates whether to clean up previous operation(such as firewall rules) when Linker is updating or deleting */ deleteOrUpdateBehavior?: string; /** * Describe firewall rules of target service to make sure source application could connect to the target. */ firewallRules?: outputs.servicelinker.FirewallRulesResponse; } /** * The authentication info when authType is secret */ interface SecretAuthInfoResponse { /** * Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. */ authMode?: string; /** * The authentication type. * Expected value is 'secret'. */ authType: "secret"; /** * Username or account name for secret auth. */ name?: string; /** * Password or key vault secret for secret auth. */ secretInfo?: outputs.servicelinker.KeyVaultSecretReferenceSecretInfoResponse | outputs.servicelinker.KeyVaultSecretUriSecretInfoResponse | outputs.servicelinker.ValueSecretInfoResponse; } /** * An option to store secret value in secure place */ interface SecretStoreResponse { /** * The key vault id to store secret */ keyVaultId?: string; /** * The key vault secret name to store secret, only valid when storing one secret */ keyVaultSecretName?: string; } /** * The service properties when target service type is SelfHostedServer */ interface SelfHostedServerResponse { /** * The endpoint of service. */ endpoint?: string; /** * The target service type. * Expected value is 'SelfHostedServer'. */ type: "SelfHostedServer"; } /** * The authentication info when authType is servicePrincipal certificate */ interface ServicePrincipalCertificateAuthInfoResponse { /** * Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. */ authMode?: string; /** * The authentication type. * Expected value is 'servicePrincipalCertificate'. */ authType: "servicePrincipalCertificate"; /** * ServicePrincipal certificate for servicePrincipal auth. */ certificate: string; /** * Application clientId for servicePrincipal auth. */ clientId: string; /** * Indicates whether to clean up previous operation when Linker is updating or deleting */ deleteOrUpdateBehavior?: string; /** * Principal Id for servicePrincipal auth. */ principalId: string; /** * Optional, this value specifies the Azure roles to be assigned. Automatically */ roles?: string[]; } /** * The authentication info when authType is servicePrincipal secret */ interface ServicePrincipalSecretAuthInfoResponse { /** * Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. */ authMode?: string; /** * The authentication type. * Expected value is 'servicePrincipalSecret'. */ authType: "servicePrincipalSecret"; /** * ServicePrincipal application clientId for servicePrincipal auth. */ clientId: string; /** * Indicates whether to clean up previous operation when Linker is updating or deleting */ deleteOrUpdateBehavior?: string; /** * Principal Id for servicePrincipal auth. */ principalId: string; /** * Optional, this value specifies the Azure roles to be assigned. Automatically */ roles?: string[]; /** * Secret for servicePrincipal auth. */ secret: string; /** * Username created in the database which is mapped to a user in AAD. */ userName?: string; } /** * A configuration item for source resource */ interface SourceConfigurationResponse { /** * The type of setting */ configType: string; /** * Descriptive information for the configuration */ description?: string; /** * The identity for key vault reference, system or user-assigned managed identity ID */ keyVaultReferenceIdentity?: string; /** * The name of setting. */ name?: string; /** * The value of setting */ value?: string; } /** * The authentication info when authType is systemAssignedIdentity */ interface SystemAssignedIdentityAuthInfoResponse { /** * Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. */ authMode?: string; /** * The authentication type. * Expected value is 'systemAssignedIdentity'. */ authType: "systemAssignedIdentity"; /** * Indicates whether to clean up previous operation when Linker is updating or deleting */ deleteOrUpdateBehavior?: string; /** * Optional, this value specifies the Azure role to be assigned */ roles?: string[]; /** * Username created in the database which is mapped to a user in AAD. */ userName?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The authentication info when authType is user account */ interface UserAccountAuthInfoResponse { /** * Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. */ authMode?: string; /** * The authentication type. * Expected value is 'userAccount'. */ authType: "userAccount"; /** * Indicates whether to clean up previous operation when Linker is updating or deleting */ deleteOrUpdateBehavior?: string; /** * Principal Id for user account. */ principalId?: string; /** * Optional, this value specifies the Azure roles to be assigned. Automatically */ roles?: string[]; /** * Username created in the database which is mapped to a user in AAD. */ userName?: string; } /** * The authentication info when authType is userAssignedIdentity */ interface UserAssignedIdentityAuthInfoResponse { /** * Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. */ authMode?: string; /** * The authentication type. * Expected value is 'userAssignedIdentity'. */ authType: "userAssignedIdentity"; /** * Client Id for userAssignedIdentity. */ clientId?: string; /** * Indicates whether to clean up previous operation when Linker is updating or deleting */ deleteOrUpdateBehavior?: string; /** * Optional, this value specifies the Azure role to be assigned */ roles?: string[]; /** * Subscription id for userAssignedIdentity. */ subscriptionId?: string; /** * Username created in the database which is mapped to a user in AAD. */ userName?: string; } /** * The VNet solution for linker */ interface VNetSolutionResponse { /** * Indicates whether to clean up previous operation when Linker is updating or deleting */ deleteOrUpdateBehavior?: string; /** * Type of VNet solution. */ type?: string; } /** * The secret info when type is rawValue. It's for scenarios that user input the secret. */ interface ValueSecretInfoResponse { /** * The secret type. * Expected value is 'rawValue'. */ secretType: "rawValue"; /** * The actual value of the secret. */ value?: string; } } export declare namespace servicenetworking { /** * Association Subnet. */ interface AssociationSubnetResponse { /** * Association ID. */ id: string; } /** * Resource ID definition used by parent to reference child resources. */ interface ResourceIdResponse { /** * Resource ID of child resource. */ id: string; } /** * SecurityPolicyConfigurations Subresource of Traffic Controller. */ interface SecurityPolicyConfigurationsResponse { /** * Contains reference to a WAF-type security policy. */ wafSecurityPolicy?: outputs.servicenetworking.WafSecurityPolicyResponse; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Web Application Firewall Policy */ interface WafPolicyResponse { /** * Resource ID of the WAF */ id: string; } /** * Web Application Firewall Security Policy */ interface WafSecurityPolicyResponse { /** * Resource ID of the Waf Security Policy */ id: string; } } export declare namespace signalrservice { /** * An IP rule */ interface IPRuleResponse { /** * Azure Networking ACL Action. */ action?: string; /** * An IP or CIDR or ServiceTag */ value?: string; } /** * Live trace category configuration of a Microsoft.SignalRService resource. */ interface LiveTraceCategoryResponse { /** * Indicates whether or the live trace category is enabled. * Available values: true, false. * Case insensitive. */ enabled?: string; /** * Gets or sets the live trace category's name. * Available values: ConnectivityLogs, MessagingLogs. * Case insensitive. */ name?: string; } /** * Live trace configuration of a Microsoft.SignalRService resource. */ interface LiveTraceConfigurationResponse { /** * Gets or sets the list of category configurations. */ categories?: outputs.signalrservice.LiveTraceCategoryResponse[]; /** * Indicates whether or not enable live trace. * When it's set to true, live trace client can connect to the service. * Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". * Available values: true, false. * Case insensitive. */ enabled?: string; } /** * liveTraceConfigurationResponseProvideDefaults sets the appropriate defaults for LiveTraceConfigurationResponse */ function liveTraceConfigurationResponseProvideDefaults(val: LiveTraceConfigurationResponse): LiveTraceConfigurationResponse; /** * A class represent managed identities used for request and response */ interface ManagedIdentityResponse { /** * Get the principal id for the system assigned identity. * Only be used in response. */ principalId: string; /** * Get the tenant id for the system assigned identity. * Only be used in response */ tenantId: string; /** * Represents the identity type: systemAssigned, userAssigned, None */ type?: string; /** * Get or set the user assigned identities */ userAssignedIdentities?: { [key: string]: outputs.signalrservice.UserAssignedIdentityPropertyResponse; }; } /** * Managed identity settings for upstream. */ interface ManagedIdentitySettingsResponse { /** * The Resource indicating the App ID URI of the target resource. * It also appears in the aud (audience) claim of the issued token. */ resource?: string; } /** * Network ACL */ interface NetworkACLResponse { /** * Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. */ allow?: string[]; /** * Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. */ deny?: string[]; } /** * ACL for a private endpoint */ interface PrivateEndpointACLResponse { /** * Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. */ allow?: string[]; /** * Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. */ deny?: string[]; /** * Name of the private endpoint connection */ name: string; } /** * A private endpoint connection to an azure resource */ interface PrivateEndpointConnectionResponse { /** * Group IDs */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * Private endpoint */ privateEndpoint?: outputs.signalrservice.PrivateEndpointResponse; /** * Connection state of the private endpoint connection */ privateLinkServiceConnectionState?: outputs.signalrservice.PrivateLinkServiceConnectionStateResponse; /** * Provisioning state of the resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.signalrservice.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Private endpoint */ interface PrivateEndpointResponse { /** * Full qualified Id of the private endpoint */ id?: string; } /** * Connection state of the private endpoint connection */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Resource log category configuration of a Microsoft.SignalRService resource. */ interface ResourceLogCategoryResponse { /** * Indicates whether or the resource log category is enabled. * Available values: true, false. * Case insensitive. */ enabled?: string; /** * Gets or sets the resource log category's name. * Available values: ConnectivityLogs, MessagingLogs. * Case insensitive. */ name?: string; } /** * Resource log configuration of a Microsoft.SignalRService resource. */ interface ResourceLogConfigurationResponse { /** * Gets or sets the list of category configurations. */ categories?: outputs.signalrservice.ResourceLogCategoryResponse[]; } /** * Reference to a resource. */ interface ResourceReferenceResponse { /** * Resource ID. */ id?: string; } /** * The billing information of the resource. */ interface ResourceSkuResponse { /** * Optional, integer. The unit count of the resource. * 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. * * If present, following values are allowed: * Free_F1: 1; * Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; * Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; * Premium_P2: 100,200,300,400,500,600,700,800,900,1000; */ capacity?: number; /** * Not used. Retained for future use. */ family: string; /** * The name of the SKU. Required. * * Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 */ name: string; /** * Not used. Retained for future use. */ size: string; /** * Optional tier of this particular SKU. 'Standard' or 'Free'. * * `Basic` is deprecated, use `Standard` instead. */ tier?: string; } /** * Serverless settings. */ interface ServerlessSettingsResponse { /** * Gets or sets Client Connection Timeout. Optional to be set. * Value in seconds. * Default value is 30 seconds. * Customer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals, * and want the client to disconnect more quickly after the last message is sent. * You can set the timeout to a longer period if messages are expected to be sent in longer intervals, * and they want to keep the same client connection alive during this session. * The service considers the client disconnected if it hasn't received a message (including keep-alive) in this interval. */ connectionTimeoutInSeconds?: number; } /** * serverlessSettingsResponseProvideDefaults sets the appropriate defaults for ServerlessSettingsResponse */ function serverlessSettingsResponseProvideDefaults(val: ServerlessSettingsResponse): ServerlessSettingsResponse; /** * The settings for the Upstream when the service is in server-less mode. */ interface ServerlessUpstreamSettingsResponse { /** * Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. */ templates?: outputs.signalrservice.UpstreamTemplateResponse[]; } /** * Describes a Shared Private Link Resource */ interface SharedPrivateLinkResourceResponse { /** * The group id from the provider of resource the shared private link resource is for */ groupId: string; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The resource id of the resource the shared private link resource is for */ privateLinkResourceId: string; /** * Provisioning state of the resource. */ provisioningState: string; /** * The request message for requesting approval of the shared private link resource */ requestMessage?: string; /** * Status of the shared private link resource */ status: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.signalrservice.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Cross-Origin Resource Sharing (CORS) settings. */ interface SignalRCorsSettingsResponse { /** * Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use "*" to allow all. If omitted, allow all by default. */ allowedOrigins?: string[]; } /** * Feature of a resource, which controls the runtime behavior. */ interface SignalRFeatureResponse { /** * FeatureFlags is the supported features of Azure SignalR service. * - ServiceMode: Flag for backend server for SignalR service. Values allowed: "Default": have your own backend server; "Serverless": your application doesn't have a backend server; "Classic": for backward compatibility. Support both Default and Serverless mode but not recommended; "PredefinedOnly": for future use. * - EnableConnectivityLogs: "true"/"false", to enable/disable the connectivity log category respectively. * - EnableMessagingLogs: "true"/"false", to enable/disable the connectivity log category respectively. * - EnableLiveTrace: Live Trace allows you to know what's happening inside Azure SignalR service, it will give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. Values allowed: "true"/"false", to enable/disable live trace feature. */ flag: string; /** * Optional properties related to this feature. */ properties?: { [key: string]: string; }; /** * Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values. */ value: string; } /** * Network ACLs for the resource */ interface SignalRNetworkACLsResponse { /** * Azure Networking ACL Action. */ defaultAction?: string; /** * IP rules for filtering public traffic */ ipRules?: outputs.signalrservice.IPRuleResponse[]; /** * ACLs for requests from private endpoints */ privateEndpoints?: outputs.signalrservice.PrivateEndpointACLResponse[]; /** * Network ACL */ publicNetwork?: outputs.signalrservice.NetworkACLResponse; } /** * TLS settings for the resource */ interface SignalRTlsSettingsResponse { /** * Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. */ clientCertEnabled?: boolean; } /** * signalRTlsSettingsResponseProvideDefaults sets the appropriate defaults for SignalRTlsSettingsResponse */ function signalRTlsSettingsResponseProvideDefaults(val: SignalRTlsSettingsResponse): SignalRTlsSettingsResponse; /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Upstream auth settings. If not set, no auth is used for upstream messages. */ interface UpstreamAuthSettingsResponse { /** * Managed identity settings for upstream. */ managedIdentity?: outputs.signalrservice.ManagedIdentitySettingsResponse; /** * Upstream auth type enum. */ type?: string; } /** * Upstream template item settings. It defines the Upstream URL of the incoming requests. * The template defines the pattern of the event, the hub or the category of the incoming request that matches current URL template. */ interface UpstreamTemplateResponse { /** * Upstream auth settings. If not set, no auth is used for upstream messages. */ auth?: outputs.signalrservice.UpstreamAuthSettingsResponse; /** * Gets or sets the matching pattern for category names. If not set, it matches any category. * There are 3 kind of patterns supported: * 1. "*", it to matches any category name. * 2. Combine multiple categories with ",", for example "connections,messages", it matches category "connections" and "messages". * 3. The single category name, for example, "connections", it matches the category "connections". */ categoryPattern?: string; /** * Gets or sets the matching pattern for event names. If not set, it matches any event. * There are 3 kind of patterns supported: * 1. "*", it to matches any event name. * 2. Combine multiple events with ",", for example "connect,disconnect", it matches event "connect" and "disconnect". * 3. The single event name, for example, "connect", it matches "connect". */ eventPattern?: string; /** * Gets or sets the matching pattern for hub names. If not set, it matches any hub. * There are 3 kind of patterns supported: * 1. "*", it to matches any hub name. * 2. Combine multiple hubs with ",", for example "hub1,hub2", it matches "hub1" and "hub2". * 3. The single hub name, for example, "hub1", it matches "hub1". */ hubPattern?: string; /** * Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. * For example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`. */ urlTemplate: string; } /** * Properties of user assigned identity. */ interface UserAssignedIdentityPropertyResponse { /** * Get the client id for the user assigned identity */ clientId: string; /** * Get the principal id for the user assigned identity */ principalId: string; } } export declare namespace softwareplan { /** * The SKU to be applied for this resource */ interface SkuResponse { /** * Name of the SKU to be applied */ name?: string; } } export declare namespace solutions { /** * Managed application artifact. */ interface ApplicationArtifactResponse { /** * The managed application artifact name. */ name: string; /** * The managed application artifact type. */ type: string; /** * The managed application artifact blob uri. */ uri: string; } /** * The managed application provider authorization. */ interface ApplicationAuthorizationResponse { /** * The provider's principal identifier. This is the identity that the provider will use to call ARM to manage the managed application resources. */ principalId: string; /** * The provider's role definition identifier. This role will define all the permissions that the provider must have on the managed application's container resource group. This role definition cannot have permission to delete the resource group. */ roleDefinitionId: string; } /** * Managed application billing details definition. */ interface ApplicationBillingDetailsDefinitionResponse { /** * The managed application resource usage Id. */ resourceUsageId?: string; } /** * The application client details to track the entity creating/updating the managed app resource. */ interface ApplicationClientDetailsResponse { /** * The client application Id. */ applicationId?: string; /** * The client Oid. */ oid?: string; /** * The client Puid */ puid?: string; } /** * Application definition artifact. */ interface ApplicationDefinitionArtifactResponse { /** * The managed application definition artifact name. */ name: string; /** * The managed application definition artifact type. */ type: string; /** * The managed application definition artifact blob uri. */ uri: string; } /** * Managed application deployment policy. */ interface ApplicationDeploymentPolicyResponse { /** * The managed application deployment mode. */ deploymentMode: string; } /** * Managed application Jit access policy. */ interface ApplicationJitAccessPolicyResponse { /** * Whether the JIT access is enabled. */ jitAccessEnabled: boolean; /** * JIT approval mode. */ jitApprovalMode?: string; /** * The JIT approvers */ jitApprovers?: outputs.solutions.JitApproverDefinitionResponse[]; /** * The maximum duration JIT access is granted. This is an ISO8601 time period value. */ maximumJitAccessDuration?: string; } /** * Managed application management policy. */ interface ApplicationManagementPolicyResponse { /** * The managed application management mode. */ mode?: string; } /** * Managed application notification endpoint. */ interface ApplicationNotificationEndpointResponse { /** * The managed application notification endpoint uri. */ uri: string; } /** * Managed application notification policy. */ interface ApplicationNotificationPolicyResponse { /** * The managed application notification endpoint. */ notificationEndpoints: outputs.solutions.ApplicationNotificationEndpointResponse[]; } /** * The application package contact information. */ interface ApplicationPackageContactResponse { /** * The contact name. */ contactName?: string; /** * The contact email. */ email: string; /** * The contact phone number. */ phone: string; } /** * Managed application locking policy. */ interface ApplicationPackageLockingPolicyDefinitionResponse { /** * The deny assignment excluded actions. */ allowedActions?: string[]; /** * The deny assignment excluded data actions. */ allowedDataActions?: string[]; } /** * The appliance package support URLs. */ interface ApplicationPackageSupportUrlsResponse { /** * The government cloud support URL. */ governmentCloud?: string; /** * The public azure support URL. */ publicAzure?: string; } /** * Managed application policy. */ interface ApplicationPolicyResponse { /** * The policy name */ name?: string; /** * The policy parameters. */ parameters?: string; /** * The policy definition Id. */ policyDefinitionId?: string; } /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The identity type. */ type?: string; /** * The list of user identities associated with the resource. The user identity dictionary key references will be resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. */ userAssignedIdentities?: { [key: string]: outputs.solutions.UserAssignedResourceIdentityResponse; }; } /** * JIT approver definition. */ interface JitApproverDefinitionResponse { /** * The approver display name. */ displayName?: string; /** * The approver service principal Id. */ id: string; /** * The approver type. */ type?: string; } /** * The JIT authorization policies. */ interface JitAuthorizationPoliciesResponse { /** * The the principal id that will be granted JIT access. */ principalId: string; /** * The role definition id that will be granted to the Principal. */ roleDefinitionId: string; } /** * The JIT scheduling policies. */ interface JitSchedulingPolicyResponse { duration: string; /** * The start time of the request. */ startTime: string; /** * The type of JIT schedule. */ type: string; } /** * The managed identity token for the managed app resource. */ interface ManagedIdentityTokenResponse { /** * The requested access token. */ accessToken?: string; /** * The aud (audience) the access token was request for. This is the same as what was provided in the listTokens request. */ authorizationAudience?: string; /** * The number of seconds the access token will be valid. */ expiresIn?: string; /** * The timespan when the access token expires. This is represented as the number of seconds from epoch. */ expiresOn?: string; /** * The timespan when the access token takes effect. This is represented as the number of seconds from epoch. */ notBefore?: string; /** * The Azure resource ID for the issued token. This is either the managed application ID or the user-assigned identity ID. */ resourceId?: string; /** * The type of the token. */ tokenType?: string; } /** * Plan for the managed application. */ interface PlanResponse { /** * The plan name. */ name: string; /** * The product code. */ product: string; /** * The promotion code. */ promotionCode?: string; /** * The publisher ID. */ publisher: string; /** * The plan's version. */ version: string; } /** * SKU for the resource. */ interface SkuResponse { /** * The SKU capacity. */ capacity?: number; /** * The SKU family. */ family?: string; /** * The SKU model. */ model?: string; /** * The SKU name. */ name: string; /** * The SKU size. */ size?: string; /** * The SKU tier. */ tier?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Represents the user assigned identity that is contained within the UserAssignedIdentities dictionary on ResourceIdentity */ interface UserAssignedResourceIdentityResponse { /** * The principal id of user assigned identity. */ principalId: string; /** * The tenant id of user assigned identity. */ tenantId: string; } } export declare namespace sovereign { /** * The details for the custom naming convention override for a specific resource type. */ interface CustomNamingConventionResponse { /** * The custom naming formula for the resource type. */ formula: string; /** * The type of the resource. */ resourceType: string; } /** * The 'Decommissioned' management group properties. */ interface DecommissionedManagementGroupPropertiesResponse { /** * This parameter determines whether the 'Decommissioned' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. */ create: boolean; /** * Array of policy initiatives applied to the management group. */ policyInitiativesAssignmentProperties: outputs.sovereign.PolicyInitiativeAssignmentPropertiesResponse[]; } /** * The properties of landing zone account resource type. */ interface LandingZoneAccountResourcePropertiesResponse { /** * The state that reflects the current stage in the creation, updating, or deletion process of the landing zone account. */ provisioningState: string; /** * The storage account that will host the generated infrastructure as code (IaC) for a landing zone deployment. */ storageAccount: string; } /** * The properties of landing zone configuration resource type. */ interface LandingZoneConfigurationResourcePropertiesResponse { /** * The status that indicates the current phase of the configuration process for a deployment. */ authoringStatus: string; /** * Parameter used to deploy a Bastion: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing Bastion. */ azureBastionCreationOption: string; /** * The Bastion subnet address. Specify the address using IPv4 CIDR notation. */ azureBastionSubnetCidrBlock?: string; /** * The custom naming convention applied to specific resource types for this landing zone configuration, which overrides the default naming convention for those resource types. Example - 'customNamingConvention': [{'resourceType': 'azureFirewalls', 'formula': '{DeploymentPrefix}-afwl-{DeploymentSuffix}'}] */ customNamingConvention?: outputs.sovereign.CustomNamingConventionResponse[]; /** * Parameter used to deploy a DDoS protection plan: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing DDoS protection plan. */ ddosProtectionCreationOption: string; /** * The assigned policies of the 'Decommissioned' management group and indicator to create it or not. */ decommissionedMgMetadata?: outputs.sovereign.DecommissionedManagementGroupPropertiesResponse; /** * The resource ID of the Bastion when reusing an existing one. */ existingAzureBastionId?: string; /** * The resource ID of the DDoS protection plan when reusing an existing one. */ existingDdosProtectionId?: string; /** * The resource ID of the log analytics workspace when reusing an existing one. */ existingLogAnalyticsWorkspaceId?: string; /** * Parameter used for deploying a Firewall: Select 'No' to skip deployment, 'Standard' to deploy the Standard SKU, or 'Premium' to deploy the Premium SKU. */ firewallCreationOption: string; /** * The Firewall subnet address used for deploying a firewall. Specify the Firewall subnet using IPv4 CIDR notation. */ firewallSubnetCidrBlock?: string; /** * The gateway subnet address used for deploying a virtual network. Specify the subnet using IPv4 CIDR notation. */ gatewaySubnetCidrBlock: string; /** * The Virtual Network address. Specify the address using IPv4 CIDR notation. */ hubNetworkCidrBlock: string; /** * The child management groups of 'Landing Zones' management group and their assigned policies. */ landingZonesMgChildren?: outputs.sovereign.LandingZoneManagementGroupPropertiesResponse[]; /** * The assigned policies of the 'Landing Zones' management group. */ landingZonesMgMetadata?: outputs.sovereign.ManagementGroupPropertiesResponse; /** * Parameter used to deploy a log analytics workspace: Select 'Yes' to enable deployment, 'No' to skip it, or 'Existing' to reuse an existing log analytics workspace. */ logAnalyticsWorkspaceCreationOption: string; /** * Parameter to define the retention period for logs, in days. The minimum duration is 30 days and the maximum is 730 days. */ logRetentionInDays: number; /** * The managed identity to be assigned to this landing zone configuration. */ managedIdentity: outputs.sovereign.ManagedIdentityPropertiesResponse; /** * The default naming convention applied to all resources for this landing zone configuration. Example - {DeploymentPrefix}-Contoso-{ResourceTypeAbbreviation}{DeploymentSuffix}-{Environment}-testing */ namingConventionFormula?: string; /** * The assigned policies of the 'Connectivity' management group under 'Platform' management group. */ platformConnectivityMgMetadata?: outputs.sovereign.ManagementGroupPropertiesResponse; /** * The assigned policies of the 'Identity' management group under 'Platform' management group. */ platformIdentityMgMetadata?: outputs.sovereign.ManagementGroupPropertiesResponse; /** * The assigned policies of the 'Management' management group under 'Platform' management group. */ platformManagementMgMetadata?: outputs.sovereign.ManagementGroupPropertiesResponse; /** * The names of the 'Platform' child management groups and their assigned policies, excluding the default ones: 'Connectivity', 'Identity', and 'Management' */ platformMgChildren?: outputs.sovereign.PlatformManagementGroupPropertiesResponse[]; /** * The assigned policies of the 'Platform' management group. */ platformMgMetadata?: outputs.sovereign.ManagementGroupPropertiesResponse; /** * The state that reflects the current stage in the creation, updating, or deletion process of the landing zone configuration. */ provisioningState: string; /** * The assigned policies of the 'Sandbox' management group and indicator to create it or not. */ sandboxMgMetadata?: outputs.sovereign.SandboxManagementGroupPropertiesResponse; /** * Tags are key-value pairs that can be assigned to a resource to organize and manage it more effectively. Example: {'name': 'a tag name', 'value': 'a tag value'} */ tags?: outputs.sovereign.TagsResponse[]; /** * The assigned policies of the parent management group. */ topLevelMgMetadata?: outputs.sovereign.ManagementGroupPropertiesResponse; } /** * The 'Landing Zones' management group properties.. */ interface LandingZoneManagementGroupPropertiesResponse { /** * Management group name. */ name: string; /** * Array of policy initiatives applied to the management group. */ policyInitiativesAssignmentProperties: outputs.sovereign.PolicyInitiativeAssignmentPropertiesResponse[]; } /** * The properties of landing zone registration resource type. */ interface LandingZoneRegistrationResourcePropertiesResponse { /** * The resource id of the associated landing zone configuration. */ existingLandingZoneConfigurationId: string; /** * The resource id of the top level management group */ existingTopLevelMgId: string; /** * The managed identity to be assigned to this landing zone registration. */ managedIdentity?: outputs.sovereign.ManagedIdentityPropertiesResponse; /** * The state that reflects the current stage in the creation, updating, or deletion process of the landing zone registration resource type. */ provisioningState: string; } /** * The properties of managed identity, specifically including type and resource ID. */ interface ManagedIdentityPropertiesResponse { /** * The type of managed identity. */ type: string; /** * The resource id of the managed identity. */ userAssignedIdentityResourceId?: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.sovereign.UserAssignedIdentityResponse; }; } /** * The properties of policy initiatives applied to the management group. */ interface ManagementGroupPropertiesResponse { /** * Array of policy initiatives applied to the management group. */ policyInitiativesAssignmentProperties: outputs.sovereign.PolicyInitiativeAssignmentPropertiesResponse[]; } /** * The 'Platform' management group properties. */ interface PlatformManagementGroupPropertiesResponse { /** * Management group name. */ name: string; /** * Array of policy initiatives applied to the management group. */ policyInitiativesAssignmentProperties: outputs.sovereign.PolicyInitiativeAssignmentPropertiesResponse[]; } /** * The properties of assigned policy initiatives. */ interface PolicyInitiativeAssignmentPropertiesResponse { /** * The parameters of the assigned policy initiative. */ assignmentParameters: any; /** * The fully qualified id of the policy initiative. */ policyInitiativeId: string; } /** * The 'Sandbox' management group properties. */ interface SandboxManagementGroupPropertiesResponse { /** * This parameter determines whether the 'Sandbox' management group will be created. If set to true, the group will be created; if set to false, it will not be created. The default value is false. */ create: boolean; /** * Array of policy initiatives applied to the management group. */ policyInitiativesAssignmentProperties: outputs.sovereign.PolicyInitiativeAssignmentPropertiesResponse[]; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Key-value pairs that can be assigned to this resource. */ interface TagsResponse { /** * A tag name. */ name: string; /** * A tag value. */ value?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace sql { /** * Certificate information */ interface CertificateInfoResponse { /** * The certificate name */ certificateName: string; /** * The certificate expiry date */ expiryDate: string; } /** * Azure Active Directory identity configuration for a resource. */ interface DatabaseIdentityResponse { /** * The Azure Active Directory tenant id. */ tenantId: string; /** * The identity type */ type?: string; /** * The resource ids of the user assigned identities to use */ userAssignedIdentities?: { [key: string]: outputs.sql.DatabaseUserIdentityResponse; }; } /** * Database level key used for encryption at rest. */ interface DatabaseKeyResponse { /** * The database key creation date. */ creationDate: string; /** * Subregion of the server key. */ subregion: string; /** * Thumbprint of the database key. */ thumbprint: string; /** * The database key type. Only supported value is 'AzureKeyVault'. */ type: string; } /** * Azure Active Directory identity configuration for a resource. */ interface DatabaseUserIdentityResponse { /** * The Azure Active Directory client id. */ clientId: string; /** * The Azure Active Directory principal id. */ principalId: string; } /** * Properties for an Azure SQL Database Vulnerability Assessment rule baseline's result. */ interface DatabaseVulnerabilityAssessmentRuleBaselineItemResponse { /** * The rule baseline result */ result: string[]; } /** * Database specific information */ interface DistributedAvailabilityGroupDatabaseResponse { /** * Link connected state */ connectedState: string; /** * The name of the database in link */ databaseName?: string; /** * Redo lag when Managed Instance link side is primary */ instanceRedoReplicationLagSeconds: number; /** * Managed instance replica id */ instanceReplicaId: string; /** * Replication lag when Managed Instance link side is primary */ instanceSendReplicationLagSeconds: number; /** * Last backup LSN */ lastBackupLsn: string; /** * Last backup LSN time */ lastBackupTime: string; /** * Last commit LSN */ lastCommitLsn: string; /** * Last commit LSN time */ lastCommitTime: string; /** * Last hardened LSN */ lastHardenedLsn: string; /** * Last hardened LSN time */ lastHardenedTime: string; /** * Last received LSN */ lastReceivedLsn: string; /** * Last received LSN time */ lastReceivedTime: string; /** * Last sent LSN */ lastSentLsn: string; /** * Last sent LSN time */ lastSentTime: string; /** * The most recent link connection error description */ mostRecentLinkError: string; /** * SQL server certificate validity */ partnerAuthCertValidity: outputs.sql.CertificateInfoResponse; /** * SQL server replica id */ partnerReplicaId: string; /** * Current link state */ replicaState: string; /** * Seeding progress */ seedingProgress: string; /** * Link health state */ synchronizationHealth: string; } /** * Per database settings of an elastic pool. */ interface ElasticPoolPerDatabaseSettingsResponse { /** * Auto Pause Delay for per database within pool */ autoPauseDelay?: number; /** * The maximum capacity any one database can consume. */ maxCapacity?: number; /** * The minimum capacity all databases are guaranteed. */ minCapacity?: number; } /** * Read-only endpoint of the failover group instance. */ interface FailoverGroupReadOnlyEndpointResponse { /** * Failover policy of the read-only endpoint for the failover group. */ failoverPolicy?: string; /** * The target partner server where the read-only endpoint points to. */ targetServer?: string; } /** * Read-write endpoint of the failover group instance. */ interface FailoverGroupReadWriteEndpointResponse { /** * Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. */ failoverPolicy: string; /** * Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. */ failoverWithDataLossGracePeriodMinutes?: number; } /** * Read-only endpoint of the failover group instance. */ interface InstanceFailoverGroupReadOnlyEndpointResponse { /** * Failover policy of the read-only endpoint for the failover group. */ failoverPolicy?: string; } /** * Read-write endpoint of the failover group instance. */ interface InstanceFailoverGroupReadWriteEndpointResponse { /** * Failover policy of the read-write endpoint for the failover group. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. */ failoverPolicy: string; /** * Grace period before failover with data loss is attempted for the read-write endpoint. If failoverPolicy is Automatic then failoverWithDataLossGracePeriodMinutes is required. */ failoverWithDataLossGracePeriodMinutes?: number; } /** * Azure Active Directory identity configuration for a resource. */ interface JobAgentIdentityResponse { /** * The job agent identity tenant id */ tenantId?: string; /** * The job agent identity type */ type: string; /** * The resource ids of the user assigned identities to use */ userAssignedIdentities?: { [key: string]: outputs.sql.JobAgentUserAssignedIdentityResponse; }; } /** * Azure Active Directory identity configuration for a resource. */ interface JobAgentUserAssignedIdentityResponse { /** * The Azure Active Directory client id. */ clientId: string; /** * The Azure Active Directory principal id. */ principalId: string; } /** * Scheduling properties of a job. */ interface JobScheduleResponse { /** * Whether or not the schedule is enabled. */ enabled?: boolean; /** * Schedule end time. */ endTime?: string; /** * Value of the schedule's recurring interval, if the ScheduleType is recurring. ISO8601 duration format. */ interval?: string; /** * Schedule start time. */ startTime?: string; /** * Schedule interval type */ type?: string; } /** * jobScheduleResponseProvideDefaults sets the appropriate defaults for JobScheduleResponse */ function jobScheduleResponseProvideDefaults(val: JobScheduleResponse): JobScheduleResponse; /** * The action to be executed by a job step. */ interface JobStepActionResponse { /** * The source of the action to execute. */ source?: string; /** * Type of action being executed by the job step. */ type?: string; /** * The action value, for example the text of the T-SQL script to execute. */ value: string; } /** * jobStepActionResponseProvideDefaults sets the appropriate defaults for JobStepActionResponse */ function jobStepActionResponseProvideDefaults(val: JobStepActionResponse): JobStepActionResponse; /** * The execution options of a job step. */ interface JobStepExecutionOptionsResponse { /** * Initial delay between retries for job step execution. */ initialRetryIntervalSeconds?: number; /** * The maximum amount of time to wait between retries for job step execution. */ maximumRetryIntervalSeconds?: number; /** * Maximum number of times the job step will be reattempted if the first attempt fails. */ retryAttempts?: number; /** * The backoff multiplier for the time between retries. */ retryIntervalBackoffMultiplier?: number; /** * Execution timeout for the job step. */ timeoutSeconds?: number; } /** * jobStepExecutionOptionsResponseProvideDefaults sets the appropriate defaults for JobStepExecutionOptionsResponse */ function jobStepExecutionOptionsResponseProvideDefaults(val: JobStepExecutionOptionsResponse): JobStepExecutionOptionsResponse; /** * The output configuration of a job step. */ interface JobStepOutputResponse { /** * The resource ID of the credential to use to connect to the output destination. */ credential?: string; /** * The output destination database. */ databaseName: string; /** * The output destination resource group. */ resourceGroupName?: string; /** * The output destination schema. */ schemaName?: string; /** * The output destination server name. */ serverName: string; /** * The output destination subscription id. */ subscriptionId?: string; /** * The output destination table. */ tableName: string; /** * The output destination type. */ type?: string; } /** * jobStepOutputResponseProvideDefaults sets the appropriate defaults for JobStepOutputResponse */ function jobStepOutputResponseProvideDefaults(val: JobStepOutputResponse): JobStepOutputResponse; /** * A job target, for example a specific database or a container of databases that is evaluated during job execution. */ interface JobTargetResponse { /** * The target database name. */ databaseName?: string; /** * The target elastic pool name. */ elasticPoolName?: string; /** * Whether the target is included or excluded from the group. */ membershipType?: string; /** * The resource ID of the credential that is used during job execution to connect to the target and determine the list of databases inside the target. */ refreshCredential?: string; /** * The target server name. */ serverName?: string; /** * The target shard map. */ shardMapName?: string; /** * The target type. */ type: string; } /** * jobTargetResponseProvideDefaults sets the appropriate defaults for JobTargetResponse */ function jobTargetResponseProvideDefaults(val: JobTargetResponse): JobTargetResponse; /** * Properties of a active directory administrator. */ interface ManagedInstanceExternalAdministratorResponse { /** * Type of the sever administrator. */ administratorType?: string; /** * Azure Active Directory only Authentication enabled. */ azureADOnlyAuthentication?: boolean; /** * Login name of the server administrator. */ login?: string; /** * Principal Type of the sever administrator. */ principalType?: string; /** * SID (object ID) of the server administrator. */ sid?: string; /** * Tenant ID of the administrator. */ tenantId?: string; } /** * Pairs of Managed Instances in the failover group. */ interface ManagedInstancePairInfoResponse { /** * Id of Partner Managed Instance in pair. */ partnerManagedInstanceId?: string; /** * Id of Primary Managed Instance in pair. */ primaryManagedInstanceId?: string; } /** * A private endpoint connection under a managed instance */ interface ManagedInstancePecPropertyResponse { /** * Resource ID. */ id: string; /** * Private endpoint connection properties */ properties: outputs.sql.ManagedInstancePrivateEndpointConnectionPropertiesResponse; } /** * Properties of a private endpoint connection. */ interface ManagedInstancePrivateEndpointConnectionPropertiesResponse { /** * Private endpoint which the connection belongs to. */ privateEndpoint?: outputs.sql.ManagedInstancePrivateEndpointPropertyResponse; /** * Connection State of the Private Endpoint Connection. */ privateLinkServiceConnectionState?: outputs.sql.ManagedInstancePrivateLinkServiceConnectionStatePropertyResponse; /** * State of the Private Endpoint Connection. */ provisioningState: string; } interface ManagedInstancePrivateEndpointPropertyResponse { /** * Resource id of the private endpoint. */ id?: string; } interface ManagedInstancePrivateLinkServiceConnectionStatePropertyResponse { /** * The private link service connection description. */ actionsRequired: string; /** * The private link service connection description. */ description: string; /** * The private link service connection status. */ status: string; } /** * Partner server information for the failover group. */ interface PartnerInfoResponse { /** * Resource identifier of the partner server. */ id: string; /** * Geo location of the partner server. */ location: string; /** * Replication role of the partner server. */ replicationRole: string; } /** * Partner region information for the failover group. */ interface PartnerRegionInfoResponse { /** * Geo location of the partner managed instances. */ location?: string; /** * Replication role of the partner managed instances. */ replicationRole: string; } /** * Properties of a private endpoint connection. */ interface PrivateEndpointConnectionPropertiesResponse { /** * Group IDs. */ groupIds: string[]; /** * Private endpoint which the connection belongs to. */ privateEndpoint?: outputs.sql.PrivateEndpointPropertyResponse; /** * Connection state of the private endpoint connection. */ privateLinkServiceConnectionState?: outputs.sql.PrivateLinkServiceConnectionStatePropertyResponse; /** * State of the private endpoint connection. */ provisioningState: string; } interface PrivateEndpointPropertyResponse { /** * Resource id of the private endpoint. */ id?: string; } interface PrivateLinkServiceConnectionStatePropertyResponse { /** * The actions required for private link service connection. */ actionsRequired: string; /** * The private link service connection description. */ description: string; /** * The private link service connection status. */ status: string; } /** * Contains error information for an Azure SQL Database, Server or Elastic Pool Recommended Action. */ interface RecommendedActionErrorInfoResponse { /** * Gets the reason why the recommended action was put to error state. e.g., DatabaseHasQdsOff, IndexAlreadyExists */ errorCode: string; /** * Gets whether the error could be ignored and recommended action could be retried. Possible values are: Yes/No */ isRetryable: string; } /** * Contains information of estimated or observed impact on various metrics for an Azure SQL Database, Server or Elastic Pool Recommended Action. */ interface RecommendedActionImpactRecordResponse { /** * Gets the absolute value of this dimension if applicable. e.g., Number of Queries affected */ absoluteValue: number; /** * Gets the absolute change in the value of this dimension. e.g., Absolute Disk space change in Megabytes */ changeValueAbsolute: number; /** * Gets the relative change in the value of this dimension. e.g., Relative Disk space change in Percentage */ changeValueRelative: number; /** * Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. */ dimensionName: string; /** * Gets the name of the impact dimension. e.g., CPUChange, DiskSpaceChange, NumberOfQueriesAffected. */ unit: string; } /** * Contains information for manual implementation for an Azure SQL Database, Server or Elastic Pool Recommended Action. */ interface RecommendedActionImplementationInfoResponse { /** * Gets the method in which this recommended action can be manually implemented. e.g., TSql, AzurePowerShell. */ method: string; /** * Gets the manual implementation script. e.g., T-SQL script that could be executed on the database. */ script: string; } /** * Contains time series of various impacted metrics for an Azure SQL Database, Server or Elastic Pool Recommended Action. */ interface RecommendedActionMetricInfoResponse { /** * Gets the name of the metric. e.g., CPU, Number of Queries. */ metricName: string; /** * Gets the start time of time interval given by this MetricInfo. */ startTime: string; /** * Gets the duration of time interval for the value given by this MetricInfo. e.g., PT1H (1 hour) */ timeGrain: string; /** * Gets the unit in which metric is measured. e.g., DTU, Frequency */ unit: string; /** * Gets the value of the metric in the time interval given by this MetricInfo. */ value: number; } /** * Database, Server or Elastic Pool Recommended Action. */ interface RecommendedActionResponse { /** * Gets additional details specific to this recommended action. */ details: { [key: string]: string; }; /** * Gets the error details if and why this recommended action is put to error state. */ errorDetails: outputs.sql.RecommendedActionErrorInfoResponse; /** * Gets the estimated impact info for this recommended action e.g., Estimated CPU gain, Estimated Disk Space change */ estimatedImpact: outputs.sql.RecommendedActionImpactRecordResponse[]; /** * Gets the time taken for applying this recommended action on user resource. e.g., time taken for index creation */ executeActionDuration: string; /** * Gets if approval for applying this recommended action was given by user/system. */ executeActionInitiatedBy: string; /** * Gets the time when this recommended action was approved for execution. */ executeActionInitiatedTime: string; /** * Gets the time when system started applying this recommended action on the user resource. e.g., index creation start time */ executeActionStartTime: string; /** * Resource ID. */ id: string; /** * Gets the implementation details of this recommended action for user to apply it manually. */ implementationDetails: outputs.sql.RecommendedActionImplementationInfoResponse; /** * Gets if this recommended action was suggested some time ago but user chose to ignore this and system added a new recommended action again. */ isArchivedAction: boolean; /** * Gets if this recommended action is actionable by user */ isExecutableAction: boolean; /** * Gets if changes applied by this recommended action can be reverted by user */ isRevertableAction: boolean; /** * Resource kind. */ kind: string; /** * Gets time when this recommended action was last refreshed. */ lastRefresh: string; /** * Gets the linked objects, if any. */ linkedObjects: string[]; /** * Resource location. */ location: string; /** * Resource name. */ name: string; /** * Gets the observed/actual impact info for this recommended action e.g., Actual CPU gain, Actual Disk Space change */ observedImpact: outputs.sql.RecommendedActionImpactRecordResponse[]; /** * Gets the reason for recommending this action. e.g., DuplicateIndex */ recommendationReason: string; /** * Gets the time taken for reverting changes of this recommended action on user resource. e.g., time taken for dropping the created index. */ revertActionDuration: string; /** * Gets if approval for reverting this recommended action was given by user/system. */ revertActionInitiatedBy: string; /** * Gets the time when this recommended action was approved for revert. */ revertActionInitiatedTime: string; /** * Gets the time when system started reverting changes of this recommended action on user resource. e.g., time when index drop is executed. */ revertActionStartTime: string; /** * Gets the impact of this recommended action. Possible values are 1 - Low impact, 2 - Medium Impact and 3 - High Impact */ score: number; /** * Gets the info of the current state the recommended action is in. */ state: outputs.sql.RecommendedActionStateInfoResponse; /** * Gets the time series info of metrics for this recommended action e.g., CPU consumption time series */ timeSeries: outputs.sql.RecommendedActionMetricInfoResponse[]; /** * Resource type. */ type: string; /** * Gets the time since when this recommended action is valid. */ validSince: string; } /** * Contains information of current state for an Azure SQL Database, Server or Elastic Pool Recommended Action. */ interface RecommendedActionStateInfoResponse { /** * Gets who initiated the execution of this recommended action. Possible Value are: User -> When user explicity notified system to apply the recommended action. System -> When auto-execute status of this advisor was set to 'Enabled', in which case the system applied it. */ actionInitiatedBy: string; /** * Current state the recommended action is in. Some commonly used states are: Active -> recommended action is active and no action has been taken yet. Pending -> recommended action is approved for and is awaiting execution. Executing -> recommended action is being applied on the user database. Verifying -> recommended action was applied and is being verified of its usefulness by the system. Success -> recommended action was applied and improvement found during verification. Pending Revert -> verification found little or no improvement so recommended action is queued for revert or user has manually reverted. Reverting -> changes made while applying recommended action are being reverted on the user database. Reverted -> successfully reverted the changes made by recommended action on user database. Ignored -> user explicitly ignored/discarded the recommended action. */ currentValue: string; /** * Gets the time when the state was last modified */ lastModified: string; } /** * Azure Active Directory identity configuration for a resource. */ interface ResourceIdentityResponse { /** * The Azure Active Directory principal id. */ principalId: string; /** * The Azure Active Directory tenant id. */ tenantId: string; /** * The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. */ type?: string; /** * The resource ids of the user assigned identities to use */ userAssignedIdentities?: { [key: string]: outputs.sql.UserIdentityResponse; }; } /** * Schedule info describing when the server should be started or stopped. */ interface ScheduleItemResponse { /** * Start day. */ startDay: string; /** * Start time. */ startTime: string; /** * Stop day. */ stopDay: string; /** * Stop time. */ stopTime: string; } /** * Properties of a active directory administrator. */ interface ServerExternalAdministratorResponse { /** * Type of the sever administrator. */ administratorType?: string; /** * Azure Active Directory only Authentication enabled. */ azureADOnlyAuthentication?: boolean; /** * Login name of the server administrator. */ login?: string; /** * Principal Type of the sever administrator. */ principalType?: string; /** * SID (object ID) of the server administrator. */ sid?: string; /** * Tenant ID of the administrator. */ tenantId?: string; } /** * Server info for the server trust group. */ interface ServerInfoResponse { /** * Server Id. */ serverId: string; } /** * A private endpoint connection under a server */ interface ServerPrivateEndpointConnectionResponse { /** * Resource ID. */ id: string; /** * Private endpoint connection properties */ properties: outputs.sql.PrivateEndpointConnectionPropertiesResponse; } /** * The managed instance's service principal configuration for a resource. */ interface ServicePrincipalResponse { /** * The Azure Active Directory application client id. */ clientId: string; /** * The Azure Active Directory application object id. */ principalId: string; /** * The Azure Active Directory tenant id. */ tenantId: string; /** * Service principal type. */ type?: string; } /** * An ARM Resource SKU. */ interface SkuResponse { /** * Capacity of the particular SKU. */ capacity?: number; /** * If the service has different generations of hardware, for the same SKU, then that can be captured here. */ family?: string; /** * The name of the SKU, typically, a letter + Number code, e.g. P3. */ name: string; /** * Size of the particular SKU */ size?: string; /** * The tier or edition of the particular SKU, e.g. Basic, Premium. */ tier?: string; } /** * Properties of sync group schema. */ interface SyncGroupSchemaResponse { /** * Name of master sync member where the schema is from. */ masterSyncMemberName?: string; /** * List of tables in sync group schema. */ tables?: outputs.sql.SyncGroupSchemaTableResponse[]; } /** * Properties of column in sync group table. */ interface SyncGroupSchemaTableColumnResponse { /** * Data size of the column. */ dataSize?: string; /** * Data type of the column. */ dataType?: string; /** * Quoted name of sync group table column. */ quotedName?: string; } /** * Properties of table in sync group schema. */ interface SyncGroupSchemaTableResponse { /** * List of columns in sync group schema. */ columns?: outputs.sql.SyncGroupSchemaTableColumnResponse[]; /** * Quoted name of sync group schema table. */ quotedName?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Azure Active Directory identity configuration for a resource. */ interface UserIdentityResponse { /** * The Azure Active Directory client id. */ clientId: string; /** * The Azure Active Directory principal id. */ principalId: string; } /** * Properties of a Vulnerability Assessment recurring scans. */ interface VulnerabilityAssessmentRecurringScansPropertiesResponse { /** * Specifies that the schedule scan notification will be is sent to the subscription administrators. */ emailSubscriptionAdmins?: boolean; /** * Specifies an array of e-mail addresses to which the scan notification is sent. */ emails?: string[]; /** * Recurring scans state. */ isEnabled?: boolean; } /** * vulnerabilityAssessmentRecurringScansPropertiesResponseProvideDefaults sets the appropriate defaults for VulnerabilityAssessmentRecurringScansPropertiesResponse */ function vulnerabilityAssessmentRecurringScansPropertiesResponseProvideDefaults(val: VulnerabilityAssessmentRecurringScansPropertiesResponse): VulnerabilityAssessmentRecurringScansPropertiesResponse; } export declare namespace sqlvirtualmachine { /** * Enable AAD authentication for SQL VM. */ interface AADAuthenticationSettingsResponse { /** * The client Id of the Managed Identity to query Microsoft Graph API. An empty string must be used for the system assigned Managed Identity */ clientId?: string; } /** * Additional SQL Server feature settings. */ interface AdditionalFeaturesServerConfigurationsResponse { /** * Enable or disable R services (SQL 2016 onwards). */ isRServicesEnabled?: boolean; } /** * Availability group configuration. */ interface AgConfigurationResponse { /** * Replica configurations. */ replicas?: outputs.sqlvirtualmachine.AgReplicaResponse[]; } /** * Availability group replica configuration. */ interface AgReplicaResponse { /** * Replica commit mode in availability group. */ commit?: string; /** * Replica failover mode in availability group. */ failover?: string; /** * Replica readable secondary mode in availability group. */ readableSecondary?: string; /** * Replica Role in availability group. */ role?: string; /** * Sql VirtualMachine Instance Id. */ sqlVirtualMachineInstanceId?: string; } /** * Configure SQL best practices Assessment for databases in your SQL virtual machine. */ interface AssessmentSettingsResponse { /** * Enable or disable SQL best practices Assessment feature on SQL virtual machine. */ enable?: boolean; /** * Run SQL best practices Assessment immediately on SQL virtual machine. */ runImmediately?: boolean; /** * Schedule for SQL best practices Assessment. */ schedule?: outputs.sqlvirtualmachine.ScheduleResponse; } /** * Configure backups for databases in your SQL virtual machine. */ interface AutoBackupSettingsResponse { /** * Backup schedule type. */ backupScheduleType?: string; /** * Include or exclude system databases from auto backup. */ backupSystemDbs?: boolean; /** * Days of the week for the backups when FullBackupFrequency is set to Weekly. */ daysOfWeek?: string[]; /** * Enable or disable autobackup on SQL virtual machine. */ enable?: boolean; /** * Enable or disable encryption for backup on SQL virtual machine. */ enableEncryption?: boolean; /** * Frequency of full backups. In both cases, full backups begin during the next scheduled time window. */ fullBackupFrequency?: string; /** * Start time of a given day during which full backups can take place. 0-23 hours. */ fullBackupStartTime?: number; /** * Duration of the time window of a given day during which full backups can take place. 1-23 hours. */ fullBackupWindowHours?: number; /** * Frequency of log backups. 5-60 minutes. */ logBackupFrequency?: number; /** * Retention period of backup: 1-90 days. */ retentionPeriod?: number; /** * Storage account url where backup will be taken to. */ storageAccountUrl?: string; /** * Storage container name where backup will be taken to. */ storageContainerName?: string; } /** * Set a patching window during which Windows and SQL patches will be applied. */ interface AutoPatchingSettingsResponse { /** * Additional Patch to be enable or enabled on the SQL Virtual Machine. */ additionalVmPatch?: string; /** * Day of week to apply the patch on. */ dayOfWeek?: string; /** * Enable or disable autopatching on SQL virtual machine. */ enable?: boolean; /** * Duration of patching. */ maintenanceWindowDuration?: number; /** * Hour of the day when patching is initiated. Local VM time. */ maintenanceWindowStartingHour?: number; } /** * autoPatchingSettingsResponseProvideDefaults sets the appropriate defaults for AutoPatchingSettingsResponse */ function autoPatchingSettingsResponseProvideDefaults(val: AutoPatchingSettingsResponse): AutoPatchingSettingsResponse; /** * Configure your SQL virtual machine to be able to connect to the Azure Key Vault service. */ interface KeyVaultCredentialSettingsResponse { /** * Azure Key Vault url. */ azureKeyVaultUrl?: string; /** * Credential name. */ credentialName?: string; /** * Enable or disable key vault credential setting. */ enable?: boolean; /** * Service principal name to access key vault. */ servicePrincipalName?: string; } /** * A load balancer configuration for an availability group listener. */ interface LoadBalancerConfigurationResponse { /** * Resource id of the load balancer. */ loadBalancerResourceId?: string; /** * Private IP address. */ privateIpAddress?: outputs.sqlvirtualmachine.PrivateIPAddressResponse; /** * Probe port. */ probePort?: number; /** * Resource id of the public IP. */ publicIpAddressResourceId?: string; /** * List of the SQL virtual machine instance resource id's that are enrolled into the availability group listener. */ sqlVirtualMachineInstances?: string[]; } /** * Multi subnet ip configuration for an availability group listener. */ interface MultiSubnetIpConfigurationResponse { /** * Private IP address. */ privateIpAddress: outputs.sqlvirtualmachine.PrivateIPAddressResponse; /** * SQL virtual machine instance resource id that are enrolled into the availability group listener. */ sqlVirtualMachineInstance: string; } /** * A private IP address bound to the availability group listener. */ interface PrivateIPAddressResponse { /** * Private IP address bound to the availability group listener. */ ipAddress?: string; /** * Subnet used to include private IP. */ subnetResourceId?: string; } /** * Azure Active Directory identity configuration for a resource. */ interface ResourceIdentityResponse { /** * The Azure Active Directory principal id. */ principalId: string; /** * The Azure Active Directory tenant id. */ tenantId: string; /** * The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. */ type?: string; } /** * Set the server/instance-level settings for SQL Server. */ interface SQLInstanceSettingsResponse { /** * SQL Server Collation. */ collation?: string; /** * SQL Server IFI. */ isIfiEnabled?: boolean; /** * SQL Server LPIM. */ isLpimEnabled?: boolean; /** * SQL Server Optimize for Adhoc workloads. */ isOptimizeForAdHocWorkloadsEnabled?: boolean; /** * SQL Server MAXDOP. */ maxDop?: number; /** * SQL Server maximum memory. */ maxServerMemoryMB?: number; /** * SQL Server minimum memory. */ minServerMemoryMB?: number; } /** * Set disk storage settings for SQL Server. */ interface SQLStorageSettingsResponse { /** * SQL Server default file path */ defaultFilePath?: string; /** * Logical Unit Numbers for the disks. */ luns?: number[]; /** * Use storage pool to build a drive if true or not provided */ useStoragePool?: boolean; } /** * Set tempDb storage settings for SQL Server. */ interface SQLTempDbSettingsResponse { /** * SQL Server tempdb data file count */ dataFileCount?: number; /** * SQL Server tempdb data file size */ dataFileSize?: number; /** * SQL Server tempdb data file autoGrowth size */ dataGrowth?: number; /** * SQL Server default file path */ defaultFilePath?: string; /** * SQL Server tempdb log file size */ logFileSize?: number; /** * SQL Server tempdb log file autoGrowth size */ logGrowth?: number; /** * Logical Unit Numbers for the disks. */ luns?: number[]; /** * SQL Server tempdb persist folder choice */ persistFolder?: boolean; /** * SQL Server tempdb persist folder location */ persistFolderPath?: string; /** * Use storage pool to build a drive if true or not provided */ useStoragePool?: boolean; } /** * Set assessment schedule for SQL Server. */ interface ScheduleResponse { /** * Day of the week to run assessment. */ dayOfWeek?: string; /** * Enable or disable assessment schedule on SQL virtual machine. */ enable?: boolean; /** * Occurrence of the DayOfWeek day within a month to schedule assessment. Takes values: 1,2,3,4 and -1. Use -1 for last DayOfWeek day of the month */ monthlyOccurrence?: number; /** * Time of the day in HH:mm format. Eg. 17:30 */ startTime?: string; /** * Number of weeks to schedule between 2 assessment runs. Takes value from 1-6 */ weeklyInterval?: number; } /** * Set the connectivity, storage and workload settings. */ interface ServerConfigurationsManagementSettingsResponse { /** * Additional SQL feature settings. */ additionalFeaturesServerConfigurations?: outputs.sqlvirtualmachine.AdditionalFeaturesServerConfigurationsResponse; /** * Azure AD authentication Settings. */ azureAdAuthenticationSettings?: outputs.sqlvirtualmachine.AADAuthenticationSettingsResponse; /** * SQL connectivity type settings. */ sqlConnectivityUpdateSettings?: outputs.sqlvirtualmachine.SqlConnectivityUpdateSettingsResponse; /** * SQL Instance settings. */ sqlInstanceSettings?: outputs.sqlvirtualmachine.SQLInstanceSettingsResponse; /** * SQL storage update settings. */ sqlStorageUpdateSettings?: outputs.sqlvirtualmachine.SqlStorageUpdateSettingsResponse; /** * SQL workload type settings. */ sqlWorkloadTypeUpdateSettings?: outputs.sqlvirtualmachine.SqlWorkloadTypeUpdateSettingsResponse; } /** * Set the access level and network port settings for SQL Server. */ interface SqlConnectivityUpdateSettingsResponse { /** * SQL Server connectivity option. */ connectivityType?: string; /** * SQL Server port. */ port?: number; } /** * Set disk storage settings for SQL Server. */ interface SqlStorageUpdateSettingsResponse { /** * Disk configuration to apply to SQL Server. */ diskConfigurationType?: string; /** * Virtual machine disk count. */ diskCount?: number; /** * Device id of the first disk to be updated. */ startingDeviceId?: number; } /** * Set workload type to optimize storage for SQL Server. */ interface SqlWorkloadTypeUpdateSettingsResponse { /** * SQL Server workload type. */ sqlWorkloadType?: string; } /** * Storage Configurations for SQL Data, Log and TempDb. */ interface StorageConfigurationSettingsResponse { /** * Disk configuration to apply to SQL Server. */ diskConfigurationType?: string; /** * SQL Server Data Storage Settings. */ sqlDataSettings?: outputs.sqlvirtualmachine.SQLStorageSettingsResponse; /** * SQL Server Log Storage Settings. */ sqlLogSettings?: outputs.sqlvirtualmachine.SQLStorageSettingsResponse; /** * SQL Server SystemDb Storage on DataPool if true. */ sqlSystemDbOnDataDisk?: boolean; /** * SQL Server TempDb Storage Settings. */ sqlTempDbSettings?: outputs.sqlvirtualmachine.SQLTempDbSettingsResponse; /** * Storage workload type. */ storageWorkloadType?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * SQL VM Troubleshooting additional properties. */ interface TroubleshootingAdditionalPropertiesResponse { /** * The unhealthy replica information */ unhealthyReplicaInfo?: outputs.sqlvirtualmachine.UnhealthyReplicaInfoResponse; } /** * Status of last troubleshooting operation on this SQL VM */ interface TroubleshootingStatusResponse { /** * End time in UTC timezone. */ endTimeUtc: string; /** * Last troubleshooting trigger time in UTC timezone */ lastTriggerTimeUtc: string; /** * Troubleshooting properties */ properties: outputs.sqlvirtualmachine.TroubleshootingAdditionalPropertiesResponse; /** * Root cause of the issue */ rootCause: string; /** * Start time in UTC timezone. */ startTimeUtc: string; /** * SQL VM troubleshooting scenario. */ troubleshootingScenario: string; } /** * troubleshootingStatusResponseProvideDefaults sets the appropriate defaults for TroubleshootingStatusResponse */ function troubleshootingStatusResponseProvideDefaults(val: TroubleshootingStatusResponse): TroubleshootingStatusResponse; /** * SQL VM Troubleshoot UnhealthyReplica scenario information. */ interface UnhealthyReplicaInfoResponse { /** * The name of the availability group */ availabilityGroupName?: string; } /** * Virtual Machine Identity details used for Sql IaaS extension configurations. */ interface VirtualMachineIdentityResponse { /** * ARM Resource Id of the identity. Only required when UserAssigned identity is selected. */ resourceId?: string; /** * Identity type of the virtual machine. Specify None to opt-out of Managed Identities. */ type?: string; } /** * Domain credentials for setting up Windows Server Failover Cluster for SQL availability group. */ interface WsfcDomainCredentialsResponse { /** * Cluster bootstrap account password. */ clusterBootstrapAccountPassword?: string; /** * Cluster operator account password. */ clusterOperatorAccountPassword?: string; /** * SQL service account password. */ sqlServiceAccountPassword?: string; } /** * Active Directory account details to operate Windows Server Failover Cluster. */ interface WsfcDomainProfileResponse { /** * Account name used for creating cluster (at minimum needs permissions to 'Create Computer Objects' in domain). */ clusterBootstrapAccount?: string; /** * Account name used for operating cluster i.e. will be part of administrators group on all the participating virtual machines in the cluster. */ clusterOperatorAccount?: string; /** * Cluster subnet type. */ clusterSubnetType?: string; /** * Fully qualified name of the domain. */ domainFqdn?: string; /** * Optional path for fileshare witness. */ fileShareWitnessPath?: string; /** * The flag to check if SQL service account is GMSA. */ isSqlServiceAccountGmsa?: boolean; /** * Organizational Unit path in which the nodes and cluster will be present. */ ouPath?: string; /** * Account name under which SQL service will run on all participating SQL virtual machines in the cluster. */ sqlServiceAccount?: string; /** * Fully qualified ARM resource id of the witness storage account. */ storageAccountUrl?: string; } } export declare namespace standbypool { /** * Details of the ContainerGroupProfile. */ interface ContainerGroupProfileResponse { /** * Specifies container group profile id of standby container groups. */ id: string; /** * Specifies revision of container group profile. */ revision?: number; } /** * Details of the ContainerGroupProperties. */ interface ContainerGroupPropertiesResponse { /** * Specifies container group profile of standby container groups. */ containerGroupProfile: outputs.standbypool.ContainerGroupProfileResponse; /** * Specifies subnet Ids for container group. */ subnetIds?: outputs.standbypool.SubnetResponse[]; } /** * Specifies the elasticity profile of the standby container group pools. */ interface StandbyContainerGroupPoolElasticityProfileResponse { /** * Specifies maximum number of standby container groups in the standby pool. */ maxReadyCapacity: number; /** * Specifies refill policy of the pool. */ refillPolicy?: string; } /** * Details of the elasticity profile. */ interface StandbyVirtualMachinePoolElasticityProfileResponse { /** * Specifies the maximum number of virtual machines in the standby virtual machine pool. */ maxReadyCapacity: number; /** * Specifies the desired minimum number of virtual machines in the standby virtual machine pool. MinReadyCapacity cannot exceed MaxReadyCapacity. */ minReadyCapacity?: number; } /** * Subnet of container group */ interface SubnetResponse { /** * Specifies ARM resource id of the subnet. */ id: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace storage { interface AccessPolicyResponse { /** * Expiry time of the access policy */ expiryTime?: string; /** * List of abbreviated permissions. */ permission?: string; /** * Start time of the access policy */ startTime?: string; } /** * This defines account-level immutability policy properties. */ interface AccountImmutabilityPolicyPropertiesResponse { /** * This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. */ allowProtectedAppendWrites?: boolean; /** * The immutability period for the blobs in the container since the policy creation, in days. */ immutabilityPeriodSinceCreationInDays?: number; /** * The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted. */ state?: string; } /** * Settings properties for Active Directory (AD). */ interface ActiveDirectoryPropertiesResponse { /** * Specifies the Active Directory account type for Azure Storage. */ accountType?: string; /** * Specifies the security identifier (SID) for Azure Storage. */ azureStorageSid?: string; /** * Specifies the domain GUID. */ domainGuid: string; /** * Specifies the primary domain that the AD DNS server is authoritative for. */ domainName: string; /** * Specifies the security identifier (SID). */ domainSid?: string; /** * Specifies the Active Directory forest to get. */ forestName?: string; /** * Specifies the NetBIOS domain name. */ netBiosDomainName?: string; /** * Specifies the Active Directory SAMAccountName for Azure Storage. */ samAccountName?: string; } /** * Settings for Azure Files identity based authentication. */ interface AzureFilesIdentityBasedAuthenticationResponse { /** * Required if directoryServiceOptions are AD, optional if they are AADKERB. */ activeDirectoryProperties?: outputs.storage.ActiveDirectoryPropertiesResponse; /** * Default share permission for users using Kerberos authentication if RBAC role is not assigned. */ defaultSharePermission?: string; /** * Indicates the directory service used. Note that this enum may be extended in the future. */ directoryServiceOptions: string; } /** * This property defines the creation time based filtering condition. Blob Inventory schema parameter 'Creation-Time' is mandatory with this filter. */ interface BlobInventoryCreationTimeResponse { /** * When set the policy filters the objects that are created in the last N days. Where N is an integer value between 1 to 36500. */ lastNDays?: number; } /** * An object that defines the blob inventory rule. */ interface BlobInventoryPolicyDefinitionResponse { /** * An object that defines the filter set. */ filters?: outputs.storage.BlobInventoryPolicyFilterResponse; /** * This is a required field, it specifies the format for the inventory files. */ format: string; /** * This is a required field. This field specifies the scope of the inventory created either at the blob or container level. */ objectType: string; /** * This is a required field. This field is used to schedule an inventory formation. */ schedule: string; /** * This is a required field. This field specifies the fields and properties of the object to be included in the inventory. The Schema field value 'Name' is always required. The valid values for this field for the 'Blob' definition.objectType include 'Name, Creation-Time, Last-Modified, Content-Length, Content-MD5, BlobType, AccessTier, AccessTierChangeTime, AccessTierInferred, Tags, Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, Snapshot, VersionId, IsCurrentVersion, Metadata, LastAccessTime, Tags, Etag, ContentType, ContentEncoding, ContentLanguage, ContentCRC64, CacheControl, ContentDisposition, LeaseStatus, LeaseState, LeaseDuration, ServerEncrypted, Deleted, DeletionId, DeletedTime, RemainingRetentionDays, ImmutabilityPolicyUntilDate, ImmutabilityPolicyMode, LegalHold, CopyId, CopyStatus, CopySource, CopyProgress, CopyCompletionTime, CopyStatusDescription, CustomerProvidedKeySha256, RehydratePriority, ArchiveStatus, XmsBlobSequenceNumber, EncryptionScope, IncrementalCopy, TagCount'. For Blob object type schema field value 'DeletedTime' is applicable only for Hns enabled accounts. The valid values for 'Container' definition.objectType include 'Name, Last-Modified, Metadata, LeaseStatus, LeaseState, LeaseDuration, PublicAccess, HasImmutabilityPolicy, HasLegalHold, Etag, DefaultEncryptionScope, DenyEncryptionScopeOverride, ImmutableStorageWithVersioningEnabled, Deleted, Version, DeletedTime, RemainingRetentionDays'. Schema field values 'Expiry-Time, hdi_isfolder, Owner, Group, Permissions, Acl, DeletionId' are valid only for Hns enabled accounts.Schema field values 'Tags, TagCount' are only valid for Non-Hns accounts. */ schemaFields: string[]; } /** * An object that defines the blob inventory rule filter conditions. For 'Blob' definition.objectType all filter properties are applicable, 'blobTypes' is required and others are optional. For 'Container' definition.objectType only prefixMatch is applicable and is optional. */ interface BlobInventoryPolicyFilterResponse { /** * An array of predefined enum values. Valid values include blockBlob, appendBlob, pageBlob. Hns accounts does not support pageBlobs. This field is required when definition.objectType property is set to 'Blob'. */ blobTypes?: string[]; /** * This property is used to filter objects based on the object creation time */ creationTime?: outputs.storage.BlobInventoryCreationTimeResponse; /** * An array of strings with maximum 10 blob prefixes to be excluded from the inventory. */ excludePrefix?: string[]; /** * Includes blob versions in blob inventory when value is set to true. The definition.schemaFields values 'VersionId and IsCurrentVersion' are required if this property is set to true, else they must be excluded. */ includeBlobVersions?: boolean; /** * For 'Container' definition.objectType the definition.schemaFields must include 'Deleted, Version, DeletedTime and RemainingRetentionDays'. For 'Blob' definition.objectType and HNS enabled storage accounts the definition.schemaFields must include 'DeletionId, Deleted, DeletedTime and RemainingRetentionDays' and for Hns disabled accounts the definition.schemaFields must include 'Deleted and RemainingRetentionDays', else it must be excluded. */ includeDeleted?: boolean; /** * Includes blob snapshots in blob inventory when value is set to true. The definition.schemaFields value 'Snapshot' is required if this property is set to true, else it must be excluded. */ includeSnapshots?: boolean; /** * An array of strings with maximum 10 blob prefixes to be included in the inventory. */ prefixMatch?: string[]; } /** * An object that wraps the blob inventory rule. Each rule is uniquely defined by name. */ interface BlobInventoryPolicyRuleResponse { /** * An object that defines the blob inventory policy rule. */ definition: outputs.storage.BlobInventoryPolicyDefinitionResponse; /** * Container name where blob inventory files are stored. Must be pre-created. */ destination: string; /** * Rule is enabled when set to true. */ enabled: boolean; /** * A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. */ name: string; } /** * The storage account blob inventory policy rules. */ interface BlobInventoryPolicySchemaResponse { /** * Deprecated Property from API version 2021-04-01 onwards, the required destination container name must be specified at the rule level 'policy.rule.destination' */ destination: string; /** * Policy is enabled if set to true. */ enabled: boolean; /** * The storage account blob inventory policy rules. The rule is applied when it is enabled. */ rules: outputs.storage.BlobInventoryPolicyRuleResponse[]; /** * The valid value is Inventory */ type: string; } /** * Blob restore parameters */ interface BlobRestoreParametersResponse { /** * Blob ranges to restore. */ blobRanges: outputs.storage.BlobRestoreRangeResponse[]; /** * Restore blob to the specified time. */ timeToRestore: string; } /** * Blob range */ interface BlobRestoreRangeResponse { /** * Blob end range. This is exclusive. Empty means account end. */ endRange: string; /** * Blob start range. This is inclusive. Empty means account start. */ startRange: string; } /** * Blob restore status. */ interface BlobRestoreStatusResponse { /** * Failure reason when blob restore is failed. */ failureReason: string; /** * Blob restore request parameters. */ parameters: outputs.storage.BlobRestoreParametersResponse; /** * Id for tracking blob restore request. */ restoreId: string; /** * The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed. */ status: string; } /** * The blob service properties for change feed events. */ interface ChangeFeedResponse { /** * Indicates whether change feed event logging is enabled for the Blob service. */ enabled?: boolean; /** * Indicates the duration of changeFeed retention in days. Minimum value is 1 day and maximum value is 146000 days (400 years). A null value indicates an infinite retention of the change feed. */ retentionInDays?: number; } /** * Specifies a CORS rule for the Blob service. */ interface CorsRuleResponse { /** * Required if CorsRule element is present. A list of headers allowed to be part of the cross-origin request. */ allowedHeaders: string[]; /** * Required if CorsRule element is present. A list of HTTP methods that are allowed to be executed by the origin. */ allowedMethods: string[]; /** * Required if CorsRule element is present. A list of origin domains that will be allowed via CORS, or "*" to allow all domains */ allowedOrigins: string[]; /** * Required if CorsRule element is present. A list of response headers to expose to CORS clients. */ exposedHeaders: string[]; /** * Required if CorsRule element is present. The number of seconds that the client/browser should cache a preflight response. */ maxAgeInSeconds: number; } /** * Sets the CORS rules. You can include up to five CorsRule elements in the request. */ interface CorsRulesResponse { /** * The List of CORS rules. You can include up to five CorsRule elements in the request. */ corsRules?: outputs.storage.CorsRuleResponse[]; } /** * The custom domain assigned to this storage account. This can be set via Update. */ interface CustomDomainResponse { /** * Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source. */ name: string; /** * Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates. */ useSubDomainName?: boolean; } /** * The connection details for Data Share source */ interface DataShareConnectionResponse { /** * The URI of the backing DataShare. Must be in the format: azds://:: */ dataShareUri: string; /** * The connection type for bucket connection in storage connector. * Expected value is 'DataShare'. */ type: "DataShare"; } /** * The properties of data share source */ interface DataShareSourceResponse { /** * Details for how to authenticate to the backing data store. */ authProperties: outputs.storage.ManagedIdentityAuthPropertiesResponse; /** * Details for how to connect to the backing data store. */ connection: outputs.storage.DataShareConnectionResponse; /** * The type of the backing data source for storage connector * Expected value is 'DataShare'. */ type: "DataShare"; } /** * Object to define snapshot and version action conditions. */ interface DateAfterCreationResponse { /** * Value indicating the age in days after creation */ daysAfterCreationGreaterThan: number; /** * Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterCreationGreaterThan to be set for snapshots and blob version based actions. The blob will be archived if both the conditions are satisfied. */ daysAfterLastTierChangeGreaterThan?: number; } /** * Object to define the base blob action conditions. Properties daysAfterModificationGreaterThan, daysAfterLastAccessTimeGreaterThan and daysAfterCreationGreaterThan are mutually exclusive. The daysAfterLastTierChangeGreaterThan property is only applicable for tierToArchive actions which requires daysAfterModificationGreaterThan to be set, also it cannot be used in conjunction with daysAfterLastAccessTimeGreaterThan or daysAfterCreationGreaterThan. */ interface DateAfterModificationResponse { /** * Value indicating the age in days after blob creation. */ daysAfterCreationGreaterThan?: number; /** * Value indicating the age in days after last blob access. This property can only be used in conjunction with last access time tracking policy */ daysAfterLastAccessTimeGreaterThan?: number; /** * Value indicating the age in days after last blob tier change time. This property is only applicable for tierToArchive actions and requires daysAfterModificationGreaterThan to be set for baseBlobs based actions. The blob will be archived if both the conditions are satisfied. */ daysAfterLastTierChangeGreaterThan?: number; /** * Value indicating the age in days after last modification */ daysAfterModificationGreaterThan?: number; } /** * The service properties for soft delete. */ interface DeleteRetentionPolicyResponse { /** * This property when set to true allows deletion of the soft deleted blob versions and snapshots. This property cannot be used blob restore policy. This property only applies to blob service and does not apply to containers or file share. */ allowPermanentDelete?: boolean; /** * Indicates the number of days that the deleted item should be retained. The minimum specified value can be 1 and the maximum value can be 365. */ days?: number; /** * Indicates whether DeleteRetentionPolicy is enabled. */ enabled?: boolean; } /** * Encryption identity for the storage account. */ interface EncryptionIdentityResponse { /** * ClientId of the multi-tenant application to be used in conjunction with the user-assigned identity for cross-tenant customer-managed-keys server-side encryption on the storage account. */ encryptionFederatedIdentityClientId?: string; /** * Resource identifier of the UserAssigned identity to be associated with server-side encryption on the storage account. */ encryptionUserAssignedIdentity?: string; } /** * The encryption settings on the storage account. */ interface EncryptionResponse { /** * The identity to be used with service-side encryption at rest. */ encryptionIdentity?: outputs.storage.EncryptionIdentityResponse; /** * The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault */ keySource?: string; /** * Properties provided by key vault. */ keyVaultProperties?: outputs.storage.KeyVaultPropertiesResponse; /** * A boolean indicating whether or not the service applies a secondary layer of encryption with platform managed keys for data at rest. */ requireInfrastructureEncryption?: boolean; /** * List of services which support encryption. */ services?: outputs.storage.EncryptionServicesResponse; } /** * encryptionResponseProvideDefaults sets the appropriate defaults for EncryptionResponse */ function encryptionResponseProvideDefaults(val: EncryptionResponse): EncryptionResponse; /** * The key vault properties for the encryption scope. This is a required field if encryption scope 'source' attribute is set to 'Microsoft.KeyVault'. */ interface EncryptionScopeKeyVaultPropertiesResponse { /** * The object identifier of the current versioned Key Vault Key in use. */ currentVersionedKeyIdentifier: string; /** * The object identifier for a key vault key object. When applied, the encryption scope will use the key referenced by the identifier to enable customer-managed key support on this encryption scope. */ keyUri?: string; /** * Timestamp of last rotation of the Key Vault Key. */ lastKeyRotationTimestamp: string; } /** * A service that allows server-side encryption to be used. */ interface EncryptionServiceResponse { /** * A boolean indicating whether or not the service encrypts the data as it is stored. Encryption at rest is enabled by default today and cannot be disabled. */ enabled?: boolean; /** * Encryption key type to be used for the encryption service. 'Account' key type implies that an account-scoped encryption key will be used. 'Service' key type implies that a default service key is used. */ keyType?: string; /** * Gets a rough estimate of the date/time when the encryption was last enabled by the user. Data is encrypted at rest by default today and cannot be disabled. */ lastEnabledTime: string; } /** * A list of services that support encryption. */ interface EncryptionServicesResponse { /** * The encryption function of the blob storage service. */ blob?: outputs.storage.EncryptionServiceResponse; /** * The encryption function of the file storage service. */ file?: outputs.storage.EncryptionServiceResponse; /** * The encryption function of the queue storage service. */ queue?: outputs.storage.EncryptionServiceResponse; /** * The encryption function of the table storage service. */ table?: outputs.storage.EncryptionServiceResponse; } /** * The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object. */ interface EndpointsResponse { /** * Gets the blob endpoint. */ blob: string; /** * Gets the dfs endpoint. */ dfs: string; /** * Gets the file endpoint. */ file: string; /** * Gets the internet routing storage endpoints */ internetEndpoints?: outputs.storage.StorageAccountInternetEndpointsResponse; /** * Gets the microsoft routing storage endpoints. */ microsoftEndpoints?: outputs.storage.StorageAccountMicrosoftEndpointsResponse; /** * Gets the queue endpoint. */ queue: string; /** * Gets the table endpoint. */ table: string; /** * Gets the web endpoint. */ web: string; } /** * Target helps provide filter parameters for the objects in the storage account and forms the execution context for the storage task */ interface ExecutionTargetResponse { /** * List of object prefixes to be excluded from task execution. If there is a conflict between include and exclude prefixes, the exclude prefix will be the determining factor */ excludePrefix?: string[]; /** * Required list of object prefixes to be included for task execution */ prefix?: string[]; } /** * Execution trigger for storage task assignment */ interface ExecutionTriggerResponse { /** * The trigger parameters of the storage task assignment execution */ parameters: outputs.storage.TriggerParametersResponse; /** * The trigger type of the storage task assignment execution */ type: string; } /** * The complex type of the extended location. */ interface ExtendedLocationResponse { /** * The name of the extended location. */ name?: string; /** * The type of the extended location. */ type?: string; } /** * File Share Paid Bursting properties. */ interface FileSharePropertiesResponseFileSharePaidBursting { /** * Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. */ paidBurstingEnabled?: boolean; /** * The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share. */ paidBurstingMaxBandwidthMibps?: number; /** * The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share. */ paidBurstingMaxIops?: number; } /** * Statistics related to replication for storage account's Blob, Table, Queue and File services. It is only available when geo-redundant replication is enabled for the storage account. */ interface GeoReplicationStatsResponse { /** * A boolean flag which indicates whether or not account failover is supported for the account. */ canFailover: boolean; /** * A boolean flag which indicates whether or not planned account failover is supported for the account. */ canPlannedFailover: boolean; /** * All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap. */ lastSyncTime: string; /** * The redundancy type of the account after an account failover is performed. */ postFailoverRedundancy: string; /** * The redundancy type of the account after a planned account failover is performed. */ postPlannedFailoverRedundancy: string; /** * The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable. */ status: string; } /** * IP rule with specific IP or IP range in CIDR format. */ interface IPRuleResponse { /** * The action of IP ACL rule. */ action?: string; /** * Specifies the IP or IP range in CIDR format. Only IPV4 address is allowed. */ iPAddressOrRange: string; } /** * ipruleResponseProvideDefaults sets the appropriate defaults for IPRuleResponse */ function ipruleResponseProvideDefaults(val: IPRuleResponse): IPRuleResponse; /** * Identity for the resource. */ interface IdentityResponse { /** * The principal ID of resource identity. */ principalId: string; /** * The tenant ID of resource. */ tenantId: string; /** * The identity type. */ type: string; /** * Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here. */ userAssignedIdentities?: { [key: string]: outputs.storage.UserAssignedIdentityResponse; }; } /** * The properties of an ImmutabilityPolicy of a blob container. */ interface ImmutabilityPolicyPropertiesResponse { /** * This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. */ allowProtectedAppendWrites?: boolean; /** * This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. */ allowProtectedAppendWritesAll?: boolean; /** * ImmutabilityPolicy Etag. */ etag: string; /** * The immutability period for the blobs in the container since the policy creation, in days. */ immutabilityPeriodSinceCreationInDays?: number; /** * The ImmutabilityPolicy state of a blob container, possible values include: Locked and Unlocked. */ state: string; /** * The ImmutabilityPolicy update history of the blob container. */ updateHistory: outputs.storage.UpdateHistoryPropertyResponse[]; } /** * This property enables and defines account-level immutability. Enabling the feature auto-enables Blob Versioning. */ interface ImmutableStorageAccountResponse { /** * A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default. */ enabled?: boolean; /** * Specifies the default account-level immutability policy which is inherited and applied to objects that do not possess an explicit immutability policy at the object level. The object-level immutability policy has higher precedence than the container-level immutability policy, which has a higher precedence than the account-level immutability policy. */ immutabilityPolicy?: outputs.storage.AccountImmutabilityPolicyPropertiesResponse; } /** * Object level immutability properties of the container. */ interface ImmutableStorageWithVersioningResponse { /** * This is an immutable property, when set to true it enables object level immutability at the container level. */ enabled?: boolean; /** * This property denotes the container level immutability to object level immutability migration state. */ migrationState: string; /** * Returns the date and time the object level immutability was enabled. */ timeStamp: string; } /** * Storage account keys creation time. */ interface KeyCreationTimeResponse { key1?: string; key2?: string; } /** * KeyPolicy assigned to the storage account. */ interface KeyPolicyResponse { /** * The key expiration period in days. */ keyExpirationPeriodInDays: number; } /** * Properties of key vault. */ interface KeyVaultPropertiesResponse { /** * This is a read only property that represents the expiration time of the current version of the customer managed key used for encryption. */ currentVersionedKeyExpirationTimestamp: string; /** * The object identifier of the current versioned Key Vault Key in use. */ currentVersionedKeyIdentifier: string; /** * The name of KeyVault key. */ keyName?: string; /** * The Uri of KeyVault. */ keyVaultUri?: string; /** * The version of KeyVault key. */ keyVersion?: string; /** * Timestamp of last rotation of the Key Vault Key. */ lastKeyRotationTimestamp: string; } /** * The blob service properties for Last access time based tracking policy. */ interface LastAccessTimeTrackingPolicyResponse { /** * An array of predefined supported blob types. Only blockBlob is the supported value. This field is currently read only */ blobType?: string[]; /** * When set to true last access time based tracking is enabled. */ enable: boolean; /** * Name of the policy. The valid value is AccessTimeTracking. This field is currently read only */ name?: string; /** * The field specifies blob object tracking granularity in days, typically how often the blob object should be tracked.This field is currently read only with value as 1 */ trackingGranularityInDays?: number; } /** * The LegalHold property of a blob container. */ interface LegalHoldPropertiesResponse { /** * The hasLegalHold public property is set to true by SRP if there are at least one existing tag. The hasLegalHold public property is set to false by SRP if all existing legal hold tags are cleared out. There can be a maximum of 1000 blob containers with hasLegalHold=true for a given account. */ hasLegalHold: boolean; /** * Protected append blob writes history. */ protectedAppendWritesHistory?: outputs.storage.ProtectedAppendWritesHistoryResponse; /** * The list of LegalHold tags of a blob container. */ tags?: outputs.storage.TagPropertyResponse[]; } /** * The managed identity auth properties for dataShare connection. */ interface ManagedIdentityAuthPropertiesResponse { /** * ARM ResourceId of the managed identity that should be used to authenticate to the backing data source. */ identityResourceId?: string; /** * The auth type supported for bucket connection in storage connector. * Expected value is 'ManagedIdentity'. */ type: "ManagedIdentity"; } /** * Actions are applied to the filtered blobs when the execution condition is met. */ interface ManagementPolicyActionResponse { /** * The management policy action for base blob */ baseBlob?: outputs.storage.ManagementPolicyBaseBlobResponse; /** * The management policy action for snapshot */ snapshot?: outputs.storage.ManagementPolicySnapShotResponse; /** * The management policy action for version */ version?: outputs.storage.ManagementPolicyVersionResponse; } /** * Management policy action for base blob. */ interface ManagementPolicyBaseBlobResponse { /** * The function to delete the blob */ delete?: outputs.storage.DateAfterModificationResponse; /** * This property enables auto tiering of a blob from cool to hot on a blob access. This property requires tierToCool.daysAfterLastAccessTimeGreaterThan. */ enableAutoTierToHotFromCool?: boolean; /** * The function to tier blobs to archive storage. */ tierToArchive?: outputs.storage.DateAfterModificationResponse; /** * The function to tier blobs to cold storage. */ tierToCold?: outputs.storage.DateAfterModificationResponse; /** * The function to tier blobs to cool storage. */ tierToCool?: outputs.storage.DateAfterModificationResponse; /** * The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts */ tierToHot?: outputs.storage.DateAfterModificationResponse; } /** * An object that defines the Lifecycle rule. Each definition is made up with a filters set and an actions set. */ interface ManagementPolicyDefinitionResponse { /** * An object that defines the action set. */ actions: outputs.storage.ManagementPolicyActionResponse; /** * An object that defines the filter set. */ filters?: outputs.storage.ManagementPolicyFilterResponse; } /** * Filters limit rule actions to a subset of blobs within the storage account. If multiple filters are defined, a logical AND is performed on all filters. */ interface ManagementPolicyFilterResponse { /** * An array of blob index tag based filters, there can be at most 10 tag filters */ blobIndexMatch?: outputs.storage.TagFilterResponse[]; /** * An array of predefined enum values. Currently blockBlob supports all tiering and delete actions. Only delete actions are supported for appendBlob. */ blobTypes: string[]; /** * An array of strings for prefixes to be match. */ prefixMatch?: string[]; } /** * An object that wraps the Lifecycle rule. Each rule is uniquely defined by name. */ interface ManagementPolicyRuleResponse { /** * An object that defines the Lifecycle rule. */ definition: outputs.storage.ManagementPolicyDefinitionResponse; /** * Rule is enabled if set to true. */ enabled?: boolean; /** * A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy. */ name: string; /** * The valid value is Lifecycle */ type: string; } /** * The Storage Account ManagementPolicies Rules. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview. */ interface ManagementPolicySchemaResponse { /** * The Storage Account ManagementPolicies Rules. See more details in: https://learn.microsoft.com/azure/storage/blobs/lifecycle-management-overview. */ rules: outputs.storage.ManagementPolicyRuleResponse[]; } /** * Management policy action for snapshot. */ interface ManagementPolicySnapShotResponse { /** * The function to delete the blob snapshot */ delete?: outputs.storage.DateAfterCreationResponse; /** * The function to tier blob snapshot to archive storage. */ tierToArchive?: outputs.storage.DateAfterCreationResponse; /** * The function to tier blobs to cold storage. */ tierToCold?: outputs.storage.DateAfterCreationResponse; /** * The function to tier blob snapshot to cool storage. */ tierToCool?: outputs.storage.DateAfterCreationResponse; /** * The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts */ tierToHot?: outputs.storage.DateAfterCreationResponse; } /** * Management policy action for blob version. */ interface ManagementPolicyVersionResponse { /** * The function to delete the blob version */ delete?: outputs.storage.DateAfterCreationResponse; /** * The function to tier blob version to archive storage. */ tierToArchive?: outputs.storage.DateAfterCreationResponse; /** * The function to tier blobs to cold storage. */ tierToCold?: outputs.storage.DateAfterCreationResponse; /** * The function to tier blob version to cool storage. */ tierToCool?: outputs.storage.DateAfterCreationResponse; /** * The function to tier blobs to hot storage. This action can only be used with Premium Block Blob Storage Accounts */ tierToHot?: outputs.storage.DateAfterCreationResponse; } /** * Multichannel setting. Applies to Premium FileStorage only. */ interface MultichannelResponse { /** * Indicates whether multichannel is enabled */ enabled?: boolean; } /** * Network rule set */ interface NetworkRuleSetResponse { /** * Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics. */ bypass?: string; /** * Specifies the default action of allow or deny when no other rules match. */ defaultAction: string; /** * Sets the IP ACL rules */ ipRules?: outputs.storage.IPRuleResponse[]; /** * Sets the resource access rules */ resourceAccessRules?: outputs.storage.ResourceAccessRuleResponse[]; /** * Sets the virtual network rules */ virtualNetworkRules?: outputs.storage.VirtualNetworkRuleResponse[]; } /** * networkRuleSetResponseProvideDefaults sets the appropriate defaults for NetworkRuleSetResponse */ function networkRuleSetResponseProvideDefaults(val: NetworkRuleSetResponse): NetworkRuleSetResponse; /** * Filters limit replication to a subset of blobs within the storage account. A logical OR is performed on values in the filter. If multiple filters are defined, a logical AND is performed on all filters. */ interface ObjectReplicationPolicyFilterResponse { /** * Blobs created after the time will be replicated to the destination. It must be in datetime format 'yyyy-MM-ddTHH:mm:ssZ'. Example: 2020-02-19T16:05:00Z */ minCreationTime?: string; /** * Optional. Filters the results to replicate only blobs whose names begin with the specified prefix. */ prefixMatch?: string[]; } /** * Optional. The object replication policy metrics feature options. */ interface ObjectReplicationPolicyPropertiesResponseMetrics { /** * Indicates whether object replication metrics feature is enabled for the policy. */ enabled?: boolean; } /** * The replication policy rule between two containers. */ interface ObjectReplicationPolicyRuleResponse { /** * Required. Destination container name. */ destinationContainer: string; /** * Optional. An object that defines the filter set. */ filters?: outputs.storage.ObjectReplicationPolicyFilterResponse; /** * Rule Id is auto-generated for each new rule on destination account. It is required for put policy on source account. */ ruleId?: string; /** * Required. Source container name. */ sourceContainer: string; } interface PermissionScopeResponse { /** * The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), Create (c), Modify Ownership (o), and Modify Permissions (p). */ permissions: string; /** * The name of resource, normally the container name or the file share name, used by the local user. */ resourceName: string; /** * The service used by the local user, e.g. blob, file. */ service: string; } /** * The Private Endpoint Connection resource. */ interface PrivateEndpointConnectionResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * The resource of private end point. */ privateEndpoint?: outputs.storage.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.storage.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The Private Endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for Private Endpoint */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Protected append writes history setting for the blob container with Legal holds. */ interface ProtectedAppendWritesHistoryResponse { /** * When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining legal hold protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. */ allowProtectedAppendWritesAll?: boolean; /** * Returns the date and time the tag was added. */ timestamp: string; } /** * Protocol settings for file service */ interface ProtocolSettingsResponse { /** * Setting for SMB protocol */ smb?: outputs.storage.SmbSettingResponse; } /** * Resource Access Rule. */ interface ResourceAccessRuleResponse { /** * Resource Id */ resourceId?: string; /** * Tenant Id */ tenantId?: string; } /** * The blob service properties for blob restore policy */ interface RestorePolicyPropertiesResponse { /** * how long this blob can be restored. It should be great than zero and less than DeleteRetentionPolicy.days. */ days?: number; /** * Blob restore is enabled if set to true. */ enabled: boolean; /** * Deprecated in favor of minRestoreTime property. */ lastEnabledTime: string; /** * Returns the minimum date and time that the restore can be started. */ minRestoreTime: string; } /** * Routing preference defines the type of network, either microsoft or internet routing to be used to deliver the user data, the default option is microsoft routing */ interface RoutingPreferenceResponse { /** * A boolean flag which indicates whether internet routing storage endpoints are to be published */ publishInternetEndpoints?: boolean; /** * A boolean flag which indicates whether microsoft routing storage endpoints are to be published */ publishMicrosoftEndpoints?: boolean; /** * Routing Choice defines the kind of network routing opted by the user. */ routingChoice?: string; } /** * SasPolicy assigned to the storage account. */ interface SasPolicyResponse { /** * The SAS Expiration Action defines the action to be performed when sasPolicy.sasExpirationPeriod is violated. The 'Log' action can be used for audit purposes and the 'Block' action can be used to block and deny the usage of SAS tokens that do not adhere to the sas policy expiration period. */ expirationAction: string; /** * The SAS expiration period, DD.HH:MM:SS. */ sasExpirationPeriod: string; } /** * sasPolicyResponseProvideDefaults sets the appropriate defaults for SasPolicyResponse */ function sasPolicyResponseProvideDefaults(val: SasPolicyResponse): SasPolicyResponse; interface SignedIdentifierResponse { /** * Access policy */ accessPolicy?: outputs.storage.AccessPolicyResponse; /** * An unique identifier of the stored access policy. */ id?: string; } /** * The SKU of the storage account. */ interface SkuResponse { /** * The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType. */ name: string; /** * The SKU tier. This is based on the SKU name. */ tier: string; } /** * Setting for SMB protocol */ interface SmbSettingResponse { /** * SMB authentication methods supported by server. Valid values are NTLMv2, Kerberos. Should be passed as a string with delimiter ';'. */ authenticationMethods?: string; /** * SMB channel encryption supported by server. Valid values are AES-128-CCM, AES-128-GCM, AES-256-GCM. Should be passed as a string with delimiter ';'. */ channelEncryption?: string; /** * Kerberos ticket encryption supported by server. Valid values are RC4-HMAC, AES-256. Should be passed as a string with delimiter ';' */ kerberosTicketEncryption?: string; /** * Multichannel setting. Applies to Premium FileStorage only. */ multichannel?: outputs.storage.MultichannelResponse; /** * SMB protocol versions supported by server. Valid values are SMB2.1, SMB3.0, SMB3.1.1. Should be passed as a string with delimiter ';'. */ versions?: string; } interface SshPublicKeyResponse { /** * Optional. It is used to store the function/usage of the key */ description?: string; /** * Ssh public key base64 encoded. The format should be: ' ', e.g. ssh-rsa AAAABBBB */ key?: string; } /** * The URIs that are used to perform a retrieval of a public blob, file, web or dfs object via a internet routing endpoint. */ interface StorageAccountInternetEndpointsResponse { /** * Gets the blob endpoint. */ blob: string; /** * Gets the dfs endpoint. */ dfs: string; /** * Gets the file endpoint. */ file: string; /** * Gets the web endpoint. */ web: string; } /** * An access key for the storage account. */ interface StorageAccountKeyResponse { /** * Creation time of the key, in round trip date format. */ creationTime: string; /** * Name of the key. */ keyName: string; /** * Permissions for the key -- read-only or full permissions. */ permissions: string; /** * Base 64-encoded value of the key. */ value: string; } /** * The URIs that are used to perform a retrieval of a public blob, queue, table, web or dfs object via a microsoft routing endpoint. */ interface StorageAccountMicrosoftEndpointsResponse { /** * Gets the blob endpoint. */ blob: string; /** * Gets the dfs endpoint. */ dfs: string; /** * Gets the file endpoint. */ file: string; /** * Gets the queue endpoint. */ queue: string; /** * Gets the table endpoint. */ table: string; /** * Gets the web endpoint. */ web: string; } /** * This defines the sku conversion status object for asynchronous sku conversions. */ interface StorageAccountSkuConversionStatusResponse { /** * This property represents the sku conversion end time. */ endTime: string; /** * This property indicates the current sku conversion status. */ skuConversionStatus: string; /** * This property represents the sku conversion start time. */ startTime: string; /** * This property represents the target sku name to which the account sku is being converted asynchronously. */ targetSkuName?: string; } /** * The storage connector properties */ interface StorageConnectorPropertiesResponse { /** * System-generated creation time of the Storage Connector in ISO 8601 date-time format (YYYY-MM-DDTHH:mm:ssZ). * Not a valid input parameter during creating. */ creationTime: string; /** * The type of backing data source for this Storage Connector. */ dataSourceType: string; /** * Arbitrary description of this Storage Connector. Max 250 characters. */ description?: string; /** * Represents the provisioning state of the storage connector. */ provisioningState: string; /** * Information about how to communicate with and authenticate to the backing data store. */ source: outputs.storage.DataShareSourceResponse; /** * State - Active or Inactive. Whether or not the Storage Connector should start as active (default: Active) * (While set to false on the Storage Connector, all data plane requests using this Storage Connector fail, and this Storage Connector is not billed if it would be otherwise. */ state?: string; /** * System-generated GUID identifier for the Storage Connector. Not a valid input parameter when creating. */ uniqueId: string; } /** * storageConnectorPropertiesResponseProvideDefaults sets the appropriate defaults for StorageConnectorPropertiesResponse */ function storageConnectorPropertiesResponseProvideDefaults(val: StorageConnectorPropertiesResponse): StorageConnectorPropertiesResponse; /** * Policy that specify the permission allowed to a managed identity */ interface StorageDataShareAccessPolicyResponse { /** * Allowed permissions. Currently, only supported value is Read. */ permission: string; /** * The AAD principal ID of the Managed Identity. */ principalId: string; /** * The AAD tenant ID of the Managed Identity. */ tenantId: string; } /** * Properties of a shared resource. */ interface StorageDataShareAssetResponse { /** * Source Path to be shared. It can be a folder or a blob. * The asset path should contain container name followed by path within the container, e.g. /container1/logs/external. */ assetPath: string; /** * Consumer visible name of the original path. */ displayName: string; } /** * The storage datashare properties */ interface StorageDataSharePropertiesResponse { /** * List of access policies that specify the permission allowed to a managed identity. * For Create - This property is required and cannot be null. If no access policies are provided at creation time, specify an empty array. * For Update - This property is optional. If set to null or not passed, the existing access policies are left unchanged. * If provided with a non-null value, the existing access policies are replaced with the specified list. */ accessPolicies: outputs.storage.StorageDataShareAccessPolicyResponse[]; /** * List of assets that specify the properties of the shared resources. * For Create - This property is required and cannot be null. If no assets are provided at creation time, specify an empty array. * For Update - This property is optional. If set to null or not passed, the existing assets are left unchanged. * If provided with a non-null value, the existing assets are replaced with the specified list. */ assets: outputs.storage.StorageDataShareAssetResponse[]; /** * System-generated GUID identifier for the Storage DataShare. Not a valid input parameter when creating. */ dataShareIdentifier: string; /** * The DataShare URI to be shared with the consumer. * URI Format - 'azds://::'. */ dataShareUri: string; /** * Arbitrary description of this Data Share. Max 250 characters. */ description?: string; /** * Represents the provisioning state of the storage datashare. */ provisioningState: string; } /** * Execution context of the storage task assignment. */ interface StorageTaskAssignmentExecutionContextResponse { /** * Execution target of the storage task assignment */ target?: outputs.storage.ExecutionTargetResponse; /** * Execution trigger of the storage task assignment */ trigger: outputs.storage.ExecutionTriggerResponse; } /** * Properties of the storage task assignment. */ interface StorageTaskAssignmentPropertiesResponse { /** * Text that describes the purpose of the storage task assignment */ description: string; /** * Whether the storage task assignment is enabled or not */ enabled: boolean; /** * The storage task assignment execution context */ executionContext: outputs.storage.StorageTaskAssignmentExecutionContextResponse; /** * Represents the provisioning state of the storage task assignment. */ provisioningState: string; /** * The storage task assignment report */ report: outputs.storage.StorageTaskAssignmentReportResponse; /** * Run status of storage task assignment */ runStatus?: outputs.storage.StorageTaskReportPropertiesResponse; /** * Id of the corresponding storage task */ taskId: string; } /** * The storage task assignment report */ interface StorageTaskAssignmentReportResponse { /** * The container prefix for the location of storage task assignment report */ prefix: string; } /** * Storage task execution report for a run instance. */ interface StorageTaskReportPropertiesResponse { /** * End time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators */ finishTime: string; /** * Total number of objects where task operation failed when was attempted. Filter options such as objectFailedCount eq 0 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators */ objectFailedCount: string; /** * Total number of objects that meet the storage tasks condition and were operated upon. Filter options such as objectsOperatedOnCount ge 100 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators */ objectsOperatedOnCount: string; /** * Total number of objects where task operation succeeded when was attempted.Filter options such as objectsSucceededCount gt 150 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators */ objectsSucceededCount: string; /** * Total number of objects that meet the condition as defined in the storage task assignment execution context. Filter options such as objectsTargetedCount gt 50 and other comparison operators can be used as described for Numerical properties in https://learn.microsoft.com/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators */ objectsTargetedCount: string; /** * Represents the overall result of the execution for the run instance */ runResult: string; /** * Represents the status of the execution. */ runStatusEnum: string; /** * Well known Azure Storage error code that represents the error encountered during execution of the run instance. */ runStatusError: string; /** * Start time of the run instance. Filter options such as startTime gt '2023-06-26T20:51:24.4494016Z' and other comparison operators can be used as described for DateTime properties in https://learn.microsoft.com/rest/api/storageservices/querying-tables-and-entities#supported-comparison-operators */ startTime: string; /** * Represents the Storage Account Id where the storage task definition was applied and executed. */ storageAccountId: string; /** * Full path to the verbose report stored in the reporting container as specified in the assignment execution context for the storage account. */ summaryReportPath: string; /** * Represents the Storage Task Assignment Id associated with the storage task that provided an execution context. */ taskAssignmentId: string; /** * Storage Task Arm Id. */ taskId: string; /** * Storage Task Version */ taskVersion: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Table Access Policy Properties Object. */ interface TableAccessPolicyResponse { /** * Expiry time of the access policy */ expiryTime?: string; /** * Required. List of abbreviated permissions. Supported permission values include 'r','a','u','d' */ permission: string; /** * Start time of the access policy */ startTime?: string; } /** * Object to set Table Access Policy. */ interface TableSignedIdentifierResponse { /** * Access policy */ accessPolicy?: outputs.storage.TableAccessPolicyResponse; /** * unique-64-character-value of the stored access policy. */ id: string; } /** * Blob index tag based filtering for blob objects */ interface TagFilterResponse { /** * This is the filter tag name, it can have 1 - 128 characters */ name: string; /** * This is the comparison operator which is used for object comparison and filtering. Only == (equality operator) is currently supported */ op: string; /** * This is the filter tag value field used for tag based filtering, it can have 0 - 256 characters */ value: string; } /** * A tag of the LegalHold of a blob container. */ interface TagPropertyResponse { /** * Returns the Object ID of the user who added the tag. */ objectIdentifier: string; /** * The tag value. */ tag: string; /** * Returns the Tenant ID that issued the token for the user who added the tag. */ tenantId: string; /** * Returns the date and time the tag was added. */ timestamp: string; /** * Returns the User Principal Name of the user who added the tag. */ upn: string; } /** * The trigger parameters update for the storage task assignment execution */ interface TriggerParametersResponse { /** * When to end task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' */ endBy?: string; /** * Run interval of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' */ interval?: number; /** * Run interval unit of task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' */ intervalUnit?: string; /** * When to start task execution. This is a required field when ExecutionTrigger.properties.type is 'OnSchedule'; this property should not be present when ExecutionTrigger.properties.type is 'RunOnce' */ startFrom?: string; /** * When to start task execution. This is a required field when ExecutionTrigger.properties.type is 'RunOnce'; this property should not be present when ExecutionTrigger.properties.type is 'OnSchedule' */ startOn?: string; } /** * An update history of the ImmutabilityPolicy of a blob container. */ interface UpdateHistoryPropertyResponse { /** * This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. */ allowProtectedAppendWrites?: boolean; /** * This property can only be changed for unlocked time-based retention policies. When enabled, new blocks can be written to both 'Append and Bock Blobs' while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted. This property cannot be changed with ExtendImmutabilityPolicy API. The 'allowProtectedAppendWrites' and 'allowProtectedAppendWritesAll' properties are mutually exclusive. */ allowProtectedAppendWritesAll?: boolean; /** * The immutability period for the blobs in the container since the policy creation, in days. */ immutabilityPeriodSinceCreationInDays: number; /** * Returns the Object ID of the user who updated the ImmutabilityPolicy. */ objectIdentifier: string; /** * Returns the Tenant ID that issued the token for the user who updated the ImmutabilityPolicy. */ tenantId: string; /** * Returns the date and time the ImmutabilityPolicy was updated. */ timestamp: string; /** * The ImmutabilityPolicy update type of a blob container, possible values include: put, lock and extend. */ update: string; /** * Returns the User Principal Name of the user who updated the ImmutabilityPolicy. */ upn: string; } /** * UserAssignedIdentity for the resource. */ interface UserAssignedIdentityResponse { /** * The client ID of the identity. */ clientId: string; /** * The principal ID of the identity. */ principalId: string; } /** * Virtual Network rule. */ interface VirtualNetworkRuleResponse { /** * The action of virtual network rule. */ action?: string; /** * Gets the state of virtual network rule. */ state?: string; /** * Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}. */ virtualNetworkResourceId: string; } /** * virtualNetworkRuleResponseProvideDefaults sets the appropriate defaults for VirtualNetworkRuleResponse */ function virtualNetworkRuleResponseProvideDefaults(val: VirtualNetworkRuleResponse): VirtualNetworkRuleResponse; } export declare namespace storageactions { /** * The else block of storage task operation */ interface ElseConditionResponse { /** * List of operations to execute in the else block */ operations: outputs.storageactions.StorageTaskOperationResponse[]; } /** * The if block of storage task operation */ interface IfConditionResponse { /** * Condition predicate to evaluate each object. See https://aka.ms/storagetaskconditions for valid properties and operators. */ condition: string; /** * List of operations to execute when the condition predicate satisfies. */ operations: outputs.storageactions.StorageTaskOperationResponse[]; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.storageactions.UserAssignedIdentityResponse; }; } /** * The storage task action represents conditional statements and operations to be performed on target objects. */ interface StorageTaskActionResponse { /** * The else block of storage task operation */ else?: outputs.storageactions.ElseConditionResponse; /** * The if block of storage task operation */ if: outputs.storageactions.IfConditionResponse; } /** * Represents an operation to be performed on the object */ interface StorageTaskOperationResponse { /** * The operation to be performed on the object. */ name: string; /** * Action to be taken when the operation fails for a object. */ onFailure?: string; /** * Action to be taken when the operation is successful for a object. */ onSuccess?: string; /** * Key-value parameters for the operation. */ parameters?: { [key: string]: string; }; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace storagecache { /** * Information about the AML file system archive */ interface AmlFilesystemArchiveResponse { /** * Lustre file system path to archive relative to the file system root. Specify '/' to archive all modified data. */ filesystemPath: string; /** * The status of the archive */ status: outputs.storagecache.AmlFilesystemArchiveResponseStatus; } /** * The status of the archive */ interface AmlFilesystemArchiveResponseStatus { /** * Server-defined error code for the archive operation */ errorCode: string; /** * Server-defined error message for the archive operation */ errorMessage: string; /** * The time of the last completed archive operation */ lastCompletionTime: string; /** * The time the latest archive operation started */ lastStartedTime: string; /** * The completion percentage of the archive operation */ percentComplete: number; /** * The state of the archive operation */ state: string; } /** * AML file system client information */ interface AmlFilesystemClientInfoResponse { /** * Container Storage Interface information for the AML file system. */ containerStorageInterface: outputs.storagecache.AmlFilesystemContainerStorageInterfaceResponse; /** * The version of Lustre running in the AML file system */ lustreVersion: string; /** * The IPv4 address used by clients to mount the AML file system's Lustre Management Service (MGS). */ mgsAddress: string; /** * Recommended command to mount the AML file system */ mountCommand: string; } /** * AML file system container storage interface information */ interface AmlFilesystemContainerStorageInterfaceResponse { /** * Recommended AKS Persistent Volume for the CSI driver, in Base64 encoded YAML */ persistentVolume: string; /** * Recommended AKS Persistent Volume Claim for the CSI driver, in Base64 encoded YAML */ persistentVolumeClaim: string; /** * Recommended AKS Storage Class for the CSI driver, in Base64 encoded YAML */ storageClass: string; } /** * AML file system encryption settings. */ interface AmlFilesystemEncryptionSettingsResponse { /** * Specifies the location of the encryption key in Key Vault. */ keyEncryptionKey?: outputs.storagecache.KeyVaultKeyReferenceResponse; } /** * An indication of AML file system health. Gives more information about health than just that related to provisioning. */ interface AmlFilesystemHealthResponse { /** * List of AML file system health states. */ state?: string; /** * Server-defined error code for the AML file system health */ statusCode?: string; /** * Describes the health state. */ statusDescription?: string; } /** * AML file system HSM settings. */ interface AmlFilesystemHsmSettingsResponse { /** * Resource ID of storage container used for hydrating the namespace and archiving from the namespace. The resource provider must have permission to create SAS tokens on the storage account. */ container: string; /** * Only blobs in the non-logging container that start with this path/prefix get imported into the cluster namespace. This is only used during initial creation of the AML file system. It automatically creates an import job resource that can be deleted. */ importPrefix?: string; /** * Only blobs in the non-logging container that start with one of the paths/prefixes in this array get imported into the cluster namespace. This is only used during initial creation of the AML file system and has '/' as the default value. It automatically creates an import job resource that can be deleted. */ importPrefixesInitial?: string[]; /** * Resource ID of storage container used for logging events and errors. Must be a separate container in the same storage account as the hydration and archive container. The resource provider must have permission to create SAS tokens on the storage account. */ loggingContainer: string; } /** * amlFilesystemHsmSettingsResponseProvideDefaults sets the appropriate defaults for AmlFilesystemHsmSettingsResponse */ function amlFilesystemHsmSettingsResponseProvideDefaults(val: AmlFilesystemHsmSettingsResponse): AmlFilesystemHsmSettingsResponse; /** * Managed Identity properties. */ interface AmlFilesystemIdentityResponse { /** * The principal ID for the user-assigned identity of the resource. */ principalId: string; /** * The tenant ID associated with the resource. */ tenantId: string; /** * The type of identity used for the resource. */ type?: string; /** * A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary. */ userAssignedIdentities?: { [key: string]: outputs.storagecache.UserAssignedIdentitiesResponseUserAssignedIdentities; }; } /** * Hydration and archive settings and status */ interface AmlFilesystemResponseHsm { /** * Archive status */ archiveStatus: outputs.storagecache.AmlFilesystemArchiveResponse[]; /** * Specifies HSM settings of the AML file system. */ settings?: outputs.storagecache.AmlFilesystemHsmSettingsResponse; } /** * amlFilesystemResponseHsmProvideDefaults sets the appropriate defaults for AmlFilesystemResponseHsm */ function amlFilesystemResponseHsmProvideDefaults(val: AmlFilesystemResponseHsm): AmlFilesystemResponseHsm; /** * Start time of a 30-minute weekly maintenance window. */ interface AmlFilesystemResponseMaintenanceWindow { /** * Day of the week on which the maintenance window will occur. */ dayOfWeek?: string; /** * The time of day (in UTC) to start the maintenance window. */ timeOfDayUTC?: string; } /** * AML file system squash settings. */ interface AmlFilesystemRootSquashSettingsResponse { /** * Squash mode of the AML file system. 'All': User and Group IDs on files will be squashed to the provided values for all users on non-trusted systems. 'RootOnly': User and Group IDs on files will be squashed to provided values for solely the root user on non-trusted systems. 'None': No squashing of User and Group IDs is performed for any users on any systems. */ mode?: string; /** * Semicolon separated NID IP Address list(s) to be added to the TrustedSystems. */ noSquashNidLists?: string; /** * Group ID to squash to. */ squashGID?: number; /** * User ID to squash to. */ squashUID?: number; /** * AML file system squash status. */ status: string; } /** * The storage account blob change feed status of the auto import job. */ interface AutoImportJobResponseBlobSyncEvents { /** * Number of deletions during auto import. */ deletions: number; /** * Number of directories imported during auto import. */ importedDirectories: number; /** * Number of files imported during auto import. */ importedFiles: number; /** * Number of symlinks imported during auto import. */ importedSymlinks: number; /** * Date and time of the last Change Feed event consumed. */ lastChangeFeedEventConsumedTime: string; /** * Date and time when last fully synchronized. */ lastTimeFullySynchronized: string; /** * Number of preexisting directories during auto import. */ preexistingDirectories: number; /** * Number of preexisting files during auto import. */ preexistingFiles: number; /** * Number of preexisting symlinks during auto import. */ preexistingSymlinks: number; /** * Rate of blob import per second during auto import. */ rateOfBlobImport: number; /** * Total number of blobs imported during auto import. */ totalBlobsImported: number; /** * Total conflicts encountered during auto import. */ totalConflicts: number; /** * Total errors encountered during auto import. */ totalErrors: number; } /** * Properties pertaining to the BlobNfsTarget. */ interface BlobNfsTargetResponse { /** * Resource ID of the storage container. */ target?: string; /** * Identifies the StorageCache usage model to be used for this storage target. */ usageModel?: string; /** * Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. */ verificationTimer?: number; /** * Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. */ writeBackTimer?: number; } /** * Active Directory settings used to join a cache to a domain. */ interface CacheActiveDirectorySettingsResponse { /** * The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z]. */ cacheNetBiosName: string; /** * Active Directory admin credentials used to join the HPC Cache to a domain. */ credentials?: outputs.storagecache.CacheActiveDirectorySettingsResponseCredentials; /** * True if the HPC Cache is joined to the Active Directory domain. */ domainJoined: string; /** * The fully qualified domain name of the Active Directory domain controller. */ domainName: string; /** * The Active Directory domain's NetBIOS name. */ domainNetBiosName: string; /** * Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. */ primaryDnsIpAddress: string; /** * Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name. */ secondaryDnsIpAddress?: string; } /** * Active Directory admin credentials used to join the HPC Cache to a domain. */ interface CacheActiveDirectorySettingsResponseCredentials { /** * Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response. */ password?: string; /** * Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response. */ username: string; } /** * Cache Directory Services settings. */ interface CacheDirectorySettingsResponse { /** * Specifies settings for joining the HPC Cache to an Active Directory domain. */ activeDirectory?: outputs.storagecache.CacheActiveDirectorySettingsResponse; /** * Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups. */ usernameDownload?: outputs.storagecache.CacheUsernameDownloadSettingsResponse; } /** * cacheDirectorySettingsResponseProvideDefaults sets the appropriate defaults for CacheDirectorySettingsResponse */ function cacheDirectorySettingsResponseProvideDefaults(val: CacheDirectorySettingsResponse): CacheDirectorySettingsResponse; /** * Cache encryption settings. */ interface CacheEncryptionSettingsResponse { /** * Specifies the location of the key encryption key in key vault. */ keyEncryptionKey?: outputs.storagecache.KeyVaultKeyReferenceResponse; /** * Specifies whether the service will automatically rotate to the newest version of the key in the key vault. */ rotationToLatestKeyVersionEnabled?: boolean; } /** * An indication of cache health. Gives more information about health than just that related to provisioning. */ interface CacheHealthResponse { /** * Outstanding conditions that need to be investigated and resolved. */ conditions: outputs.storagecache.ConditionResponse[]; /** * List of cache health states. Down is when the cluster is not responding. Degraded is when its functioning but has some alerts. Transitioning when it is creating or deleting. Unknown will be returned in old api versions when a new value is added in future versions. WaitingForKey is when the create is waiting for the system assigned identity to be given access to the encryption key in the encryption settings. */ state?: string; /** * Describes explanation of state. */ statusDescription?: string; } /** * Cache identity properties. */ interface CacheIdentityResponse { /** * The principal ID for the system-assigned identity of the cache. */ principalId: string; /** * The tenant ID associated with the cache. */ tenantId: string; /** * The type of identity used for the cache */ type?: string; /** * A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary. */ userAssignedIdentities?: { [key: string]: outputs.storagecache.CacheIdentityResponseUserAssignedIdentities; }; } interface CacheIdentityResponseUserAssignedIdentities { /** * The client ID of the user-assigned identity. */ clientId: string; /** * The principal ID of the user-assigned identity. */ principalId: string; } /** * Cache network settings. */ interface CacheNetworkSettingsResponse { /** * DNS search domain */ dnsSearchDomain?: string; /** * DNS servers for the cache to use. It will be set from the network configuration if no value is provided. */ dnsServers?: string[]; /** * The IPv4 maximum transmission unit configured for the subnet. */ mtu?: number; /** * NTP server IP Address or FQDN for the cache to use. The default is time.windows.com. */ ntpServer?: string; /** * Array of additional IP addresses used by this cache. */ utilityAddresses: string[]; } /** * cacheNetworkSettingsResponseProvideDefaults sets the appropriate defaults for CacheNetworkSettingsResponse */ function cacheNetworkSettingsResponseProvideDefaults(val: CacheNetworkSettingsResponse): CacheNetworkSettingsResponse; /** * SKU for the cache. */ interface CacheResponseSku { /** * SKU name for this cache. */ name?: string; } /** * Cache security settings. */ interface CacheSecuritySettingsResponse { /** * NFS access policies defined for this cache. */ accessPolicies?: outputs.storagecache.NfsAccessPolicyResponse[]; } /** * Cache Upgrade Settings. */ interface CacheUpgradeSettingsResponse { /** * When upgradeScheduleEnabled is true, this field holds the user-chosen upgrade time. At the user-chosen time, the firmware update will automatically be installed on the cache. */ scheduledTime?: string; /** * True if the user chooses to select an installation time between now and firmwareUpdateDeadline. Else the firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. */ upgradeScheduleEnabled?: boolean; } /** * Properties describing the software upgrade state of the cache. */ interface CacheUpgradeStatusResponse { /** * Version string of the firmware currently installed on this cache. */ currentFirmwareVersion: string; /** * Time at which the pending firmware update will automatically be installed on the cache. */ firmwareUpdateDeadline: string; /** * True if there is a firmware update ready to install on this cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation. */ firmwareUpdateStatus: string; /** * Time of the last successful firmware update. */ lastFirmwareUpdate: string; /** * When firmwareUpdateAvailable is true, this field holds the version string for the update. */ pendingFirmwareVersion: string; } /** * Settings for Extended Groups username and group download. */ interface CacheUsernameDownloadSettingsResponse { /** * Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true. */ autoDownloadCertificate?: boolean; /** * The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true. */ caCertificateURI?: string; /** * When present, these are the credentials for the secure LDAP connection. */ credentials?: outputs.storagecache.CacheUsernameDownloadSettingsResponseCredentials; /** * Whether or not the LDAP connection should be encrypted. */ encryptLdapConnection?: boolean; /** * Whether or not Extended Groups is enabled. */ extendedGroups?: boolean; /** * The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'. */ groupFileURI?: string; /** * The base distinguished name for the LDAP domain. */ ldapBaseDN?: string; /** * The fully qualified domain name or IP address of the LDAP server to use. */ ldapServer?: string; /** * Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided. */ requireValidCertificate?: boolean; /** * The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'. */ userFileURI?: string; /** * Indicates whether or not the HPC Cache has performed the username download successfully. */ usernameDownloaded: string; /** * This setting determines how the cache gets username and group names for clients. */ usernameSource?: string; } /** * cacheUsernameDownloadSettingsResponseProvideDefaults sets the appropriate defaults for CacheUsernameDownloadSettingsResponse */ function cacheUsernameDownloadSettingsResponseProvideDefaults(val: CacheUsernameDownloadSettingsResponse): CacheUsernameDownloadSettingsResponse; /** * When present, these are the credentials for the secure LDAP connection. */ interface CacheUsernameDownloadSettingsResponseCredentials { /** * The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. */ bindDn?: string; /** * The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response. */ bindPassword?: string; } /** * Properties pertaining to the ClfsTarget */ interface ClfsTargetResponse { /** * Resource ID of storage container. */ target?: string; } /** * Outstanding conditions that will need to be resolved. */ interface ConditionResponse { /** * The issue requiring attention. */ message: string; /** * The time when the condition was raised. */ timestamp: string; } /** * Describes a reference to key vault key. */ interface KeyVaultKeyReferenceResponse { /** * The URL referencing a key encryption key in key vault. */ keyUrl: string; /** * Describes a resource Id to source key vault. */ sourceVault: outputs.storagecache.KeyVaultKeyReferenceResponseSourceVault; } /** * Describes a resource Id to source key vault. */ interface KeyVaultKeyReferenceResponseSourceVault { /** * Resource Id. */ id?: string; } /** * A namespace junction. */ interface NamespaceJunctionResponse { /** * Namespace path on a cache for a Storage Target. */ namespacePath?: string; /** * Name of the access policy applied to this junction. */ nfsAccessPolicy?: string; /** * NFS export where targetPath exists. */ nfsExport?: string; /** * Path in Storage Target to which namespacePath points. */ targetPath?: string; } /** * namespaceJunctionResponseProvideDefaults sets the appropriate defaults for NamespaceJunctionResponse */ function namespaceJunctionResponseProvideDefaults(val: NamespaceJunctionResponse): NamespaceJunctionResponse; /** * Properties pertaining to the Nfs3Target */ interface Nfs3TargetResponse { /** * IP address or host name of an NFSv3 host (e.g., 10.0.44.44). */ target?: string; /** * Identifies the StorageCache usage model to be used for this storage target. */ usageModel?: string; /** * Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates. */ verificationTimer?: number; /** * Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage. */ writeBackTimer?: number; } /** * A set of rules describing access policies applied to NFSv3 clients of the cache. */ interface NfsAccessPolicyResponse { /** * The set of rules describing client accesses allowed under this policy. */ accessRules: outputs.storagecache.NfsAccessRuleResponse[]; /** * Name identifying this policy. Access Policy names are not case sensitive. */ name: string; } /** * Rule to place restrictions on portions of the cache namespace being presented to clients. */ interface NfsAccessRuleResponse { /** * Access allowed by this rule. */ access: string; /** * GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided. */ anonymousGID?: string; /** * UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided. */ anonymousUID?: string; /** * Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied. */ filter?: string; /** * Map root accesses to anonymousUID and anonymousGID. */ rootSquash?: boolean; /** * Scope for this rule. The scope and filter determine which clients match the rule. */ scope: string; /** * For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'. */ submountAccess?: boolean; /** * Allow SUID semantics. */ suid?: boolean; } /** * A priming job instance. */ interface PrimingJobResponse { /** * The job details or error information if any. */ primingJobDetails: string; /** * The unique identifier of the priming job. */ primingJobId: string; /** * The priming job name. */ primingJobName: string; /** * The current progress of the priming job, as a percentage. */ primingJobPercentComplete: number; /** * The state of the priming operation. */ primingJobState: string; /** * The status code of the priming job. */ primingJobStatus: string; } /** * SKU for the resource. */ interface SkuNameResponse { /** * SKU name for this resource. */ name?: string; } /** * Storage Target space allocation properties. */ interface StorageTargetSpaceAllocationResponse { /** * The percentage of cache space allocated for this storage target */ allocationPercentage?: number; /** * Name of the storage target. */ name?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Properties pertaining to the UnknownTarget */ interface UnknownTargetResponse { /** * Dictionary of string->string pairs containing information about the Storage Target. */ attributes?: { [key: string]: string; }; } interface UserAssignedIdentitiesResponseUserAssignedIdentities { /** * The client ID of the user-assigned identity. */ clientId: string; /** * The principal ID of the user-assigned identity. */ principalId: string; } } export declare namespace storagediscovery { /** * Storage Discovery Scope. This had added validations */ interface StorageDiscoveryScopeResponse { /** * Display name of the collection */ displayName: string; /** * Resource types for the collection */ resourceTypes: string[]; /** * The storage account tags keys to filter */ tagKeysOnly?: string[]; /** * Resource tags. */ tags?: { [key: string]: string; }; } /** * Storage Discovery Workspace Properties */ interface StorageDiscoveryWorkspacePropertiesResponse { /** * The description of the storage discovery workspace */ description?: string; /** * The status of the last operation. */ provisioningState: string; /** * The scopes of the storage discovery workspace. */ scopes: outputs.storagediscovery.StorageDiscoveryScopeResponse[]; /** * The storage discovery sku */ sku?: string; /** * The view level storage discovery data estate */ workspaceRoots: string[]; } /** * storageDiscoveryWorkspacePropertiesResponseProvideDefaults sets the appropriate defaults for StorageDiscoveryWorkspacePropertiesResponse */ function storageDiscoveryWorkspacePropertiesResponseProvideDefaults(val: StorageDiscoveryWorkspacePropertiesResponse): StorageDiscoveryWorkspacePropertiesResponse; /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace storagemover { interface AgentPropertiesErrorDetailsResponse { /** * Error code reported by Agent */ code?: string; /** * Expanded description of reported error code */ message?: string; } /** * The Azure Key Vault secret URIs which store the credentials. */ interface AzureKeyVaultSmbCredentialsResponse { /** * The Azure Key Vault secret URI which stores the password. Use empty string to clean-up existing value. */ passwordUri?: string; /** * The Credentials type. * Expected value is 'AzureKeyVaultSmb'. */ type: "AzureKeyVaultSmb"; /** * The Azure Key Vault secret URI which stores the username. Use empty string to clean-up existing value. */ usernameUri?: string; } /** * The properties of Azure Storage blob container endpoint. */ interface AzureStorageBlobContainerEndpointPropertiesResponse { /** * The name of the Storage blob container that is the target destination. */ blobContainerName: string; /** * A description for the Endpoint. */ description?: string; /** * The Endpoint resource type. * Expected value is 'AzureStorageBlobContainer'. */ endpointType: "AzureStorageBlobContainer"; /** * The provisioning state of this resource. */ provisioningState: string; /** * The Azure Resource ID of the storage account that is the target destination. */ storageAccountResourceId: string; } /** * The properties of Azure Storage SMB file share endpoint. */ interface AzureStorageSmbFileShareEndpointPropertiesResponse { /** * A description for the Endpoint. */ description?: string; /** * The Endpoint resource type. * Expected value is 'AzureStorageSmbFileShare'. */ endpointType: "AzureStorageSmbFileShare"; /** * The name of the Azure Storage file share. */ fileShareName: string; /** * The provisioning state of this resource. */ provisioningState: string; /** * The Azure Resource ID of the storage account. */ storageAccountResourceId: string; } /** * Properties of the Connection resource. */ interface ConnectionPropertiesResponse { /** * The connection status. */ connectionStatus: string; /** * A description for the Connection. */ description?: string; /** * List of job definitions associated with this connection. */ jobList?: string[]; /** * The PrivateEndpointName associated with the connection. */ privateEndpointName: string; /** * The privateEndpoint resource Id */ privateEndpointResourceId: string; /** * The PrivateLinkServiceId for the connection. */ privateLinkServiceId: string; /** * The provisioning state of this resource. */ provisioningState: string; } /** * The properties of NFS share endpoint. */ interface NfsMountEndpointPropertiesResponse { /** * A description for the Endpoint. */ description?: string; /** * The Endpoint resource type. * Expected value is 'NfsMount'. */ endpointType: "NfsMount"; /** * The directory being exported from the server. */ export: string; /** * The host name or IP address of the server exporting the file system. */ host: string; /** * The NFS protocol version. */ nfsVersion?: string; /** * The provisioning state of this resource. */ provisioningState: string; } /** * The properties of SMB share endpoint. */ interface SmbMountEndpointPropertiesResponse { /** * The Azure Key Vault secret URIs which store the required credentials to access the SMB share. */ credentials?: outputs.storagemover.AzureKeyVaultSmbCredentialsResponse; /** * A description for the Endpoint. */ description?: string; /** * The Endpoint resource type. * Expected value is 'SmbMount'. */ endpointType: "SmbMount"; /** * The host name or IP address of the server exporting the file system. */ host: string; /** * The provisioning state of this resource. */ provisioningState: string; /** * The name of the SMB share being exported from the server. */ shareName: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The time of day. */ interface TimeResponse { /** * The hour element of the time. Allowed values range from 0 (start of the selected day) to 24 (end of the selected day). Hour value 24 cannot be combined with any other minute value but 0. */ hour: number; /** * The minute element of the time. Allowed values are 0 and 30. If not specified, its value defaults to 0. */ minute?: number; } /** * timeResponseProvideDefaults sets the appropriate defaults for TimeResponse */ function timeResponseProvideDefaults(val: TimeResponse): TimeResponse; /** * The WAN-link upload limit schedule. Overlapping recurrences are not allowed. */ interface UploadLimitScheduleResponse { /** * The set of weekly repeating recurrences of the WAN-link upload limit schedule. */ weeklyRecurrences?: outputs.storagemover.UploadLimitWeeklyRecurrenceResponse[]; } /** * The weekly recurrence of the WAN-link upload limit schedule. The start time must be earlier in the day than the end time. The recurrence must not span across multiple days. */ interface UploadLimitWeeklyRecurrenceResponse { /** * The set of days of week for the schedule recurrence. A day must not be specified more than once in a recurrence. */ days: string[]; /** * The end time of the schedule recurrence. Full hour and 30-minute intervals are supported. */ endTime: outputs.storagemover.TimeResponse; /** * The WAN-link upload bandwidth (maximum data transfer rate) in megabits per second. Value of 0 indicates no throughput is allowed and any running migration job is effectively paused for the duration of this recurrence. Only data plane operations are governed by this limit. Control plane operations ensure seamless functionality. The agent may exceed this limit with control messages, if necessary. */ limitInMbps: number; /** * The start time of the schedule recurrence. Full hour and 30-minute intervals are supported. */ startTime: outputs.storagemover.TimeResponse; } /** * uploadLimitWeeklyRecurrenceResponseProvideDefaults sets the appropriate defaults for UploadLimitWeeklyRecurrenceResponse */ function uploadLimitWeeklyRecurrenceResponseProvideDefaults(val: UploadLimitWeeklyRecurrenceResponse): UploadLimitWeeklyRecurrenceResponse; } export declare namespace storagepool { /** * Access Control List (ACL) for an iSCSI Target; defines LUN masking policy */ interface AclResponse { /** * iSCSI initiator IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:client". */ initiatorIqn: string; /** * List of LUN names mapped to the ACL. */ mappedLuns: string[]; } /** * Azure Managed Disk to attach to the Disk Pool. */ interface DiskResponse { /** * Unique Azure Resource ID of the Managed Disk. */ id: string; } /** * LUN to expose the Azure Managed Disk. */ interface IscsiLunResponse { /** * Specifies the Logical Unit Number of the iSCSI LUN. */ lun: number; /** * Azure Resource ID of the Managed Disk. */ managedDiskAzureResourceId: string; /** * User defined name for iSCSI LUN; example: "lun0" */ name: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemMetadataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The type of identity that last modified the resource. */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace storagesync { /** * Cloud endpoint change enumeration activity object */ interface CloudEndpointChangeEnumerationActivityResponse { /** * Progress percentage for processing deletes. This is done separately from the rest of the enumeration run */ deletesProgressPercent: number; /** * Last updated timestamp */ lastUpdatedTimestamp: string; /** * Estimate of time remaining for the enumeration run */ minutesRemaining: number; /** * Change enumeration operation state */ operationState: string; /** * Count of directories processed */ processedDirectoriesCount: number; /** * Count of files processed */ processedFilesCount: number; /** * Progress percentage for change enumeration run, excluding processing of deletes */ progressPercent: number; /** * Timestamp when change enumeration started */ startedTimestamp: string; /** * When non-zero, indicates an issue that is delaying change enumeration */ statusCode: number; /** * Change enumeration total counts state */ totalCountsState: string; /** * Total count of directories enumerated */ totalDirectoriesCount: number; /** * Total count of files enumerated */ totalFilesCount: number; /** * Total enumerated size in bytes */ totalSizeBytes: number; } /** * Cloud endpoint change enumeration status object */ interface CloudEndpointChangeEnumerationStatusResponse { /** * Change enumeration activity */ activity: outputs.storagesync.CloudEndpointChangeEnumerationActivityResponse; /** * Status of last completed change enumeration */ lastEnumerationStatus: outputs.storagesync.CloudEndpointLastChangeEnumerationStatusResponse; /** * Last updated timestamp */ lastUpdatedTimestamp: string; } /** * Cloud endpoint change enumeration status object */ interface CloudEndpointLastChangeEnumerationStatusResponse { /** * Timestamp when change enumeration completed */ completedTimestamp: string; /** * Count of directories in the namespace */ namespaceDirectoriesCount: number; /** * Count of files in the namespace */ namespaceFilesCount: number; /** * Namespace size in bytes */ namespaceSizeBytes: number; /** * Timestamp of when change enumeration is expected to run again */ nextRunTimestamp: string; /** * Timestamp when change enumeration started */ startedTimestamp: string; } /** * Server endpoint cloud tiering status object. */ interface CloudTieringCachePerformanceResponse { /** * Count of bytes that were served from the local server */ cacheHitBytes: number; /** * Percentage of total bytes (hit + miss) that were served from the local server */ cacheHitBytesPercent: number; /** * Count of bytes that were served from the cloud */ cacheMissBytes: number; /** * Last updated timestamp */ lastUpdatedTimestamp: string; } /** * Status of the date policy */ interface CloudTieringDatePolicyStatusResponse { /** * Last updated timestamp */ lastUpdatedTimestamp: string; /** * Most recent access time of tiered files */ tieredFilesMostRecentAccessTimestamp: string; } /** * Server endpoint cloud tiering status object. */ interface CloudTieringFilesNotTieringResponse { /** * Array of tiering errors */ errors: outputs.storagesync.FilesNotTieringErrorResponse[]; /** * Last updated timestamp */ lastUpdatedTimestamp: string; /** * Last cloud tiering result (HResult) */ totalFileCount: number; } /** * Information regarding the low disk mode state */ interface CloudTieringLowDiskModeResponse { /** * Last updated timestamp */ lastUpdatedTimestamp: string; /** * Low disk mode state */ state: string; } /** * Server endpoint cloud tiering status object. */ interface CloudTieringSpaceSavingsResponse { /** * Cached content size on the server */ cachedSizeBytes: number; /** * Last updated timestamp */ lastUpdatedTimestamp: string; /** * Count of bytes saved on the server */ spaceSavingsBytes: number; /** * Percentage of cached size over total size */ spaceSavingsPercent: number; /** * Total size of content in the azure file share */ totalSizeCloudBytes: number; /** * Volume size */ volumeSizeBytes: number; } /** * Status of the volume free space policy */ interface CloudTieringVolumeFreeSpacePolicyStatusResponse { /** * Current volume free space percentage. */ currentVolumeFreeSpacePercent: number; /** * In the case where multiple server endpoints are present in a volume, an effective free space policy is applied. */ effectiveVolumeFreeSpacePolicy: number; /** * Last updated timestamp */ lastUpdatedTimestamp: string; } /** * Files not tiering error object */ interface FilesNotTieringErrorResponse { /** * Error code (HResult) */ errorCode: number; /** * Count of files with this error */ fileCount: number; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.storagesync.UserAssignedIdentityResponse; }; } /** * The private endpoint connection resource. */ interface PrivateEndpointConnectionResponse { /** * The group ids for the private endpoint resource. */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint resource. */ privateEndpoint?: outputs.storagesync.PrivateEndpointResponse; /** * A collection of information about the state of the connection between service consumer and provider. */ privateLinkServiceConnectionState: outputs.storagesync.PrivateLinkServiceConnectionStateResponse; /** * The provisioning state of the private endpoint connection resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.storagesync.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Background data download activity object */ interface ServerEndpointBackgroundDataDownloadActivityResponse { /** * Running count of bytes downloaded */ downloadedBytes: number; /** * Progress percentage */ percentProgress: number; /** * Timestamp when the operation started */ startedTimestamp: string; /** * Timestamp when properties were updated */ timestamp: string; } /** * Server endpoint cloud tiering status object. */ interface ServerEndpointCloudTieringStatusResponse { /** * Information regarding how well the local cache on the server is performing. */ cachePerformance: outputs.storagesync.CloudTieringCachePerformanceResponse; /** * Status of the date policy */ datePolicyStatus: outputs.storagesync.CloudTieringDatePolicyStatusResponse; /** * Information regarding files that failed to be tiered */ filesNotTiering: outputs.storagesync.CloudTieringFilesNotTieringResponse; /** * Cloud tiering health state. */ health: string; /** * The last updated timestamp of health state */ healthLastUpdatedTimestamp: string; /** * Last cloud tiering result (HResult) */ lastCloudTieringResult: number; /** * Last cloud tiering success timestamp */ lastSuccessTimestamp: string; /** * Last updated timestamp */ lastUpdatedTimestamp: string; /** * Information regarding the low disk mode state */ lowDiskMode: outputs.storagesync.CloudTieringLowDiskModeResponse; /** * Information regarding how much local space cloud tiering is saving. */ spaceSavings: outputs.storagesync.CloudTieringSpaceSavingsResponse; /** * Status of the volume free space policy */ volumeFreeSpacePolicyStatus: outputs.storagesync.CloudTieringVolumeFreeSpacePolicyStatusResponse; } /** * Files not syncing error object */ interface ServerEndpointFilesNotSyncingErrorResponse { /** * Error code (HResult) */ errorCode: number; /** * Count of persistent files not syncing with the specified error code */ persistentCount: number; /** * Count of transient files not syncing with the specified error code */ transientCount: number; } /** * Server endpoint provisioning status information */ interface ServerEndpointProvisioningStatusResponse { /** * Server Endpoint provisioning status */ provisioningStatus: string; /** * Provisioning Step status information for each step in the provisioning process */ provisioningStepStatuses: outputs.storagesync.ServerEndpointProvisioningStepStatusResponse[]; /** * Server Endpoint provisioning type */ provisioningType: string; } /** * Server endpoint provisioning step status object. */ interface ServerEndpointProvisioningStepStatusResponse { /** * Additional information for the provisioning step */ additionalInformation: { [key: string]: string; }; /** * End time of the provisioning step */ endTime: string; /** * Error code (HResult) for the provisioning step */ errorCode: number; /** * Estimated completion time of the provisioning step in minutes */ minutesLeft: number; /** * Name of the provisioning step */ name: string; /** * Estimated progress percentage */ progressPercentage: number; /** * Start time of the provisioning step */ startTime: string; /** * Status of the provisioning step */ status: string; } /** * Server endpoint recall error object */ interface ServerEndpointRecallErrorResponse { /** * Count of occurences of the error */ count: number; /** * Error code (HResult) */ errorCode: number; } /** * Server endpoint recall status object. */ interface ServerEndpointRecallStatusResponse { /** * Last updated timestamp */ lastUpdatedTimestamp: string; /** * Array of recall errors */ recallErrors: outputs.storagesync.ServerEndpointRecallErrorResponse[]; /** * Total count of recall errors. */ totalRecallErrorsCount: number; } /** * Sync Session status object. */ interface ServerEndpointSyncActivityStatusResponse { /** * Applied bytes */ appliedBytes: number; /** * Applied item count. */ appliedItemCount: number; /** * Per item error count */ perItemErrorCount: number; /** * Session minutes remaining (if available) */ sessionMinutesRemaining: number; /** * Sync mode */ syncMode: string; /** * Timestamp when properties were updated */ timestamp: string; /** * Total bytes (if available) */ totalBytes: number; /** * Total item count (if available) */ totalItemCount: number; } /** * Sync Session status object. */ interface ServerEndpointSyncSessionStatusResponse { /** * Array of per-item errors coming from the last sync session. */ filesNotSyncingErrors: outputs.storagesync.ServerEndpointFilesNotSyncingErrorResponse[]; /** * Sync mode */ lastSyncMode: string; /** * Last sync per item error count. */ lastSyncPerItemErrorCount: number; /** * Last sync result (HResult) */ lastSyncResult: number; /** * Last sync success timestamp */ lastSyncSuccessTimestamp: string; /** * Last sync timestamp */ lastSyncTimestamp: string; /** * Count of persistent files not syncing. */ persistentFilesNotSyncingCount: number; /** * Count of transient files not syncing. */ transientFilesNotSyncingCount: number; } /** * Server Endpoint sync status */ interface ServerEndpointSyncStatusResponse { /** * Background data download activity */ backgroundDataDownloadActivity: outputs.storagesync.ServerEndpointBackgroundDataDownloadActivityResponse; /** * Combined Health Status. */ combinedHealth: string; /** * Download sync activity */ downloadActivity: outputs.storagesync.ServerEndpointSyncActivityStatusResponse; /** * Download Health Status. */ downloadHealth: string; /** * Download Status */ downloadStatus: outputs.storagesync.ServerEndpointSyncSessionStatusResponse; /** * Last Updated Timestamp */ lastUpdatedTimestamp: string; /** * Offline Data Transfer State */ offlineDataTransferStatus: string; /** * Sync activity */ syncActivity: string; /** * Total count of persistent files not syncing (combined upload + download). */ totalPersistentFilesNotSyncingCount: number; /** * Upload sync activity */ uploadActivity: outputs.storagesync.ServerEndpointSyncActivityStatusResponse; /** * Upload Health Status. */ uploadHealth: string; /** * Upload Status */ uploadStatus: outputs.storagesync.ServerEndpointSyncSessionStatusResponse; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace streamanalytics { /** * The properties that are associated with an aggregate function. */ interface AggregateFunctionPropertiesResponse { /** * The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint. */ binding?: outputs.streamanalytics.AzureMachineLearningWebServiceFunctionBindingResponse | outputs.streamanalytics.JavaScriptFunctionBindingResponse; /** * The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. */ etag: string; inputs?: outputs.streamanalytics.FunctionInputResponse[]; /** * Describes the output of a function. */ output?: outputs.streamanalytics.FunctionOutputResponse; /** * Indicates the type of function. * Expected value is 'Aggregate'. */ type: "Aggregate"; } /** * Describes how data from an input is serialized or how data is serialized when written to an output in Avro format. */ interface AvroSerializationResponse { /** * Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. * Expected value is 'Avro'. */ type: "Avro"; } /** * Describes an Azure Data Lake Store output data source. */ interface AzureDataLakeStoreOutputDataSourceResponse { /** * The name of the Azure Data Lake Store account. Required on PUT (CreateOrReplace) requests. */ accountName?: string; /** * Authentication Mode. */ authenticationMode?: string; /** * The date format. Wherever {date} appears in filePathPrefix, the value of this property is used as the date format instead. */ dateFormat?: string; /** * The location of the file to which the output should be written to. Required on PUT (CreateOrReplace) requests. */ filePathPrefix?: string; /** * A refresh token that can be used to obtain a valid access token that can then be used to authenticate with the data source. A valid refresh token is currently only obtainable via the Azure Portal. It is recommended to put a dummy string value here when creating the data source and then going to the Azure Portal to authenticate the data source which will update this property with a valid refresh token. Required on PUT (CreateOrReplace) requests. */ refreshToken?: string; /** * The tenant id of the user used to obtain the refresh token. Required on PUT (CreateOrReplace) requests. */ tenantId?: string; /** * The time format. Wherever {time} appears in filePathPrefix, the value of this property is used as the time format instead. */ timeFormat?: string; /** * The user display name of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token. */ tokenUserDisplayName?: string; /** * The user principal name (UPN) of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token. */ tokenUserPrincipalName?: string; /** * Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. * Expected value is 'Microsoft.DataLake/Accounts'. */ type: "Microsoft.DataLake/Accounts"; } /** * Defines the metadata of AzureFunctionOutputDataSource */ interface AzureFunctionOutputDataSourceResponse { /** * If you want to use an Azure Function from another subscription, you can do so by providing the key to access your function. */ apiKey?: string; /** * The name of your Azure Functions app. */ functionAppName?: string; /** * The name of the function in your Azure Functions app. */ functionName?: string; /** * A property that lets you specify the maximum number of events in each batch that's sent to Azure Functions. The default value is 100. */ maxBatchCount?: number; /** * A property that lets you set the maximum size for each output batch that's sent to your Azure function. The input unit is in bytes. By default, this value is 262,144 bytes (256 KB). */ maxBatchSize?: number; /** * Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. * Expected value is 'Microsoft.AzureFunction'. */ type: "Microsoft.AzureFunction"; } /** * The binding to an Azure Machine Learning web service. */ interface AzureMachineLearningWebServiceFunctionBindingResponse { /** * The API key used to authenticate with Request-Response endpoint. */ apiKey?: string; /** * Number between 1 and 10000 describing maximum number of rows for every Azure ML RRS execute request. Default is 1000. */ batchSize?: number; /** * The Request-Response execute endpoint of the Azure Machine Learning web service. Find out more here: https://docs.microsoft.com/en-us/azure/machine-learning/machine-learning-consume-web-services#request-response-service-rrs */ endpoint?: string; /** * The inputs for the Azure Machine Learning web service endpoint. */ inputs?: outputs.streamanalytics.AzureMachineLearningWebServiceInputsResponse; /** * A list of outputs from the Azure Machine Learning web service endpoint execution. */ outputs?: outputs.streamanalytics.AzureMachineLearningWebServiceOutputColumnResponse[]; /** * Indicates the function binding type. * Expected value is 'Microsoft.MachineLearning/WebService'. */ type: "Microsoft.MachineLearning/WebService"; } /** * Describes an input column for the Azure Machine Learning web service endpoint. */ interface AzureMachineLearningWebServiceInputColumnResponse { /** * The (Azure Machine Learning supported) data type of the input column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx . */ dataType?: string; /** * The zero based index of the function parameter this input maps to. */ mapTo?: number; /** * The name of the input column. */ name?: string; } /** * The inputs for the Azure Machine Learning web service endpoint. */ interface AzureMachineLearningWebServiceInputsResponse { /** * A list of input columns for the Azure Machine Learning web service endpoint. */ columnNames?: outputs.streamanalytics.AzureMachineLearningWebServiceInputColumnResponse[]; /** * The name of the input. This is the name provided while authoring the endpoint. */ name?: string; } /** * Describes an output column for the Azure Machine Learning web service endpoint. */ interface AzureMachineLearningWebServiceOutputColumnResponse { /** * The (Azure Machine Learning supported) data type of the output column. A list of valid Azure Machine Learning data types are described at https://msdn.microsoft.com/en-us/library/azure/dn905923.aspx . */ dataType?: string; /** * The name of the output column. */ name?: string; } /** * Describes an Azure SQL database output data source. */ interface AzureSqlDatabaseOutputDataSourceResponse { /** * Authentication Mode. */ authenticationMode?: string; /** * The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests. */ database?: string; /** * Max Batch count for write to Sql database, the default value is 10,000. Optional on PUT requests. */ maxBatchCount?: number; /** * Max Writer count, currently only 1(single writer) and 0(based on query partition) are available. Optional on PUT requests. */ maxWriterCount?: number; /** * The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. */ password?: string; /** * The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests. */ server?: string; /** * The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. */ table?: string; /** * Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. * Expected value is 'Microsoft.Sql/Server/Database'. */ type: "Microsoft.Sql/Server/Database"; /** * The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. */ user?: string; } /** * Describes an Azure SQL database reference input data source. */ interface AzureSqlReferenceInputDataSourceResponse { /** * This element is associated with the datasource element. This is the name of the database that output will be written to. */ database?: string; /** * This element is associated with the datasource element. This query is used to fetch incremental changes from the SQL database. To use this option, we recommend using temporal tables in Azure SQL Database. */ deltaSnapshotQuery?: string; /** * This element is associated with the datasource element. This query is used to fetch data from the sql database. */ fullSnapshotQuery?: string; /** * This element is associated with the datasource element. This is the password that will be used to connect to the SQL Database instance. */ password?: string; /** * This element is associated with the datasource element. This indicates how frequently the data will be fetched from the database. It is of DateTime format. */ refreshRate?: string; /** * Indicates the type of data refresh option. */ refreshType?: string; /** * This element is associated with the datasource element. This is the name of the server that contains the database that will be written to. */ server?: string; /** * This element is associated with the datasource element. The name of the table in the Azure SQL database.. */ table?: string; /** * Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. * Expected value is 'Microsoft.Sql/Server/Database'. */ type: "Microsoft.Sql/Server/Database"; /** * This element is associated with the datasource element. This is the user name that will be used to connect to the SQL Database instance. */ user?: string; } /** * Describes an Azure Synapse output data source. */ interface AzureSynapseOutputDataSourceResponse { /** * The name of the Azure SQL database. Required on PUT (CreateOrReplace) requests. */ database?: string; /** * The password that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. */ password?: string; /** * The name of the SQL server containing the Azure SQL database. Required on PUT (CreateOrReplace) requests. */ server?: string; /** * The name of the table in the Azure SQL database. Required on PUT (CreateOrReplace) requests. */ table?: string; /** * Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. * Expected value is 'Microsoft.Sql/Server/DataWarehouse'. */ type: "Microsoft.Sql/Server/DataWarehouse"; /** * The user name that will be used to connect to the Azure SQL database. Required on PUT (CreateOrReplace) requests. */ user?: string; } /** * Describes an Azure Table output data source. */ interface AzureTableOutputDataSourceResponse { /** * The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. */ accountKey?: string; /** * The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. */ accountName?: string; /** * The number of rows to write to the Azure Table at a time. */ batchSize?: number; /** * If specified, each item in the array is the name of a column to remove (if present) from output event entities. */ columnsToRemove?: string[]; /** * This element indicates the name of a column from the SELECT statement in the query that will be used as the partition key for the Azure Table. Required on PUT (CreateOrReplace) requests. */ partitionKey?: string; /** * This element indicates the name of a column from the SELECT statement in the query that will be used as the row key for the Azure Table. Required on PUT (CreateOrReplace) requests. */ rowKey?: string; /** * The name of the Azure Table. Required on PUT (CreateOrReplace) requests. */ table?: string; /** * Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. * Expected value is 'Microsoft.Storage/Table'. */ type: "Microsoft.Storage/Table"; } /** * Describes a blob output data source. */ interface BlobOutputDataSourceResponse { /** * Authentication Mode. */ authenticationMode?: string; /** * Blob path prefix. */ blobPathPrefix?: string; /** * The name of a container within the associated Storage account. This container contains either the blob(s) to be read from or written to. Required on PUT (CreateOrReplace) requests. */ container?: string; /** * The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. */ dateFormat?: string; /** * The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example. */ pathPattern?: string; /** * A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. */ storageAccounts?: outputs.streamanalytics.StorageAccountResponse[]; /** * The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. */ timeFormat?: string; /** * Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. * Expected value is 'Microsoft.Storage/Blob'. */ type: "Microsoft.Storage/Blob"; } /** * Describes a blob input data source that contains reference data. */ interface BlobReferenceInputDataSourceResponse { /** * Authentication Mode. */ authenticationMode?: string; /** * The name of a container within the associated Storage account. This container contains either the blob(s) to be read from or written to. Required on PUT (CreateOrReplace) requests. */ container?: string; /** * The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. */ dateFormat?: string; /** * The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example. */ pathPattern?: string; /** * A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. */ storageAccounts?: outputs.streamanalytics.StorageAccountResponse[]; /** * The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. */ timeFormat?: string; /** * Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. * Expected value is 'Microsoft.Storage/Blob'. */ type: "Microsoft.Storage/Blob"; } /** * Describes a blob input data source that contains stream data. */ interface BlobStreamInputDataSourceResponse { /** * Authentication Mode. */ authenticationMode?: string; /** * The name of a container within the associated Storage account. This container contains either the blob(s) to be read from or written to. Required on PUT (CreateOrReplace) requests. */ container?: string; /** * The date format. Wherever {date} appears in pathPattern, the value of this property is used as the date format instead. */ dateFormat?: string; /** * The blob path pattern. Not a regular expression. It represents a pattern against which blob names will be matched to determine whether or not they should be included as input or output to the job. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a more detailed explanation and example. */ pathPattern?: string; /** * The partition count of the blob input data source. Range 1 - 1024. */ sourcePartitionCount?: number; /** * A list of one or more Azure Storage accounts. Required on PUT (CreateOrReplace) requests. */ storageAccounts?: outputs.streamanalytics.StorageAccountResponse[]; /** * The time format. Wherever {time} appears in pathPattern, the value of this property is used as the time format instead. */ timeFormat?: string; /** * Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. * Expected value is 'Microsoft.Storage/Blob'. */ type: "Microsoft.Storage/Blob"; } /** * The properties associated with a Stream Analytics cluster. */ interface ClusterInfoResponse { /** * The resource id of cluster. */ id?: string; } /** * A streaming job. */ interface ClusterJobResponse { /** * Resource ID of the streaming job. */ id: string; /** * The current execution state of the streaming job. */ jobState: string; /** * The number of streaming units that are used by the streaming job. */ streamingUnits: number; } /** * The SKU of the cluster. This determines the size/capacity of the cluster. Required on PUT (CreateOrUpdate) requests. */ interface ClusterSkuResponse { /** * Denotes the number of streaming units the cluster can support. Valid values for this property are multiples of 36 with a minimum value of 36 and maximum value of 216. Required on PUT (CreateOrUpdate) requests. */ capacity?: number; /** * Specifies the SKU name of the cluster. Required on PUT (CreateOrUpdate) requests. */ name?: string; } /** * Describes how input data is compressed */ interface CompressionResponse { /** * Indicates the type of compression that the input uses. Required on PUT (CreateOrReplace) requests. */ type: string; } /** * Describes how data from an input is serialized or how data is serialized when written to an output in CSV format. */ interface CsvSerializationResponse { /** * Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. Required on PUT (CreateOrReplace) requests. */ encoding?: string; /** * Specifies the delimiter that will be used to separate comma-separated value (CSV) records. See https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-input or https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for a list of supported values. Required on PUT (CreateOrReplace) requests. */ fieldDelimiter?: string; /** * Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. * Expected value is 'Csv'. */ type: "Csv"; } /** * Condition applicable to the resource, or to the job overall, that warrant customer attention. */ interface DiagnosticConditionResponse { /** * The opaque diagnostic code. */ code: string; /** * The human-readable message describing the condition in detail. Localized in the Accept-Language of the client request. */ message: string; /** * The UTC timestamp of when the condition started. Customers should be able to find a corresponding event in the ops log around this time. */ since: string; } /** * Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. */ interface DiagnosticsResponse { /** * A collection of zero or more conditions applicable to the resource, or to the job overall, that warrant customer attention. */ conditions: outputs.streamanalytics.DiagnosticConditionResponse[]; } /** * Describes a DocumentDB output data source. */ interface DocumentDbOutputDataSourceResponse { /** * The DocumentDB account name or ID. Required on PUT (CreateOrReplace) requests. */ accountId?: string; /** * The account key for the DocumentDB account. Required on PUT (CreateOrReplace) requests. */ accountKey?: string; /** * The collection name pattern for the collections to be used. The collection name format can be constructed using the optional {partition} token, where partitions start from 0. See the DocumentDB section of https://docs.microsoft.com/en-us/rest/api/streamanalytics/stream-analytics-output for more information. Required on PUT (CreateOrReplace) requests. */ collectionNamePattern?: string; /** * The name of the DocumentDB database. Required on PUT (CreateOrReplace) requests. */ database?: string; /** * The name of the field in output events used to specify the primary key which insert or update operations are based on. */ documentId?: string; /** * The name of the field in output events used to specify the key for partitioning output across collections. If 'collectionNamePattern' contains the {partition} token, this property is required to be specified. */ partitionKey?: string; /** * Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. * Expected value is 'Microsoft.Storage/DocumentDB'. */ type: "Microsoft.Storage/DocumentDB"; } /** * Describes an Event Hub output data source. */ interface EventHubOutputDataSourceResponse { /** * Authentication Mode. */ authenticationMode?: string; /** * The name of the Event Hub. Required on PUT (CreateOrReplace) requests. */ eventHubName?: string; /** * The key/column that is used to determine to which partition to send event data. */ partitionKey?: string; /** * The properties associated with this Event Hub output. */ propertyColumns?: string[]; /** * The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. */ serviceBusNamespace?: string; /** * The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. */ sharedAccessPolicyKey?: string; /** * The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. */ sharedAccessPolicyName?: string; /** * Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. * Expected value is 'Microsoft.ServiceBus/EventHub'. */ type: "Microsoft.ServiceBus/EventHub"; } /** * Describes an Event Hub input data source that contains stream data. */ interface EventHubStreamInputDataSourceResponse { /** * Authentication Mode. */ authenticationMode?: string; /** * The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not specified, the input uses the Event Hub’s default consumer group. */ consumerGroupName?: string; /** * The name of the Event Hub. Required on PUT (CreateOrReplace) requests. */ eventHubName?: string; /** * The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. */ serviceBusNamespace?: string; /** * The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. */ sharedAccessPolicyKey?: string; /** * The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. */ sharedAccessPolicyName?: string; /** * Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. * Expected value is 'Microsoft.ServiceBus/EventHub'. */ type: "Microsoft.ServiceBus/EventHub"; } /** * Describes an Event Hub output data source. */ interface EventHubV2OutputDataSourceResponse { /** * Authentication Mode. */ authenticationMode?: string; /** * The name of the Event Hub. Required on PUT (CreateOrReplace) requests. */ eventHubName?: string; /** * The key/column that is used to determine to which partition to send event data. */ partitionKey?: string; /** * The properties associated with this Event Hub output. */ propertyColumns?: string[]; /** * The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. */ serviceBusNamespace?: string; /** * The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. */ sharedAccessPolicyKey?: string; /** * The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. */ sharedAccessPolicyName?: string; /** * Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. * Expected value is 'Microsoft.EventHub/EventHub'. */ type: "Microsoft.EventHub/EventHub"; } /** * Describes an Event Hub input data source that contains stream data. */ interface EventHubV2StreamInputDataSourceResponse { /** * Authentication Mode. */ authenticationMode?: string; /** * The name of an Event Hub Consumer Group that should be used to read events from the Event Hub. Specifying distinct consumer group names for multiple inputs allows each of those inputs to receive the same events from the Event Hub. If not specified, the input uses the Event Hub’s default consumer group. */ consumerGroupName?: string; /** * The name of the Event Hub. Required on PUT (CreateOrReplace) requests. */ eventHubName?: string; /** * The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. */ serviceBusNamespace?: string; /** * The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. */ sharedAccessPolicyKey?: string; /** * The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. */ sharedAccessPolicyName?: string; /** * Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. * Expected value is 'Microsoft.EventHub/EventHub'. */ type: "Microsoft.EventHub/EventHub"; } /** * Describes a file input data source that contains reference data. */ interface FileReferenceInputDataSourceResponse { /** * The path of the file. */ path?: string; /** * Indicates the type of input data source containing reference data. Required on PUT (CreateOrReplace) requests. * Expected value is 'File'. */ type: "File"; } /** * Describes one input parameter of a function. */ interface FunctionInputResponse { /** * The (Azure Stream Analytics supported) data type of the function input parameter. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx */ dataType?: string; /** * A flag indicating if the parameter is a configuration parameter. True if this input parameter is expected to be a constant. Default is false. */ isConfigurationParameter?: boolean; } /** * Describes the output of a function. */ interface FunctionOutputResponse { /** * The (Azure Stream Analytics supported) data type of the function output. A list of valid Azure Stream Analytics data types are described at https://msdn.microsoft.com/en-us/library/azure/dn835065.aspx */ dataType?: string; } /** * A function object, containing all information associated with the named function. All functions are contained under a streaming job. */ interface FunctionResponse { /** * Resource Id */ id: string; /** * Resource name */ name?: string; /** * The properties that are associated with a function. */ properties?: outputs.streamanalytics.AggregateFunctionPropertiesResponse | outputs.streamanalytics.ScalarFunctionPropertiesResponse; /** * Resource type */ type: string; } /** * Describes a Gateway Message Bus output data source. */ interface GatewayMessageBusOutputDataSourceResponse { /** * The name of the Service Bus topic. */ topic?: string; /** * Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. * Expected value is 'GatewayMessageBus'. */ type: "GatewayMessageBus"; } /** * Describes a blob input data source that contains stream data. */ interface GatewayMessageBusStreamInputDataSourceResponse { /** * The name of the Service Bus topic. */ topic?: string; /** * Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. * Expected value is 'GatewayMessageBus'. */ type: "GatewayMessageBus"; } /** * Describes how identity is verified */ interface IdentityResponse { /** * The identity principal ID */ principalId: string; /** * The identity tenantId */ tenantId: string; /** * The identity type */ type?: string; } /** * An input object, containing all information associated with the named input. All inputs are contained under a streaming job. */ interface InputResponse { /** * Resource Id */ id: string; /** * Resource name */ name?: string; /** * The properties that are associated with an input. Required on PUT (CreateOrReplace) requests. */ properties?: outputs.streamanalytics.ReferenceInputPropertiesResponse | outputs.streamanalytics.StreamInputPropertiesResponse; /** * Resource type */ type: string; } /** * Describes an IoT Hub input data source that contains stream data. */ interface IoTHubStreamInputDataSourceResponse { /** * The name of an IoT Hub Consumer Group that should be used to read events from the IoT Hub. If not specified, the input uses the Iot Hub’s default consumer group. */ consumerGroupName?: string; /** * The IoT Hub endpoint to connect to (ie. messages/events, messages/operationsMonitoringEvents, etc.). */ endpoint?: string; /** * The name or the URI of the IoT Hub. Required on PUT (CreateOrReplace) requests. */ iotHubNamespace?: string; /** * The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. */ sharedAccessPolicyKey?: string; /** * The shared access policy name for the IoT Hub. This policy must contain at least the Service connect permission. Required on PUT (CreateOrReplace) requests. */ sharedAccessPolicyName?: string; /** * Indicates the type of input data source containing stream data. Required on PUT (CreateOrReplace) requests. * Expected value is 'Microsoft.Devices/IotHubs'. */ type: "Microsoft.Devices/IotHubs"; } /** * The binding to a JavaScript function. */ interface JavaScriptFunctionBindingResponse { /** * The JavaScript code containing a single function definition. For example: 'function (x, y) { return x + y; }' */ script?: string; /** * Indicates the function binding type. * Expected value is 'Microsoft.StreamAnalytics/JavascriptUdf'. */ type: "Microsoft.StreamAnalytics/JavascriptUdf"; } /** * The properties that are associated with an Azure Storage account with MSI */ interface JobStorageAccountResponse { /** * The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. */ accountKey?: string; /** * The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. */ accountName?: string; /** * Authentication Mode. */ authenticationMode?: string; } /** * Describes how data from an input is serialized or how data is serialized when written to an output in JSON format. */ interface JsonSerializationResponse { /** * Specifies the encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. Required on PUT (CreateOrReplace) requests. */ encoding?: string; /** * This property only applies to JSON serialization of outputs only. It is not applicable to inputs. This property specifies the format of the JSON the output will be written in. The currently supported values are 'lineSeparated' indicating the output will be formatted by having each JSON object separated by a new line and 'array' indicating the output will be formatted as an array of JSON objects. Default value is 'lineSeparated' if left null. */ format?: string; /** * Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. * Expected value is 'Json'. */ type: "Json"; } /** * An output object, containing all information associated with the named output. All outputs are contained under a streaming job. */ interface OutputResponse { /** * Describes the data source that output will be written to. Required on PUT (CreateOrReplace) requests. */ datasource?: outputs.streamanalytics.AzureDataLakeStoreOutputDataSourceResponse | outputs.streamanalytics.AzureFunctionOutputDataSourceResponse | outputs.streamanalytics.AzureSqlDatabaseOutputDataSourceResponse | outputs.streamanalytics.AzureSynapseOutputDataSourceResponse | outputs.streamanalytics.AzureTableOutputDataSourceResponse | outputs.streamanalytics.BlobOutputDataSourceResponse | outputs.streamanalytics.DocumentDbOutputDataSourceResponse | outputs.streamanalytics.EventHubOutputDataSourceResponse | outputs.streamanalytics.EventHubV2OutputDataSourceResponse | outputs.streamanalytics.GatewayMessageBusOutputDataSourceResponse | outputs.streamanalytics.PowerBIOutputDataSourceResponse | outputs.streamanalytics.ServiceBusQueueOutputDataSourceResponse | outputs.streamanalytics.ServiceBusTopicOutputDataSourceResponse; /** * Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. */ diagnostics: outputs.streamanalytics.DiagnosticsResponse; /** * The current entity tag for the output. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. */ etag: string; /** * Resource Id */ id: string; /** * Resource name */ name?: string; /** * Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests. */ serialization?: outputs.streamanalytics.AvroSerializationResponse | outputs.streamanalytics.CsvSerializationResponse | outputs.streamanalytics.JsonSerializationResponse | outputs.streamanalytics.ParquetSerializationResponse; /** * The size window to constrain a Stream Analytics output to. */ sizeWindow?: number; /** * The time frame for filtering Stream Analytics job outputs. */ timeWindow?: string; /** * Resource type */ type: string; } /** * Describes how data from an input is serialized or how data is serialized when written to an output in Parquet format. */ interface ParquetSerializationResponse { /** * Indicates the type of serialization that the input or output uses. Required on PUT (CreateOrReplace) requests. * Expected value is 'Parquet'. */ type: "Parquet"; } /** * Describes a Power BI output data source. */ interface PowerBIOutputDataSourceResponse { /** * Authentication Mode. */ authenticationMode?: string; /** * The name of the Power BI dataset. Required on PUT (CreateOrReplace) requests. */ dataset?: string; /** * The ID of the Power BI group. */ groupId?: string; /** * The name of the Power BI group. Use this property to help remember which specific Power BI group id was used. */ groupName?: string; /** * A refresh token that can be used to obtain a valid access token that can then be used to authenticate with the data source. A valid refresh token is currently only obtainable via the Azure Portal. It is recommended to put a dummy string value here when creating the data source and then going to the Azure Portal to authenticate the data source which will update this property with a valid refresh token. Required on PUT (CreateOrReplace) requests. */ refreshToken?: string; /** * The name of the Power BI table under the specified dataset. Required on PUT (CreateOrReplace) requests. */ table?: string; /** * The user display name of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token. */ tokenUserDisplayName?: string; /** * The user principal name (UPN) of the user that was used to obtain the refresh token. Use this property to help remember which user was used to obtain the refresh token. */ tokenUserPrincipalName?: string; /** * Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. * Expected value is 'PowerBI'. */ type: "PowerBI"; } /** * A collection of read-only information about the state of the connection to the private remote resource. */ interface PrivateLinkConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired: string; /** * The reason for approval/rejection of the connection. */ description: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the remote resource/service. */ status: string; } /** * A grouping of information about the connection to the remote resource. */ interface PrivateLinkServiceConnectionResponse { /** * The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to. Required on PUT (CreateOrUpdate) requests. */ groupIds?: string[]; /** * A collection of read-only information about the state of the connection to the private remote resource. */ privateLinkServiceConnectionState?: outputs.streamanalytics.PrivateLinkConnectionStateResponse; /** * The resource id of the private link service. Required on PUT (CreateOrUpdate) requests. */ privateLinkServiceId?: string; /** * A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars. */ requestMessage: string; } /** * The properties that are associated with an input containing reference data. */ interface ReferenceInputPropertiesResponse { /** * Describes how input data is compressed */ compression?: outputs.streamanalytics.CompressionResponse; /** * Describes an input data source that contains reference data. Required on PUT (CreateOrReplace) requests. */ datasource?: outputs.streamanalytics.AzureSqlReferenceInputDataSourceResponse | outputs.streamanalytics.BlobReferenceInputDataSourceResponse | outputs.streamanalytics.FileReferenceInputDataSourceResponse; /** * Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. */ diagnostics: outputs.streamanalytics.DiagnosticsResponse; /** * The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. */ etag: string; /** * partitionKey Describes a key in the input data which is used for partitioning the input data */ partitionKey?: string; /** * Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests. */ serialization?: outputs.streamanalytics.AvroSerializationResponse | outputs.streamanalytics.CsvSerializationResponse | outputs.streamanalytics.JsonSerializationResponse | outputs.streamanalytics.ParquetSerializationResponse; /** * Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. * Expected value is 'Reference'. */ type: "Reference"; } /** * The properties that are associated with a scalar function. */ interface ScalarFunctionPropertiesResponse { /** * The physical binding of the function. For example, in the Azure Machine Learning web service’s case, this describes the endpoint. */ binding?: outputs.streamanalytics.AzureMachineLearningWebServiceFunctionBindingResponse | outputs.streamanalytics.JavaScriptFunctionBindingResponse; /** * The current entity tag for the function. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. */ etag: string; inputs?: outputs.streamanalytics.FunctionInputResponse[]; /** * Describes the output of a function. */ output?: outputs.streamanalytics.FunctionOutputResponse; /** * Indicates the type of function. * Expected value is 'Scalar'. */ type: "Scalar"; } /** * Describes a Service Bus Queue output data source. */ interface ServiceBusQueueOutputDataSourceResponse { /** * Authentication Mode. */ authenticationMode?: string; /** * A string array of the names of output columns to be attached to Service Bus messages as custom properties. */ propertyColumns?: string[]; /** * The name of the Service Bus Queue. Required on PUT (CreateOrReplace) requests. */ queueName?: string; /** * The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. */ serviceBusNamespace?: string; /** * The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. */ sharedAccessPolicyKey?: string; /** * The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. */ sharedAccessPolicyName?: string; /** * The system properties associated with the Service Bus Queue. The following system properties are supported: ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc. */ systemPropertyColumns?: any; /** * Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. * Expected value is 'Microsoft.ServiceBus/Queue'. */ type: "Microsoft.ServiceBus/Queue"; } /** * Describes a Service Bus Topic output data source. */ interface ServiceBusTopicOutputDataSourceResponse { /** * Authentication Mode. */ authenticationMode?: string; /** * A string array of the names of output columns to be attached to Service Bus messages as custom properties. */ propertyColumns?: string[]; /** * The namespace that is associated with the desired Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. */ serviceBusNamespace?: string; /** * The shared access policy key for the specified shared access policy. Required on PUT (CreateOrReplace) requests. */ sharedAccessPolicyKey?: string; /** * The shared access policy name for the Event Hub, Service Bus Queue, Service Bus Topic, etc. Required on PUT (CreateOrReplace) requests. */ sharedAccessPolicyName?: string; /** * The system properties associated with the Service Bus Topic Output. The following system properties are supported: ReplyToSessionId, ContentType, To, Subject, CorrelationId, TimeToLive, PartitionKey, SessionId, ScheduledEnqueueTime, MessageId, ReplyTo, Label, ScheduledEnqueueTimeUtc. */ systemPropertyColumns?: { [key: string]: string; }; /** * The name of the Service Bus Topic. Required on PUT (CreateOrReplace) requests. */ topicName?: string; /** * Indicates the type of data source output will be written to. Required on PUT (CreateOrReplace) requests. * Expected value is 'Microsoft.ServiceBus/Topic'. */ type: "Microsoft.ServiceBus/Topic"; } /** * The properties that are associated with a SKU. */ interface SkuResponse { /** * The name of the SKU. Required on PUT (CreateOrReplace) requests. */ name?: string; } /** * The properties that are associated with an Azure Storage account */ interface StorageAccountResponse { /** * The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests. */ accountKey?: string; /** * The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests. */ accountName?: string; } /** * The properties that are associated with an input containing stream data. */ interface StreamInputPropertiesResponse { /** * Describes how input data is compressed */ compression?: outputs.streamanalytics.CompressionResponse; /** * Describes an input data source that contains stream data. Required on PUT (CreateOrReplace) requests. */ datasource?: outputs.streamanalytics.BlobStreamInputDataSourceResponse | outputs.streamanalytics.EventHubStreamInputDataSourceResponse | outputs.streamanalytics.EventHubV2StreamInputDataSourceResponse | outputs.streamanalytics.GatewayMessageBusStreamInputDataSourceResponse | outputs.streamanalytics.IoTHubStreamInputDataSourceResponse; /** * Describes conditions applicable to the Input, Output, or the job overall, that warrant customer attention. */ diagnostics: outputs.streamanalytics.DiagnosticsResponse; /** * The current entity tag for the input. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. */ etag: string; /** * partitionKey Describes a key in the input data which is used for partitioning the input data */ partitionKey?: string; /** * Describes how data from an input is serialized or how data is serialized when written to an output. Required on PUT (CreateOrReplace) requests. */ serialization?: outputs.streamanalytics.AvroSerializationResponse | outputs.streamanalytics.CsvSerializationResponse | outputs.streamanalytics.JsonSerializationResponse | outputs.streamanalytics.ParquetSerializationResponse; /** * Indicates whether the input is a source of reference data or stream data. Required on PUT (CreateOrReplace) requests. * Expected value is 'Stream'. */ type: "Stream"; } /** * A transformation object, containing all information associated with the named transformation. All transformations are contained under a streaming job. */ interface TransformationResponse { /** * The current entity tag for the transformation. This is an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency. */ etag: string; /** * Resource Id */ id: string; /** * Resource name */ name?: string; /** * Specifies the query that will be run in the streaming job. You can learn more about the Stream Analytics Query Language (SAQL) here: https://msdn.microsoft.com/library/azure/dn834998 . Required on PUT (CreateOrReplace) requests. */ query?: string; /** * Specifies the number of streaming units that the streaming job uses. */ streamingUnits?: number; /** * Resource type */ type: string; /** * Specifies the valid streaming units a streaming job can scale to. */ validStreamingUnits?: number[]; } /** * transformationResponseProvideDefaults sets the appropriate defaults for TransformationResponse */ function transformationResponseProvideDefaults(val: TransformationResponse): TransformationResponse; } export declare namespace subscription { /** * Put subscription creation result properties. */ interface SubscriptionAliasResponsePropertiesResponse { /** * The accept ownership state of the resource. */ acceptOwnershipState: string; /** * Url to accept ownership of the subscription. */ acceptOwnershipUrl: string; /** * Billing scope of the subscription. * For CustomerLed and FieldLed - /billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName} * For PartnerLed - /billingAccounts/{billingAccountName}/customers/{customerName} * For Legacy EA - /billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName} */ billingScope?: string; /** * Created Time */ createdTime?: string; /** * The display name of the subscription. */ displayName?: string; /** * The Management Group Id. */ managementGroupId?: string; /** * The provisioning state of the resource. */ provisioningState: string; /** * Reseller Id */ resellerId?: string; /** * Newly created subscription Id. */ subscriptionId: string; /** * Owner Id of the subscription */ subscriptionOwnerId?: string; /** * Tags for the subscription */ tags?: { [key: string]: string; }; /** * The workload type of the subscription. It can be either Production or DevTest. */ workload?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Properties of subscription Response for Changed Target Directory. */ interface TargetDirectoryResultPropertiesResponse { /** * Destination Owner Id where Subscription will be accepted. */ destinationOwnerId: string; /** * Destination Tenant Id where Subscription will be accepted. */ destinationTenantId: string; /** * Subscription Initiate Request Expiry time */ expiresOn: string; /** * Subscription Status. */ status: string; } } export declare namespace synapse { /** * Auto-pausing properties of a Big Data pool powered by Apache Spark */ interface AutoPausePropertiesResponse { /** * Number of minutes of idle time before the Big Data pool is automatically paused. */ delayInMinutes?: number; /** * Whether auto-pausing is enabled for the Big Data pool. */ enabled?: boolean; } /** * Auto-scaling properties of a Big Data pool powered by Apache Spark */ interface AutoScalePropertiesResponse { /** * Whether automatic scaling is enabled for the Big Data pool. */ enabled?: boolean; /** * The maximum number of nodes the Big Data pool can support. */ maxNodeCount?: number; /** * The minimum number of nodes the Big Data pool can support. */ minNodeCount?: number; } /** * Azure SKU definition. */ interface AzureSkuResponse { /** * The number of instances of the cluster. */ capacity?: number; /** * SKU name. */ name: string; /** * SKU size. */ size: string; } /** * The custom setup of running cmdkey commands. */ interface CmdkeySetupResponse { /** * The password of data source access. */ password: outputs.synapse.SecureStringResponse; /** * The server name of data source access. */ targetName: any; /** * The type of custom setup. * Expected value is 'CmdkeySetup'. */ type: "CmdkeySetup"; /** * The user name of data source access. */ userName: any; } /** * The custom setup of installing 3rd party components. */ interface ComponentSetupResponse { /** * The name of the 3rd party component. */ componentName: string; /** * The license key to activate the component. */ licenseKey?: outputs.synapse.SecureStringResponse; /** * The type of custom setup. * Expected value is 'ComponentSetup'. */ type: "ComponentSetup"; } /** * Initial workspace AAD admin properties for a CSP subscription */ interface CspWorkspaceAdminPropertiesResponse { /** * AAD object ID of initial workspace admin */ initialWorkspaceAdminObjectId?: string; } /** * Details of the customer managed key associated with the workspace */ interface CustomerManagedKeyDetailsResponse { /** * Key encryption key */ kekIdentity?: outputs.synapse.KekIdentityPropertiesResponse; /** * The key object of the workspace */ key?: outputs.synapse.WorkspaceKeyDetailsResponse; /** * The customer managed key status on the workspace */ status: string; } /** * Details of the data lake storage account associated with the workspace */ interface DataLakeStorageAccountDetailsResponse { /** * Account URL */ accountUrl?: string; /** * Create managed private endpoint to this storage account or not */ createManagedPrivateEndpoint?: boolean; /** * Filesystem name */ filesystem?: string; /** * ARM resource Id of this storage account */ resourceId?: string; } /** * A class that contains database statistics information. */ interface DatabaseStatisticsResponse { /** * The database size - the total size of compressed data and index in bytes. */ size?: number; } /** * Dynamic Executor Allocation Properties */ interface DynamicExecutorAllocationResponse { /** * Indicates whether Dynamic Executor Allocation is enabled or not. */ enabled?: boolean; /** * The maximum number of executors alloted */ maxExecutors?: number; /** * The minimum number of executors alloted */ minExecutors?: number; } /** * Details of the encryption associated with the workspace */ interface EncryptionDetailsResponse { /** * Customer Managed Key Details */ cmk?: outputs.synapse.CustomerManagedKeyDetailsResponse; /** * Double Encryption enabled */ doubleEncryptionEnabled: boolean; } /** * The entity reference. */ interface EntityReferenceResponse { /** * The name of this referenced entity. */ referenceName?: string; /** * The type of this referenced entity. */ type?: string; } /** * The custom setup of setting environment variable. */ interface EnvironmentVariableSetupResponse { /** * The type of custom setup. * Expected value is 'EnvironmentVariableSetup'. */ type: "EnvironmentVariableSetup"; /** * The name of the environment variable. */ variableName: string; /** * The value of the environment variable. */ variableValue: string; } /** * A class representing follower database request. */ interface FollowerDatabaseDefinitionResponse { /** * Resource name of the attached database configuration in the follower cluster. */ attachedDatabaseConfigurationName: string; /** * The database name owned by this cluster that was followed. * in case following all databases. */ databaseName: string; /** * Resource id of the cluster that follows a database owned by this cluster. */ kustoPoolResourceId: string; } /** * The compute resource properties for managed integration runtime. */ interface IntegrationRuntimeComputePropertiesResponse { /** * Data flow properties for managed integration runtime. */ dataFlowProperties?: outputs.synapse.IntegrationRuntimeDataFlowPropertiesResponse; /** * The location for managed integration runtime. The supported regions could be found on https://docs.microsoft.com/en-us/azure/data-factory/data-factory-data-movement-activities */ location?: string; /** * Maximum parallel executions count per node for managed integration runtime. */ maxParallelExecutionsPerNode?: number; /** * The node size requirement to managed integration runtime. */ nodeSize?: string; /** * The required number of nodes for managed integration runtime. */ numberOfNodes?: number; /** * VNet properties for managed integration runtime. */ vNetProperties?: outputs.synapse.IntegrationRuntimeVNetPropertiesResponse; } /** * Custom setup script properties for a managed dedicated integration runtime. */ interface IntegrationRuntimeCustomSetupScriptPropertiesResponse { /** * The URI of the Azure blob container that contains the custom setup script. */ blobContainerUri?: string; /** * The SAS token of the Azure blob container. */ sasToken?: outputs.synapse.SecureStringResponse; } /** * The definition and properties of virtual network to which Azure-SSIS integration runtime will join. */ interface IntegrationRuntimeCustomerVirtualNetworkResponse { /** * The ID of subnet to which Azure-SSIS integration runtime will join. */ subnetId?: string; } /** * Data flow properties for managed integration runtime. */ interface IntegrationRuntimeDataFlowPropertiesResponse { /** * Compute type of the cluster which will execute data flow job. */ computeType?: string; /** * Core count of the cluster which will execute data flow job. Supported values are: 8, 16, 32, 48, 80, 144 and 272. */ coreCount?: number; /** * Time to live (in minutes) setting of the cluster which will execute data flow job. */ timeToLive?: number; } /** * Data proxy properties for a managed dedicated integration runtime. */ interface IntegrationRuntimeDataProxyPropertiesResponse { /** * The self-hosted integration runtime reference. */ connectVia?: outputs.synapse.EntityReferenceResponse; /** * The path to contain the staged data in the Blob storage. */ path?: string; /** * The staging linked service reference. */ stagingLinkedService?: outputs.synapse.EntityReferenceResponse; } /** * Catalog information for managed dedicated integration runtime. */ interface IntegrationRuntimeSsisCatalogInfoResponse { /** * The password of the administrator user account of the catalog database. */ catalogAdminPassword?: outputs.synapse.SecureStringResponse; /** * The administrator user name of catalog database. */ catalogAdminUserName?: string; /** * The pricing tier for the catalog database. The valid values could be found in https://azure.microsoft.com/en-us/pricing/details/sql-database/ */ catalogPricingTier?: string; /** * The catalog database server URL. */ catalogServerEndpoint?: string; } /** * SSIS properties for managed integration runtime. */ interface IntegrationRuntimeSsisPropertiesResponse { /** * Catalog information for managed dedicated integration runtime. */ catalogInfo?: outputs.synapse.IntegrationRuntimeSsisCatalogInfoResponse; /** * Custom setup script properties for a managed dedicated integration runtime. */ customSetupScriptProperties?: outputs.synapse.IntegrationRuntimeCustomSetupScriptPropertiesResponse; /** * Data proxy properties for a managed dedicated integration runtime. */ dataProxyProperties?: outputs.synapse.IntegrationRuntimeDataProxyPropertiesResponse; /** * The edition for the SSIS Integration Runtime */ edition?: string; /** * Custom setup without script properties for a SSIS integration runtime. */ expressCustomSetupProperties?: (outputs.synapse.CmdkeySetupResponse | outputs.synapse.ComponentSetupResponse | outputs.synapse.EnvironmentVariableSetupResponse)[]; /** * License type for bringing your own license scenario. */ licenseType?: string; } /** * VNet properties for managed integration runtime. */ interface IntegrationRuntimeVNetPropertiesResponse { /** * Resource IDs of the public IP addresses that this integration runtime will use. */ publicIPs?: string[]; /** * The name of the subnet this integration runtime will join. */ subnet?: string; /** * The ID of subnet, to which this Azure-SSIS integration runtime will be joined. */ subnetId?: string; /** * The ID of the VNet that this integration runtime will join. */ vNetId?: string; } /** * Key encryption key properties */ interface KekIdentityPropertiesResponse { /** * Boolean specifying whether to use system assigned identity or not */ useSystemAssignedIdentity?: any; /** * User assigned identity resource Id */ userAssignedIdentity?: string; } /** * The language extension object. */ interface LanguageExtensionResponse { /** * The language extension name. */ languageExtensionName?: string; } /** * The list of language extension objects. */ interface LanguageExtensionsListResponse { /** * The list of language extensions. */ value?: outputs.synapse.LanguageExtensionResponse[]; } /** * Library/package information of a Big Data pool powered by Apache Spark */ interface LibraryInfoResponse { /** * Storage blob container name. */ containerName?: string; /** * Creator Id of the library/package. */ creatorId: string; /** * Name of the library. */ name?: string; /** * Storage blob path of library. */ path?: string; /** * Provisioning status of the library/package. */ provisioningStatus: string; /** * Type of the library. */ type?: string; /** * The last update time of the library. */ uploadedTimestamp: string; } /** * Library requirements for a Big Data pool powered by Apache Spark */ interface LibraryRequirementsResponse { /** * The library requirements. */ content?: string; /** * The filename of the library requirements file. */ filename?: string; /** * The last update time of the library requirements file. */ time: string; } /** * The key authorization type integration runtime. */ interface LinkedIntegrationRuntimeKeyAuthorizationResponse { /** * The authorization type for integration runtime sharing. * Expected value is 'Key'. */ authorizationType: "Key"; /** * The key used for authorization. */ key: outputs.synapse.SecureStringResponse; } /** * The role based access control (RBAC) authorization type integration runtime. */ interface LinkedIntegrationRuntimeRbacAuthorizationResponse { /** * The authorization type for integration runtime sharing. * Expected value is 'RBAC'. */ authorizationType: "RBAC"; /** * The resource identifier of the integration runtime to be shared. */ resourceId: string; } /** * The linked integration runtime information. */ interface LinkedIntegrationRuntimeResponse { /** * The creating time of the linked integration runtime. */ createTime: string; /** * The location of the workspace for which the linked integration runtime belong to. */ dataFactoryLocation: string; /** * The name of the workspace for which the linked integration runtime belong to. */ dataFactoryName: string; /** * The name of the linked integration runtime. */ name: string; /** * The subscription ID for which the linked integration runtime belong to. */ subscriptionId: string; } /** * The workspace managed identity */ interface ManagedIdentityResponse { /** * The principal ID of the workspace managed identity */ principalId: string; /** * The tenant ID of the workspace managed identity */ tenantId: string; /** * The type of managed identity for the workspace */ type?: string; /** * The user assigned managed identities. */ userAssignedIdentities?: { [key: string]: outputs.synapse.UserAssignedManagedIdentityResponse; }; } /** * Error definition for managed integration runtime. */ interface ManagedIntegrationRuntimeErrorResponse { /** * Error code. */ code: string; /** * Error message. */ message: string; /** * Managed integration runtime error parameters. */ parameters: string[]; /** * The time when the error occurred. */ time: string; } /** * Properties of integration runtime node. */ interface ManagedIntegrationRuntimeNodeResponse { /** * The errors that occurred on this integration runtime node. */ errors?: outputs.synapse.ManagedIntegrationRuntimeErrorResponse[]; /** * The managed integration runtime node id. */ nodeId: string; /** * The managed integration runtime node status. */ status: string; } /** * Properties of managed integration runtime operation result. */ interface ManagedIntegrationRuntimeOperationResultResponse { /** * The activity id for the operation request. */ activityId: string; /** * The error code. */ errorCode: string; /** * Managed integration runtime error parameters. */ parameters: string[]; /** * The operation result. */ result: string; /** * The start time of the operation. */ startTime: string; /** * The operation type. Could be start or stop. */ type: string; } /** * Managed integration runtime, including managed elastic and managed dedicated integration runtimes. */ interface ManagedIntegrationRuntimeResponse { /** * The compute resource for managed integration runtime. */ computeProperties?: outputs.synapse.IntegrationRuntimeComputePropertiesResponse; /** * The name of virtual network to which Azure-SSIS integration runtime will join */ customerVirtualNetwork?: outputs.synapse.IntegrationRuntimeCustomerVirtualNetworkResponse; /** * Integration runtime description. */ description?: string; /** * The id of the managed virtual network. */ id?: string; /** * Integration runtime state, only valid for managed dedicated integration runtime. */ provisioningState: string; /** * The reference name of the managed virtual network */ referenceName?: string; /** * SSIS properties for managed integration runtime. */ ssisProperties?: outputs.synapse.IntegrationRuntimeSsisPropertiesResponse; /** * The type of integration runtime. * Expected value is 'Managed'. */ type: "Managed"; } /** * Managed integration runtime status. */ interface ManagedIntegrationRuntimeStatusResponse { /** * The time at which the integration runtime was created, in ISO8601 format. */ createTime: string; /** * The workspace name which the integration runtime belong to. */ dataFactoryName: string; /** * The last operation result that occurred on this integration runtime. */ lastOperation: outputs.synapse.ManagedIntegrationRuntimeOperationResultResponse; /** * The list of nodes for managed integration runtime. */ nodes: outputs.synapse.ManagedIntegrationRuntimeNodeResponse[]; /** * The errors that occurred on this integration runtime. */ otherErrors: outputs.synapse.ManagedIntegrationRuntimeErrorResponse[]; /** * The state of integration runtime. */ state: string; /** * The type of integration runtime. * Expected value is 'Managed'. */ type: "Managed"; } /** * Managed Virtual Network Settings */ interface ManagedVirtualNetworkSettingsResponse { /** * Allowed Aad Tenant Ids For Linking */ allowedAadTenantIdsForLinking?: string[]; /** * Linked Access Check On Target Resource */ linkedAccessCheckOnTargetResource?: boolean; /** * Prevent Data Exfiltration */ preventDataExfiltration?: boolean; } /** * A class that contains the optimized auto scale definition. */ interface OptimizedAutoscaleResponse { /** * A boolean value that indicate if the optimized autoscale feature is enabled or not. */ isEnabled: boolean; /** * Maximum allowed instances count. */ maximum: number; /** * Minimum allowed instances count. */ minimum: number; /** * The version of the template defined, for instance 1. */ version: number; } /** * Private Endpoint Connection For Private Link Hub - Basic */ interface PrivateEndpointConnectionForPrivateLinkHubBasicResponse { /** * identifier */ id: string; /** * The private endpoint which the connection belongs to. */ privateEndpoint?: outputs.synapse.PrivateEndpointResponse; /** * Connection state of the private endpoint connection. */ privateLinkServiceConnectionState?: outputs.synapse.PrivateLinkServiceConnectionStateResponse; /** * Provisioning state of the private endpoint connection. */ provisioningState: string; } /** * A private endpoint connection */ interface PrivateEndpointConnectionResponse { /** * Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} */ id: string; /** * The name of the resource */ name: string; /** * The private endpoint which the connection belongs to. */ privateEndpoint?: outputs.synapse.PrivateEndpointResponse; /** * Connection state of the private endpoint connection. */ privateLinkServiceConnectionState?: outputs.synapse.PrivateLinkServiceConnectionStateResponse; /** * Provisioning state of the private endpoint connection. */ provisioningState: string; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Private endpoint details */ interface PrivateEndpointResponse { /** * Resource id of the private endpoint. */ id: string; } /** * Connection state details of the private endpoint */ interface PrivateLinkServiceConnectionStateResponse { /** * The actions required for private link service connection. */ actionsRequired: string; /** * The private link service connection description. */ description?: string; /** * The private link service connection status. */ status?: string; } /** * Purview Configuration */ interface PurviewConfigurationResponse { /** * Purview Resource ID */ purviewResourceId?: string; } /** * Azure Synapse secure string definition. The string value will be masked with asterisks '*' during Get or List API calls. */ interface SecureStringResponse { /** * Type of the secret. * Expected value is 'SecureString'. */ type: "SecureString"; /** * Value of secure string. */ value: string; } /** * Properties of Self-hosted integration runtime node. */ interface SelfHostedIntegrationRuntimeNodeResponse { /** * The integration runtime capabilities dictionary */ capabilities: { [key: string]: string; }; /** * Maximum concurrent jobs on the integration runtime node. */ concurrentJobsLimit: number; /** * The time at which the integration runtime will expire in ISO8601 format. */ expiryTime: string; /** * URI for the host machine of the integration runtime. */ hostServiceUri: string; /** * Indicates whether this node is the active dispatcher for integration runtime requests. */ isActiveDispatcher: boolean; /** * The most recent time at which the integration runtime was connected in ISO8601 format. */ lastConnectTime: string; /** * The last time for the integration runtime node update end. */ lastEndUpdateTime: string; /** * The time the node last started up. */ lastStartTime: string; /** * The last time for the integration runtime node update start. */ lastStartUpdateTime: string; /** * The integration runtime node last stop time. */ lastStopTime: string; /** * The result of the last integration runtime node update. */ lastUpdateResult: string; /** * Machine name of the integration runtime node. */ machineName: string; /** * The maximum concurrent jobs in this integration runtime. */ maxConcurrentJobs: number; /** * Name of the integration runtime node. */ nodeName: string; /** * The time at which the integration runtime node was registered in ISO8601 format. */ registerTime: string; /** * Status of the integration runtime node. */ status: string; /** * Version of the integration runtime node. */ version: string; /** * Status of the integration runtime node version. */ versionStatus: string; } /** * Self-hosted integration runtime. */ interface SelfHostedIntegrationRuntimeResponse { /** * Integration runtime description. */ description?: string; /** * Linked integration runtime type from data factory */ linkedInfo?: outputs.synapse.LinkedIntegrationRuntimeKeyAuthorizationResponse | outputs.synapse.LinkedIntegrationRuntimeRbacAuthorizationResponse; /** * The type of integration runtime. * Expected value is 'SelfHosted'. */ type: "SelfHosted"; } /** * Self-hosted integration runtime status. */ interface SelfHostedIntegrationRuntimeStatusResponse { /** * Whether Self-hosted integration runtime auto update has been turned on. */ autoUpdate: string; /** * The estimated time when the self-hosted integration runtime will be updated. */ autoUpdateETA: string; /** * Object with additional information about integration runtime capabilities. */ capabilities: { [key: string]: string; }; /** * The time at which the integration runtime was created, in ISO8601 format. */ createTime: string; /** * The workspace name which the integration runtime belong to. */ dataFactoryName: string; /** * It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist). */ internalChannelEncryption: string; /** * The latest version on download center. */ latestVersion: string; /** * The list of linked integration runtimes that are created to share with this integration runtime. */ links?: outputs.synapse.LinkedIntegrationRuntimeResponse[]; /** * The local time zone offset in hours. */ localTimeZoneOffset: string; /** * The node communication Channel encryption mode */ nodeCommunicationChannelEncryptionMode: string; /** * The list of nodes for this integration runtime. */ nodes?: outputs.synapse.SelfHostedIntegrationRuntimeNodeResponse[]; /** * The version that the integration runtime is going to update to. */ pushedVersion: string; /** * The date at which the integration runtime will be scheduled to update, in ISO8601 format. */ scheduledUpdateDate: string; /** * The URLs for the services used in integration runtime backend service. */ serviceUrls: string[]; /** * The state of integration runtime. */ state: string; /** * The task queue id of the integration runtime. */ taskQueueId: string; /** * The type of integration runtime. * Expected value is 'SelfHosted'. */ type: "SelfHosted"; /** * The time in the date scheduled by service to update the integration runtime, e.g., PT03H is 3 hours */ updateDelayOffset: string; /** * Version of the integration runtime. */ version: string; /** * Status of the integration runtime version. */ versionStatus: string; } /** * SQL pool SKU */ interface SkuResponse { /** * If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted. */ capacity?: number; /** * The SKU name */ name?: string; /** * The service tier */ tier?: string; } /** * SparkConfig Properties for a Big Data pool powered by Apache Spark */ interface SparkConfigPropertiesResponse { /** * The type of the spark config properties file. */ configurationType?: string; /** * The spark config properties. */ content?: string; /** * The filename of the spark config properties file. */ filename?: string; /** * The last update time of the spark config properties file. */ time: string; } /** * Properties for an Sql pool vulnerability assessment rule baseline's result. */ interface SqlPoolVulnerabilityAssessmentRuleBaselineItemResponse { /** * The rule baseline result */ result: string[]; } /** * Ssis environment reference. */ interface SsisEnvironmentReferenceResponse { /** * Environment folder name. */ environmentFolderName?: string; /** * Environment name. */ environmentName?: string; /** * Environment reference id. */ id?: number; /** * Reference type */ referenceType?: string; } /** * Ssis environment. */ interface SsisEnvironmentResponse { /** * Metadata description. */ description?: string; /** * Folder id which contains environment. */ folderId?: number; /** * Metadata id. */ id?: number; /** * Metadata name. */ name?: string; /** * The type of SSIS object metadata. * Expected value is 'Environment'. */ type: "Environment"; /** * Variable in environment */ variables?: outputs.synapse.SsisVariableResponse[]; } /** * Ssis folder. */ interface SsisFolderResponse { /** * Metadata description. */ description?: string; /** * Metadata id. */ id?: number; /** * Metadata name. */ name?: string; /** * The type of SSIS object metadata. * Expected value is 'Folder'. */ type: "Folder"; } /** * Ssis Package. */ interface SsisPackageResponse { /** * Metadata description. */ description?: string; /** * Folder id which contains package. */ folderId?: number; /** * Metadata id. */ id?: number; /** * Metadata name. */ name?: string; /** * Parameters in package */ parameters?: outputs.synapse.SsisParameterResponse[]; /** * Project id which contains package. */ projectId?: number; /** * Project version which contains package. */ projectVersion?: number; /** * The type of SSIS object metadata. * Expected value is 'Package'. */ type: "Package"; } /** * Ssis parameter. */ interface SsisParameterResponse { /** * Parameter type. */ dataType?: string; /** * Default value of parameter. */ defaultValue?: string; /** * Parameter description. */ description?: string; /** * Design default value of parameter. */ designDefaultValue?: string; /** * Parameter id. */ id?: number; /** * Parameter name. */ name?: string; /** * Whether parameter is required. */ required?: boolean; /** * Whether parameter is sensitive. */ sensitive?: boolean; /** * Default sensitive value of parameter. */ sensitiveDefaultValue?: string; /** * Parameter value set. */ valueSet?: boolean; /** * Parameter value type. */ valueType?: string; /** * Parameter reference variable. */ variable?: string; } /** * Ssis project. */ interface SsisProjectResponse { /** * Metadata description. */ description?: string; /** * Environment reference in project */ environmentRefs?: outputs.synapse.SsisEnvironmentReferenceResponse[]; /** * Folder id which contains project. */ folderId?: number; /** * Metadata id. */ id?: number; /** * Metadata name. */ name?: string; /** * Parameters in project */ parameters?: outputs.synapse.SsisParameterResponse[]; /** * The type of SSIS object metadata. * Expected value is 'Project'. */ type: "Project"; /** * Project version. */ version?: number; } /** * Ssis variable. */ interface SsisVariableResponse { /** * Variable type. */ dataType?: string; /** * Variable description. */ description?: string; /** * Variable id. */ id?: number; /** * Variable name. */ name?: string; /** * Whether variable is sensitive. */ sensitive?: boolean; /** * Variable sensitive value. */ sensitiveValue?: string; /** * Variable value. */ value?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Tables that will be included and excluded in the follower database */ interface TableLevelSharingPropertiesResponse { /** * List of external tables exclude from the follower database */ externalTablesToExclude?: string[]; /** * List of external tables to include in the follower database */ externalTablesToInclude?: string[]; /** * List of materialized views exclude from the follower database */ materializedViewsToExclude?: string[]; /** * List of materialized views to include in the follower database */ materializedViewsToInclude?: string[]; /** * List of tables to exclude from the follower database */ tablesToExclude?: string[]; /** * List of tables to include in the follower database */ tablesToInclude?: string[]; } /** * User Assigned Managed Identity */ interface UserAssignedManagedIdentityResponse { /** * The client ID. */ clientId: string; /** * The principal ID. */ principalId: string; } /** * Virtual Network Profile */ interface VirtualNetworkProfileResponse { /** * Subnet ID used for computes in workspace */ computeSubnetId?: string; } /** * Properties of a Vulnerability Assessment recurring scans. */ interface VulnerabilityAssessmentRecurringScansPropertiesResponse { /** * Specifies that the schedule scan notification will be is sent to the subscription administrators. */ emailSubscriptionAdmins?: boolean; /** * Specifies an array of e-mail addresses to which the scan notification is sent. */ emails?: string[]; /** * Recurring scans state. */ isEnabled?: boolean; } /** * vulnerabilityAssessmentRecurringScansPropertiesResponseProvideDefaults sets the appropriate defaults for VulnerabilityAssessmentRecurringScansPropertiesResponse */ function vulnerabilityAssessmentRecurringScansPropertiesResponseProvideDefaults(val: VulnerabilityAssessmentRecurringScansPropertiesResponse): VulnerabilityAssessmentRecurringScansPropertiesResponse; /** * Details of the customer managed key associated with the workspace */ interface WorkspaceKeyDetailsResponse { /** * Workspace Key sub-resource key vault url */ keyVaultUrl?: string; /** * Workspace Key sub-resource name */ name?: string; } /** * Git integration settings */ interface WorkspaceRepositoryConfigurationResponse { /** * Account name */ accountName?: string; /** * Collaboration branch */ collaborationBranch?: string; /** * GitHub Enterprise host name. For example: `https://github.mydomain.com` */ hostName?: string; /** * The last commit ID */ lastCommitId?: string; /** * VSTS project name */ projectName?: string; /** * Repository name */ repositoryName?: string; /** * Root folder to use in the repository */ rootFolder?: string; /** * The VSTS tenant ID */ tenantId?: string; /** * Type of workspace repositoryID configuration. Example WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration */ type?: string; } } export declare namespace syntex { /** * Document processor properties */ interface DocumentProcessorPropertiesResponse { /** * The managed resource provisioning state. */ provisioningState: string; /** * The ID (GUID) of an SharePoint Online (SPO) tenant associated with this document processor resource */ spoTenantId: string; /** * The URL of an SharePoint Online (SPO) tenant associated with this document processor resource */ spoTenantUrl: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace testbase { interface BillingHubExecutionUsageDetailResponse { applicationName?: string; applicationVersion?: string; billedCharges?: number; endTimeStamp?: string; executionRequestId?: string; meterId?: string; osBuild?: string; release?: string; sku?: string; startTimeStamp?: string; testType?: string; updateType?: string; usedBillableHours?: number; usedFreeHours?: number; } interface BillingHubFreeHourIncrementEntryResponse { createTimeStamp?: string; expirationTimeStamp?: string; freeHourStatus?: string; freeHourType?: string; incrementalFreeHours?: number; remainingFreeHours?: number; } interface BillingHubGetUsageRequestResponse { endTimeStamp: string; pageIndex?: number; pageSize?: number; startTimeStamp: string; } interface BillingHubPackageUsageResponse { applicationName?: string; applicationVersion?: string; azureResourceUri?: string; totalCharges?: number; totalUsedBillableHours?: number; totalUsedFreeHours?: number; usageEntriesGroupedByUpdateType?: outputs.testbase.BillingHubUsageGroupedByUpdateTypeResponse[]; } interface BillingHubUsageGroupResponse { executionUsageDetails?: outputs.testbase.BillingHubExecutionUsageDetailResponse[]; osBuild?: string; productFamily?: string; release?: string; releaseBuildDate?: string; releaseBuildNumber?: number; releaseBuildRevision?: number; testType?: string; totalCharges?: number; totalUsedBillableHours?: number; totalUsedFreeHours?: number; } interface BillingHubUsageGroupedByUpdateTypeResponse { totalCharges?: number; totalUsedBillableHours?: number; totalUsedFreeHours?: number; updateType?: string; usageGroups?: outputs.testbase.BillingHubUsageGroupResponse[]; } /** * The command used in the test */ interface CommandResponse { /** * The action of the command. */ action: string; /** * Specifies whether to run the command even if a previous command is failed. */ alwaysRun?: boolean; /** * Specifies whether to apply update before the command. */ applyUpdateBefore?: boolean; /** * The content of the command. The content depends on source type. */ content: string; /** * The type of command content. */ contentType: string; /** * Specifies whether to enroll Intune before the command. */ enrollIntuneBefore?: boolean; /** * Specifies whether to install first party applications before running the command. */ install1PAppBefore?: boolean; /** * Specifies the max run time of the command. */ maxRunTime?: number; /** * The name of the command. */ name: string; /** * Specifies whether the command is assigned to be executed after in-place upgrade. */ postUpgrade?: boolean; /** * Specifies whether the command is assigned to be executed before in-place upgrade. */ preUpgrade?: boolean; /** * Specifies whether to restart the VM after the command executed. */ restartAfter?: boolean; /** * Specifies whether to run the command in interactive mode. */ runAsInteractive?: boolean; /** * Specifies whether to run the command as administrator. */ runElevated?: boolean; } /** * The user object receiver value. */ interface DistributionGroupListReceiverValueResponse { /** * The list of distribution groups. */ distributionGroups?: string[]; } /** * The Metadata of a single Intune App. */ interface DraftPackageIntuneAppMetadataItemResponse { /** * Intune app id. */ appId?: string; /** * Intune app name. */ appName?: string; /** * Creation date of the app. */ createDate?: string; /** * Ids of dependency apps. */ dependencyIds?: string[]; /** * Count of dependency apps. */ dependentAppCount?: number; /** * Description of the app. */ description?: string; /** * Expected exit codes returned from Intune App. */ expectedExitCodes?: string[]; /** * Install command. */ installCommand?: string; /** * last processed time tickets. */ lastProcessed?: number; /** * Minimum supported OS. The OS version must be greater than this version to run this app. */ minimumSupportedOS?: string; /** * Owner of the app. */ owner?: string; /** * Publisher of the app. */ publisher?: string; /** * Setup file path. */ setupFile?: string; /** * Extract status. */ status?: string; /** * Uninstall command. */ uninstallCommand?: string; /** * Intune app version. */ version?: string; } /** * The metadata of Intune app(s) used for generation. */ interface DraftPackageIntuneAppMetadataResponse { /** * The Metadata of the Intune App through intunewin file uploading. */ intuneApp?: outputs.testbase.DraftPackageIntuneAppMetadataItemResponse; /** * The Metadata of dependencies of the Intune App through intunewin file uploading. */ intuneAppDependencies?: outputs.testbase.DraftPackageIntuneAppMetadataItemResponse[]; } /** * Metadata of the enrolled Intune app. */ interface EnrolledIntuneAppResponse { /** * Intune app id. */ appId: string; /** * Intune app name. */ appName: string; /** * Intune app expected installation path. */ expectedInstallationPath: string; } /** * Properties of the definition of a first party application of the Test Base package. */ interface FirstPartyAppDefinitionResponse { /** * The architecture of a first party application of a Test Base Account. */ architecture?: string; /** * The channel info of a first party application of a Test Base Account. */ channel?: string; /** * Specifies how the first party applications should be inter-operated with user's application. */ interopExecutionMode?: string; /** * The media name of a first party application of a Test Base Account. */ name?: string; /** * The ring info of a first party application of a Test Base Account. */ ring?: string; } /** * firstPartyAppDefinitionResponseProvideDefaults sets the appropriate defaults for FirstPartyAppDefinitionResponse */ function firstPartyAppDefinitionResponseProvideDefaults(val: FirstPartyAppDefinitionResponse): FirstPartyAppDefinitionResponse; /** * Properties of the definition of a gallery application used in Test Base package. */ interface GalleryAppDefinitionResponse { /** * Whether the disclaimer of the gallery application is accepted. */ isConsented?: boolean; /** * The SKU id of the gallery application. */ skuId: string; } /** * galleryAppDefinitionResponseProvideDefaults sets the appropriate defaults for GalleryAppDefinitionResponse */ function galleryAppDefinitionResponseProvideDefaults(val: GalleryAppDefinitionResponse): GalleryAppDefinitionResponse; /** * The information of a highlighted file that user should pay attention to. */ interface HighlightedFileResponse { /** * The path of the highlighted file. */ path: string; /** * The name of sections to highlight. */ sections?: string[]; /** * A flag to save whether this file is viewed by user. */ visited?: boolean; } /** * highlightedFileResponseProvideDefaults sets the appropriate defaults for HighlightedFileResponse */ function highlightedFileResponseProvideDefaults(val: HighlightedFileResponse): HighlightedFileResponse; /** * The image validation result. */ interface ImageValidationResultsResponse { /** * The validation results of the image. */ results?: outputs.testbase.VerificationResultResponse[]; } /** * Specifies the baseline os and target os for in-place upgrade tests. */ interface InplaceUpgradeOSInfoResponse { /** * Specifies the baseline os for in-place upgrade tests. */ baselineOS?: outputs.testbase.OsPropertiesResponse; /** * Specifies the target os for in-place upgrade tests. */ targetOS?: string; } /** * The metadata of Intune enrollment. */ interface IntuneEnrollmentMetadataResponse { /** * The enrolled Intune apps. */ appList?: outputs.testbase.EnrolledIntuneAppResponse[]; /** * The id of the Intune enrollment credential. */ credentialId?: string; /** * The expected duration of Intune applications and policies deployment. */ expectedDeploymentDurationInMinute?: number; } /** * A notification event receivers. */ interface NotificationEventReceiverResponse { /** * The type of the notification event receiver. */ receiverType?: string; /** * The notification event receiver value. */ receiverValue?: outputs.testbase.NotificationReceiverValueResponse; } /** * A notification event receiver value. */ interface NotificationReceiverValueResponse { /** * The user object receiver value. */ distributionGroupListReceiverValue?: outputs.testbase.DistributionGroupListReceiverValueResponse; /** * The user object receiver value. */ subscriptionReceiverValue?: outputs.testbase.SubscriptionReceiverValueResponse; /** * The user object receiver value. */ userObjectReceiverValue?: outputs.testbase.UserObjectReceiverValueResponse; } /** * The properties of an operating system. */ interface OsPropertiesResponse { /** * The name of the custom image resource. */ customImageDisplayName: string; /** * Specify the referenced Test Base Custom Image Id if available. */ customImageId?: string; /** * The name of the OS. */ osName?: string; /** * The properties of the OS release. */ releaseProperties?: outputs.testbase.ReleasePropertiesResponse; } /** * The validation results. There's validation on package when it's created or updated. */ interface PackageValidationResultResponse { /** * Error information. */ errors: string[]; /** * Indicates whether the package passed the validation. */ isValid: boolean; /** * Validation name. */ validationName: string; } interface PreReleaseAccessRequestSpecResponse { city?: string; companyWebsite?: string; countryAndRegion?: string; email?: string; engagements?: string[]; organizationName?: string; stateOrProvince?: string; streetAddress?: string; zipCode?: string; } /** * The properties of an operating system release. */ interface ReleasePropertiesResponse { /** * The build number of the OS release. */ buildNumber?: string; /** * The build revision of the OS release. */ buildRevision?: string; /** * The name of the OS release. */ releaseName?: string; /** * The release version date of the OS release. */ releaseVersionDate?: string; } /** * The subscription role receiver value. */ interface SubscriptionReceiverValueResponse { /** * The role of the notification receiver. */ role?: string; /** * The subscription id of the notification receiver. */ subscriptionId?: string; /** * The subscription name of the notification receiver. */ subscriptionName?: string; } /** * Managed service identity (either system assigned, or none) */ interface SystemAssignedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (either system assigned, or none). */ type: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Specifies current state of tabs. */ interface TabStateResponse { /** * Current tab. */ currentTab?: string; /** * visited tabs. */ visitedTabs?: string[]; } /** * The information of the target OS to be tested. */ interface TargetOSInfoResponse { /** * Specifies the baseline OSs to be tested. */ baselineOSs?: string[]; /** * Insider Channel Ids. Only used for feature update. */ insiderChannelIds?: string[]; /** * Specifies the OS update type to test against, e.g., 'Security updates' or 'Feature updates'. */ osUpdateType: string; /** * Specifies the ids of the target OSs from Custom Images to be tested. */ targetOSImageIds?: string[]; /** * Specifies the target OSs to be tested. */ targetOSs?: string[]; } /** * Properties of the Test Base Account SKU Capability. */ interface TestBaseAccountSKUCapabilityResponse { /** * An invariant to describe the feature, such as 'SLA'. */ name: string; /** * An invariant if the feature is measured by quantity, such as 99.9%. */ value: string; } /** * Describes a Test Base Account SKU. */ interface TestBaseAccountSKUResponse { /** * The capabilities of a SKU. */ capabilities: outputs.testbase.TestBaseAccountSKUCapabilityResponse[]; /** * The locations that the SKU is available. */ locations?: string[]; /** * The name of the SKU. This is typically a letter + number code, such as B0 or S0. */ name: string; /** * The type of resource the SKU applies to. */ resourceType?: string; /** * The tier of this particular SKU. */ tier: string; } /** * The definition of a Test. */ interface TestResponse { /** * The commands used in the test. */ commands: outputs.testbase.CommandResponse[]; /** * Indicates if this test is active.It doesn't schedule test for not active Test. */ isActive?: boolean; /** * The type of the test. */ testType: string; /** * Resource identifier of the validation test result. */ validationResultId: string; /** * The status of the validation run of the package. */ validationRunStatus: string; } /** * The user object receiver value. */ interface UserObjectReceiverValueResponse { /** * user object ids. */ userObjectIds?: string[]; } /** * The detailed result of a validation or rule checking. */ interface VerificationResultResponse { /** * Message for clarification. */ message?: string; /** * Indicates if the validation or rule checking is passed. */ result: string; /** * The name of the verification rule. */ verificationName?: string; } } export declare namespace timeseriesinsights { /** * An object that contains the details about an environment's state. */ interface EnvironmentStateDetailsResponse { /** * Contains the code that represents the reason of an environment being in a particular state. Can be used to programmatically handle specific cases. */ code?: string; /** * A message that describes the state in detail. */ message?: string; } /** * An object that represents the status of the environment, and its internal state in the Time Series Insights service. */ interface EnvironmentStatusResponse { /** * An object that represents the status of ingress on an environment. */ ingress: outputs.timeseriesinsights.IngressEnvironmentStatusResponse; /** * An object that represents the status of warm storage on an environment. */ warmStorage: outputs.timeseriesinsights.WarmStorageEnvironmentStatusResponse; } /** * The storage configuration provides the non-secret connection details about the customer storage account that is used to store the environment's data. */ interface Gen2StorageConfigurationOutputResponse { /** * The name of the storage account that will hold the environment's Gen2 data. */ accountName: string; } /** * An object that represents the status of ingress on an environment. */ interface IngressEnvironmentStatusResponse { /** * This string represents the state of ingress operations on an environment. It can be "Disabled", "Ready", "Running", "Paused" or "Unknown" */ state?: string; /** * An object that contains the details about an environment's state. */ stateDetails: outputs.timeseriesinsights.EnvironmentStateDetailsResponse; } /** * An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events. */ interface LocalTimestampResponse { /** * An enum that represents the format of the local timestamp property that needs to be set. */ format?: string; /** * An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded. */ timeZoneOffset?: outputs.timeseriesinsights.LocalTimestampResponseTimeZoneOffset; } /** * An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded. */ interface LocalTimestampResponseTimeZoneOffset { /** * The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00) */ propertyName?: string; } /** * A key property for the reference data set. A reference data set can have multiple key properties. */ interface ReferenceDataSetKeyPropertyResponse { /** * The name of the key property. */ name?: string; /** * The type of the key property. */ type?: string; } /** * The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate. */ interface SkuResponse { /** * The capacity of the sku. For Gen1 environments, this value can be changed to support scale out of environments after they have been created. */ capacity: number; /** * The name of this SKU. */ name: string; } /** * The structure of the property that a time series id can have. An environment can have multiple such properties. */ interface TimeSeriesIdPropertyResponse { /** * The name of the property. */ name?: string; /** * The type of the property. */ type?: string; } /** * An object that represents the status of warm storage on an environment. */ interface WarmStorageEnvironmentStatusResponse { /** * A value that represents the number of properties used by the environment for S1/S2 SKU and number of properties used by Warm Store for PAYG SKU */ currentCount?: number; /** * A value that represents the maximum number of properties used allowed by the environment for S1/S2 SKU and maximum number of properties allowed by Warm Store for PAYG SKU. */ maxCount?: number; /** * This string represents the state of warm storage properties usage. It can be "Ok", "Error", "Unknown". */ state?: string; } /** * The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query. */ interface WarmStoreConfigurationPropertiesResponse { /** * ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store. */ dataRetention: string; } } export declare namespace trafficmanager { /** * Class containing DNS settings in a Traffic Manager profile. */ interface DnsConfigResponse { /** * The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of the RelativeName with the DNS domain used by Azure Traffic Manager. */ fqdn: string; /** * The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile. */ relativeName?: string; /** * The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS responses provided by this Traffic Manager profile. */ ttl?: number; } /** * Custom header name and value. */ interface EndpointPropertiesCustomHeadersItemResponse { /** * Header name. */ name?: string; /** * Header value. */ value?: string; } /** * Subnet first address, scope, and/or last address. */ interface EndpointPropertiesSubnetsItemResponse { /** * First address in the subnet. */ first?: string; /** * Last address in the subnet. */ last?: string; /** * Block size (number of leading bits in the subnet mask). */ scope?: number; } /** * Class representing a Traffic Manager endpoint. */ interface EndpointResponse { /** * If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in the traffic routing method. */ alwaysServe?: string; /** * List of custom headers. */ customHeaders?: outputs.trafficmanager.EndpointPropertiesCustomHeadersItemResponse[]; /** * Specifies the location of the external or nested endpoints when using the 'Performance' traffic routing method. */ endpointLocation?: string; /** * The monitoring status of the endpoint. */ endpointMonitorStatus?: string; /** * The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included in the traffic routing method. */ endpointStatus?: string; /** * The list of countries/regions mapped to this endpoint when using the 'Geographic' traffic routing method. Please consult Traffic Manager Geographic documentation for a full list of accepted values. */ geoMapping?: string[]; /** * Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} */ id?: string; /** * The minimum number of endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'. */ minChildEndpoints?: number; /** * The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'. */ minChildEndpointsIPv4?: number; /** * The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child profile in order for the parent profile to be considered available. Only applicable to endpoint of type 'NestedEndpoints'. */ minChildEndpointsIPv6?: number; /** * The name of the resource */ name?: string; /** * The priority of this endpoint when using the 'Priority' traffic routing method. Possible values are from 1 to 1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all endpoints, and no two endpoints can share the same priority value. */ priority?: number; /** * The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the 'Subnet' traffic routing method. An empty list will match all ranges not covered by other endpoints. */ subnets?: outputs.trafficmanager.EndpointPropertiesSubnetsItemResponse[]; /** * The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses to direct traffic to this endpoint. */ target?: string; /** * The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type 'ExternalEndpoints'. */ targetResourceId?: string; /** * The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. */ type?: string; /** * The weight of this endpoint when using the 'Weighted' traffic routing method. Possible values are from 1 to 1000. */ weight?: number; } /** * Custom header name and value. */ interface MonitorConfigCustomHeadersItemResponse { /** * Header name. */ name?: string; /** * Header value. */ value?: string; } /** * Min and max value of a status code range. */ interface MonitorConfigExpectedStatusCodeRangesItemResponse { /** * Max status code. */ max?: number; /** * Min status code. */ min?: number; } /** * Class containing endpoint monitoring settings in a Traffic Manager profile. */ interface MonitorConfigResponse { /** * List of custom headers. */ customHeaders?: outputs.trafficmanager.MonitorConfigCustomHeadersItemResponse[]; /** * List of expected status code ranges. */ expectedStatusCodeRanges?: outputs.trafficmanager.MonitorConfigExpectedStatusCodeRangesItemResponse[]; /** * The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager will check the health of each endpoint in this profile. */ intervalInSeconds?: number; /** * The path relative to the endpoint domain name used to probe for endpoint health. */ path?: string; /** * The TCP port used to probe for endpoint health. */ port?: number; /** * The profile-level monitoring status of the Traffic Manager profile. */ profileMonitorStatus?: string; /** * The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. */ protocol?: string; /** * The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows endpoints in this profile to response to the health check. */ timeoutInSeconds?: number; /** * The number of consecutive failed health check that Traffic Manager tolerates before declaring an endpoint in this profile Degraded after the next failed health check. */ toleratedNumberOfFailures?: number; } } export declare namespace verifiedid { /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace videoindexer { /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.videoindexer.UserAssignedIdentityResponse; }; } /** * The private endpoint resource. */ interface PrivateEndpointResponse { /** * The ARM identifier for private endpoint. */ id: string; } /** * A collection of information about the state of the connection between service consumer and provider. */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * The storage services details */ interface StorageServicesForPutRequestResponse { /** * The storage services resource id */ resourceId?: string; /** * The user assigned identity to be used to grant permissions */ userAssignedIdentity?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } } export declare namespace virtualmachineimages { /** * Generates version number that will be latest based on existing version numbers. */ interface DistributeVersionerLatestResponse { /** * Major version for the generated version number. Determine what is "latest" based on versions with this value as the major version. -1 is equivalent to leaving it unset. */ major?: number; /** * Version numbering scheme to be used. * Expected value is 'Latest'. */ scheme: "Latest"; } /** * distributeVersionerLatestResponseProvideDefaults sets the appropriate defaults for DistributeVersionerLatestResponse */ function distributeVersionerLatestResponseProvideDefaults(val: DistributeVersionerLatestResponse): DistributeVersionerLatestResponse; /** * Generates version number based on version number of source image */ interface DistributeVersionerSourceResponse { /** * Version numbering scheme to be used. * Expected value is 'Source'. */ scheme: "Source"; } /** * Indicates if the image template needs to be built on create/update */ interface ImageTemplateAutoRunResponse { /** * Enabling this field will trigger an automatic build on image template creation or update. */ state?: string; } /** * Uploads files to VMs (Linux, Windows). Corresponds to Packer file provisioner */ interface ImageTemplateFileCustomizerResponse { /** * The absolute path to a file (with nested directory structures already created) where the file (from sourceUri) will be uploaded to in the VM */ destination?: string; /** * Friendly Name to provide context on what this customization step does */ name?: string; /** * SHA256 checksum of the file provided in the sourceUri field above */ sha256Checksum?: string; /** * The URI of the file to be uploaded for customizing the VM. It can be a github link, SAS URI for Azure Storage, etc */ sourceUri?: string; /** * The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer * Expected value is 'File'. */ type: "File"; } /** * imageTemplateFileCustomizerResponseProvideDefaults sets the appropriate defaults for ImageTemplateFileCustomizerResponse */ function imageTemplateFileCustomizerResponseProvideDefaults(val: ImageTemplateFileCustomizerResponse): ImageTemplateFileCustomizerResponse; /** * Uploads files required for validation to VMs (Linux, Windows). Corresponds to Packer file provisioner */ interface ImageTemplateFileValidatorResponse { /** * The absolute path to a file (with nested directory structures already created) where the file (from sourceUri) will be uploaded to in the VM */ destination?: string; /** * Friendly Name to provide context on what this validation step does */ name?: string; /** * SHA256 checksum of the file provided in the sourceUri field above */ sha256Checksum?: string; /** * The URI of the file to be uploaded to the VM for validation. It can be a github link, Azure Storage URI (authorized or SAS), etc */ sourceUri?: string; /** * The type of validation you want to use on the Image. For example, "Shell" can be shell validation * Expected value is 'File'. */ type: "File"; } /** * imageTemplateFileValidatorResponseProvideDefaults sets the appropriate defaults for ImageTemplateFileValidatorResponse */ function imageTemplateFileValidatorResponseProvideDefaults(val: ImageTemplateFileValidatorResponse): ImageTemplateFileValidatorResponse; /** * Identity for the image template. */ interface ImageTemplateIdentityResponse { /** * The type of identity used for the image template. The type 'None' will remove any identities from the image template. */ type?: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.virtualmachineimages.UserAssignedIdentityResponse; }; } /** * Describes the latest status of running an image template */ interface ImageTemplateLastRunStatusResponse { /** * End time of the last run (UTC) */ endTime?: string; /** * Verbose information about the last run state */ message?: string; /** * State of the last run */ runState?: string; /** * Sub-state of the last run */ runSubState?: string; /** * Start time of the last run (UTC) */ startTime?: string; } /** * Distribute as a Managed Disk Image. */ interface ImageTemplateManagedImageDistributorResponse { /** * Tags that will be applied to the artifact once it has been created/updated by the distributor. */ artifactTags?: { [key: string]: string; }; /** * Resource Id of the Managed Disk Image */ imageId: string; /** * Azure location for the image, should match if image already exists */ location: string; /** * The name to be used for the associated RunOutput. */ runOutputName: string; /** * Type of distribution. * Expected value is 'ManagedImage'. */ type: "ManagedImage"; } /** * Describes an image source that is a managed image in customer subscription. This image must reside in the same subscription and region as the Image Builder template. */ interface ImageTemplateManagedImageSourceResponse { /** * ARM resource id of the managed image in customer subscription */ imageId: string; /** * Specifies the type of source image you want to start with. * Expected value is 'ManagedImage'. */ type: "ManagedImage"; } /** * Describes an image source from [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages). */ interface ImageTemplatePlatformImageSourceResponse { /** * Image version from the [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages). This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'. */ exactVersion: string; /** * Image offer from the [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages). */ offer?: string; /** * Optional configuration of purchase plan for platform image. */ planInfo?: outputs.virtualmachineimages.PlatformImagePurchasePlanResponse; /** * Image Publisher in [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages). */ publisher?: string; /** * Image sku from the [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages). */ sku?: string; /** * Specifies the type of source image you want to start with. * Expected value is 'PlatformImage'. */ type: "PlatformImage"; /** * Image version from the [Azure Gallery Images](https://docs.microsoft.com/en-us/rest/api/compute/virtualmachineimages). If 'latest' is specified here, the version is evaluated when the image build takes place, not when the template is submitted. */ version?: string; } /** * Runs the specified PowerShell on the VM (Windows). Corresponds to Packer powershell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified. */ interface ImageTemplatePowerShellCustomizerResponse { /** * Array of PowerShell commands to execute */ inline?: string[]; /** * Friendly Name to provide context on what this customization step does */ name?: string; /** * If specified, the PowerShell script will be run with elevated privileges using the Local System user. Can only be true when the runElevated field above is set to true. */ runAsSystem?: boolean; /** * If specified, the PowerShell script will be run with elevated privileges */ runElevated?: boolean; /** * URI of the PowerShell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc */ scriptUri?: string; /** * SHA256 checksum of the power shell script provided in the scriptUri field above */ sha256Checksum?: string; /** * The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer * Expected value is 'PowerShell'. */ type: "PowerShell"; /** * Valid exit codes for the PowerShell script. [Default: 0] */ validExitCodes?: number[]; } /** * imageTemplatePowerShellCustomizerResponseProvideDefaults sets the appropriate defaults for ImageTemplatePowerShellCustomizerResponse */ function imageTemplatePowerShellCustomizerResponseProvideDefaults(val: ImageTemplatePowerShellCustomizerResponse): ImageTemplatePowerShellCustomizerResponse; /** * Runs the specified PowerShell script during the validation phase (Windows). Corresponds to Packer powershell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified. */ interface ImageTemplatePowerShellValidatorResponse { /** * Array of PowerShell commands to execute */ inline?: string[]; /** * Friendly Name to provide context on what this validation step does */ name?: string; /** * If specified, the PowerShell script will be run with elevated privileges using the Local System user. Can only be true when the runElevated field above is set to true. */ runAsSystem?: boolean; /** * If specified, the PowerShell script will be run with elevated privileges */ runElevated?: boolean; /** * URI of the PowerShell script to be run for validation. It can be a github link, Azure Storage URI, etc */ scriptUri?: string; /** * SHA256 checksum of the power shell script provided in the scriptUri field above */ sha256Checksum?: string; /** * The type of validation you want to use on the Image. For example, "Shell" can be shell validation * Expected value is 'PowerShell'. */ type: "PowerShell"; /** * Valid exit codes for the PowerShell script. [Default: 0] */ validExitCodes?: number[]; } /** * imageTemplatePowerShellValidatorResponseProvideDefaults sets the appropriate defaults for ImageTemplatePowerShellValidatorResponse */ function imageTemplatePowerShellValidatorResponseProvideDefaults(val: ImageTemplatePowerShellValidatorResponse): ImageTemplatePowerShellValidatorResponse; /** * Error handling options upon a build failure */ interface ImageTemplatePropertiesResponseErrorHandling { /** * If there is a customizer error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a customizer error and this field is set to 'abort', the build VM will be preserved. */ onCustomizerError?: string; /** * If there is a validation error and this field is set to 'cleanup', the build VM and associated network resources will be cleaned up. This is the default behavior. If there is a validation error and this field is set to 'abort', the build VM will be preserved. */ onValidationError?: string; } /** * imageTemplatePropertiesResponseErrorHandlingProvideDefaults sets the appropriate defaults for ImageTemplatePropertiesResponseErrorHandling */ function imageTemplatePropertiesResponseErrorHandlingProvideDefaults(val: ImageTemplatePropertiesResponseErrorHandling): ImageTemplatePropertiesResponseErrorHandling; /** * Specifies optimization to be performed on image. */ interface ImageTemplatePropertiesResponseOptimize { /** * Optimization is applied on the image for a faster VM boot. */ vmBoot?: outputs.virtualmachineimages.ImageTemplatePropertiesResponseVmBoot; } /** * Configuration options and list of validations to be performed on the resulting image. */ interface ImageTemplatePropertiesResponseValidate { /** * If validation fails and this field is set to false, output image(s) will not be distributed. This is the default behavior. If validation fails and this field is set to true, output image(s) will still be distributed. Please use this option with caution as it may result in bad images being distributed for use. In either case (true or false), the end to end image run will be reported as having failed in case of a validation failure. [Note: This field has no effect if validation succeeds.] */ continueDistributeOnFailure?: boolean; /** * List of validations to be performed. */ inVMValidations?: (outputs.virtualmachineimages.ImageTemplateFileValidatorResponse | outputs.virtualmachineimages.ImageTemplatePowerShellValidatorResponse | outputs.virtualmachineimages.ImageTemplateShellValidatorResponse)[]; /** * If this field is set to true, the image specified in the 'source' section will directly be validated. No separate build will be run to generate and then validate a customized image. */ sourceValidationOnly?: boolean; } /** * imageTemplatePropertiesResponseValidateProvideDefaults sets the appropriate defaults for ImageTemplatePropertiesResponseValidate */ function imageTemplatePropertiesResponseValidateProvideDefaults(val: ImageTemplatePropertiesResponseValidate): ImageTemplatePropertiesResponseValidate; /** * Optimization is applied on the image for a faster VM boot. */ interface ImageTemplatePropertiesResponseVmBoot { /** * Enabling this field will improve VM boot time by optimizing the final customized image output. */ state?: string; } /** * Reboots a VM and waits for it to come back online (Windows). Corresponds to Packer windows-restart provisioner */ interface ImageTemplateRestartCustomizerResponse { /** * Friendly Name to provide context on what this customization step does */ name?: string; /** * Command to check if restart succeeded [Default: ''] */ restartCheckCommand?: string; /** * Command to execute the restart [Default: 'shutdown /r /f /t 0 /c "packer restart"'] */ restartCommand?: string; /** * Restart timeout specified as a string of magnitude and unit, e.g. '5m' (5 minutes) or '2h' (2 hours) [Default: '5m'] */ restartTimeout?: string; /** * The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer * Expected value is 'WindowsRestart'. */ type: "WindowsRestart"; } /** * Distribute via Azure Compute Gallery. */ interface ImageTemplateSharedImageDistributorResponse { /** * Tags that will be applied to the artifact once it has been created/updated by the distributor. */ artifactTags?: { [key: string]: string; }; /** * Flag that indicates whether created image version should be excluded from latest. Omit to use the default (false). */ excludeFromLatest?: boolean; /** * Resource Id of the Azure Compute Gallery image */ galleryImageId: string; /** * [Deprecated] A list of regions that the image will be replicated to. This list can be specified only if targetRegions is not specified. This field is deprecated - use targetRegions instead. */ replicationRegions?: string[]; /** * The name to be used for the associated RunOutput. */ runOutputName: string; /** * [Deprecated] Storage account type to be used to store the shared image. Omit to use the default (Standard_LRS). This field can be specified only if replicationRegions is specified. This field is deprecated - use targetRegions instead. */ storageAccountType?: string; /** * The target regions where the distributed Image Version is going to be replicated to. This object supersedes replicationRegions and can be specified only if replicationRegions is not specified. */ targetRegions?: outputs.virtualmachineimages.TargetRegionResponse[]; /** * Type of distribution. * Expected value is 'SharedImage'. */ type: "SharedImage"; /** * Describes how to generate new x.y.z version number for distribution. */ versioning?: outputs.virtualmachineimages.DistributeVersionerLatestResponse | outputs.virtualmachineimages.DistributeVersionerSourceResponse; } /** * imageTemplateSharedImageDistributorResponseProvideDefaults sets the appropriate defaults for ImageTemplateSharedImageDistributorResponse */ function imageTemplateSharedImageDistributorResponseProvideDefaults(val: ImageTemplateSharedImageDistributorResponse): ImageTemplateSharedImageDistributorResponse; /** * Describes an image source that is an image version in an Azure Compute Gallery or a Direct Shared Gallery. */ interface ImageTemplateSharedImageVersionSourceResponse { /** * Exact ARM resource id of the image version. This readonly field differs from the image version Id in 'imageVersionId' only if the version name specified in 'imageVersionId' field is 'latest'. */ exactVersion: string; /** * ARM resource id of the image version. When image version name is 'latest', the version is evaluated when the image build takes place. */ imageVersionId: string; /** * Specifies the type of source image you want to start with. * Expected value is 'SharedImageVersion'. */ type: "SharedImageVersion"; } /** * Runs a shell script during the customization phase (Linux). Corresponds to Packer shell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified. */ interface ImageTemplateShellCustomizerResponse { /** * Array of shell commands to execute */ inline?: string[]; /** * Friendly Name to provide context on what this customization step does */ name?: string; /** * URI of the shell script to be run for customizing. It can be a github link, SAS URI for Azure Storage, etc */ scriptUri?: string; /** * SHA256 checksum of the shell script provided in the scriptUri field */ sha256Checksum?: string; /** * The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer * Expected value is 'Shell'. */ type: "Shell"; } /** * imageTemplateShellCustomizerResponseProvideDefaults sets the appropriate defaults for ImageTemplateShellCustomizerResponse */ function imageTemplateShellCustomizerResponseProvideDefaults(val: ImageTemplateShellCustomizerResponse): ImageTemplateShellCustomizerResponse; /** * Runs the specified shell script during the validation phase (Linux). Corresponds to Packer shell provisioner. Exactly one of 'scriptUri' or 'inline' can be specified. */ interface ImageTemplateShellValidatorResponse { /** * Array of shell commands to execute */ inline?: string[]; /** * Friendly Name to provide context on what this validation step does */ name?: string; /** * URI of the shell script to be run for validation. It can be a github link, Azure Storage URI, etc */ scriptUri?: string; /** * SHA256 checksum of the shell script provided in the scriptUri field */ sha256Checksum?: string; /** * The type of validation you want to use on the Image. For example, "Shell" can be shell validation * Expected value is 'Shell'. */ type: "Shell"; } /** * imageTemplateShellValidatorResponseProvideDefaults sets the appropriate defaults for ImageTemplateShellValidatorResponse */ function imageTemplateShellValidatorResponseProvideDefaults(val: ImageTemplateShellValidatorResponse): ImageTemplateShellValidatorResponse; /** * Distribute via VHD in a storage account. */ interface ImageTemplateVhdDistributorResponse { /** * Tags that will be applied to the artifact once it has been created/updated by the distributor. */ artifactTags?: { [key: string]: string; }; /** * The name to be used for the associated RunOutput. */ runOutputName: string; /** * Type of distribution. * Expected value is 'VHD'. */ type: "VHD"; /** * Optional Azure Storage URI for the distributed VHD blob. Omit to use the default (empty string) in which case VHD would be published to the storage account in the staging resource group. */ uri?: string; } /** * Describes the virtual machines used to build and validate images */ interface ImageTemplateVmProfileResponse { /** * Size of the OS disk in GB. Omit or specify 0 to use Azure's default OS disk size. */ osDiskSizeGB?: number; /** * Optional array of resource IDs of user assigned managed identities to be configured on the build VM and validation VM. This may include the identity of the image template. */ userAssignedIdentities?: string[]; /** * Size of the virtual machine used to build, customize and capture images. Omit or specify empty string to use the default (Standard_D1_v2 for Gen1 images and Standard_D2ds_v4 for Gen2 images). */ vmSize?: string; /** * Optional configuration of the virtual network to use to deploy the build VM and validation VM in. Omit if no specific virtual network needs to be used. */ vnetConfig?: outputs.virtualmachineimages.VirtualNetworkConfigResponse; } /** * imageTemplateVmProfileResponseProvideDefaults sets the appropriate defaults for ImageTemplateVmProfileResponse */ function imageTemplateVmProfileResponseProvideDefaults(val: ImageTemplateVmProfileResponse): ImageTemplateVmProfileResponse; /** * Installs Windows Updates. Corresponds to Packer Windows Update Provisioner (https://github.com/rgl/packer-provisioner-windows-update) */ interface ImageTemplateWindowsUpdateCustomizerResponse { /** * Array of filters to select updates to apply. Omit or specify empty array to use the default (no filter). Refer to above link for examples and detailed description of this field. */ filters?: string[]; /** * Friendly Name to provide context on what this customization step does */ name?: string; /** * Criteria to search updates. Omit or specify empty string to use the default (search all). Refer to above link for examples and detailed description of this field. */ searchCriteria?: string; /** * The type of customization tool you want to use on the Image. For example, "Shell" can be shell customizer * Expected value is 'WindowsUpdate'. */ type: "WindowsUpdate"; /** * Maximum number of updates to apply at a time. Omit or specify 0 to use the default (1000) */ updateLimit?: number; } /** * imageTemplateWindowsUpdateCustomizerResponseProvideDefaults sets the appropriate defaults for ImageTemplateWindowsUpdateCustomizerResponse */ function imageTemplateWindowsUpdateCustomizerResponseProvideDefaults(val: ImageTemplateWindowsUpdateCustomizerResponse): ImageTemplateWindowsUpdateCustomizerResponse; /** * Purchase plan configuration for platform image. */ interface PlatformImagePurchasePlanResponse { /** * Name of the purchase plan. */ planName: string; /** * Product of the purchase plan. */ planProduct: string; /** * Publisher of the purchase plan. */ planPublisher: string; } /** * Describes the error happened when create or update an image template */ interface ProvisioningErrorResponse { /** * Verbose error message about the provisioning failure */ message?: string; /** * Error code of the provisioning failure */ provisioningErrorCode?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Describes the target region information. */ interface TargetRegionResponse { /** * The name of the region. */ name: string; /** * The number of replicas of the Image Version to be created in this region. Omit to use the default (1). */ replicaCount?: number; /** * Specifies the storage account type to be used to store the image in this region. Omit to use the default (Standard_LRS). */ storageAccountType?: string; } /** * targetRegionResponseProvideDefaults sets the appropriate defaults for TargetRegionResponse */ function targetRegionResponseProvideDefaults(val: TargetRegionResponse): TargetRegionResponse; /** * Describes the status of a trigger */ interface TriggerStatusResponse { /** * The status code. */ code: string; /** * The detailed status message, including for alerts and error messages. */ message: string; /** * The time of the status. */ time: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * Virtual Network configuration. */ interface VirtualNetworkConfigResponse { /** * Resource id of a pre-existing subnet on which Azure Container Instance will be deployed for Isolated Builds. This field may be specified only if `subnetId` is also specified and must be on the same Virtual Network as the subnet specified in `subnetId`. */ containerInstanceSubnetId?: string; /** * Size of the proxy virtual machine used to pass traffic to the build VM and validation VM. This must not be specified if `containerInstanceSubnetId` is specified because no proxy virtual machine is deployed in that case. Omit or specify empty string to use the default (Standard_A1_v2). */ proxyVmSize?: string; /** * Resource id of a pre-existing subnet on which the build VM and validation VM will be deployed */ subnetId?: string; } /** * virtualNetworkConfigResponseProvideDefaults sets the appropriate defaults for VirtualNetworkConfigResponse */ function virtualNetworkConfigResponseProvideDefaults(val: VirtualNetworkConfigResponse): VirtualNetworkConfigResponse; } export declare namespace vmwarecloudsimple { /** * Properties of dedicated cloud node */ interface DedicatedCloudNodePropertiesResponse { /** * Availability Zone id, e.g. "az1" */ availabilityZoneId: string; /** * Availability Zone name, e.g. "Availability Zone 1" */ availabilityZoneName: string; /** * VMWare Cloud Rack Name */ cloudRackName: string; /** * date time the resource was created */ created: string; /** * SKU's id */ id: string; /** * SKU's name */ name: string; /** * count of nodes to create */ nodesCount: number; /** * Placement Group id, e.g. "n1" */ placementGroupId: string; /** * Placement Name, e.g. "Placement Group 1" */ placementGroupName: string; /** * Private Cloud Id */ privateCloudId: string; /** * Resource Pool Name */ privateCloudName: string; /** * The provisioning status of the resource */ provisioningState: string; /** * purchase id */ purchaseId: string; /** * Node status, indicates is private cloud set up on this node or not */ status: string; /** * VMWare Cluster Name */ vmwareClusterName: string; } /** * Guest OS Customization properties */ interface GuestOSCustomizationResponse { /** * List of dns servers to use */ dnsServers?: string[]; /** * Virtual Machine hostname */ hostName?: string; /** * Password for login */ password?: string; /** * id of customization policy */ policyId?: string; /** * Username for login */ username?: string; } /** * Guest OS nic customization */ interface GuestOSNICCustomizationResponse { /** * IP address allocation method */ allocation?: string; /** * List of dns servers to use */ dnsServers?: string[]; /** * Gateway addresses assigned to nic */ gateway?: string[]; /** * Static ip address for nic */ ipAddress?: string; /** * Network mask for nic */ mask?: string; /** * primary WINS server for Windows */ primaryWinsServer?: string; /** * secondary WINS server for Windows */ secondaryWinsServer?: string; } /** * Resource pool model */ interface ResourcePoolResponse { /** * Hierarchical resource pool name */ fullName: string; /** * resource pool id (privateCloudId:vsphereId) */ id: string; /** * Azure region */ location: string; /** * {ResourcePoolName} */ name: string; /** * The Private Cloud Id */ privateCloudId: string; /** * {resourceProviderNamespace}/{resourceType} */ type: string; } /** * The purchase SKU for CloudSimple paid resources */ interface SkuResponse { /** * The capacity of the SKU */ capacity?: string; /** * dedicatedCloudNode example: 8 x Ten-Core Intel® Xeon® Processor E5-2640 v4 2.40GHz 25MB Cache (90W); 12 x 64GB PC4-19200 2400MHz DDR4 ECC Registered DIMM, ... */ description?: string; /** * If the service has different generations of hardware, for the same SKU, then that can be captured here */ family?: string; /** * The name of the SKU for VMWare CloudSimple Node */ name: string; /** * The tier of the SKU */ tier?: string; } /** * Virtual disk controller model */ interface VirtualDiskControllerResponse { /** * Controller's id */ id: string; /** * The display name of Controller */ name: string; /** * dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) */ subType: string; /** * disk controller type (SCSI) */ type: string; } /** * Virtual disk model */ interface VirtualDiskResponse { /** * Disk's Controller id */ controllerId: string; /** * Disk's independence mode type */ independenceMode: string; /** * Disk's total size */ totalSize: number; /** * Disk's id */ virtualDiskId?: string; /** * Disk's display name */ virtualDiskName: string; } /** * Virtual network model */ interface VirtualNetworkResponse { /** * can be used in vm creation/deletion */ assignable: boolean; /** * virtual network id (privateCloudId:vsphereId) */ id: string; /** * Azure region */ location: string; /** * {VirtualNetworkName} */ name: string; /** * The Private Cloud id */ privateCloudId: string; /** * {resourceProviderNamespace}/{resourceType} */ type: string; } /** * Virtual NIC model */ interface VirtualNicResponse { /** * guest OS customization for nic */ customization?: outputs.vmwarecloudsimple.GuestOSNICCustomizationResponse; /** * NIC ip address */ ipAddresses?: string[]; /** * NIC MAC address */ macAddress?: string; /** * Virtual Network */ network: outputs.vmwarecloudsimple.VirtualNetworkResponse; /** * NIC type */ nicType: string; /** * Is NIC powered on/off on boot */ powerOnBoot?: boolean; /** * NIC id */ virtualNicId?: string; /** * NIC name */ virtualNicName: string; } } export declare namespace web { /** * The properties of an AI gateway. */ interface AiGatewayPropertiesResponse { /** * The description of the resource. */ aiGatewayId: string; } /** * The configuration settings of the Allowed Audiences validation flow. */ interface AllowedAudiencesValidationResponse { /** * The configuration settings of the allowed list of audiences from which to validate the JWT token. */ allowedAudiences?: string[]; } /** * The configuration settings of the Azure Active Directory allowed principals. */ interface AllowedPrincipalsResponse { /** * The list of the allowed groups. */ groups?: string[]; /** * The list of the allowed identities. */ identities?: string[]; } interface ApiConnectionDefinitionResponseProperties { api?: outputs.web.ApiReferenceResponse; /** * Timestamp of last connection change */ changedTime?: string; /** * Timestamp of the connection creation */ createdTime?: string; /** * Dictionary of custom parameter values */ customParameterValues?: { [key: string]: string; }; /** * Display name */ displayName?: string; /** * Dictionary of nonsecret parameter values */ nonSecretParameterValues?: { [key: string]: string; }; /** * Dictionary of parameter values */ parameterValues?: { [key: string]: string; }; /** * Status of the connection */ statuses?: outputs.web.ConnectionStatusDefinitionResponse[]; /** * Links to test the API connection */ testLinks?: outputs.web.ApiConnectionTestLinkResponse[]; } /** * API connection properties */ interface ApiConnectionTestLinkResponse { /** * HTTP Method */ method?: string; /** * Test link request URI */ requestUri?: string; } /** * Information about the formal API definition for the app. */ interface ApiDefinitionInfoResponse { /** * The URL of the API definition. */ url?: string; } /** * Azure API management (APIM) configuration linked to the app. */ interface ApiManagementConfigResponse { /** * APIM-Api Identifier. */ id?: string; } /** * OAuth settings for the API */ interface ApiOAuthSettingsParameterResponse { /** * Options available to this parameter */ options?: any; /** * UI definitions per culture as caller can specify the culture */ uiDefinition?: any; /** * Value of the setting */ value?: string; } /** * OAuth settings for the connection provider */ interface ApiOAuthSettingsResponse { /** * Resource provider client id */ clientId?: string; /** * Client Secret needed for OAuth */ clientSecret?: string; /** * OAuth parameters key is the name of parameter */ customParameters?: { [key: string]: outputs.web.ApiOAuthSettingsParameterResponse; }; /** * Identity provider */ identityProvider?: string; /** * Read only properties for this oauth setting. */ properties?: any; /** * Url */ redirectUrl?: string; /** * OAuth scopes */ scopes?: string[]; } interface ApiReferenceResponse { /** * Brand color */ brandColor?: string; /** * The custom API description */ description?: string; /** * The display name */ displayName?: string; /** * The icon URI */ iconUri?: string; /** * Resource reference id */ id?: string; /** * The name of the API */ name?: string; /** * The JSON representation of the swagger */ swagger?: any; /** * Resource reference type */ type?: string; } /** * The API backend service */ interface ApiResourceBackendServiceResponse { /** * The service URL */ serviceUrl?: string; } /** * API Definitions */ interface ApiResourceDefinitionsResponse { /** * The modified swagger URL */ modifiedSwaggerUrl?: string; /** * The original swagger URL */ originalSwaggerUrl?: string; } interface AppLogsConfigurationResponse { destination?: string; logAnalyticsConfiguration?: outputs.web.LogAnalyticsConfigurationResponse; } /** * The configuration settings of the app registration for providers that have app ids and app secrets */ interface AppRegistrationResponse { /** * The App ID of the app used for login. */ appId?: string; /** * The app setting name that contains the app secret. */ appSecretSettingName?: string; } /** * The configuration settings of the registration for the Apple provider */ interface AppleRegistrationResponse { /** * The Client ID of the app used for login. */ clientId?: string; /** * The app setting name that contains the client secret. */ clientSecretSettingName?: string; } /** * The configuration settings of the Apple provider. */ interface AppleResponse { /** * false if the Apple provider should not be enabled despite the set registration; otherwise, true. */ enabled?: boolean; /** * The configuration settings of the login flow. */ login?: outputs.web.LoginScopesResponse; /** * The configuration settings of the Apple registration. */ registration?: outputs.web.AppleRegistrationResponse; } /** * Application logs configuration. */ interface ApplicationLogsConfigResponse { /** * Application logs to blob storage configuration. */ azureBlobStorage?: outputs.web.AzureBlobStorageApplicationLogsConfigResponse; /** * Application logs to azure table storage configuration. */ azureTableStorage?: outputs.web.AzureTableStorageApplicationLogsConfigResponse; /** * Application logs to file system configuration. */ fileSystem?: outputs.web.FileSystemApplicationLogsConfigResponse; } /** * applicationLogsConfigResponseProvideDefaults sets the appropriate defaults for ApplicationLogsConfigResponse */ function applicationLogsConfigResponseProvideDefaults(val: ApplicationLogsConfigResponse): ApplicationLogsConfigResponse; interface ArcConfigurationResponse { artifactStorageAccessMode?: string; artifactStorageClassName?: string; artifactStorageMountPath?: string; artifactStorageNodeName?: string; artifactsStorageType?: string; frontEndServiceConfiguration?: outputs.web.FrontEndConfigurationResponse; } /** * A wrapper for an ARM resource id */ interface ArmIdWrapperResponse { id: string; } /** * The plan object in Azure Resource Manager, represents a marketplace plan. */ interface ArmPlanResponse { /** * The name. */ name?: string; /** * The product. */ product?: string; /** * The promotion code. */ promotionCode?: string; /** * The publisher. */ publisher?: string; /** * Version of product. */ version?: string; } /** * Full view of networking configuration for an ASE. */ interface AseV3NetworkingConfigurationResponse { /** * Property to enable and disable new private endpoint connection creation on ASE */ allowNewPrivateEndpointConnections?: boolean; externalInboundIpAddresses: string[]; /** * Property to enable and disable FTP on ASEV3 */ ftpEnabled?: boolean; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * Customer provided Inbound IP Address. Only able to be set on Ase create. */ inboundIpAddressOverride?: string; internalInboundIpAddresses: string[]; /** * Kind of resource. */ kind?: string; linuxOutboundIpAddresses: string[]; /** * The name of the resource */ name: string; /** * Property to enable and disable Remote Debug on ASEV3 */ remoteDebugEnabled?: boolean; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.web.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; windowsOutboundIpAddresses: string[]; } /** * The configuration settings of the platform of App Service Authentication/Authorization. */ interface AuthPlatformResponse { /** * The path of the config file containing auth settings if they come from a file. * If the path is relative, base will the site's root directory. */ configFilePath?: string; /** * true if the Authentication / Authorization feature is enabled for the current app; otherwise, false. */ enabled?: boolean; /** * The RuntimeVersion of the Authentication / Authorization feature in use for the current app. * The setting in this value can control the behavior of certain features in the Authentication / Authorization module. */ runtimeVersion?: string; } /** * Actions which to take by the auto-heal module when a rule is triggered. */ interface AutoHealActionsResponse { /** * Predefined action to be taken. */ actionType?: string; /** * Custom action to be taken. */ customAction?: outputs.web.AutoHealCustomActionResponse; /** * Minimum time the process must execute * before taking the action */ minProcessExecutionTime?: string; } /** * Custom action to be executed * when an auto heal rule is triggered. */ interface AutoHealCustomActionResponse { /** * Executable to be run. */ exe?: string; /** * Parameters for the executable. */ parameters?: string; } /** * Rules that can be defined for auto-heal. */ interface AutoHealRulesResponse { /** * Actions to be executed when a rule is triggered. */ actions?: outputs.web.AutoHealActionsResponse; /** * Conditions that describe when to execute the auto-heal actions. */ triggers?: outputs.web.AutoHealTriggersResponse; } /** * Triggers for auto-heal. */ interface AutoHealTriggersResponse { /** * A rule based on private bytes. */ privateBytesInKB?: number; /** * A rule based on total requests. */ requests?: outputs.web.RequestsBasedTriggerResponse; /** * A rule based on request execution time. */ slowRequests?: outputs.web.SlowRequestsBasedTriggerResponse; /** * A rule based on multiple Slow Requests Rule with path */ slowRequestsWithPath?: outputs.web.SlowRequestsBasedTriggerResponse[]; /** * A rule based on status codes. */ statusCodes?: outputs.web.StatusCodesBasedTriggerResponse[]; /** * A rule based on status codes ranges. */ statusCodesRange?: outputs.web.StatusCodesRangeBasedTriggerResponse[]; } /** * The configuration settings of the Azure Active Directory login flow. */ interface AzureActiveDirectoryLoginResponse { /** * true if the www-authenticate provider should be omitted from the request; otherwise, false. */ disableWWWAuthenticate?: boolean; /** * Login parameters to send to the OpenID Connect authorization endpoint when * a user logs in. Each parameter must be in the form "key=value". */ loginParameters?: string[]; } /** * The configuration settings of the Azure Active Directory app registration. */ interface AzureActiveDirectoryRegistrationResponse { /** * The Client ID of this relying party application, known as the client_id. * This setting is required for enabling OpenID Connection authentication with Azure Active Directory or * other 3rd party OpenID Connect providers. * More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html */ clientId?: string; /** * An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as * a replacement for the Client Secret Certificate Thumbprint. It is also optional. */ clientSecretCertificateIssuer?: string; /** * An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as * a replacement for the Client Secret Certificate Thumbprint. It is also optional. */ clientSecretCertificateSubjectAlternativeName?: string; /** * An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as * a replacement for the Client Secret. It is also optional. */ clientSecretCertificateThumbprint?: string; /** * The app setting name that contains the client secret of the relying party application. */ clientSecretSettingName?: string; /** * The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. * When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://login.microsoftonline.com/v2.0/{tenant-guid}/`. * This URI is a case-sensitive identifier for the token issuer. * More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html */ openIdIssuer?: string; } /** * The configuration settings of the Azure Active directory provider. */ interface AzureActiveDirectoryResponse { /** * false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true. */ enabled?: boolean; /** * Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling. * This is an internal flag primarily intended to support the Azure Management Portal. Users should not * read or write to this property. */ isAutoProvisioned?: boolean; /** * The configuration settings of the Azure Active Directory login flow. */ login?: outputs.web.AzureActiveDirectoryLoginResponse; /** * The configuration settings of the Azure Active Directory app registration. */ registration?: outputs.web.AzureActiveDirectoryRegistrationResponse; /** * The configuration settings of the Azure Active Directory token validation flow. */ validation?: outputs.web.AzureActiveDirectoryValidationResponse; } /** * The configuration settings of the Azure Active Directory token validation flow. */ interface AzureActiveDirectoryValidationResponse { /** * The list of audiences that can make successful authentication/authorization requests. */ allowedAudiences?: string[]; /** * The configuration settings of the default authorization policy. */ defaultAuthorizationPolicy?: outputs.web.DefaultAuthorizationPolicyResponse; /** * The configuration settings of the checks that should be made while validating the JWT Claims. */ jwtClaimChecks?: outputs.web.JwtClaimChecksResponse; } /** * Application logs azure blob storage configuration. */ interface AzureBlobStorageApplicationLogsConfigResponse { /** * Log level. */ level?: string; /** * Retention in days. * Remove blobs older than X days. * 0 or lower means no retention. */ retentionInDays?: number; /** * SAS url to a azure blob container with read/write/list/delete permissions. */ sasUrl?: string; } /** * Http logs to azure blob storage configuration. */ interface AzureBlobStorageHttpLogsConfigResponse { /** * True if configuration is enabled, false if it is disabled and null if configuration is not set. */ enabled?: boolean; /** * Retention in days. * Remove blobs older than X days. * 0 or lower means no retention. */ retentionInDays?: number; /** * SAS url to a azure blob container with read/write/list/delete permissions. */ sasUrl?: string; } /** * The azure resource error info. */ interface AzureResourceErrorInfoResponse { /** * The error code. */ code: string; /** * The error details. */ details?: outputs.web.AzureResourceErrorInfoResponse[]; /** * The error message. */ message: string; } /** * The configuration settings of the registration for the Azure Static Web Apps provider */ interface AzureStaticWebAppsRegistrationResponse { /** * The Client ID of the app used for login. */ clientId?: string; } /** * The configuration settings of the Azure Static Web Apps provider. */ interface AzureStaticWebAppsResponse { /** * false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true. */ enabled?: boolean; /** * The configuration settings of the Azure Static Web Apps registration. */ registration?: outputs.web.AzureStaticWebAppsRegistrationResponse; } /** * Azure Files or Blob Storage access information value for dictionary storage. */ interface AzureStorageInfoValueResponse { /** * Access key for the storage account. */ accessKey?: string; /** * Name of the storage account. */ accountName?: string; /** * Path to mount the storage within the site's runtime environment. */ mountPath?: string; /** * Mounting protocol to use for the storage account. */ protocol?: string; /** * Name of the file share (container name, for Blob storage). */ shareName?: string; /** * State of the storage account. */ state: string; /** * Type of storage. */ type?: string; } /** * Application logs to Azure table storage configuration. */ interface AzureTableStorageApplicationLogsConfigResponse { /** * Log level. */ level?: string; /** * SAS URL to an Azure table with add/query/delete permissions. */ sasUrl: string; } /** * Backup description. */ interface BackupItemResponse { /** * Id of the backup. */ backupId: number; /** * Name of the blob which contains data for this backup. */ blobName: string; /** * Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support. */ correlationId: string; /** * Timestamp of the backup creation. */ created: string; /** * List of databases included in the backup. */ databases: outputs.web.DatabaseBackupSettingResponse[]; /** * Timestamp when this backup finished. */ finishedTimeStamp: string; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * Kind of resource. */ kind?: string; /** * Timestamp of a last restore operation which used this backup. */ lastRestoreTimeStamp: string; /** * Details regarding this backup. Might contain an error message. */ log: string; /** * The name of the resource */ name: string; /** * True if this backup has been created due to a schedule being triggered. */ scheduled: boolean; /** * Size of the backup in bytes. */ sizeInBytes: number; /** * Backup status. */ status: string; /** * SAS URL for the storage account container which contains this backup. */ storageAccountUrl: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.web.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; /** * Size of the original web app which has been backed up. */ websiteSizeInBytes: number; } /** * Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy. */ interface BackupScheduleResponse { /** * How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day) */ frequencyInterval: number; /** * The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7) */ frequencyUnit: string; /** * True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise. */ keepAtLeastOneBackup: boolean; /** * Last time when this schedule was triggered. */ lastExecutionTime: string; /** * After how many days backups should be deleted. */ retentionPeriodInDays: number; /** * When the schedule should start working. */ startTime?: string; } /** * backupScheduleResponseProvideDefaults sets the appropriate defaults for BackupScheduleResponse */ function backupScheduleResponseProvideDefaults(val: BackupScheduleResponse): BackupScheduleResponse; /** * The configuration settings of the storage of the tokens if blob storage is used. */ interface BlobStorageTokenStoreResponse { /** * The name of the app setting containing the SAS URL of the blob storage containing the tokens. */ sasUrlSettingName?: string; } /** * Describes the capabilities/features allowed for a specific SKU. */ interface CapabilityResponse { /** * Name of the SKU capability. */ name?: string; /** * Reason of the SKU capability. */ reason?: string; /** * Value of the SKU capability. */ value?: string; } /** * The configuration settings of the app registration for providers that have client ids and client secrets */ interface ClientRegistrationResponse { /** * The Client ID of the app used for login. */ clientId?: string; /** * The app setting name that contains the client secret. */ clientSecretSettingName?: string; } /** * Database connection string value to type pair. */ interface ConnStringValueTypePairResponse { /** * Type of database. */ type: string; /** * Value of pair. */ value: string; } /** * Connection error */ interface ConnectionErrorResponse { /** * Code of the status */ code?: string; /** * Resource ETag */ etag?: string; /** * Resource id */ id: string; /** * Resource location */ location?: string; /** * Description of the status */ message?: string; /** * Resource name */ name: string; /** * Resource tags */ tags?: { [key: string]: string; }; /** * Resource type */ type: string; } interface ConnectionGatewayDefinitionResponseProperties { /** * The URI of the backend */ backendUri?: string; /** * The gateway installation reference */ connectionGatewayInstallation?: outputs.web.ConnectionGatewayReferenceResponse; /** * The gateway admin */ contactInformation?: string[]; /** * The gateway description */ description?: string; /** * The gateway display name */ displayName?: string; /** * The machine name of the gateway */ machineName?: string; /** * The gateway status */ status?: any; } /** * The gateway installation reference */ interface ConnectionGatewayReferenceResponse { /** * Resource reference id */ id?: string; /** * Resource reference location */ location?: string; /** * Resource reference name */ name?: string; /** * Resource reference type */ type?: string; } /** * Connection provider parameters */ interface ConnectionParameterResponse { /** * OAuth settings for the connection provider */ oAuthSettings?: outputs.web.ApiOAuthSettingsResponse; /** * Type of the parameter */ type?: string; } /** * Connection status */ interface ConnectionStatusDefinitionResponse { /** * Connection error */ error?: outputs.web.ConnectionErrorResponse; /** * The gateway status */ status?: string; /** * Target of the error */ target?: string; } /** * A consent link */ interface ConsentLinkDefinitionResponse { /** * Display name of the parameter in the connection provider's OAuth settings */ displayName?: string; /** * URI for first party login */ firstPartyLoginUri?: string; /** * URI for the consent link */ link?: string; /** * Status of the link */ status?: string; } interface ContainerAppsConfigurationResponse { /** * Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. */ appSubnetResourceId?: string; /** * Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined. */ controlPlaneSubnetResourceId?: string; /** * Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry */ daprAIInstrumentationKey?: string; /** * CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined. */ dockerBridgeCidr?: string; /** * IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges. */ platformReservedCidr?: string; /** * An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server */ platformReservedDnsIP?: string; } /** * The configuration settings of the session cookie's expiration. */ interface CookieExpirationResponse { /** * The convention used when determining the session cookie's expiration. */ convention?: string; /** * The time after the request is made when the session cookie should expire. */ timeToExpiration?: string; } /** * Cross-Origin Resource Sharing (CORS) settings for the app. */ interface CorsSettingsResponse { /** * Gets or sets the list of origins that should be allowed to make cross-origin * calls (for example: http://example.com:12345). Use "*" to allow all. */ allowedOrigins?: string[]; /** * Gets or sets whether CORS requests with credentials are allowed. See * https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials * for more details. */ supportCredentials?: boolean; } /** * Custom API properties */ interface CustomApiPropertiesDefinitionResponse { /** * API Definitions */ apiDefinitions?: outputs.web.ApiResourceDefinitionsResponse; /** * The API type */ apiType?: string; /** * The API backend service */ backendService?: outputs.web.ApiResourceBackendServiceResponse; /** * Brand color */ brandColor?: string; /** * The custom API capabilities */ capabilities?: string[]; /** * Connection parameters */ connectionParameters?: { [key: string]: outputs.web.ConnectionParameterResponse; }; /** * The custom API description */ description?: string; /** * The display name */ displayName?: string; /** * The icon URI */ iconUri?: string; /** * Runtime URLs */ runtimeUrls?: string[]; /** * The JSON representation of the swagger */ swagger?: any; /** * The WSDL definition */ wsdlDefinition?: outputs.web.WsdlDefinitionResponse; } /** * Full view of the custom domain suffix configuration for ASEv3. */ interface CustomDnsSuffixConfigurationResponse { /** * The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix. */ certificateUrl?: string; /** * The default custom domain suffix to use for all sites deployed on the ASE. */ dnsSuffix?: string; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available. */ keyVaultReferenceIdentity?: string; /** * Kind of resource. */ kind?: string; /** * The name of the resource */ name: string; provisioningDetails: string; provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.web.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * The configuration settings of the custom Open ID Connect provider. */ interface CustomOpenIdConnectProviderResponse { /** * false if the custom Open ID provider provider should not be enabled; otherwise, true. */ enabled?: boolean; /** * The configuration settings of the login flow of the custom Open ID Connect provider. */ login?: outputs.web.OpenIdConnectLoginResponse; /** * The configuration settings of the app registration for the custom Open ID Connect provider. */ registration?: outputs.web.OpenIdConnectRegistrationResponse; } /** * App Dapr configuration. */ interface DaprConfigResponse { /** * Dapr application identifier */ appId?: string; /** * Tells Dapr which port your application is listening on */ appPort?: number; /** * Enables API logging for the Dapr sidecar */ enableApiLogging?: boolean; /** * Boolean indicating if the Dapr side car is enabled */ enabled?: boolean; /** * Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB. */ httpMaxRequestSize?: number; /** * Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB. */ httpReadBufferSize?: number; /** * Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. */ logLevel?: string; } /** * daprConfigResponseProvideDefaults sets the appropriate defaults for DaprConfigResponse */ function daprConfigResponseProvideDefaults(val: DaprConfigResponse): DaprConfigResponse; /** * Database backup settings. */ interface DatabaseBackupSettingResponse { /** * Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one. */ connectionString?: string; /** * Contains a connection string name that is linked to the SiteConfig.ConnectionStrings. * This is used during restore with overwrite connection strings options. */ connectionStringName?: string; /** * Database type (e.g. SqlAzure / MySql). */ databaseType: string; name?: string; } /** * Static Site Database Connection overview. */ interface DatabaseConnectionOverviewResponse { /** * A list of configuration files associated with this database connection. */ configurationFiles: outputs.web.StaticSiteDatabaseConnectionConfigurationFileOverviewResponse[]; /** * If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource. */ connectionIdentity: string; /** * If present, the name of this database connection resource. */ name: string; /** * The region of the database resource. */ region: string; /** * The resource id of the database. */ resourceId: string; } /** * The configuration settings of the Azure Active Directory default authorization policy. */ interface DefaultAuthorizationPolicyResponse { /** * The configuration settings of the Azure Active Directory allowed applications. */ allowedApplications?: string[]; /** * The configuration settings of the Azure Active Directory allowed principals. */ allowedPrincipals?: outputs.web.AllowedPrincipalsResponse; } interface DefaultIdentityResponse { /** * Type of managed service identity. */ identityType?: string; userAssignedIdentityResourceId?: string; } /** * Enabled configuration. */ interface EnabledConfigResponse { /** * True if configuration is enabled, false if it is disabled and null if configuration is not set. */ enabled?: boolean; } interface EnvironmentVariableResponse { /** * Environment variable name */ name: string; /** * The value of this environment variable must be the name of an AppSetting. The actual value of the environment variable in container will be retrieved from the specified AppSetting at runtime. If the AppSetting is not found, the value will be set to an empty string in the container at runtime. */ value: string; } /** * Body of the error response returned from the API. */ interface ErrorEntityResponse { /** * Basic error code. */ code?: string; /** * Error Details. */ details?: outputs.web.ErrorEntityResponse[]; /** * Type of error. */ extendedCode?: string; /** * Inner errors. */ innerErrors?: outputs.web.ErrorEntityResponse[]; /** * Any details of the error. */ message?: string; /** * Message template. */ messageTemplate?: string; /** * Parameters for the template. */ parameters?: string[]; /** * The error target. */ target?: string; } /** * Routing rules in production experiments. */ interface ExperimentsResponse { /** * List of ramp-up rules. */ rampUpRules?: outputs.web.RampUpRuleResponse[]; } /** * The expression. */ interface ExpressionResponse { /** * The azure resource error info. */ error?: outputs.web.AzureResourceErrorInfoResponse; /** * The sub expressions. */ subexpressions?: outputs.web.ExpressionResponse[]; /** * The text. */ text?: string; /** * Anything */ value?: any; } /** * The expression root. */ interface ExpressionRootResponse { /** * The azure resource error info. */ error?: outputs.web.AzureResourceErrorInfoResponse; /** * The path. */ path?: string; /** * The sub expressions. */ subexpressions?: outputs.web.ExpressionResponse[]; /** * The text. */ text?: string; /** * Anything */ value?: any; } /** * Extended Location. */ interface ExtendedLocationResponse { /** * Name of extended location. */ name?: string; /** * Type of extended location. */ type: string; } /** * The configuration settings of the Facebook provider. */ interface FacebookResponse { /** * false if the Facebook provider should not be enabled despite the set registration; otherwise, true. */ enabled?: boolean; /** * The version of the Facebook api to be used while logging in. */ graphApiVersion?: string; /** * The configuration settings of the login flow. */ login?: outputs.web.LoginScopesResponse; /** * The configuration settings of the app registration for the Facebook provider. */ registration?: outputs.web.AppRegistrationResponse; } /** * Application logs to file system configuration. */ interface FileSystemApplicationLogsConfigResponse { /** * Log level. */ level?: string; } /** * fileSystemApplicationLogsConfigResponseProvideDefaults sets the appropriate defaults for FileSystemApplicationLogsConfigResponse */ function fileSystemApplicationLogsConfigResponseProvideDefaults(val: FileSystemApplicationLogsConfigResponse): FileSystemApplicationLogsConfigResponse; /** * Http logs to file system configuration. */ interface FileSystemHttpLogsConfigResponse { /** * True if configuration is enabled, false if it is disabled and null if configuration is not set. */ enabled?: boolean; /** * Retention in days. * Remove files older than X days. * 0 or lower means no retention. */ retentionInDays?: number; /** * Maximum size in megabytes that http log files can use. * When reached old log files will be removed to make space for new ones. * Value can range between 25 and 100. */ retentionInMb?: number; } /** * The configuration settings of the storage of the tokens if a file system is used. */ interface FileSystemTokenStoreResponse { /** * The directory in which the tokens will be stored. */ directory?: string; } /** * The configuration settings of a forward proxy used to make the requests. */ interface ForwardProxyResponse { /** * The convention used to determine the url of the request made. */ convention?: string; /** * The name of the header containing the host of the request. */ customHostHeaderName?: string; /** * The name of the header containing the scheme of the request. */ customProtoHeaderName?: string; } interface FrontEndConfigurationResponse { kind?: string; } /** * Function app configuration. */ interface FunctionAppConfigResponse { /** * Function app deployment configuration. */ deployment?: outputs.web.FunctionsDeploymentResponse; /** * Function app runtime settings. */ runtime?: outputs.web.FunctionsRuntimeResponse; /** * Function app scale and concurrency settings. */ scaleAndConcurrency?: outputs.web.FunctionsScaleAndConcurrencyResponse; /** * Function app site update strategy configuration. */ siteUpdateStrategy?: outputs.web.FunctionsSiteUpdateStrategyResponse; } /** * Sets the number of 'Always Ready' instances for a function group or a specific function. */ interface FunctionsAlwaysReadyConfigResponse { /** * Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready. */ instanceCount?: number; /** * Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready. */ name?: string; } /** * Configuration section for the function app deployment. */ interface FunctionsDeploymentResponse { /** * Storage for deployed package used by the function app. */ storage?: outputs.web.FunctionsDeploymentStorageResponse; } /** * Authentication method to access the storage account for deployment. */ interface FunctionsDeploymentStorageAuthenticationResponse { /** * Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type. */ storageAccountConnectionStringName?: string; /** * Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString. */ type?: string; /** * Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type. */ userAssignedIdentityResourceId?: string; } /** * Storage for deployed package used by the function app. */ interface FunctionsDeploymentStorageResponse { /** * Authentication method to access the storage account for deployment. */ authentication?: outputs.web.FunctionsDeploymentStorageAuthenticationResponse; /** * Property to select Azure Storage type. Available options: blobContainer. */ type?: string; /** * Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/. */ value?: string; } /** * Function app runtime name and version. */ interface FunctionsRuntimeResponse { /** * Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom */ name?: string; /** * Function app runtime version. Example: 8 (for dotnet-isolated) */ version?: string; } /** * Scale and concurrency settings for the function app. */ interface FunctionsScaleAndConcurrencyResponse { /** * 'Always Ready' configuration for the function app. */ alwaysReady?: outputs.web.FunctionsAlwaysReadyConfigResponse[]; /** * Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally. */ instanceMemoryMB?: number; /** * The maximum number of on demand instances per function group. */ maximumInstanceCount?: number; /** * Scale and concurrency settings for the function app triggers. */ triggers?: outputs.web.FunctionsScaleAndConcurrencyTriggersResponse; } /** * Scale and concurrency settings for the HTTP trigger. */ interface FunctionsScaleAndConcurrencyTriggersHttpResponse { /** * The maximum number of concurrent HTTP trigger invocations per instance. */ perInstanceConcurrency?: number; } /** * Scale and concurrency settings for the function app triggers. */ interface FunctionsScaleAndConcurrencyTriggersResponse { /** * Scale and concurrency settings for the HTTP trigger. */ http?: outputs.web.FunctionsScaleAndConcurrencyTriggersHttpResponse; } /** * Function app site update strategy configuration for deployments and site config updates. */ interface FunctionsSiteUpdateStrategyResponse { /** * Function app site update strategy type. Available options: Recreate, RollingUpdate */ type?: string; } /** * The GitHub action code configuration. */ interface GitHubActionCodeConfigurationResponse { /** * Runtime stack is used to determine the workflow file content for code base apps. */ runtimeStack?: string; /** * Runtime version is used to determine what build version to set in the workflow file. */ runtimeVersion?: string; } /** * The GitHub action configuration. */ interface GitHubActionConfigurationResponse { /** * GitHub Action code configuration. */ codeConfiguration?: outputs.web.GitHubActionCodeConfigurationResponse; /** * GitHub Action container configuration. */ containerConfiguration?: outputs.web.GitHubActionContainerConfigurationResponse; /** * Workflow option to determine whether the workflow file should be generated and written to the repository. */ generateWorkflowFile?: boolean; /** * This will help determine the workflow configuration to select. */ isLinux?: boolean; } /** * The GitHub action container configuration. */ interface GitHubActionContainerConfigurationResponse { /** * The image name for the build. */ imageName?: string; /** * The password used to upload the image to the container registry. */ password?: string; /** * The server URL for the container registry where the build will be hosted. */ serverUrl?: string; /** * The username used to upload the image to the container registry. */ username?: string; } /** * The configuration settings of the GitHub provider. */ interface GitHubResponse { /** * false if the GitHub provider should not be enabled despite the set registration; otherwise, true. */ enabled?: boolean; /** * The configuration settings of the login flow. */ login?: outputs.web.LoginScopesResponse; /** * The configuration settings of the app registration for the GitHub provider. */ registration?: outputs.web.ClientRegistrationResponse; } /** * The configuration settings that determines the validation flow of users using App Service Authentication/Authorization. */ interface GlobalValidationResponse { /** * The paths for which unauthenticated flow would not be redirected to the login page. */ excludedPaths?: string[]; /** * The default authentication provider to use when multiple providers are configured. * This setting is only needed if multiple providers are configured and the unauthenticated client * action is set to "RedirectToLoginPage". */ redirectToProvider?: string; /** * true if the authentication flow is required any request is made; otherwise, false. */ requireAuthentication?: boolean; /** * The action to take when an unauthenticated client attempts to access the app. */ unauthenticatedClientAction?: string; } /** * The configuration settings of the Google provider. */ interface GoogleResponse { /** * false if the Google provider should not be enabled despite the set registration; otherwise, true. */ enabled?: boolean; /** * The configuration settings of the login flow. */ login?: outputs.web.LoginScopesResponse; /** * The configuration settings of the app registration for the Google provider. */ registration?: outputs.web.ClientRegistrationResponse; /** * The configuration settings of the Azure Active Directory token validation flow. */ validation?: outputs.web.AllowedAudiencesValidationResponse; } /** * The IIS handler mappings used to define which handler processes HTTP requests with certain extension. * For example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension. */ interface HandlerMappingResponse { /** * Command-line arguments to be passed to the script processor. */ arguments?: string; /** * Requests with this extension will be handled using the specified FastCGI application. */ extension?: string; /** * The absolute path to the FastCGI application. */ scriptProcessor?: string; } /** * SSL-enabled hostname. */ interface HostNameSslStateResponse { /** * Indicates whether the hostname is a standard or repository hostname. */ hostType?: string; /** * Hostname. */ name?: string; /** * SSL type. */ sslState?: string; /** * SSL certificate thumbprint. */ thumbprint?: string; /** * Set to true to update existing hostname. */ toUpdate?: boolean; /** * Virtual IP address assigned to the hostname if IP based SSL is enabled. */ virtualIP?: string; } /** * Specification for an App Service Environment to use for this resource. */ interface HostingEnvironmentProfileResponse { /** * Resource ID of the App Service Environment. */ id?: string; /** * Name of the App Service Environment. */ name: string; /** * Resource type of the App Service Environment. */ type: string; } /** * Http logs configuration. */ interface HttpLogsConfigResponse { /** * Http logs to azure blob storage configuration. */ azureBlobStorage?: outputs.web.AzureBlobStorageHttpLogsConfigResponse; /** * Http logs to file system configuration. */ fileSystem?: outputs.web.FileSystemHttpLogsConfigResponse; } /** * The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization. */ interface HttpSettingsResponse { /** * The configuration settings of a forward proxy used to make the requests. */ forwardProxy?: outputs.web.ForwardProxyResponse; /** * false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true. */ requireHttps?: boolean; /** * The configuration settings of the paths HTTP requests. */ routes?: outputs.web.HttpSettingsRoutesResponse; } /** * The configuration settings of the paths HTTP requests. */ interface HttpSettingsRoutesResponse { /** * The prefix that should precede all the authentication/authorization paths. */ apiPrefix?: string; } /** * A domain specific resource identifier. */ interface IdentifierResponse { /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * Kind of resource. */ kind?: string; /** * The name of the resource */ name: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.web.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; /** * String representation of the identity. */ value?: string; } /** * The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization. */ interface IdentityProvidersResponse { /** * The configuration settings of the Apple provider. */ apple?: outputs.web.AppleResponse; /** * The configuration settings of the Azure Active directory provider. */ azureActiveDirectory?: outputs.web.AzureActiveDirectoryResponse; /** * The configuration settings of the Azure Static Web Apps provider. */ azureStaticWebApps?: outputs.web.AzureStaticWebAppsResponse; /** * The map of the name of the alias of each custom Open ID Connect provider to the * configuration settings of the custom Open ID Connect provider. */ customOpenIdConnectProviders?: { [key: string]: outputs.web.CustomOpenIdConnectProviderResponse; }; /** * The configuration settings of the Facebook provider. */ facebook?: outputs.web.FacebookResponse; /** * The configuration settings of the GitHub provider. */ gitHub?: outputs.web.GitHubResponse; /** * The configuration settings of the Google provider. */ google?: outputs.web.GoogleResponse; /** * The configuration settings of the legacy Microsoft Account provider. */ legacyMicrosoftAccount?: outputs.web.LegacyMicrosoftAccountResponse; /** * The configuration settings of the Twitter provider. */ twitter?: outputs.web.TwitterResponse; } /** * Server farm install script configuration. */ interface InstallScriptResponse { /** * Name of the install script. */ name?: string; /** * Source of the install script. */ source?: outputs.web.InstallScriptSourceResponse; } /** * Object to hold install script reference. */ interface InstallScriptSourceResponse { /** * Install script source URI where the install script file will be fetched from. */ sourceUri?: string; /** * Type of the install script. */ type?: string; } /** * IP security restriction on an app. */ interface IpSecurityRestrictionResponse { /** * Allow or Deny access for this IP range. */ action?: string; /** * IP restriction rule description. */ description?: string; /** * IP restriction rule headers. * X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). * The matching logic is .. * - If the property is null or empty (default), all hosts(or lack of) are allowed. * - A value is compared using ordinal-ignore-case (excluding port number). * - Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com * but not the root domain contoso.com or multi-level foo.bar.contoso.com * - Unicode host names are allowed but are converted to Punycode for matching. * * X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). * The matching logic is .. * - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. * - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. * * X-Azure-FDID and X-FD-HealthProbe. * The matching logic is exact match. */ headers?: { [key: string]: string[]; }; /** * IP address the security restriction is valid for. * It can be in form of pure ipv4 address (required SubnetMask property) or * CIDR notation such as ipv4/mask (leading bit match). For CIDR, * SubnetMask property must not be specified. */ ipAddress?: string; /** * IP restriction rule name. */ name?: string; /** * Priority of IP restriction rule. */ priority?: number; /** * Subnet mask for the range of IP addresses the restriction is valid for. */ subnetMask?: string; /** * (internal) Subnet traffic tag */ subnetTrafficTag?: number; /** * Defines what this IP filter will be used for. This is to support IP filtering on proxies. */ tag?: string; /** * Virtual network resource id */ vnetSubnetResourceId?: string; /** * (internal) Vnet traffic tag */ vnetTrafficTag?: number; } /** * The configuration settings of the checks that should be made while validating the JWT Claims. */ interface JwtClaimChecksResponse { /** * The list of the allowed client applications. */ allowedClientApplications?: string[]; /** * The list of the allowed groups. */ allowedGroups?: string[]; } /** * Object to hold key vault reference and the resolution status */ interface KeyVaultReferenceWithStatusResponse { /** * Reference status of the key vault secret. */ referenceStatus?: string; /** * Key vault secret URI. */ secretUri?: string; } /** * Specification for a Kubernetes Environment to use for this resource. */ interface KubeEnvironmentProfileResponse { /** * Resource ID of the Kubernetes Environment. */ id?: string; /** * Name of the Kubernetes Environment. */ name: string; /** * Resource type of the Kubernetes Environment. */ type: string; } /** * The configuration settings of the legacy Microsoft Account provider. */ interface LegacyMicrosoftAccountResponse { /** * false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true. */ enabled?: boolean; /** * The configuration settings of the login flow. */ login?: outputs.web.LoginScopesResponse; /** * The configuration settings of the app registration for the legacy Microsoft Account provider. */ registration?: outputs.web.ClientRegistrationResponse; /** * The configuration settings of the legacy Microsoft Account provider token validation flow. */ validation?: outputs.web.AllowedAudiencesValidationResponse; } interface LogAnalyticsConfigurationResponse { customerId?: string; } /** * The configuration settings of the login flow of users using App Service Authentication/Authorization. */ interface LoginResponse { /** * External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored. * This is an advanced setting typically only needed by Windows Store application backends. * Note that URLs within the current domain are always implicitly allowed. */ allowedExternalRedirectUrls?: string[]; /** * The configuration settings of the session cookie's expiration. */ cookieExpiration?: outputs.web.CookieExpirationResponse; /** * The configuration settings of the nonce used in the login flow. */ nonce?: outputs.web.NonceResponse; /** * true if the fragments from the request are preserved after the login request is made; otherwise, false. */ preserveUrlFragmentsForLogins?: boolean; /** * The routes that specify the endpoints used for login and logout requests. */ routes?: outputs.web.LoginRoutesResponse; /** * The configuration settings of the token store. */ tokenStore?: outputs.web.TokenStoreResponse; } /** * The routes that specify the endpoints used for login and logout requests. */ interface LoginRoutesResponse { /** * The endpoint at which a logout request should be made. */ logoutEndpoint?: string; } /** * The configuration settings of the login flow, including the scopes that should be requested. */ interface LoginScopesResponse { /** * A list of the scopes that should be requested while authenticating. */ scopes?: string[]; } /** * Managed service identity. */ interface ManagedServiceIdentityResponse { /** * Principal Id of managed service identity. */ principalId: string; /** * Tenant of managed service identity. */ tenantId: string; /** * Type of managed service identity. */ type?: string; /** * The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} */ userAssignedIdentities?: { [key: string]: outputs.web.UserAssignedIdentityResponse; }; } /** * Name value pair. */ interface NameValuePairResponse { /** * Pair name. */ name?: string; /** * Pair value. */ value?: string; } /** * The configuration settings of the nonce used in the login flow. */ interface NonceResponse { /** * The time after the request is made when the nonce should expire. */ nonceExpirationInterval?: string; /** * false if the nonce should not be validated while completing the login flow; otherwise, true. */ validateNonce?: boolean; } /** * The authentication client credentials of the custom Open ID Connect provider. */ interface OpenIdConnectClientCredentialResponse { /** * The app setting that contains the client secret for the custom Open ID Connect provider. */ clientSecretSettingName?: string; /** * The method that should be used to authenticate the user. */ method?: string; } /** * The configuration settings of the endpoints used for the custom Open ID Connect provider. */ interface OpenIdConnectConfigResponse { /** * The endpoint to be used to make an authorization request. */ authorizationEndpoint?: string; /** * The endpoint that provides the keys necessary to validate the token. */ certificationUri?: string; /** * The endpoint that issues the token. */ issuer?: string; /** * The endpoint to be used to request a token. */ tokenEndpoint?: string; /** * The endpoint that contains all the configuration endpoints for the provider. */ wellKnownOpenIdConfiguration?: string; } /** * The configuration settings of the login flow of the custom Open ID Connect provider. */ interface OpenIdConnectLoginResponse { /** * The name of the claim that contains the users name. */ nameClaimType?: string; /** * A list of the scopes that should be requested while authenticating. */ scopes?: string[]; } /** * The configuration settings of the app registration for the custom Open ID Connect provider. */ interface OpenIdConnectRegistrationResponse { /** * The authentication credentials of the custom Open ID Connect provider. */ clientCredential?: outputs.web.OpenIdConnectClientCredentialResponse; /** * The client id of the custom Open ID Connect provider. */ clientId?: string; /** * The configuration settings of the endpoints used for the custom Open ID Connect provider. */ openIdConnectConfiguration?: outputs.web.OpenIdConnectConfigResponse; } /** * Outbound traffic options over virtual network. */ interface OutboundVnetRoutingResponse { /** * Enables all other routing options defined in OutboundVnetRouting if this setting is set to true. */ allTraffic?: boolean; /** * This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled. */ applicationTraffic?: boolean; /** * Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled */ backupRestoreTraffic?: boolean; /** * Enables accessing content over virtual network. Previously called VnetContentShareEnabled */ contentShareTraffic?: boolean; /** * Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled. */ imagePullTraffic?: boolean; } /** * The state of a private link connection */ interface PrivateLinkConnectionStateResponse { /** * ActionsRequired for a private link connection */ actionsRequired?: string; /** * Description of a private link connection */ description?: string; /** * Status of a private link connection */ status?: string; } /** * Push settings for the App. */ interface PushSettingsResponse { /** * Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint. */ dynamicTagsJson?: string; /** * Resource Id. */ id: string; /** * Gets or sets a flag indicating whether the Push endpoint is enabled. */ isPushEnabled: boolean; /** * Kind of resource. */ kind?: string; /** * Resource Name. */ name: string; /** * Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint. */ tagWhitelistJson?: string; /** * Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. * Tags can consist of alphanumeric characters and the following: * '_', '@', '#', '.', ':', '-'. * Validation should be performed at the PushRequestHandler. */ tagsRequiringAuth?: string; /** * Resource type. */ type: string; } /** * Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance. */ interface RampUpRuleResponse { /** * Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net. */ actionHostName?: string; /** * Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. */ changeDecisionCallbackUrl?: string; /** * Specifies interval in minutes to reevaluate ReroutePercentage. */ changeIntervalInMinutes?: number; /** * In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or * MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm * can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl. */ changeStep?: number; /** * Specifies upper boundary below which ReroutePercentage will stay. */ maxReroutePercentage?: number; /** * Specifies lower boundary above which ReroutePercentage will stay. */ minReroutePercentage?: number; /** * Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. */ name?: string; /** * Percentage of the traffic which will be redirected to ActionHostName. */ reroutePercentage?: number; } /** * Server farm registry adapter configuration. */ interface RegistryAdapterResponse { /** * Key vault reference to the value that will be placed in the registry location */ keyVaultSecretReference?: outputs.web.KeyVaultReferenceWithStatusResponse; /** * Registry key for the adapter. */ registryKey?: string; /** * Type of the registry adapter. */ type?: string; } /** * A remote private endpoint connection */ interface RemotePrivateEndpointConnectionResponse { /** * Resource Id. */ id: string; /** * Private IPAddresses mapped to the remote private endpoint */ ipAddresses?: string[]; /** * Kind of resource. */ kind?: string; /** * Resource Name. */ name: string; /** * PrivateEndpoint of a remote private endpoint connection */ privateEndpoint?: outputs.web.ArmIdWrapperResponse; /** * The state of a private link connection */ privateLinkServiceConnectionState?: outputs.web.PrivateLinkConnectionStateResponse; provisioningState: string; /** * Resource type. */ type: string; } /** * Trigger based on total requests. */ interface RequestsBasedTriggerResponse { /** * Request Count. */ count?: number; /** * Time interval. */ timeInterval?: string; } /** * Function app resource requirements. */ interface ResourceConfigResponse { /** * Required CPU in cores, e.g. 0.5 */ cpu?: number; /** * Required memory, e.g. "1Gi" */ memory?: string; } /** * Message envelope that contains the common Azure resource manager properties and the resource provider specific content. */ interface ResponseMessageEnvelopeRemotePrivateEndpointConnectionResponse { /** * Azure-AsyncOperation Error info. */ error?: outputs.web.ErrorEntityResponse; /** * Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this * value for GET requests only. * For example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename} */ id?: string; /** * MSI resource */ identity?: outputs.web.ManagedServiceIdentityResponse; /** * Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia. */ location?: string; /** * Name of resource. */ name?: string; /** * Azure resource manager plan. */ plan?: outputs.web.ArmPlanResponse; /** * Resource specific properties. */ properties?: outputs.web.RemotePrivateEndpointConnectionResponse; /** * SKU description of the resource. */ sku?: outputs.web.SkuDescriptionResponse; /** * Azure-AsyncOperation Status info. */ status?: string; /** * Tags associated with resource. */ tags?: { [key: string]: string; }; /** * Type of resource e.g "Microsoft.Web/sites". */ type?: string; /** * Logical Availability Zones the service is hosted in */ zones?: string[]; } /** * Represents details of a single instance in a server farm. */ interface ServerFarmInstanceResponse { /** * The instance name. */ instanceName?: string; /** * The instance IP address. */ ipAddress?: string; /** * The instance status. */ status?: string; } /** * Network settings for an app service plan. */ interface ServerFarmNetworkSettingsResponse { /** * Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} */ virtualNetworkSubnetId?: string; } /** * Configuration of an App Service app. */ interface SiteConfigResponse { /** * Flag to use Managed Identity Creds for ACR pull */ acrUseManagedIdentityCreds?: boolean; /** * If using user managed identity, the user managed identity ClientId */ acrUserManagedIdentityID?: string; /** * true if Always On is enabled; otherwise, false. */ alwaysOn?: boolean; /** * Information about the formal API definition for the app. */ apiDefinition?: outputs.web.ApiDefinitionInfoResponse; /** * Azure API management settings linked to the app. */ apiManagementConfig?: outputs.web.ApiManagementConfigResponse; /** * App command line to launch. */ appCommandLine?: string; /** * true if Auto Heal is enabled; otherwise, false. */ autoHealEnabled?: boolean; /** * Auto Heal rules. */ autoHealRules?: outputs.web.AutoHealRulesResponse; /** * Auto-swap slot name. */ autoSwapSlotName?: string; /** * List of Azure Storage Accounts. */ azureStorageAccounts?: { [key: string]: outputs.web.AzureStorageInfoValueResponse; }; /** * Cross-Origin Resource Sharing (CORS) settings. */ cors?: outputs.web.CorsSettingsResponse; /** * Default documents. */ defaultDocuments?: string[]; /** * true if detailed error logging is enabled; otherwise, false. */ detailedErrorLoggingEnabled?: boolean; /** * Document root. */ documentRoot?: string; /** * Maximum number of workers that a site can scale out to. * This setting only applies to apps in plans where ElasticScaleEnabled is true */ elasticWebAppScaleLimit?: number; /** * This is work around for polymorphic types. */ experiments?: outputs.web.ExperimentsResponse; /** * State of FTP / FTPS service */ ftpsState?: string; /** * Maximum number of workers that a site can scale out to. * This setting only applies to the Consumption and Elastic Premium Plans */ functionAppScaleLimit?: number; /** * Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, * the ScaleController will not monitor event sources directly, but will instead call to the * runtime to get scale status. */ functionsRuntimeScaleMonitoringEnabled?: boolean; /** * Handler mappings. */ handlerMappings?: outputs.web.HandlerMappingResponse[]; /** * Health check path */ healthCheckPath?: string; /** * Http20Enabled: configures a web site to allow clients to connect over http2.0 */ http20Enabled?: boolean; /** * Http20ProxyFlag: Configures a website to allow http2.0 to pass be proxied all the way to the app. 0 = disabled, 1 = pass through all http2 traffic, 2 = pass through gRPC only. */ http20ProxyFlag?: number; /** * true if HTTP logging is enabled; otherwise, false. */ httpLoggingEnabled?: boolean; /** * IP security restrictions for main. */ ipSecurityRestrictions?: outputs.web.IpSecurityRestrictionResponse[]; /** * Default action for main access restriction if no rules are matched. */ ipSecurityRestrictionsDefaultAction?: string; /** * Java container. */ javaContainer?: string; /** * Java container version. */ javaContainerVersion?: string; /** * Java version. */ javaVersion?: string; /** * Identity to use for Key Vault Reference authentication. */ keyVaultReferenceIdentity?: string; /** * Site limits. */ limits?: outputs.web.SiteLimitsResponse; /** * Linux App Framework and version */ linuxFxVersion?: string; /** * Site load balancing. */ loadBalancing?: string; /** * true to enable local MySQL; otherwise, false. */ localMySqlEnabled?: boolean; /** * HTTP logs directory size limit. */ logsDirectorySizeLimit?: number; /** * Site MachineKey. */ machineKey: outputs.web.SiteMachineKeyResponse; /** * Managed pipeline mode. */ managedPipelineMode?: string; /** * Managed Service Identity Id */ managedServiceIdentityId?: number; /** * The minimum strength TLS cipher suite allowed for an application */ minTlsCipherSuite?: string; /** * MinTlsVersion: configures the minimum version of TLS required for SSL requests */ minTlsVersion?: string; /** * Number of minimum instance count for a site * This setting only applies to the Elastic Plans */ minimumElasticInstanceCount?: number; /** * .NET Framework version. */ netFrameworkVersion?: string; /** * Version of Node.js. */ nodeVersion?: string; /** * Number of workers. */ numberOfWorkers?: number; /** * Version of PHP. */ phpVersion?: string; /** * Version of PowerShell. */ powerShellVersion?: string; /** * Number of preWarmed instances. * This setting only applies to the Consumption and Elastic Plans */ preWarmedInstanceCount?: number; /** * Property to allow or block all public traffic. */ publicNetworkAccess?: string; /** * Publishing user name. */ publishingUsername?: string; /** * Push endpoint settings. */ push?: outputs.web.PushSettingsResponse; /** * Version of Python. */ pythonVersion?: string; /** * true if remote debugging is enabled; otherwise, false. */ remoteDebuggingEnabled?: boolean; /** * Remote debugging version. */ remoteDebuggingVersion?: string; /** * true if request tracing is enabled; otherwise, false. */ requestTracingEnabled?: boolean; /** * Request tracing expiration time. */ requestTracingExpirationTime?: string; /** * IP security restrictions for scm. */ scmIpSecurityRestrictions?: outputs.web.IpSecurityRestrictionResponse[]; /** * Default action for scm access restriction if no rules are matched. */ scmIpSecurityRestrictionsDefaultAction?: string; /** * IP security restrictions for scm to use main. */ scmIpSecurityRestrictionsUseMain?: boolean; /** * ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site */ scmMinTlsVersion?: string; /** * SCM type. */ scmType?: string; /** * Tracing options. */ tracingOptions?: string; /** * true to use 32-bit worker process; otherwise, false. */ use32BitWorkerProcess?: boolean; /** * Virtual applications. */ virtualApplications?: outputs.web.VirtualApplicationResponse[]; /** * Virtual Network name. */ vnetName?: string; /** * The number of private ports assigned to this app. These will be assigned dynamically on runtime. */ vnetPrivatePortsCount?: number; /** * Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. */ vnetRouteAllEnabled?: boolean; /** * true if WebSocket is enabled; otherwise, false. */ webSocketsEnabled?: boolean; /** * Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones */ websiteTimeZone?: string; /** * Xenon App Framework and version */ windowsFxVersion?: string; /** * Explicit Managed Service Identity Id */ xManagedServiceIdentityId?: number; } /** * siteConfigResponseProvideDefaults sets the appropriate defaults for SiteConfigResponse */ function siteConfigResponseProvideDefaults(val: SiteConfigResponse): SiteConfigResponse; interface SiteDnsConfigResponse { /** * Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting. */ dnsAltServer?: string; /** * Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only. */ dnsLegacySortOrder: boolean; /** * Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled. */ dnsMaxCacheTimeout?: number; /** * Total number of retries for dns lookup. Allowed range: 1-5. Default is 3. */ dnsRetryAttemptCount?: number; /** * Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3. */ dnsRetryAttemptTimeout?: number; /** * List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set. */ dnsServers?: string[]; } /** * Metric limits set on an app. */ interface SiteLimitsResponse { /** * Maximum allowed disk size usage in MB. */ maxDiskSizeInMb?: number; /** * Maximum allowed memory usage in MB. */ maxMemoryInMb?: number; /** * Maximum allowed CPU usage percentage. */ maxPercentageCpu?: number; } /** * MachineKey of an app. */ interface SiteMachineKeyResponse { /** * Algorithm used for decryption. */ decryption?: string; /** * Decryption key. */ decryptionKey?: string; /** * MachineKey validation. */ validation?: string; /** * Validation key. */ validationKey?: string; } /** * Description of the App Service plan scale options. */ interface SkuCapacityResponse { /** * Default number of workers for this App Service plan SKU. */ default?: number; /** * Maximum number of Elastic workers for this App Service plan SKU. */ elasticMaximum?: number; /** * Maximum number of workers for this App Service plan SKU. */ maximum?: number; /** * Minimum number of workers for this App Service plan SKU. */ minimum?: number; /** * Available scale configurations for an App Service plan. */ scaleType?: string; } /** * Description of a SKU for a scalable resource. */ interface SkuDescriptionResponse { /** * Capabilities of the SKU, e.g., is traffic manager enabled? */ capabilities?: outputs.web.CapabilityResponse[]; /** * Current number of instances assigned to the resource. */ capacity?: number; /** * Family code of the resource SKU. */ family?: string; /** * Locations of the SKU. */ locations?: string[]; /** * Name of the resource SKU. */ name?: string; /** * Size specifier of the resource SKU. */ size?: string; /** * Min, max, and default scale values of the SKU. */ skuCapacity?: outputs.web.SkuCapacityResponse; /** * Service tier of the resource SKU. */ tier?: string; } /** * The status of the last successful slot swap operation. */ interface SlotSwapStatusResponse { /** * The destination slot of the last swap operation. */ destinationSlotName: string; /** * The source slot of the last swap operation. */ sourceSlotName: string; /** * The time the last successful slot swap completed. */ timestampUtc: string; } /** * Trigger based on request execution time. */ interface SlowRequestsBasedTriggerResponse { /** * Request Count. */ count?: number; /** * Request Path. */ path?: string; /** * Time interval. */ timeInterval?: string; /** * Time taken. */ timeTaken?: string; } /** * Build properties for the static site. */ interface StaticSiteBuildPropertiesResponse { /** * A custom command to run during deployment of the Azure Functions API application. */ apiBuildCommand?: string; /** * The path to the api code within the repository. */ apiLocation?: string; /** * Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation) */ appArtifactLocation?: string; /** * A custom command to run during deployment of the static content application. */ appBuildCommand?: string; /** * The path to the app code within the repository. */ appLocation?: string; /** * Github Action secret name override. */ githubActionSecretNameOverride?: string; /** * The output path of the app after building. */ outputLocation?: string; /** * Skip Github Action workflow generation. */ skipGithubActionWorkflowGeneration?: boolean; } /** * A database connection configuration file */ interface StaticSiteDatabaseConnectionConfigurationFileOverviewResponse { /** * The Base64 encoding of the file contents. */ contents: string; /** * The name of the configuration file. */ fileName: string; /** * The type of configuration file. */ type: string; } /** * Static Site Linked Backend ARM resource. */ interface StaticSiteLinkedBackendResponse { /** * The resource id of the backend linked to the static site */ backendResourceId?: string; /** * The date and time on which the backend was linked to the static site. */ createdOn: string; /** * The provisioning state of the linking process. */ provisioningState: string; /** * The region of the backend linked to the static site */ region?: string; } /** * Template Options for the static site. */ interface StaticSiteTemplateOptionsResponse { /** * Description of the newly generated repository. */ description?: string; /** * Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public). */ isPrivate?: boolean; /** * Owner of the newly generated repository. */ owner?: string; /** * Name of the newly generated repository. */ repositoryName?: string; /** * URL of the template repository. The newly generated repository will be based on this one. */ templateRepositoryUrl?: string; } /** * Static Site User ARM resource. */ interface StaticSiteUserARMResourceResponse { /** * The display name for the static site user. */ displayName: string; /** * Resource Id. */ id: string; /** * Kind of resource. */ kind?: string; /** * Resource Name. */ name: string; /** * The identity provider for the static site user. */ provider: string; /** * The roles for the static site user, in free-form string format */ roles?: string; /** * Resource type. */ type: string; /** * The user id for the static site user. */ userId: string; } /** * A static site user provided function. */ interface StaticSiteUserProvidedFunctionAppResponse { /** * The date and time on which the function app was registered with the static site. */ createdOn: string; /** * The region of the function app registered with the static site */ functionAppRegion?: string; /** * The resource id of the function app registered with the static site */ functionAppResourceId?: string; /** * Resource Id. */ id: string; /** * Kind of resource. */ kind?: string; /** * Resource Name. */ name: string; /** * Resource type. */ type: string; } /** * Trigger based on status code. */ interface StatusCodesBasedTriggerResponse { /** * Request Count. */ count?: number; /** * Request Path */ path?: string; /** * HTTP status code. */ status?: number; /** * Request Sub Status. */ subStatus?: number; /** * Time interval. */ timeInterval?: string; /** * Win32 error code. */ win32Status?: number; } /** * Trigger based on range of status codes. */ interface StatusCodesRangeBasedTriggerResponse { /** * Request Count. */ count?: number; path?: string; /** * HTTP status code. */ statusCodes?: string; /** * Time interval. */ timeInterval?: string; } /** * Server farm storage mount configuration. */ interface StorageMountResponse { /** * KV reference to the credentials to connect to the share. */ credentialsKeyVaultReference?: outputs.web.KeyVaultReferenceWithStatusResponse; /** * Path on worker where storage will be mounted. */ destinationPath?: string; /** * Name of the storage mount. */ name?: string; /** * Source of the fileshare/storage. */ source?: string; /** * Type of the storage mount. */ type?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * The configuration settings of the token store. */ interface TokenStoreResponse { /** * The configuration settings of the storage of the tokens if blob storage is used. */ azureBlobStorage?: outputs.web.BlobStorageTokenStoreResponse; /** * true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false. * The default is false. */ enabled?: boolean; /** * The configuration settings of the storage of the tokens if a file system is used. */ fileSystem?: outputs.web.FileSystemTokenStoreResponse; /** * The number of hours after session token expiration that a session token can be used to * call the token refresh API. The default is 72 hours. */ tokenRefreshExtensionHours?: number; } /** * The configuration settings of the app registration for the Twitter provider. */ interface TwitterRegistrationResponse { /** * The OAuth 1.0a consumer key of the Twitter application used for sign-in. * This setting is required for enabling Twitter Sign-In. * Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in */ consumerKey?: string; /** * The app setting name that contains the OAuth 1.0a consumer secret of the Twitter * application used for sign-in. */ consumerSecretSettingName?: string; } /** * The configuration settings of the Twitter provider. */ interface TwitterResponse { /** * false if the Twitter provider should not be enabled despite the set registration; otherwise, true. */ enabled?: boolean; /** * The configuration settings of the app registration for the Twitter provider. */ registration?: outputs.web.TwitterRegistrationResponse; } /** * User Assigned identity. */ interface UserAssignedIdentityResponse { /** * Client Id of user assigned identity */ clientId: string; /** * Principal Id of user assigned identity */ principalId: string; } /** * Virtual application in an app. */ interface VirtualApplicationResponse { /** * Physical path. */ physicalPath?: string; /** * true if preloading is enabled; otherwise, false. */ preloadEnabled?: boolean; /** * Virtual directories for virtual application. */ virtualDirectories?: outputs.web.VirtualDirectoryResponse[]; /** * Virtual path. */ virtualPath?: string; } /** * Directory for virtual application. */ interface VirtualDirectoryResponse { /** * Physical path. */ physicalPath?: string; /** * Path to virtual application. */ virtualPath?: string; } /** * Specification for using a Virtual Network. */ interface VirtualNetworkProfileResponse { /** * Resource id of the Virtual Network. */ id: string; /** * Name of the Virtual Network (read-only). */ name: string; /** * Subnet within the Virtual Network. */ subnet?: string; /** * Resource type of the Virtual Network (read-only). */ type: string; } /** * Virtual Network route contract used to pass routing information for a Virtual Network. */ interface VnetRouteResponse { /** * The ending address for this route. If the start address is specified in CIDR notation, this must be omitted. */ endAddress?: string; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * Kind of resource. */ kind?: string; /** * The name of the resource */ name: string; /** * The type of route this is: * DEFAULT - By default, every app has routes to the local address ranges specified by RFC1918 * INHERITED - Routes inherited from the real Virtual Network routes * STATIC - Static route set on the app only * * These values will be used for syncing an app's routes with those from a Virtual Network. */ routeType?: string; /** * The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified. */ startAddress?: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.web.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } interface VolumeMountResponse { /** * Target path on the container where volume is mounted on */ containerMountPath: string; /** * Config Data to be mounted on the volume */ data?: string; /** * Boolean to specify if the mount is read only on the container */ readOnly?: boolean; /** * Sub path in the volume where volume is mounted from. */ volumeSubPath: string; } /** * Additional workflow properties. */ interface WorkflowEnvelopePropertiesResponse { /** * Gets or sets the files. */ files?: any; /** * Gets or sets the state of the workflow. */ flowState?: string; /** * Gets or sets workflow health. */ health?: outputs.web.WorkflowHealthResponse; } /** * Represents the workflow health. */ interface WorkflowHealthResponse { /** * Gets or sets the workflow error. */ error?: outputs.web.ErrorEntityResponse; /** * Gets or sets the workflow health state. */ state: string; } /** * Gets the workflow trigger callback URL query parameters. */ interface WorkflowTriggerListCallbackUrlQueriesResponse { /** * The api version. */ apiVersion?: string; /** * The SAS timestamp. */ se?: string; /** * The SAS signature. */ sig?: string; /** * The SAS permissions. */ sp?: string; /** * The SAS version. */ sv?: string; } /** * The WSDL definition */ interface WsdlDefinitionResponse { /** * The WSDL content */ content?: string; /** * The WSDL import method */ importMethod?: string; /** * The service with name and endpoint names */ service?: outputs.web.WsdlServiceResponse; /** * The WSDL URL */ url?: string; } /** * The service with name and endpoint names */ interface WsdlServiceResponse { /** * List of the endpoints' qualified names */ endpointQualifiedNames?: string[]; /** * The service's qualified name */ qualifiedName: string; } } export declare namespace webpubsub { /** * Properties of event handler. */ interface EventHandlerResponse { /** * Upstream auth settings. If not set, no auth is used for upstream messages. */ auth?: outputs.webpubsub.UpstreamAuthSettingsResponse; /** * Gets or sets the list of system events. */ systemEvents?: string[]; /** * Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in. * For example, UrlTemplate can be `http://example.com/api/{hub}/{event}`. The host part can't contains parameters. */ urlTemplate: string; /** * Gets or sets the matching pattern for event names. * There are 3 kinds of patterns supported: * 1. "*", it matches any event name * 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" * 3. A single event name, for example, "event1", it matches "event1" */ userEventPattern?: string; } /** * An Event Hub endpoint. * The managed identity of Web PubSub service must be enabled, and the identity should have the "Azure Event Hubs Data sender" role to access Event Hub. */ interface EventHubEndpointResponse { /** * The name of the Event Hub. */ eventHubName: string; /** * The fully qualified namespace name of the Event Hub resource. For example, "example.servicebus.windows.net". */ fullyQualifiedNamespace: string; /** * Expected value is 'EventHub'. */ type: "EventHub"; } /** * A setting defines which kinds of events should be sent to which endpoint. */ interface EventListenerResponse { /** * An endpoint specifying where Web PubSub should send events to. */ endpoint: outputs.webpubsub.EventHubEndpointResponse; /** * A base class for event filter which determines whether an event should be sent to an event listener. */ filter: outputs.webpubsub.EventNameFilterResponse; } /** * Filter events by their name. */ interface EventNameFilterResponse { /** * Gets or sets a list of system events. Supported events: "connected" and "disconnected". Blocking event "connect" is not supported because it requires a response. */ systemEvents?: string[]; /** * Expected value is 'EventName'. */ type: "EventName"; /** * Gets or sets a matching pattern for event names. * There are 3 kinds of patterns supported: * 1. "*", it matches any event name * 2. Combine multiple events with ",", for example "event1,event2", it matches events "event1" and "event2" * 3. A single event name, for example, "event1", it matches "event1" */ userEventPattern?: string; } /** * An IP rule */ interface IPRuleResponse { /** * Azure Networking ACL Action. */ action?: string; /** * An IP or CIDR or ServiceTag */ value?: string; } /** * Live trace category configuration of a Microsoft.SignalRService resource. */ interface LiveTraceCategoryResponse { /** * Indicates whether or the live trace category is enabled. * Available values: true, false. * Case insensitive. */ enabled?: string; /** * Gets or sets the live trace category's name. * Available values: ConnectivityLogs, MessagingLogs. * Case insensitive. */ name?: string; } /** * Live trace configuration of a Microsoft.SignalRService resource. */ interface LiveTraceConfigurationResponse { /** * Gets or sets the list of category configurations. */ categories?: outputs.webpubsub.LiveTraceCategoryResponse[]; /** * Indicates whether or not enable live trace. * When it's set to true, live trace client can connect to the service. * Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". * Available values: true, false. * Case insensitive. */ enabled?: string; } /** * liveTraceConfigurationResponseProvideDefaults sets the appropriate defaults for LiveTraceConfigurationResponse */ function liveTraceConfigurationResponseProvideDefaults(val: LiveTraceConfigurationResponse): LiveTraceConfigurationResponse; /** * A class represent managed identities used for request and response */ interface ManagedIdentityResponse { /** * Get the principal id for the system assigned identity. * Only be used in response. */ principalId: string; /** * Get the tenant id for the system assigned identity. * Only be used in response */ tenantId: string; /** * Represents the identity type: systemAssigned, userAssigned, None */ type?: string; /** * Get or set the user assigned identities */ userAssignedIdentities?: { [key: string]: outputs.webpubsub.UserAssignedIdentityPropertyResponse; }; } /** * Managed identity settings for upstream. */ interface ManagedIdentitySettingsResponse { /** * The Resource indicating the App ID URI of the target resource. * It also appears in the aud (audience) claim of the issued token. */ resource?: string; } /** * Network ACL */ interface NetworkACLResponse { /** * Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. */ allow?: string[]; /** * Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. */ deny?: string[]; } /** * ACL for a private endpoint */ interface PrivateEndpointACLResponse { /** * Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. */ allow?: string[]; /** * Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. */ deny?: string[]; /** * Name of the private endpoint connection */ name: string; } /** * A private endpoint connection to an azure resource */ interface PrivateEndpointConnectionResponse { /** * Group IDs */ groupIds: string[]; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * Private endpoint */ privateEndpoint?: outputs.webpubsub.PrivateEndpointResponse; /** * Connection state of the private endpoint connection */ privateLinkServiceConnectionState?: outputs.webpubsub.PrivateLinkServiceConnectionStateResponse; /** * Provisioning state of the resource. */ provisioningState: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.webpubsub.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Private endpoint */ interface PrivateEndpointResponse { /** * Full qualified Id of the private endpoint */ id?: string; } /** * Connection state of the private endpoint connection */ interface PrivateLinkServiceConnectionStateResponse { /** * A message indicating if changes on the service provider require any updates on the consumer. */ actionsRequired?: string; /** * The reason for approval/rejection of the connection. */ description?: string; /** * Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. */ status?: string; } /** * Resource log category configuration of a Microsoft.SignalRService resource. */ interface ResourceLogCategoryResponse { /** * Indicates whether or the resource log category is enabled. * Available values: true, false. * Case insensitive. */ enabled?: string; /** * Gets or sets the resource log category's name. * Available values: ConnectivityLogs, MessagingLogs. * Case insensitive. */ name?: string; } /** * Resource log configuration of a Microsoft.SignalRService resource. */ interface ResourceLogConfigurationResponse { /** * Gets or sets the list of category configurations. */ categories?: outputs.webpubsub.ResourceLogCategoryResponse[]; } /** * Reference to a resource. */ interface ResourceReferenceResponse { /** * Resource ID. */ id?: string; } /** * The billing information of the resource. */ interface ResourceSkuResponse { /** * Optional, integer. The unit count of the resource. * 1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. * * If present, following values are allowed: * Free_F1: 1; * Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; * Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; * Premium_P2: 100,200,300,400,500,600,700,800,900,1000; */ capacity?: number; /** * Not used. Retained for future use. */ family: string; /** * The name of the SKU. Required. * * Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 */ name: string; /** * Not used. Retained for future use. */ size: string; /** * Optional tier of this particular SKU. 'Standard' or 'Free'. * * `Basic` is deprecated, use `Standard` instead. */ tier?: string; } /** * Describes a Shared Private Link Resource */ interface SharedPrivateLinkResourceResponse { /** * The group id from the provider of resource the shared private link resource is for */ groupId: string; /** * Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" */ id: string; /** * The name of the resource */ name: string; /** * The resource id of the resource the shared private link resource is for */ privateLinkResourceId: string; /** * Provisioning state of the resource. */ provisioningState: string; /** * The request message for requesting approval of the shared private link resource */ requestMessage?: string; /** * Status of the shared private link resource */ status: string; /** * Azure Resource Manager metadata containing createdBy and modifiedBy information. */ systemData: outputs.webpubsub.SystemDataResponse; /** * The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" */ type: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Upstream auth settings. If not set, no auth is used for upstream messages. */ interface UpstreamAuthSettingsResponse { /** * Managed identity settings for upstream. */ managedIdentity?: outputs.webpubsub.ManagedIdentitySettingsResponse; /** * Upstream auth type enum. */ type?: string; } /** * Properties of user assigned identity. */ interface UserAssignedIdentityPropertyResponse { /** * Get the client id for the user assigned identity */ clientId: string; /** * Get the principal id for the user assigned identity */ principalId: string; } /** * Properties of a hub. */ interface WebPubSubHubPropertiesResponse { /** * The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny". */ anonymousConnectPolicy?: string; /** * Event handler of a hub. */ eventHandlers?: outputs.webpubsub.EventHandlerResponse[]; /** * Event listener settings for forwarding your client events to listeners. * Event listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients. * One event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter. * Maximum count of event listeners among all hubs is 10. */ eventListeners?: outputs.webpubsub.EventListenerResponse[]; /** * The settings for configuring the WebSocket ping-pong interval in seconds for all clients in the hub. Valid range: 1 to 120. Default to 20 seconds. */ webSocketKeepAliveIntervalInSeconds?: number; } /** * webPubSubHubPropertiesResponseProvideDefaults sets the appropriate defaults for WebPubSubHubPropertiesResponse */ function webPubSubHubPropertiesResponseProvideDefaults(val: WebPubSubHubPropertiesResponse): WebPubSubHubPropertiesResponse; /** * Network ACLs for the resource */ interface WebPubSubNetworkACLsResponse { /** * Azure Networking ACL Action. */ defaultAction?: string; /** * IP rules for filtering public traffic */ ipRules?: outputs.webpubsub.IPRuleResponse[]; /** * ACLs for requests from private endpoints */ privateEndpoints?: outputs.webpubsub.PrivateEndpointACLResponse[]; /** * Network ACL */ publicNetwork?: outputs.webpubsub.NetworkACLResponse; } /** * SocketIO settings for the resource */ interface WebPubSubSocketIOSettingsResponse { /** * The service mode of Web PubSub for Socket.IO. Values allowed: * "Default": have your own backend Socket.IO server * "Serverless": your application doesn't have a backend server */ serviceMode?: string; } /** * TLS settings for the resource */ interface WebPubSubTlsSettingsResponse { /** * Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input will be ignored for free tier. */ clientCertEnabled?: boolean; } /** * webPubSubTlsSettingsResponseProvideDefaults sets the appropriate defaults for WebPubSubTlsSettingsResponse */ function webPubSubTlsSettingsResponseProvideDefaults(val: WebPubSubTlsSettingsResponse): WebPubSubTlsSettingsResponse; } export declare namespace weightsandbiases { /** * Properties specific to Instance */ interface InstancePropertiesResponse { /** * Marketplace details of the resource. */ marketplace: outputs.weightsandbiases.MarketplaceDetailsResponse; /** * partner properties */ partnerProperties?: outputs.weightsandbiases.PartnerPropertiesResponse; /** * Provisioning state of the resource. */ provisioningState: string; /** * Single sign-on properties */ singleSignOnProperties?: outputs.weightsandbiases.SingleSignOnPropertiesV2Response; /** * Details of the user. */ user: outputs.weightsandbiases.UserDetailsResponse; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.weightsandbiases.UserAssignedIdentityResponse; }; } /** * Marketplace details for an organization */ interface MarketplaceDetailsResponse { /** * Offer details for the marketplace that is selected by the user */ offerDetails: outputs.weightsandbiases.OfferDetailsResponse; /** * Azure subscription id for the the marketplace offer is purchased from */ subscriptionId?: string; /** * Marketplace subscription status */ subscriptionStatus: string; } /** * Offer details for the marketplace that is selected by the user */ interface OfferDetailsResponse { /** * Offer Id for the marketplace offer */ offerId: string; /** * Plan Id for the marketplace offer */ planId: string; /** * Plan Name for the marketplace offer */ planName?: string; /** * Publisher Id for the marketplace offer */ publisherId: string; /** * Plan Display Name for the marketplace offer */ termId?: string; /** * Plan Display Name for the marketplace offer */ termUnit?: string; } /** * Partner's specific Properties */ interface PartnerPropertiesResponse { /** * The region of the instance */ region: string; /** * The subdomain of the instance */ subdomain: string; } /** * Properties specific to Single Sign On Resource */ interface SingleSignOnPropertiesV2Response { /** * List of AAD domains fetched from Microsoft Graph for user. */ aadDomains?: string[]; /** * AAD enterprise application Id used to setup SSO */ enterpriseAppId?: string; /** * State of the Single Sign On for the resource */ state?: string; /** * Type of Single Sign-On mechanism being used */ type: string; /** * URL for SSO to be used by the partner to redirect the user to their system */ url?: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * User details for an organization */ interface UserDetailsResponse { /** * Email address of the user */ emailAddress?: string; /** * First name of the user */ firstName?: string; /** * Last name of the user */ lastName?: string; /** * User's phone number */ phoneNumber?: string; /** * User's principal name */ upn?: string; } } export declare namespace widget { /** * Employee properties */ interface EmployeePropertiesResponse { /** * Age of employee */ age?: number; /** * City of employee */ city?: string; /** * Profile of employee */ profile?: string; /** * The status of the last operation. */ provisioningState: string; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } } export declare namespace workloads { /** * Defines the Alert Query Parameter. */ interface AlertQueryParameterResponse { /** * The name of the alert query parameter. */ name?: string; /** * The value of the alert query parameter. */ value?: string; } /** * Describes the properties of an alert. */ interface AlertRulePropertiesResponse { /** * Action Group resource Ids to invoke when the alert fires */ actionGroups?: string[]; /** * The alert query parameters. */ alertQueryParameters?: outputs.workloads.AlertQueryParameterResponse[]; /** * The value that indicates whether the alert should be automatically resolved or not. The default is Disable. */ autoMitigate?: string; /** * Evaluation of metric on a particular column. */ dimension?: string; /** * How often the scheduled query rule is evaluated. */ evaluationFrequency?: number; /** * The operator for failing periods. */ failingPeriodsOperator?: string; /** * The number of failing periods to trigger an alert. */ failingPeriodsToAlert?: number; /** * Mute actions for the chosen period of time after the alert is fired. */ muteActionsDuration?: number; /** * Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. */ severity?: number; /** * Indicates whether the alert is in an enabled state. */ status?: string; /** * The threshold of the alert. */ threshold?: number; /** * The threshold operator of the alert. */ thresholdOperator?: string; /** * The period of time on which the Alert query will be executed. */ windowSize?: number; } /** * Configuration details of app service plan */ interface AppServicePlanConfigurationResponse { /** * The number of workers in app service plan. If this is not set or set to 0, auto scale will be configured for the app service plan, otherwise, instance count is set to this number. */ capacity?: number; /** * The App Service plan tier. */ tier?: string; } /** * Gets or sets the application server configuration. */ interface ApplicationServerConfigurationResponse { /** * The number of app server instances. */ instanceCount: number; /** * The subnet id. */ subnetId: string; /** * Gets or sets the virtual machine configuration. */ virtualMachineConfiguration: outputs.workloads.VirtualMachineConfigurationResponse; } /** * The full resource names object for application layer resources. The number of entries in this list should be equal to the number VMs to be created for application layer. */ interface ApplicationServerFullResourceNamesResponse { /** * The full name for availability set. In case name is not provided, it will be defaulted to {SID}-App-AvSet. */ availabilitySetName?: string; /** * The list of virtual machine naming details. */ virtualMachines?: outputs.workloads.VirtualMachineResourceNamesResponse[]; } /** * The Application Server VM Details. */ interface ApplicationServerVmDetailsResponse { /** * Storage details of all the Storage Accounts attached to the App Virtual Machine. For e.g. NFS on AFS Shared Storage. */ storageDetails: outputs.workloads.StorageInformationResponse[]; /** * Defines the type of application server VM. */ type: string; /** * The virtual machine id. */ virtualMachineId: string; } /** * Gets or sets the central server configuration. */ interface CentralServerConfigurationResponse { /** * The number of central server VMs. */ instanceCount: number; /** * The subnet id. */ subnetId: string; /** * Gets or sets the virtual machine configuration. */ virtualMachineConfiguration: outputs.workloads.VirtualMachineConfigurationResponse; } /** * The full resource names object for central server layer resources. */ interface CentralServerFullResourceNamesResponse { /** * The full name for availability set. In case name is not provided, it will be defaulted to {SID}-ASCS-AvSet. */ availabilitySetName?: string; /** * The resource names object for load balancer and related resources. */ loadBalancer?: outputs.workloads.LoadBalancerResourceNamesResponse; /** * The list of names for all ASCS virtual machines to be deployed. The number of entries in this list should be equal to the number VMs to be created for ASCS layer. At maximum, there can be two virtual machines at this layer: ASCS and ERS. */ virtualMachines?: outputs.workloads.VirtualMachineResourceNamesResponse[]; } /** * The SAP Central Services Instance VM details. */ interface CentralServerVmDetailsResponse { /** * Storage details of all the Storage Accounts attached to the ASCS Virtual Machine. For e.g. NFS on AFS Shared Storage. */ storageDetails: outputs.workloads.StorageInformationResponse[]; /** * Defines the type of central server VM. */ type: string; /** * The virtual machine id. */ virtualMachineId: string; } /** * The SAP instance specific configuration data. */ interface ConfigurationDataResponse { /** * Provide the CPU value of the server. For example, 16, 32 etc. */ cpu: number; /** * Provide the CPU clock speed of the server in MHz. This should be a non-zero value. For example, 2100. */ cpuInMhz: number; /** * Provide the CPU architecture type of the server. For example, Xeon Platinum 8171M, Xeon E5-2673 v3. */ cpuType: string; /** * The database of this is a server instance. Applicable only if SAP instance type for this server instance is 'DB'. */ databaseType: string; /** * Provide the HW manufacturer company of the server. For example, Microsoft Corporation. */ hardwareManufacturer: string; /** * Specify if the Hardware is a physical server or virtual machine. */ model: string; /** * Provide the RAM of the server. This should be a non-zero value. For example, 256. */ ram: number; /** * Provide the SAPS for each server of the SAP system. This should be a non-zero value. For example, 1000. */ saps: number; /** * Provide the target HANA database size you need. Applicable only if SAP instance type for this server instance is 'DB' and you are migrating an AnyDb database to SAP S/4HANA. */ targetHanaRamSizeGB: number; /** * Provide the total disk IOPS capacity. Add the disk volume for each individual disk and provide the sum total in this field. */ totalDiskIops: number; /** * Provide the total disk volume capacity in GB. Add the disk volume for each individual disks and provide the total sum in this field. */ totalDiskSizeGB: number; } /** * Error definition. */ interface ConnectorErrorDefinitionResponse { /** * Service specific error code which serves as the substatus for the HTTP error code. */ code: string; /** * Internal error details. */ details: outputs.workloads.ConnectorErrorDefinitionResponse[]; /** * Description of the error. */ message: string; } /** * Gets or sets the file share configuration where the transport directory fileshare is created and mounted as a part of the create infra flow. Please pre-create the resource group you intend to place the transport directory in. The storage account and fileshare will be auto-created by the ACSS and doesn't need to be pre-created. */ interface CreateAndMountFileShareConfigurationResponse { /** * The type of file share config. * Expected value is 'CreateAndMount'. */ configurationType: "CreateAndMount"; /** * The name of transport file share resource group. This should be pre created by the customer. The app rg is used in case of missing input. */ resourceGroup?: string; /** * The name of file share storage account name . A custom name is used in case of missing input. */ storageAccountName?: string; } /** * Defines the policy properties for database backup. */ interface DBBackupPolicyPropertiesResponse { /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'AzureWorkload'. */ backupManagementType: "AzureWorkload"; /** * Fix the policy inconsistency */ makePolicyConsistent?: boolean; /** * The name of the DB backup policy. */ name: string; /** * Number of items associated with this policy. */ protectedItemsCount?: number; /** * ResourceGuard Operation Requests */ resourceGuardOperationRequests?: string[]; /** * Common settings for the backup management */ settings?: outputs.workloads.SettingsResponse; /** * List of sub-protection policies which includes schedule and retention */ subProtectionPolicy?: outputs.workloads.SubProtectionPolicyResponse[]; /** * Type of workload for the backup management */ workLoadType?: string; } /** * Daily retention format. */ interface DailyRetentionFormatResponse { /** * List of days of the month. */ daysOfTheMonth?: outputs.workloads.DayResponse[]; } /** * Daily retention schedule. */ interface DailyRetentionScheduleResponse { /** * Retention duration of retention Policy. */ retentionDuration?: outputs.workloads.RetentionDurationResponse; /** * Retention times of retention policy. */ retentionTimes?: string[]; } /** * Daily schedule. */ interface DailyScheduleResponse { /** * List of times of day this schedule has to be run. */ scheduleRunTimes?: string[]; } /** * Gets or sets the database configuration. */ interface DatabaseConfigurationResponse { /** * The database type. */ databaseType?: string; /** * Gets or sets the disk configuration. */ diskConfiguration?: outputs.workloads.DiskConfigurationResponse; /** * The number of database VMs. */ instanceCount: number; /** * The subnet id. */ subnetId: string; /** * Gets or sets the virtual machine configuration. */ virtualMachineConfiguration: outputs.workloads.VirtualMachineConfigurationResponse; } /** * The full resource names object for database layer resources. The number of entries in this list should be equal to the number VMs to be created for database layer. */ interface DatabaseServerFullResourceNamesResponse { /** * The full name for availability set. In case name is not provided, it will be defaulted to {SID}-DB-AvSet. */ availabilitySetName?: string; /** * The resource names object for load balancer and related resources. */ loadBalancer?: outputs.workloads.LoadBalancerResourceNamesResponse; /** * The list of virtual machine naming details. */ virtualMachines?: outputs.workloads.VirtualMachineResourceNamesResponse[]; } /** * Database VM details. */ interface DatabaseVmDetailsResponse { /** * Defines the SAP Instance status. */ status: string; /** * Storage details of all the Storage Accounts attached to the Database Virtual Machine. For e.g. NFS on AFS Shared Storage. */ storageDetails: outputs.workloads.StorageInformationResponse[]; /** * The virtual machine id. */ virtualMachineId: string; } /** * Day of the week. */ interface DayResponse { /** * Date of the month */ date?: number; /** * Whether Date is last date of month */ isLast?: boolean; } /** * Gets or sets the DB2 provider properties. */ interface Db2ProviderInstancePropertiesResponse { /** * Gets or sets the db2 database name. */ dbName?: string; /** * Gets or sets the db2 database password. */ dbPassword?: string; /** * Gets or sets the key vault URI to secret with the database password. */ dbPasswordUri?: string; /** * Gets or sets the db2 database sql port. */ dbPort?: string; /** * Gets or sets the db2 database user name. */ dbUsername?: string; /** * Gets or sets the target virtual machine name. */ hostname?: string; /** * The provider type. For example, the value can be SapHana. * Expected value is 'Db2'. */ providerType: "Db2"; /** * Gets or sets the SAP System Identifier */ sapSid?: string; /** * Gets or sets the blob URI to SSL certificate for the DB2 Database. */ sslCertificateUri?: string; /** * Gets or sets certificate preference if secure communication is enabled. */ sslPreference?: string; } /** * Defines the url and storage account ID where deployer VM packages are uploaded */ interface DeployerVmPackagesResponse { /** * The deployer VM packages storage account id */ storageAccountId?: string; /** * The URL to the deployer VM packages file. */ url?: string; } /** * Deployment Configuration. */ interface DeploymentConfigurationResponse { /** * The geo-location where the SAP system is to be created. */ appLocation?: string; /** * The configuration Type. * Expected value is 'Deployment'. */ configurationType: "Deployment"; /** * The infrastructure configuration. */ infrastructureConfiguration?: outputs.workloads.SingleServerConfigurationResponse | outputs.workloads.ThreeTierConfigurationResponse; /** * The software configuration. */ softwareConfiguration?: outputs.workloads.ExternalInstallationSoftwareConfigurationResponse | outputs.workloads.SAPInstallWithoutOSConfigSoftwareConfigurationResponse | outputs.workloads.ServiceInitiatedSoftwareConfigurationResponse; } /** * Deployment along with OS Configuration. */ interface DeploymentWithOSConfigurationResponse { /** * The geo-location where the SAP system is to be created. */ appLocation?: string; /** * The configuration Type. * Expected value is 'DeploymentWithOSConfig'. */ configurationType: "DeploymentWithOSConfig"; /** * The infrastructure configuration. */ infrastructureConfiguration?: outputs.workloads.SingleServerConfigurationResponse | outputs.workloads.ThreeTierConfigurationResponse; /** * The OS and SAP configuration. */ osSapConfiguration?: outputs.workloads.OsSapConfigurationResponse; /** * The software configuration. */ softwareConfiguration?: outputs.workloads.ExternalInstallationSoftwareConfigurationResponse | outputs.workloads.SAPInstallWithoutOSConfigSoftwareConfigurationResponse | outputs.workloads.ServiceInitiatedSoftwareConfigurationResponse; } /** * Discovery Details. */ interface DiscoveryConfigurationResponse { /** * The geo-location where the SAP system exists. */ appLocation: string; /** * The virtual machine ID of the Central Server. */ centralServerVmId?: string; /** * The configuration Type. * Expected value is 'Discovery'. */ configurationType: "Discovery"; /** * The custom storage account name for the storage account created by the service in the managed resource group created as part of VIS deployment.

    Refer to the storage account naming rules [here](https://learn.microsoft.com/azure/azure-resource-manager/management/resource-name-rules#microsoftstorage).

    If not provided, the service will create the storage account with a random name. */ managedRgStorageAccountName?: string; } /** * The Disk Configuration Details. */ interface DiskConfigurationResponse { /** * The disk configuration for the db volume. For HANA, Required volumes are: ['hana/data', 'hana/log', hana/shared', 'usr/sap', 'os'], Optional volume : ['backup']. */ diskVolumeConfigurations?: { [key: string]: outputs.workloads.DiskVolumeConfigurationResponse; }; } /** * The supported disk size details for a disk type. */ interface DiskDetailsResponse { /** * The disk tier, e.g. P10, E10. */ diskTier?: string; /** * The disk Iops. */ iopsReadWrite?: number; /** * The maximum supported disk count. */ maximumSupportedDiskCount?: number; /** * The disk provisioned throughput in MBps. */ mbpsReadWrite?: number; /** * The minimum supported disk count. */ minimumSupportedDiskCount?: number; /** * The disk size in GB. */ sizeGB?: number; /** * The type of disk sku. For example, Standard_LRS, Standard_ZRS, Premium_LRS, Premium_ZRS. */ sku?: outputs.workloads.DiskSkuResponse; } /** * Defines the disk exclusion properties for virtual machine backup. */ interface DiskExclusionPropertiesResponse { /** * List of Disks' Logical Unit Numbers (LUN) to be used for VM Protection. */ diskLunList: number[]; /** * Flag to indicate whether DiskLunList is to be included/ excluded from backup. */ isInclusionList: boolean; } /** * The type of disk sku. For example, Standard_LRS, Standard_ZRS, Premium_LRS, Premium_ZRS. */ interface DiskSkuResponse { /** * Defines the disk sku name. */ name?: string; } /** * The disk configuration required for the selected volume. */ interface DiskVolumeConfigurationResponse { /** * The total number of disks required for the concerned volume. */ count?: number; /** * The disk size in GB. */ sizeGB?: number; /** * The disk SKU details. */ sku?: outputs.workloads.DiskSkuResponse; } /** * Defines the SAP Enqueue Replication Server (ERS) properties. */ interface EnqueueReplicationServerPropertiesResponse { /** * Defines the type of Enqueue Replication Server. */ ersVersion: string; /** * Defines the health of SAP Instances. */ health: string; /** * ERS SAP Hostname. */ hostname: string; /** * ERS Instance Number. */ instanceNo: string; /** * ERS SAP IP Address. */ ipAddress: string; /** * ERS SAP Kernel Patch level. */ kernelPatch: string; /** * ERS SAP Kernel Version. */ kernelVersion: string; } /** * Defines the SAP Enqueue Server properties. */ interface EnqueueServerPropertiesResponse { /** * Defines the health of SAP Instances. */ health: string; /** * Enqueue Server SAP Hostname. */ hostname: string; /** * Enqueue Server SAP IP Address. */ ipAddress: string; /** * Enqueue Server Port. */ port: number; } /** * The resource management error additional info. */ interface ErrorAdditionalInfoResponse { /** * The additional info. */ info: any; /** * The additional info type. */ type: string; } /** * Error definition. */ interface ErrorDefinitionResponse { /** * Service specific error code which serves as the substatus for the HTTP error code. */ code: string; /** * Internal error details. */ details: outputs.workloads.ErrorDefinitionResponse[]; /** * Description of the error. */ message: string; } /** * Error definition. */ interface ErrorDefinitionSapDiscoverySiteResponse { /** * Service specific error code which serves as the substatus for the HTTP error code. */ code: string; /** * Internal error details. */ details: outputs.workloads.ErrorDefinitionResponse[]; /** * Description of the error. */ message: string; /** * Description of the recommendation. */ recommendation: string; } /** * Error definition. */ interface ErrorDefinitionSapInstanceResponse { /** * Service specific error code which serves as the substatus for the HTTP error code. */ code: string; /** * Internal error details. */ details: outputs.workloads.ErrorDefinitionResponse[]; /** * Description of the error. */ message: string; /** * Description of the recommendation. */ recommendation: string; } /** * Error definition. */ interface ErrorDefinitionServerInstanceResponse { /** * Service specific error code which serves as the substatus for the HTTP error code. */ code: string; /** * Internal error details. */ details: outputs.workloads.ErrorDefinitionResponse[]; /** * Description of the error. */ message: string; /** * Description of the recommendation. */ recommendation: string; } /** * The error detail. */ interface ErrorDetailResponse { /** * The error additional info. */ additionalInfo: outputs.workloads.ErrorAdditionalInfoResponse[]; /** * The error code. */ code: string; /** * The error details. */ details: outputs.workloads.ErrorDetailResponse[]; /** * The error message. */ message: string; /** * The error target. */ target: string; } /** * The SAP instance specific performance data for Excel import. */ interface ExcelPerformanceDataResponse { /** * The data source for this resource. * Expected value is 'Excel'. */ dataSource: "Excel"; /** * Provide the max CPU percentage load on the server. Omit the percentage symbol while filling this value. */ maxCpuLoad: number; /** * Provide the source Database size in GB. Applicable only if SAP instance type for this server instance is 'DB'. */ totalSourceDbSizeGB: number; } /** * Existing recovery services vault. */ interface ExistingRecoveryServicesVaultResponse { /** * The resource ID of the recovery services vault that has been created. */ id: string; /** * The vault type, whether it is existing or has to be created. * Expected value is 'Existing'. */ vaultType: "Existing"; } /** * The extended location definition. */ interface ExtendedLocationResponse { /** * The extended location name. */ name: string; /** * The extended location type. */ type: string; } /** * The SAP Software configuration Input when the software is installed externally outside the service. */ interface ExternalInstallationSoftwareConfigurationResponse { /** * The resource ID of the virtual machine containing the central server instance. */ centralServerVmId?: string; /** * The SAP software installation Type. * Expected value is 'External'. */ softwareInstallationType: "External"; } /** * Defines the SAP Gateway Server properties. */ interface GatewayServerPropertiesResponse { /** * Defines the health of SAP Instances. */ health: string; /** * Gateway Port. */ port: number; } /** * Defines the HANA Backup data for a virtual instance for SAP. */ interface HanaBackupDataResponse { /** * Defines the policy properties for database backup. */ backupPolicy: outputs.workloads.DBBackupPolicyPropertiesResponse; /** * The type of backup, VM, SQL or HANA. * Expected value is 'HANA'. */ backupType: "HANA"; /** * Defines the policy properties for database backup. */ dbInstanceSnapshotBackupPolicy?: outputs.workloads.DBBackupPolicyPropertiesResponse; /** * Name of the HANA Database User Store Key. */ hdbuserstoreKeyName: string; /** * Gets or sets the database instance number. */ instanceNumber?: string; /** * The properties of the recovery services vault used for backup. */ recoveryServicesVault: outputs.workloads.ExistingRecoveryServicesVaultResponse | outputs.workloads.NewRecoveryServicesVaultResponse; /** * Path of the SSL key store. */ sslConfiguration?: outputs.workloads.SSLConfigurationResponse; } /** * Gets or sets the provider properties. */ interface HanaDbProviderInstancePropertiesResponse { /** * Gets or sets the hana database name. */ dbName?: string; /** * Gets or sets the database password. */ dbPassword?: string; /** * Gets or sets the key vault URI to secret with the database password. */ dbPasswordUri?: string; /** * Gets or sets the database user name. */ dbUsername?: string; /** * Gets or sets the target virtual machine size. */ hostname?: string; /** * Gets or sets the database instance number. */ instanceNumber?: string; /** * The provider type. For example, the value can be SapHana. * Expected value is 'SapHana'. */ providerType: "SapHana"; /** * Gets or sets the SAP System Identifier. */ sapSid?: string; /** * Gets or sets the database sql port. */ sqlPort?: string; /** * Gets or sets the blob URI to SSL certificate for the DB. */ sslCertificateUri?: string; /** * Gets or sets the hostname(s) in the SSL certificate. */ sslHostNameInCertificate?: string; /** * Gets or sets certificate preference if secure communication is enabled. */ sslPreference?: string; } /** * Resource health details */ interface HealthResponse { /** * Health state of the resource */ healthState: string; /** * Reasons impacting health state */ impactingReasons: string; } /** * Gets or sets the high availability configuration. */ interface HighAvailabilityConfigurationResponse { /** * The high availability type. */ highAvailabilityType: string; } /** * Gets or sets the HA software configuration. */ interface HighAvailabilitySoftwareConfigurationResponse { /** * The fencing client id. */ fencingClientId: string; /** * The fencing client id secret/password. The secret should never expire. This will be used pacemaker to start/stop the cluster VMs. */ fencingClientPassword: string; } /** * Hourly schedule. */ interface HourlyScheduleResponse { /** * Interval at which backup needs to be triggered. For hourly the value * can be 4/6/8/12 */ interval?: number; /** * To specify duration of the backup window */ scheduleWindowDuration?: number; /** * To specify start time of the backup window */ scheduleWindowStartTime?: string; } /** * Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set. */ interface ImageReferenceResponse { /** * Specifies the ARM resource ID of the Azure Compute Gallery image version used for creating ACSS VMs. You will need to provide this input when you choose to deploy virtual machines in ACSS with OS image from the Azure Compute gallery. */ id?: string; /** * Specifies the offer of the platform image or marketplace image used to create the virtual machine. */ offer?: string; /** * The image publisher. */ publisher?: string; /** * The image SKU. */ sku?: string; /** * Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available. */ version?: string; } /** * Instant recovery point additional details. */ interface InstantRPAdditionalDetailsResponse { /** * Azure backup resource group name prefix. */ azureBackupRGNamePrefix?: string; /** * Azure backup resource group name suffix. */ azureBackupRGNameSuffix?: string; } /** * Specifies the Linux operating system settings on the virtual machine. For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://learn.microsoft.com/azure/virtual-machines/linux/endorsed-distros). */ interface LinuxConfigurationResponse { /** * Specifies whether password authentication should be disabled. */ disablePasswordAuthentication?: boolean; /** * The OS Type * Expected value is 'Linux'. */ osType: "Linux"; /** * Specifies the ssh key configuration for a Linux OS. (This property is deprecated, please use 'sshKeyPair' instead) */ ssh?: outputs.workloads.SshConfigurationResponse; /** * The SSH Key-pair used to authenticate with the VM's. */ sshKeyPair?: outputs.workloads.SshKeyPairResponse; } /** * The Load Balancer details such as Load Balancer ID. */ interface LoadBalancerDetailsResponse { /** * Fully qualified resource ID for the load balancer. */ id: string; } /** * The resource names object for load balancer and related resources. */ interface LoadBalancerResourceNamesResponse { /** * The list of backend pool names. Currently, ACSS deploys only one backend pool and hence, size of this list should be 1 */ backendPoolNames?: string[]; /** * The list of frontend IP configuration names. If provided as input, size of this list should be 2 for cs layer and should be 1 for database layer. */ frontendIpConfigurationNames?: string[]; /** * The list of health probe names. If provided as input, size of this list should be 2 for cs layer and should be 1 for database layer. */ healthProbeNames?: string[]; /** * The full resource name for load balancer. If this value is not provided, load balancer will be name as {ASCS/DB}-loadBalancer. */ loadBalancerName?: string; } /** * Log policy schedule. */ interface LogSchedulePolicyResponse { /** * Frequency of the log schedule operation of this policy in minutes. */ scheduleFrequencyInMins?: number; /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'LogSchedulePolicy'. */ schedulePolicyType: "LogSchedulePolicy"; } /** * Long term retention policy. */ interface LongTermRetentionPolicyResponse { /** * Daily retention schedule of the protection policy. */ dailySchedule?: outputs.workloads.DailyRetentionScheduleResponse; /** * Monthly retention schedule of the protection policy. */ monthlySchedule?: outputs.workloads.MonthlyRetentionScheduleResponse; /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'LongTermRetentionPolicy'. */ retentionPolicyType: "LongTermRetentionPolicy"; /** * Weekly retention schedule of the protection policy. */ weeklySchedule?: outputs.workloads.WeeklyRetentionScheduleResponse; /** * Yearly retention schedule of the protection policy. */ yearlySchedule?: outputs.workloads.YearlyRetentionScheduleResponse; } /** * Long term policy schedule. */ interface LongTermSchedulePolicyResponse { /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'LongTermSchedulePolicy'. */ schedulePolicyType: "LongTermSchedulePolicy"; } /** * Managed resource group configuration */ interface ManagedRGConfigurationResponse { /** * Managed resource group name */ name?: string; } /** * Managed resource group configuration */ interface ManagedResourceGroupConfigurationResponse { /** * Managed resource group name */ name?: string; } /** * Managed service identity (system assigned and/or user assigned identities) */ interface ManagedServiceIdentityResponse { /** * The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity. */ principalId: string; /** * The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. */ tenantId: string; /** * Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). */ type: string; /** * The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. */ userAssignedIdentities?: { [key: string]: outputs.workloads.UserAssignedIdentityResponse; }; } /** * Defines the SAP message server properties. */ interface MessageServerPropertiesResponse { /** * Defines the health of SAP Instances. */ health: string; /** * message server SAP Hostname. */ hostname: string; /** * message server HTTP Port. */ httpPort: number; /** * message server HTTPS Port. */ httpsPort: number; /** * message server internal MS port. */ internalMsPort: number; /** * message server IP Address. */ ipAddress: string; /** * message server port. */ msPort: number; } /** * Monthly retention schedule. */ interface MonthlyRetentionScheduleResponse { /** * Retention duration of retention Policy. */ retentionDuration?: outputs.workloads.RetentionDurationResponse; /** * Daily retention format for monthly retention policy. */ retentionScheduleDaily?: outputs.workloads.DailyRetentionFormatResponse; /** * Retention schedule format type for monthly retention policy. */ retentionScheduleFormatType?: string; /** * Weekly retention format for monthly retention policy. */ retentionScheduleWeekly?: outputs.workloads.WeeklyRetentionFormatResponse; /** * Retention times of retention policy. */ retentionTimes?: string[]; } /** * Gets or sets the file share configuration where the transport directory fileshare already exists, and user wishes to mount the fileshare as a part of the create infra flow. */ interface MountFileShareConfigurationResponse { /** * The type of file share config. * Expected value is 'Mount'. */ configurationType: "Mount"; /** * The fileshare resource ID */ id: string; /** * The private endpoint resource ID */ privateEndpointId: string; } /** * Gets or sets the SQL server provider properties. */ interface MsSqlServerProviderInstancePropertiesResponse { /** * Gets or sets the database password. */ dbPassword?: string; /** * Gets or sets the key vault URI to secret with the database password. */ dbPasswordUri?: string; /** * Gets or sets the database sql port. */ dbPort?: string; /** * Gets or sets the database user name. */ dbUsername?: string; /** * Gets or sets the SQL server host name. */ hostname?: string; /** * The provider type. For example, the value can be SapHana. * Expected value is 'MsSqlServer'. */ providerType: "MsSqlServer"; /** * Gets or sets the SAP System Identifier */ sapSid?: string; /** * Gets or sets the blob URI to SSL certificate for the SQL Database. */ sslCertificateUri?: string; /** * Gets or sets certificate preference if secure communication is enabled. */ sslPreference?: string; } /** * The SAP instance specific performance data for native discovery. */ interface NativePerformanceDataResponse { /** * The data source for this resource. * Expected value is 'Native'. */ dataSource: "Native"; } /** * Defines the network configuration type for SAP system infrastructure that is being deployed */ interface NetworkConfigurationResponse { /** * Specifies whether a secondary IP address should be added to the network interface on all VMs of the SAP system being deployed */ isSecondaryIpEnabled?: boolean; } /** * networkConfigurationResponseProvideDefaults sets the appropriate defaults for NetworkConfigurationResponse */ function networkConfigurationResponseProvideDefaults(val: NetworkConfigurationResponse): NetworkConfigurationResponse; /** * The resource names object for network interface and related resources. */ interface NetworkInterfaceResourceNamesResponse { /** * The full name for network interface. If name is not provided, service uses a default name based on the deployment type. For SingleServer, default name is {SID}-Nic. In case of HA-AvZone systems, default name will be {SID}-{App/ASCS/DB}-Zone{A/B}-Nic with an incrementor at the end in case of more than 1 instance per layer. For distributed and HA-AvSet systems, default name will be {SID}-{App/ASCS/DB}-Nic with an incrementor at the end in case of more than 1 instance per layer. */ networkInterfaceName?: string; } /** * New recovery services vault. */ interface NewRecoveryServicesVaultResponse { /** * The name of the recovery services vault has to be created. */ name: string; /** * The name of the resource group where the recovery services vault has to be created. */ resourceGroup: string; /** * The vault type, whether it is existing or has to be created. * Expected value is 'New'. */ vaultType: "New"; } /** * Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned. */ interface OSProfileResponse { /** * Specifies the password of the administrator account.

    **Minimum-length (Windows):** 8 characters

    **Minimum-length (Linux):** 6 characters

    **Max-length (Windows):** 123 characters

    **Max-length (Linux):** 72 characters

    **Complexity requirements:** 3 out of 4 conditions below need to be fulfilled
    Has lower characters
    Has upper characters
    Has a digit
    Has a special character (Regex match [\W_])

    **Disallowed values:** "abc@123", "P@$$w0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

    For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/reset-rdp)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://learn.microsoft.com/troubleshoot/azure/virtual-machines/troubleshoot-ssh-connection) */ adminPassword?: string; /** * Specifies the name of the administrator account.

    This property cannot be updated after the VM is created.

    **Windows-only restriction:** Cannot end in "."

    **Disallowed values:** "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

    **Minimum-length (Linux):** 1 character

    **Max-length (Linux):** 64 characters

    **Max-length (Windows):** 20 characters. */ adminUsername?: string; /** * Specifies Windows operating system settings on the virtual machine. */ osConfiguration?: outputs.workloads.LinuxConfigurationResponse | outputs.workloads.WindowsConfigurationResponse; } /** * Gets or sets the Oracle provider properties. */ interface OracleProviderInstancePropertiesResponse { /** * Gets or sets the oracle database name. */ dbName?: string; /** * Gets or sets the oracle database password. */ dbPassword?: string; /** * Gets or sets the key vault URI to secret with the database password. */ dbPasswordUri?: string; /** * Gets or sets the oracle database sql port. */ dbPort?: string; /** * Gets or sets the oracle database user name. */ dbUsername?: string; /** * Gets or sets the target virtual machine name. */ hostname?: string; /** * The provider type. For example, the value can be SapHana. * Expected value is 'Oracle'. */ providerType: "Oracle"; /** * Gets or sets the SAP System Identifier */ sapSid?: string; /** * Gets or sets the blob URI to SSL certificate for the Oracle Database. */ sslCertificateUri?: string; /** * Gets or sets certificate preference if secure communication is enabled. */ sslPreference?: string; } /** * Defines the OS and SAP Configurations for Deployment */ interface OsSapConfigurationResponse { /** * The url and storage account ID where deployer VM packages are uploaded */ deployerVmPackages?: outputs.workloads.DeployerVmPackagesResponse; /** * The FQDN to set for the SAP system */ sapFqdn?: string; } /** * Gets or sets the PrometheusHaCluster provider properties. */ interface PrometheusHaClusterProviderInstancePropertiesResponse { /** * Gets or sets the clusterName. */ clusterName?: string; /** * Gets or sets the target machine name. */ hostname?: string; /** * URL of the Node Exporter endpoint. */ prometheusUrl?: string; /** * The provider type. For example, the value can be SapHana. * Expected value is 'PrometheusHaCluster'. */ providerType: "PrometheusHaCluster"; /** * Gets or sets the cluster sid. */ sid?: string; /** * Gets or sets the blob URI to SSL certificate for the HA cluster exporter. */ sslCertificateUri?: string; /** * Gets or sets certificate preference if secure communication is enabled. */ sslPreference?: string; } /** * Gets or sets the PrometheusOS provider properties. */ interface PrometheusOsProviderInstancePropertiesResponse { /** * URL of the Node Exporter endpoint */ prometheusUrl?: string; /** * The provider type. For example, the value can be SapHana. * Expected value is 'PrometheusOS'. */ providerType: "PrometheusOS"; /** * Gets or sets the SAP System Identifier */ sapSid?: string; /** * Gets or sets the blob URI to SSL certificate for the prometheus node exporter. */ sslCertificateUri?: string; /** * Gets or sets certificate preference if secure communication is enabled. */ sslPreference?: string; } /** * Retention duration. */ interface RetentionDurationResponse { /** * Count of duration types. Retention duration is obtained by the counting the duration type Count times. * For example, when Count = 3 and DurationType = Weeks, retention duration will be three weeks. */ count?: number; /** * Retention duration type of retention policy. */ durationType?: string; } /** * The SAP Availability Zone Pair. */ interface SAPAvailabilityZonePairResponse { /** * The zone A. */ zoneA?: number; /** * The zone B. */ zoneB?: number; } /** * The SAP Disk Configuration contains 'recommended disk' details and list of supported disks detail for a volume type. */ interface SAPDiskConfigurationResponse { /** * The recommended disk details for a given VM Sku. */ recommendedConfiguration?: outputs.workloads.DiskVolumeConfigurationResponse; /** * The list of supported disks for a given VM Sku. */ supportedConfigurations?: outputs.workloads.DiskDetailsResponse[]; } /** * The SAP Software configuration Input when the software is to be installed by service without OS Configurations */ interface SAPInstallWithoutOSConfigSoftwareConfigurationResponse { /** * The URL to the SAP Build of Materials(BOM) file. */ bomUrl: string; /** * Gets or sets the HA software configuration. */ highAvailabilitySoftwareConfiguration?: outputs.workloads.HighAvailabilitySoftwareConfigurationResponse; /** * The SAP bits storage account id. */ sapBitsStorageAccountId: string; /** * The SAP software installation Type. * Expected value is 'SAPInstallWithoutOSConfig'. */ softwareInstallationType: "SAPInstallWithoutOSConfig"; /** * The software version to install. */ softwareVersion: string; } /** * An error response from the SAP migrate resources. */ interface SAPMigrateErrorResponse { /** * Service specific error code which serves as the substatus for the HTTP error code. */ code: string; /** * Internal error details. */ details: outputs.workloads.ErrorDefinitionSapDiscoverySiteResponse[]; /** * Description of the error. */ message: string; /** * Description of the recommendation. */ recommendation: string; } /** * An error response from the SAP migrate resources. */ interface SAPMigrateErrorSapInstanceResponse { /** * Service specific error code which serves as the substatus for the HTTP error code. */ code: string; /** * Internal error details. */ details: outputs.workloads.ErrorDefinitionSapInstanceResponse[]; /** * Description of the error. */ message: string; /** * Description of the recommendation. */ recommendation: string; } /** * An error response from the SAP migrate resources. */ interface SAPMigrateErrorServerInstanceResponse { /** * Service specific error code which serves as the substatus for the HTTP error code. */ code: string; /** * Internal error details. */ details: outputs.workloads.ErrorDefinitionServerInstanceResponse[]; /** * Description of the error. */ message: string; /** * Description of the recommendation. */ recommendation: string; } /** * The SAP supported SKU. */ interface SAPSupportedSkuResponse { /** * True if the Sku is certified for App server in the SAP system. */ isAppServerCertified?: boolean; /** * True if the Sku is certified for Database server in the SAP system. */ isDatabaseCertified?: boolean; /** * The VM Sku. */ vmSku?: string; } /** * An error response from the Virtual Instance for SAP Workload service. */ interface SAPVirtualInstanceErrorResponse { /** * The Virtual Instance for SAP error body. */ properties?: outputs.workloads.ErrorDefinitionResponse; } /** * Managed service identity (user assigned identities) */ interface SAPVirtualInstanceIdentityResponse { /** * The type of managed identity assigned to this resource. */ type: string; /** * The identities assigned to this resource by the user. */ userAssignedIdentities?: { [key: string]: outputs.workloads.UserAssignedIdentityResponse; }; } /** * Specify the HANA database TLS/SSL properties which will be used for enabling Azure Backup for this database. You need to specify these details if you have enabled secure communication for your HANA database. */ interface SSLConfigurationResponse { /** * Specify the crypto provider being used (commoncrypto/openssl). If this argument is not provided, it is automatically determined by searching in the configuration files. */ sslCryptoProvider?: string; /** * Specify the hostname as mentioned in the SSL certificate. If this argument is not provided, it is automatically determined by searching in the SSL certificate. */ sslHostNameInCertificate?: string; /** * Specify the name of the keystore file that contains the client's identity (eg. sapsrv.pse). The script will search for the file in the appropriate directory depending on the crypto provider mentioned. If this argument is not provided, it is automatically determined by searching in the configuration files. */ sslKeyStore?: string; /** * Specify the name of the trust store file that contains the server’s public certificates (eg. sapsrv.pse). The script will search for the file in the appropriate directory depending on the crypto provider mentioned. If this argument is not provided, it is automatically determined by searching in the configuration files. */ sslTrustStore?: string; } /** * Gets or sets the Threshold Values for Top Metrics Health. */ interface SapLandscapeMonitorMetricThresholdsResponse { /** * Gets or sets the threshold value for Green. */ green?: number; /** * Gets or sets the name of the threshold. */ name?: string; /** * Gets or sets the threshold value for Red. */ red?: number; /** * Gets or sets the threshold value for Yellow. */ yellow?: number; } /** * Gets or sets the SID groupings by landscape and Environment. */ interface SapLandscapeMonitorPropertiesGroupingResponse { /** * Gets or sets the list of landscape to SID mappings. */ landscape?: outputs.workloads.SapLandscapeMonitorSidMappingResponse[]; /** * Gets or sets the list of Sap Applications to SID mappings. */ sapApplication?: outputs.workloads.SapLandscapeMonitorSidMappingResponse[]; } /** * Gets or sets the mapping for SID to Environment/Applications. */ interface SapLandscapeMonitorSidMappingResponse { /** * Gets or sets the name of the grouping. */ name?: string; /** * Gets or sets the list of SID's. */ topSid?: string[]; } /** * Gets or sets the provider properties. */ interface SapNetWeaverProviderInstancePropertiesResponse { /** * The provider type. For example, the value can be SapHana. * Expected value is 'SapNetWeaver'. */ providerType: "SapNetWeaver"; /** * Gets or sets the SAP Client ID. */ sapClientId?: string; /** * Gets or sets the list of HostFile Entries */ sapHostFileEntries?: string[]; /** * Gets or sets the target virtual machine IP Address/FQDN. */ sapHostname?: string; /** * Gets or sets the instance number of SAP NetWeaver. */ sapInstanceNr?: string; /** * Sets the SAP password. */ sapPassword?: string; /** * Gets or sets the key vault URI to secret with the SAP password. */ sapPasswordUri?: string; /** * Gets or sets the SAP HTTP port number. */ sapPortNumber?: string; /** * Gets or sets the SAP System Identifier */ sapSid?: string; /** * Gets or sets the SAP user name. */ sapUsername?: string; /** * Gets or sets the blob URI to SSL certificate for the SAP system. */ sslCertificateUri?: string; /** * Gets or sets certificate preference if secure communication is enabled. */ sslPreference?: string; } /** * The SAP Software configuration Input when the software is to be installed by service. */ interface ServiceInitiatedSoftwareConfigurationResponse { /** * The URL to the SAP Build of Materials(BOM) file. */ bomUrl: string; /** * Gets or sets the HA software configuration. */ highAvailabilitySoftwareConfiguration?: outputs.workloads.HighAvailabilitySoftwareConfigurationResponse; /** * The SAP bits storage account id. */ sapBitsStorageAccountId: string; /** * The FQDN to set for the SAP system during install. */ sapFqdn: string; /** * The SAP software installation Type. * Expected value is 'ServiceInitiated'. */ softwareInstallationType: "ServiceInitiated"; /** * The software version to install. */ softwareVersion: string; /** * The SSH private key. */ sshPrivateKey: string; } /** * Common settings field for backup management */ interface SettingsResponse { /** * Workload compression flag. This has been added so that 'isSqlCompression' * will be deprecated once clients upgrade to consider this flag. */ isCompression?: boolean; /** * SQL compression flag */ issqlcompression?: boolean; /** * TimeZone optional input as string. For example: TimeZone = "Pacific Standard Time". */ timeZone?: string; } /** * The resource names object for shared storage. */ interface SharedStorageResourceNamesResponse { /** * The full name of the shared storage account. If it is not provided, it will be defaulted to {SID}nfs{guid of 15 chars}. */ sharedStorageAccountName?: string; /** * The full name of private end point for the shared storage account. If it is not provided, it will be defaulted to {storageAccountName}_pe */ sharedStorageAccountPrivateEndPointName?: string; } /** * Simple policy retention. */ interface SimpleRetentionPolicyResponse { /** * Retention duration of the protection policy. */ retentionDuration?: outputs.workloads.RetentionDurationResponse; /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'SimpleRetentionPolicy'. */ retentionPolicyType: "SimpleRetentionPolicy"; } /** * Simple policy schedule. */ interface SimpleSchedulePolicyResponse { /** * Hourly Schedule of this Policy */ hourlySchedule?: outputs.workloads.HourlyScheduleResponse; /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'SimpleSchedulePolicy'. */ schedulePolicyType: "SimpleSchedulePolicy"; /** * List of days of week this schedule has to be run. */ scheduleRunDays?: string[]; /** * Frequency of the schedule operation of this policy. */ scheduleRunFrequency?: string; /** * List of times of day this schedule has to be run. */ scheduleRunTimes?: string[]; /** * At every number weeks this schedule has to be run. */ scheduleWeeklyFrequency?: number; } /** * The V2 policy schedule for IaaS that supports hourly backups. */ interface SimpleSchedulePolicyV2Response { /** * Daily schedule of this policy */ dailySchedule?: outputs.workloads.DailyScheduleResponse; /** * hourly schedule of this policy */ hourlySchedule?: outputs.workloads.HourlyScheduleResponse; /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'SimpleSchedulePolicyV2'. */ schedulePolicyType: "SimpleSchedulePolicyV2"; /** * Frequency of the schedule operation of this policy. */ scheduleRunFrequency?: string; /** * Weekly schedule of this policy */ weeklySchedule?: outputs.workloads.WeeklyScheduleResponse; } /** * Gets or sets the single server configuration. For prerequisites for creating the infrastructure, please see [here](https://go.microsoft.com/fwlink/?linkid=2212611&clcid=0x409) */ interface SingleServerConfigurationResponse { /** * The application resource group where SAP system resources will be deployed. */ appResourceGroup: string; /** * The set of custom names to be used for underlying azure resources that are part of the SAP system. */ customResourceNames?: outputs.workloads.SingleServerFullResourceNamesResponse; /** * The database type. */ databaseType?: string; /** * Gets or sets the disk configuration. */ dbDiskConfiguration?: outputs.workloads.DiskConfigurationResponse; /** * The type of SAP deployment, single server or Three tier. * Expected value is 'SingleServer'. */ deploymentType: "SingleServer"; /** * Network configuration for the server */ networkConfiguration?: outputs.workloads.NetworkConfigurationResponse; /** * The subnet id. */ subnetId: string; /** * Gets or sets the virtual machine configuration. */ virtualMachineConfiguration: outputs.workloads.VirtualMachineConfigurationResponse; } /** * singleServerConfigurationResponseProvideDefaults sets the appropriate defaults for SingleServerConfigurationResponse */ function singleServerConfigurationResponseProvideDefaults(val: SingleServerConfigurationResponse): SingleServerConfigurationResponse; /** * The resource name object where the specified values will be full resource names of the corresponding resources in a single server SAP system. */ interface SingleServerFullResourceNamesResponse { /** * The pattern type to be used for resource naming. * Expected value is 'FullResourceName'. */ namingPatternType: "FullResourceName"; /** * The resource names object for virtual machine and related resources. */ virtualMachine?: outputs.workloads.VirtualMachineResourceNamesResponse; } /** * Gets or sets the file share configuration for scenarios where transport directory fileshare is not created or required. */ interface SkipFileShareConfigurationResponse { /** * The type of file share config. * Expected value is 'Skip'. */ configurationType: "Skip"; } /** * Snapshot Backup related fields for WorkloadType SAP Hana system */ interface SnapshotBackupAdditionalDetailsResponse { /** * Instant RP details for the snapshot. */ instantRPDetails?: string; /** * Retention range for instant Rp in days. */ instantRpRetentionRangeInDays?: number; /** * User Assigned managed identity details used for snapshot policy. */ userAssignedManagedIdentityDetails?: outputs.workloads.UserAssignedManagedIdentityDetailsResponse; } /** * Defines the SQL Backup data for a virtual instance for SAP. */ interface SqlBackupDataResponse { /** * Defines the policy properties for database backup. */ backupPolicy: outputs.workloads.DBBackupPolicyPropertiesResponse; /** * The type of backup, VM, SQL or HANA. * Expected value is 'SQL'. */ backupType: "SQL"; /** * The properties of the recovery services vault used for backup. */ recoveryServicesVault: outputs.workloads.ExistingRecoveryServicesVaultResponse | outputs.workloads.NewRecoveryServicesVaultResponse; } /** * SSH configuration for Linux based VMs running on Azure */ interface SshConfigurationResponse { /** * The list of SSH public keys used to authenticate with linux based VMs. */ publicKeys?: outputs.workloads.SshPublicKeyResponse[]; } /** * The SSH Key-pair used to authenticate with the VM. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). */ interface SshKeyPairResponse { /** * SSH private key. */ privateKey?: string; /** * SSH public key */ publicKey?: string; } /** * Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed. */ interface SshPublicKeyResponse { /** * SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

    For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://learn.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). */ keyData?: string; } /** * Gets or sets the storage configuration. */ interface StorageConfigurationResponse { /** * The properties of the transport directory attached to the VIS. The default for transportFileShareConfiguration is the createAndMount flow if storage configuration is missing. */ transportFileShareConfiguration?: outputs.workloads.CreateAndMountFileShareConfigurationResponse | outputs.workloads.MountFileShareConfigurationResponse | outputs.workloads.SkipFileShareConfigurationResponse; } /** * Storage details of all the Storage accounts attached to the VM. For e.g. NFS on AFS Shared Storage. */ interface StorageInformationResponse { /** * Fully qualified resource ID for the storage account. */ id: string; } /** * Sub-protection policy which includes schedule and retention */ interface SubProtectionPolicyResponse { /** * Type of backup policy type */ policyType?: string; /** * Retention policy with the details on backup copy retention ranges. */ retentionPolicy?: outputs.workloads.LongTermRetentionPolicyResponse | outputs.workloads.SimpleRetentionPolicyResponse; /** * Backup schedule specified as part of backup policy. */ schedulePolicy?: outputs.workloads.LogSchedulePolicyResponse | outputs.workloads.LongTermSchedulePolicyResponse | outputs.workloads.SimpleSchedulePolicyResponse | outputs.workloads.SimpleSchedulePolicyV2Response; /** * Hana DB instance snapshot backup additional details. */ snapshotBackupAdditionalDetails?: outputs.workloads.SnapshotBackupAdditionalDetailsResponse; /** * Tiering policy to automatically move RPs to another tier. * Key is Target Tier, defined in RecoveryPointTierType enum. * Tiering policy specifies the criteria to move RP to the target tier. */ tieringPolicy?: { [key: string]: outputs.workloads.TieringPolicyResponse; }; } /** * Metadata pertaining to creation and last modification of the resource. */ interface SystemDataResponse { /** * The timestamp of resource creation (UTC). */ createdAt?: string; /** * The identity that created the resource. */ createdBy?: string; /** * The type of identity that created the resource. */ createdByType?: string; /** * The timestamp of resource last modification (UTC) */ lastModifiedAt?: string; /** * The identity that last modified the resource. */ lastModifiedBy?: string; /** * The type of identity that last modified the resource. */ lastModifiedByType?: string; } /** * Gets or sets the three tier SAP configuration. For prerequisites for creating the infrastructure, please see [here](https://go.microsoft.com/fwlink/?linkid=2212611&clcid=0x409) */ interface ThreeTierConfigurationResponse { /** * The application resource group where SAP system resources will be deployed. */ appResourceGroup: string; /** * The application server configuration. */ applicationServer: outputs.workloads.ApplicationServerConfigurationResponse; /** * The central server configuration. */ centralServer: outputs.workloads.CentralServerConfigurationResponse; /** * The set of custom names to be used for underlying azure resources that are part of the SAP system. */ customResourceNames?: outputs.workloads.ThreeTierFullResourceNamesResponse; /** * The database configuration. */ databaseServer: outputs.workloads.DatabaseConfigurationResponse; /** * The type of SAP deployment, single server or Three tier. * Expected value is 'ThreeTier'. */ deploymentType: "ThreeTier"; /** * The high availability configuration. */ highAvailabilityConfig?: outputs.workloads.HighAvailabilityConfigurationResponse; /** * Network configuration common to all servers */ networkConfiguration?: outputs.workloads.NetworkConfigurationResponse; /** * The storage configuration. */ storageConfiguration?: outputs.workloads.StorageConfigurationResponse; } /** * threeTierConfigurationResponseProvideDefaults sets the appropriate defaults for ThreeTierConfigurationResponse */ function threeTierConfigurationResponseProvideDefaults(val: ThreeTierConfigurationResponse): ThreeTierConfigurationResponse; /** * The resource name object where the specified values will be full resource names of the corresponding resources in a three tier SAP system. */ interface ThreeTierFullResourceNamesResponse { /** * The full resource names object for application layer resources. The number of entries in this list should be equal to the number VMs to be created for application layer. */ applicationServer?: outputs.workloads.ApplicationServerFullResourceNamesResponse; /** * The full resource names object for central server layer resources. */ centralServer?: outputs.workloads.CentralServerFullResourceNamesResponse; /** * The full resource names object for database layer resources. The number of entries in this list should be equal to the number VMs to be created for database layer. */ databaseServer?: outputs.workloads.DatabaseServerFullResourceNamesResponse; /** * The pattern type to be used for resource naming. * Expected value is 'FullResourceName'. */ namingPatternType: "FullResourceName"; /** * The resource names object for shared storage. */ sharedStorage?: outputs.workloads.SharedStorageResourceNamesResponse; } /** * Tiering Policy for a target tier. * If the policy is not specified for a given target tier, service retains the existing configured tiering policy for that tier */ interface TieringPolicyResponse { /** * Number of days/weeks/months/years to retain backups in current tier before tiering. * Used only if TieringMode is set to TierAfter */ duration?: number; /** * Retention duration type: days/weeks/months/years * Used only if TieringMode is set to TierAfter */ durationType?: string; /** * Tiering Mode to control automatic tiering of recovery points. Supported values are: * 1. TierRecommended: Tier all recovery points recommended to be tiered * 2. TierAfter: Tier all recovery points after a fixed period, as specified in duration + durationType below. * 3. DoNotTier: Do not tier any recovery points */ tieringMode?: string; } /** * User assigned managed identity properties. */ interface UserAssignedIdentityPropertiesResponse { clientId?: string; principalId?: string; } /** * User assigned identity properties */ interface UserAssignedIdentityResponse { /** * The client ID of the assigned identity. */ clientId: string; /** * The principal ID of the assigned identity. */ principalId: string; } /** * User assigned managed identity details. */ interface UserAssignedManagedIdentityDetailsResponse { identityArmId?: string; identityName?: string; /** * User assigned managed identity properties. */ userAssignedIdentityProperties?: outputs.workloads.UserAssignedIdentityPropertiesResponse; } /** * Managed service identity (user assigned identities) */ interface UserAssignedServiceIdentityResponse { /** * Type of manage identity */ type: string; /** * User assigned identities dictionary */ userAssignedIdentities?: { [key: string]: outputs.workloads.UserAssignedIdentityResponse; }; } /** * Defines the VM Backup data for a virtual instance for SAP. */ interface VMBackupDataResponse { /** * Defines the policy properties for virtual machine backup. */ backupPolicy: outputs.workloads.VMBackupPolicyPropertiesResponse; /** * The type of backup, VM, SQL or HANA. * Expected value is 'VM'. */ backupType: "VM"; /** * Defines the disk exclusion properties for virtual machine backup. */ diskExclusionProperties?: outputs.workloads.DiskExclusionPropertiesResponse; /** * The properties of the recovery services vault used for backup. */ recoveryServicesVault: outputs.workloads.ExistingRecoveryServicesVaultResponse | outputs.workloads.NewRecoveryServicesVaultResponse; } /** * Defines the policy properties for virtual machine backup. */ interface VMBackupPolicyPropertiesResponse { /** * This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. * Expected value is 'AzureIaasVM'. */ backupManagementType: "AzureIaasVM"; /** * Instant recovery point additional details. */ instantRPDetails?: outputs.workloads.InstantRPAdditionalDetailsResponse; /** * Instant RP retention policy range in days */ instantRpRetentionRangeInDays?: number; /** * The name of the VM Backup policy. */ name: string; /** * The policy type. */ policyType?: string; /** * Number of items associated with this policy. */ protectedItemsCount?: number; /** * ResourceGuard Operation Requests */ resourceGuardOperationRequests?: string[]; /** * Retention policy with the details on backup copy retention ranges. */ retentionPolicy?: outputs.workloads.LongTermRetentionPolicyResponse | outputs.workloads.SimpleRetentionPolicyResponse; /** * Backup schedule specified as part of backup policy. */ schedulePolicy?: outputs.workloads.LogSchedulePolicyResponse | outputs.workloads.LongTermSchedulePolicyResponse | outputs.workloads.SimpleSchedulePolicyResponse | outputs.workloads.SimpleSchedulePolicyV2Response; /** * Tiering policy to automatically move RPs to another tier * Key is Target Tier, defined in RecoveryPointTierType enum. * Tiering policy specifies the criteria to move RP to the target tier. */ tieringPolicy?: { [key: string]: outputs.workloads.TieringPolicyResponse; }; /** * Time zone optional input as string. For example: "Pacific Standard Time". */ timeZone?: string; } /** * Defines the virtual machine configuration. */ interface VirtualMachineConfigurationResponse { /** * The image reference. */ imageReference: outputs.workloads.ImageReferenceResponse; /** * The OS profile. */ osProfile: outputs.workloads.OSProfileResponse; /** * The virtual machine size. */ vmSize: string; } /** * The resource names object for virtual machine and related resources. */ interface VirtualMachineResourceNamesResponse { /** * The full resource names for virtual machine data disks. This is a dictionary containing list of names of data disks per volume. Currently supported volumes for database layer are ['hana/data', 'hana/log', hana/shared', 'usr/sap', 'os', 'backup']. For application and cs layers, only 'default' volume is supported */ dataDiskNames?: { [key: string]: string[]; }; /** * The full name for virtual-machine's host (computer name). Currently, ACSS only supports host names which are less than or equal to 13 characters long. If this value is not provided, vmName will be used as host name. */ hostName?: string; /** * The list of network interface name objects for the selected virtual machine. Currently, only one network interface is supported per virtual machine. */ networkInterfaces?: outputs.workloads.NetworkInterfaceResourceNamesResponse[]; /** * The full name for OS disk attached to the VM. If this value is not provided, it will be named by ARM as per its default naming standards (prefixed with vm name). There is only one OS disk attached per Virtual Machine. */ osDiskName?: string; /** * The full name for virtual machine. The length of this field can be upto 64 characters. If name is not provided, service uses a default name based on the deployment type. For SingleServer, default name is {SID}vm. In case of HA-AvZone systems, default name will be {SID}{app/ascs/db}z{a/b}vm with an incrementor at the end in case of more than 1 vm per layer. For distributed and HA-AvSet systems, default name will be {SID}{app/ascs/db}vm with an incrementor at the end in case of more than 1 vm per layer. */ vmName?: string; } /** * Weekly retention format. */ interface WeeklyRetentionFormatResponse { /** * List of days of the week. */ daysOfTheWeek?: string[]; /** * List of weeks of month. */ weeksOfTheMonth?: string[]; } /** * Weekly retention schedule. */ interface WeeklyRetentionScheduleResponse { /** * List of days of week for weekly retention policy. */ daysOfTheWeek?: string[]; /** * Retention duration of retention Policy. */ retentionDuration?: outputs.workloads.RetentionDurationResponse; /** * Retention times of retention policy. */ retentionTimes?: string[]; } /** * Weekly schedule. */ interface WeeklyScheduleResponse { /** * Schedule run days. */ scheduleRunDays?: string[]; /** * List of times of day this schedule has to be run. */ scheduleRunTimes?: string[]; } /** * Specifies Windows operating system settings on the virtual machine. */ interface WindowsConfigurationResponse { /** * The OS Type * Expected value is 'Windows'. */ osType: "Windows"; } /** * Yearly retention schedule. */ interface YearlyRetentionScheduleResponse { /** * List of months of year of yearly retention policy. */ monthsOfYear?: string[]; /** * Retention duration of retention Policy. */ retentionDuration?: outputs.workloads.RetentionDurationResponse; /** * Daily retention format for yearly retention policy. */ retentionScheduleDaily?: outputs.workloads.DailyRetentionFormatResponse; /** * Retention schedule format for yearly retention policy. */ retentionScheduleFormatType?: string; /** * Weekly retention format for yearly retention policy. */ retentionScheduleWeekly?: outputs.workloads.WeeklyRetentionFormatResponse; /** * Retention times of retention policy. */ retentionTimes?: string[]; } } //# sourceMappingURL=output.d.ts.map