5.0.0 • Published 5 years ago

@datafire/azure_web_recommendations v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/azure_web_recommendations

Client library for Recommendations API Client

Installation and Usage

npm install --save @datafire/azure_web_recommendations
let azure_web_recommendations = require('@datafire/azure_web_recommendations').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

Recommendations_List

List all recommendations for a subscription.

azure_web_recommendations.Recommendations_List({
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • featured boolean: Specify true to return only the most critical recommendations. The default is false, which returns all recommendations.
    • $filter string: Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'PT1H|PT1M|P1D
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Recommendations_ResetAllFilters

Reset all recommendation opt-out settings for a subscription.

azure_web_recommendations.Recommendations_ResetAllFilters({
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Output schema unknown

Recommendations_DisableRecommendationForSubscription

Disables the specified rule so it will not apply to a subscription in the future.

azure_web_recommendations.Recommendations_DisableRecommendationForSubscription({
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • name required string: Rule name
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Output schema unknown

Recommendations_ListHistoryForHostingEnvironment

Get past recommendations for an app, optionally specified by the time range.

azure_web_recommendations.Recommendations_ListHistoryForHostingEnvironment({
  "resourceGroupName": "",
  "hostingEnvironmentName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • hostingEnvironmentName required string: Name of the hosting environment.
    • expiredOnly boolean: Specify false to return all recommendations. The default is true, which returns only expired recommendations.
    • $filter string: Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'PT1H|PT1M|P1D
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Recommendations_ListRecommendedRulesForHostingEnvironment

Get all recommendations for an app.

azure_web_recommendations.Recommendations_ListRecommendedRulesForHostingEnvironment({
  "resourceGroupName": "",
  "hostingEnvironmentName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • hostingEnvironmentName required string: Name of the app.
    • featured boolean: Specify true to return only the most critical recommendations. The default is false, which returns all recommendations.
    • $filter string: Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification'
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Recommendations_DisableAllForHostingEnvironment

Disable all recommendations for an app.

azure_web_recommendations.Recommendations_DisableAllForHostingEnvironment({
  "resourceGroupName": "",
  "environmentName": "",
  "hostingEnvironmentName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • environmentName required string: Name of the app.
    • hostingEnvironmentName required string
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Output schema unknown

Recommendations_ResetAllFiltersForHostingEnvironment

Reset all recommendation opt-out settings for an app.

azure_web_recommendations.Recommendations_ResetAllFiltersForHostingEnvironment({
  "resourceGroupName": "",
  "environmentName": "",
  "hostingEnvironmentName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • environmentName required string: Name of the app.
    • hostingEnvironmentName required string
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Output schema unknown

Recommendations_GetRuleDetailsByHostingEnvironment

Get a recommendation rule for an app.

azure_web_recommendations.Recommendations_GetRuleDetailsByHostingEnvironment({
  "resourceGroupName": "",
  "hostingEnvironmentName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • hostingEnvironmentName required string: Name of the hosting environment.
    • name required string: Name of the recommendation.
    • updateSeen boolean: Specify true to update the last-seen timestamp of the recommendation object.
    • recommendationId string: The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Recommendations_DisableRecommendationForHostingEnvironment

Disables the specific rule for a web site permanently.

azure_web_recommendations.Recommendations_DisableRecommendationForHostingEnvironment({
  "resourceGroupName": "",
  "environmentName": "",
  "name": "",
  "hostingEnvironmentName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • environmentName required string: Site name
    • name required string: Rule name
    • hostingEnvironmentName required string
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Output schema unknown

Recommendations_ListHistoryForWebApp

Get past recommendations for an app, optionally specified by the time range.

azure_web_recommendations.Recommendations_ListHistoryForWebApp({
  "resourceGroupName": "",
  "siteName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Name of the app.
    • expiredOnly boolean: Specify false to return all recommendations. The default is true, which returns only expired recommendations.
    • $filter string: Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'PT1H|PT1M|P1D
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Recommendations_ListRecommendedRulesForWebApp

Get all recommendations for an app.

azure_web_recommendations.Recommendations_ListRecommendedRulesForWebApp({
  "resourceGroupName": "",
  "siteName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Name of the app.
    • featured boolean: Specify true to return only the most critical recommendations. The default is false, which returns all recommendations.
    • $filter string: Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification'
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Recommendations_DisableAllForWebApp

Disable all recommendations for an app.

azure_web_recommendations.Recommendations_DisableAllForWebApp({
  "resourceGroupName": "",
  "siteName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Name of the app.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Output schema unknown

Recommendations_ResetAllFiltersForWebApp

Reset all recommendation opt-out settings for an app.

azure_web_recommendations.Recommendations_ResetAllFiltersForWebApp({
  "resourceGroupName": "",
  "siteName": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Name of the app.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Output schema unknown

Recommendations_GetRuleDetailsByWebApp

Get a recommendation rule for an app.

azure_web_recommendations.Recommendations_GetRuleDetailsByWebApp({
  "resourceGroupName": "",
  "siteName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Name of the app.
    • name required string: Name of the recommendation.
    • updateSeen boolean: Specify true to update the last-seen timestamp of the recommendation object.
    • recommendationId string: The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry.
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Recommendations_DisableRecommendationForSite

Disables the specific rule for a web site permanently.

azure_web_recommendations.Recommendations_DisableRecommendationForSite({
  "resourceGroupName": "",
  "siteName": "",
  "name": "",
  "subscriptionId": "",
  "api-version": ""
}, context)

Input

  • input object
    • resourceGroupName required string: Name of the resource group to which the resource belongs.
    • siteName required string: Site name
    • name required string: Rule name
    • subscriptionId required string: Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
    • api-version required string: API Version

Output

Output schema unknown

Definitions

Recommendation

  • Recommendation object: Represents a recommendation result generated by the recommendation engine.
    • properties object: Recommendation resource specific properties
      • actionName string: Name of action recommended by this object.
      • bladeName string: Deep link to a blade on the portal.
      • categoryTags array: The list of category tags that this recommendation belongs to.
        • items string
      • channels string (values: Notification, Api, Email, Webhook, All): List of channels that this recommendation can apply.
      • creationTime string: Timestamp when this instance was created.
      • displayName string: UI friendly name of the rule (may not be unique).
      • enabled integer: True if this recommendation is still valid (i.e. "actionable"). False if it is invalid.
      • endTime string: The end time in UTC of a range that the recommendation refers to.
      • extensionName string: Extension name of the portal if exists.
      • forwardLink string: Forward link to an external document associated with the rule.
      • isDynamic boolean: True if this is associated with a dynamically added rule
      • level string (values: Critical, Warning, Information, NonUrgentSuggestion): Level indicating how critical this recommendation can impact.
      • message string: Recommendation text.
      • nextNotificationTime string: When to notify this recommendation next in UTC. Null means that this will never be notified anymore.
      • notificationExpirationTime string: Date and time in UTC when this notification expires.
      • notifiedTime string: Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet.
      • recommendationId string: A GUID value that each recommendation object is associated with.
      • resourceId string: Full ARM resource ID string that this recommendation object is associated with.
      • resourceScope string (values: ServerFarm, Subscription, WebSite): Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site.
      • ruleName string: Unique name of the rule.
      • score number: A metric value measured by the rule.
      • startTime string: The beginning time in UTC of a range that the recommendation refers to.
      • states array: The list of states of this recommendation. If it's null then it should be considered "Active".
        • items string
    • id string: Resource Id.
    • kind string: Kind of resource.
    • name string: Resource Name.
    • type string: Resource type.

RecommendationCollection

  • RecommendationCollection object: Collection of recommendations.
    • nextLink string: Link to next page of resources.
    • value required array: Collection of resources.

RecommendationRule

  • RecommendationRule object: Represents a recommendation rule that the recommendation engine can perform.
    • properties object: RecommendationRule resource specific properties
      • actionName string: Name of action that is recommended by this rule in string.
      • bladeName string: Deep link to a blade on the portal. Applicable to dynamic rule only.
      • categoryTags array: The list of category tags that this recommendation rule belongs to.
        • items string
      • channels string (values: Notification, Api, Email, Webhook, All): List of available channels that this rule applies.
      • description string: Localized detailed description of the rule.
      • displayName string: UI friendly name of the rule.
      • extensionName string: Extension name of the portal if exists. Applicable to dynamic rule only.
      • forwardLink string: Forward link to an external document associated with the rule. Applicable to dynamic rule only.
      • isDynamic boolean: True if this is associated with a dynamically added rule
      • level string (values: Critical, Warning, Information, NonUrgentSuggestion): Level of impact indicating how critical this rule is.
      • message string: Localized name of the rule (Good for UI).
      • recommendationId string: Recommendation ID of an associated recommendation object tied to the rule, if exists.
      • recommendationName string: Unique name of the rule.
    • id string: Resource Id.
    • kind string: Kind of resource.
    • name string: Resource Name.
    • type string: Resource type.
datafire
@infinitebrahmanuniverse/nolb-_datafire_az@everything-registry/sub-chunk-221
5.0.0

5 years ago

4.0.0

8 years ago

3.0.0

8 years ago