@datafire/azure_azsadmin_blobservices

3.0.0 • Public • Published

@datafire/azure_azsadmin_blobservices

Client library for StorageManagementClient

Installation and Usage

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

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

Description

The Admin Storage Management Client.

Actions

BlobServices_Get

Returns the BLOB service.

azure_azsadmin_blobservices.BlobServices_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "farmId": "",
  "serviceType": "",
  "api-version": ""
}, context)

Input

  • input object
    • subscriptionId required string: Subscription Id.
    • resourceGroupName required string: Resource group name.
    • farmId required string: Farm Id.
    • serviceType required string (values: default): The service type.
    • api-version required string: REST Api Version.

Output

BlobServices_ListMetricDefinitions

Returns the list of metric definitions for BLOB service.

azure_azsadmin_blobservices.BlobServices_ListMetricDefinitions({
  "subscriptionId": "",
  "resourceGroupName": "",
  "farmId": "",
  "serviceType": "",
  "api-version": ""
}, context)

Input

  • input object
    • subscriptionId required string: Subscription Id.
    • resourceGroupName required string: Resource group name.
    • farmId required string: Farm Id.
    • serviceType required string (values: default): The service type.
    • api-version required string: REST Api Version.

Output

  • output object: Pageable list of metric definitions.
    • nextLink string: URI to the next page.
    • value array: List of metric definitions.
      • items object: Metric definition.
        • metricAvailabilities array: Metric availabilities.
          • items object: Metric availability.
            • retention string: Retention of metric.
            • timeGrain string: Time grain.
        • name object: Localizable string.
          • localizedValue string: Localized value of the string.
          • value string: Value of the string.
        • primaryAggregationType string (values: None, Average, Total, Minimum, Maximum, Last): Aggregate type.
        • unit string (values: Count, Bytes, Seconds, CountPerSecond, BytesPerSecond): Metric unit.

BlobServices_ListMetrics

Returns a list of metrics for BLOB service.

azure_azsadmin_blobservices.BlobServices_ListMetrics({
  "subscriptionId": "",
  "resourceGroupName": "",
  "farmId": "",
  "serviceType": "",
  "api-version": ""
}, context)

Input

  • input object
    • subscriptionId required string: Subscription Id.
    • resourceGroupName required string: Resource group name.
    • farmId required string: Farm Id.
    • serviceType required string (values: default): The service type.
    • api-version required string: REST Api Version.

Output

  • output object: Pageable list of metrics.
    • nextLink string: URI to the next page.
    • value array: List of metrics.
      • items object: Metric information.
        • endTime string: Metric end time.
        • metricUnit string (values: Count, Bytes, Seconds, CountPerSecond, BytesPerSecond): Metric unit.
        • metricValues array: List of metric values.
          • items object: Metric value.
            • average number: Average value of metric.
            • count integer: Count of metric values.
            • maximum number: Maximum value of metric.
            • minimum number: Minimum value of metric.
            • properties string: Metric value properties.
            • timeStamp string: Timestamp of metric value.
            • total number: Total value of metric.
        • name object: Localizable string.
          • localizedValue string: Localized value of the string.
          • value string: Value of the string.
        • startTime string: Metric start time.
        • timeGrain string: Metric time grain.

Definitions

BlobService

  • BlobService object: The BLOB service.
    • properties BlobServiceProperties
    • id string: Resource ID.
    • location string: Resource location.
    • name string: Resource Name.
    • tags object: Resource tags.
    • type string: Resource type.

BlobServiceProperties

  • BlobServiceProperties object: Blob service properties.
    • settings BlobServiceSettings
    • healthStatus string (values: Unknown, Healthy, Warning, Critical): Current health status.
    • version string: Storage service version.

