@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [![Python version](https://badge.fury.io/py/pu
1,714 lines • 8.26 MB
TypeScript
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.ConditionResponse[];
/**
* 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 ConditionResponse {
/**
* 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[];
}
/**
* 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 m