3.0.0 • Published 5 years ago

@datafire/azure_azsadmin_product v3.0.0

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

@datafire/azure_azsadmin_product

Client library for AzureBridgeAdminClient

Installation and Usage

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

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

Description

AzureBridge Admin Client.

Actions

Products_List

Return product name.

azure_azsadmin_product.Products_List({
  "subscriptionId": "",
  "resourceGroup": "",
  "activationName": "",
  "api-version": ""
}, context)

Input

  • input object
    • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.
    • resourceGroup required string: The resource group the resource is located under.
    • activationName required string: Name of the activation.
    • api-version required string: Client Api Version.

Output

Products_Get

Return product name.

azure_azsadmin_product.Products_Get({
  "subscriptionId": "",
  "resourceGroup": "",
  "activationName": "",
  "productName": "",
  "api-version": ""
}, context)

Input

  • input object
    • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.
    • resourceGroup required string: The resource group the resource is located under.
    • activationName required string: Name of the activation.
    • productName required string: Name of the product.
    • api-version required string: Client Api Version.

Output

Products_Download

Downloads a product from azure marketplace.

azure_azsadmin_product.Products_Download({
  "subscriptionId": "",
  "resourceGroup": "",
  "activationName": "",
  "productName": "",
  "api-version": ""
}, context)

Input

  • input object
    • subscriptionId required string: Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.
    • resourceGroup required string: The resource group the resource is located under.
    • activationName required string: Name of the activation.
    • productName required string: Name of the product.
    • api-version required string: Client Api Version.

Output

  • output object: Downloaded product resource.
    • properties object: Properties for aggregate usage.
      • galleryPackageBlobSasUri string: The URI to the .azpkg file that provides information required for showing product in the gallery.
      • legalTerms string: Legal terms for the product.
      • links array: List of product links.
        • items object: Link to a product.
          • displayName string: Displayed name of product.
          • uri string: URI to product.
      • privacyPolicy string: Privacy policy of the product.
      • productDetailsProperties object: Product information.
        • computeRole string (values: None, IaaS, PaaS): Compute role type (IaaS or PaaS).
        • isSystemExtension boolean: Specifies if product is a Virtual Machine Extension.
        • sourceBlob object: The URI.
          • uri string: The URI.
        • supportMultipleExtensions boolean: Indicates if specified product supports multiple extensions.
        • version string: Specifies product version.
        • vmOsType string (values: None, Windows, Linux): Operating system type (Windows or Linux).
        • vmScaleSetEnabled boolean: Indicates if virtual machine Scale Set is enabled in the specified product.
        • dataDiskImages array: List of attached data disks.
          • items object: Data disk image.
            • lun integer: The LUN.
            • sourceBlobSasUri string: SAS key for source blob.
        • osDiskImage object: OS disk image.
          • operatingSystem string (values: None, Windows, Linux): Operating system type (Windows or Linux).
          • sourceBlobSasUri string: SAS key for source blob.
        • version string: Specifies product version.
      • provisioningState string (values: Stopped, Starting, Running, Stopping, Succeeded, Downloading): The provisioning state of the resource.
      • vmExtensionType string: Extension type of the VM.
      • billingPartNumber string: Billing part number.
      • compatibility object: Product compatibility
        • description string: Full error message if any compatibility issues are found
        • isCompatible boolean: Tells if product is compatible with current device
        • issues array: List of all issues found
          • items string (values: HigherDeviceVersionRequired, LowerDeviceVersionRequired, CapacityBillingModelRequired, PayAsYouGoBillingModelRequired, DevelopmentBillingModelRequired, AzureADIdentitySystemRequired, ADFSIdentitySystemRequired, ConnectionToInternetRequired, ConnectionToAzureRequired, DisconnectedEnvironmentRequired): Compatibility issue
        • message string: Short error message if any compatibility issues are found
      • description string: Description of the product.
      • displayName string: Name displayed for the product.
      • galleryItemIdentity string: Gallery item identity.
      • iconUris object: Icons for the gallery items.
        • hero string: The hero (815x290) icon relative path.
        • large string: The large (115x115) icon relative path.
        • medium string: The medium (90x90) icon relative path.
        • small string: The small (40x40) icon relative path.
        • wide string: The wide (255x115) icon relative path.
      • offer string: Offer name.
      • offerVersion string: Offer version.
      • payloadLength integer: Size in bytes.
      • productKind string: The kind. E.g. VirtualMachineProductProperties.ProductKind or WebApp, SolutionTemplate.
      • productProperties object: Additional properties of the product
        • version string: The version of the product
      • publisherDisplayName string: Name of publisher.
      • publisherIdentifier string: Publisher identifier.
      • sku string: Product SKU.
    • id string: URI of the resource.
    • location string: Location of the resource
    • name string: Name of the resource.
    • tags object: List of key value pairs.
    • type string: Type of resource.

Definitions

Product

  • Product object: Properties for a product.
    • legalTerms string: Legal terms for the product.
    • links array: List of product links.
      • items object: Link to a product.
        • displayName string: Displayed name of product.
        • uri string: URI to product.
    • privacyPolicy string: Privacy policy of the product.
    • provisioningState string (values: Stopped, Starting, Running, Stopping, Succeeded, Downloading): The provisioning state of the resource.
    • vmExtensionType string: Extension type of the VM.
    • billingPartNumber string: Billing part number.
    • compatibility object: Product compatibility
      • description string: Full error message if any compatibility issues are found
      • isCompatible boolean: Tells if product is compatible with current device
      • issues array: List of all issues found
        • items string (values: HigherDeviceVersionRequired, LowerDeviceVersionRequired, CapacityBillingModelRequired, PayAsYouGoBillingModelRequired, DevelopmentBillingModelRequired, AzureADIdentitySystemRequired, ADFSIdentitySystemRequired, ConnectionToInternetRequired, ConnectionToAzureRequired, DisconnectedEnvironmentRequired): Compatibility issue
      • message string: Short error message if any compatibility issues are found
    • description string: Description of the product.
    • displayName string: Name displayed for the product.
    • galleryItemIdentity string: Gallery item identity.
    • iconUris object: Icons for the gallery items.
      • hero string: The hero (815x290) icon relative path.
      • large string: The large (115x115) icon relative path.
      • medium string: The medium (90x90) icon relative path.
      • small string: The small (40x40) icon relative path.
      • wide string: The wide (255x115) icon relative path.
    • offer string: Offer name.
    • offerVersion string: Offer version.
    • payloadLength integer: Size in bytes.
    • productKind string: The kind. E.g. VirtualMachineProductProperties.ProductKind or WebApp, SolutionTemplate.
    • productProperties object: Additional properties of the product
      • version string: The version of the product
    • publisherDisplayName string: Name of publisher.
    • publisherIdentifier string: Publisher identifier.
    • sku string: Product SKU.

ProductResource

  • ProductResource object: Product resource.
    • properties Product
    • id string: URI of the resource.
    • location string: Location of the resource
    • name string: Name of the resource.
    • tags object: List of key value pairs.
    • type string: Type of resource.

ProductResourcesPage

  • ProductResourcesPage object: Holds an array of products and the next link.
    • nextLink string: URI to the next page.
    • value array: List of products.
datafire
@infinitebrahmanuniverse/nolb-_datafire_az@everything-registry/sub-chunk-220
3.0.0

5 years ago