BlobServiceSettings

  • BlobServiceSettings object: Blob service settings.
    • blobSvcContainerGcInterval integer: The interval, in seconds, of container garbage collection.
    • blobSvcShallowGcInterval integer: The interval ,in seconds, of shallow garbage collection.
    • blobSvcStreamMapMinContainerOccupancyPercent integer: The minimal container occupancy percent for stream mapping.
    • frontEndHttpListenPort integer: The HTTP port of the storage service front end.
    • frontEndHttpsListenPort integer: The HTTPs port of the storage service front end.
    • frontEndCallbackThreadsCount integer: Front end callback threads count.
    • frontEndCpuBasedKeepAliveThrottlingCpuMonitorIntervalInSeconds integer: Interval (in second) of CPU monitor for front end CPU based keep-alive throttling.
    • frontEndCpuBasedKeepAliveThrottlingEnabled boolean: Switch of front end CPU based keep-alive throttling.
    • frontEndCpuBasedKeepAliveThrottlingPercentCpuThreshold number: Threshold (% percentage) of front end CPU based keep-alive throttling.
    • frontEndCpuBasedKeepAliveThrottlingPercentRequestsToThrottle number: Threshold (% percentage) of requests to throttle in front end CPU based keep-alive throttling.
    • frontEndMaxMillisecondsBetweenMemorySamples integer: Maximum interval (in millisecond) between memory samples of front end.
    • frontEndMemoryThrottleThresholdSettings string: Front end memory throttle threshold settings.
    • frontEndMemoryThrottlingEnabled boolean: Switch of front end memory throttling.
    • frontEndMinThreadPoolThreads integer: Front end minimum number of threads in thread pool.
    • frontEndThreadPoolBasedKeepAliveIOCompletionThreshold integer: Threshold of front end thread pool based keep-alive IO completion.
    • frontEndThreadPoolBasedKeepAliveMonitorIntervalInSeconds integer: Monitor interval (in seconds) of front end thread pool based keep-alive monitor.
    • frontEndThreadPoolBasedKeepAlivePercentage number: Percentage (%) of front end thread pool based keep-alive.
    • frontEndThreadPoolBasedKeepAliveWorkerThreadThreshold integer: Threshold of front end thread pool based keep-alive worker thread.
    • frontEndUseSlaTimeInAvailability boolean: Switch of whether front end uses SLA time in availability.

BlobServiceWritableSettings

  • BlobServiceWritableSettings object: Settings of BLOB service.
    • blobSvcContainerGcInterval integer: The interval, in seconds, of container garbage collection.
    • blobSvcShallowGcInterval integer: The interval ,in seconds, of shallow garbage collection.
    • blobSvcStreamMapMinContainerOccupancyPercent integer: The minimal container occupancy percent for stream mapping.
    • frontEndHttpListenPort integer: The HTTP port of the storage service front end.
    • frontEndHttpsListenPort integer: The HTTPs port of the storage service front end.
    • frontEndCallbackThreadsCount integer: Front end callback threads count.
    • frontEndCpuBasedKeepAliveThrottlingCpuMonitorIntervalInSeconds integer: Interval (in second) of CPU monitor for front end CPU based keep-alive throttling.
    • frontEndCpuBasedKeepAliveThrottlingEnabled boolean: Switch of front end CPU based keep-alive throttling.
    • frontEndCpuBasedKeepAliveThrottlingPercentCpuThreshold number: Threshold (% percentage) of front end CPU based keep-alive throttling.
    • frontEndCpuBasedKeepAliveThrottlingPercentRequestsToThrottle number: Threshold (% percentage) of requests to throttle in front end CPU based keep-alive throttling.
    • frontEndMaxMillisecondsBetweenMemorySamples integer: Maximum interval (in millisecond) between memory samples of front end.
    • frontEndMemoryThrottleThresholdSettings string: Front end memory throttle threshold settings.
    • frontEndMemoryThrottlingEnabled boolean: Switch of front end memory throttling.
    • frontEndMinThreadPoolThreads integer: Front end minimum number of threads in thread pool.
    • frontEndThreadPoolBasedKeepAliveIOCompletionThreshold integer: Threshold of front end thread pool based keep-alive IO completion.
    • frontEndThreadPoolBasedKeepAliveMonitorIntervalInSeconds integer: Monitor interval (in seconds) of front end thread pool based keep-alive monitor.
    • frontEndThreadPoolBasedKeepAlivePercentage number: Percentage (%) of front end thread pool based keep-alive.
    • frontEndThreadPoolBasedKeepAliveWorkerThreadThreshold integer: Threshold of front end thread pool based keep-alive worker thread.
    • frontEndUseSlaTimeInAvailability boolean: Switch of whether front end uses SLA time in availability.

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/azure_azsadmin_blobservices

Weekly Downloads

3

Version

3.0.0

License

MIT

Unpacked Size

65.7 kB

Total Files

4

Last publish

Collaborators

  • datafire