Microsoft.Azure.Commerce.UsageAggregates.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.Azure.Commerce.UsageAggregates</name> </assembly> <members> <member name="T:Microsoft.Azure.Commerce.UsageAggregates.Models.InfoField"> <summary> Key-value pairs of instance details in the legacy format. </summary> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.Models.InfoField.#ctor"> <summary> Initializes a new instance of the InfoField class. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.InfoField.Project"> <summary> Optional. Identifies the name of the instance provisioned by the user. </summary> </member> <member name="T:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageAggregation"> <summary> Describes the usageAggregation. </summary> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageAggregation.#ctor"> <summary> Initializes a new instance of the UsageAggregation class. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageAggregation.Id"> <summary> Optional. Unique Id for the usage aggregate. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageAggregation.Name"> <summary> Optional. Name of the usage aggregate. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageAggregation.Properties"> <summary> Optional. Usage data. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageAggregation.Type"> <summary> Optional. Type of the resource being returned. </summary> </member> <member name="T:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageAggregationGetResponse"> <summary> The Get UsageAggregates operation response. </summary> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageAggregationGetResponse.#ctor"> <summary> Initializes a new instance of the UsageAggregationGetResponse class. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageAggregationGetResponse.NextLink"> <summary> Optional. Gets or sets the link to the next set of results. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageAggregationGetResponse.ContinuationToken"> <summary> Optional. Gets or sets the continuation token used for success calls to the same set of input parameters. If null or emtpy then there aren't anymore results on the server. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageAggregationGetResponse.UsageAggregations"> <summary> Optional. Gets or sets details for the requested aggregation. </summary> </member> <member name="T:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageSample"> <summary> Describes a sample of the usageAggregation. </summary> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageSample.#ctor"> <summary> Initializes a new instance of the UsageSample class. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageSample.InfoFields"> <summary> Optional. Key-value pairs of instance details (legacy format). </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageSample.InstanceData"> <summary> Optional. Key-value pairs of instance details represented as a string. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageSample.MeterCategory"> <summary> Optional. Category of the consumed resource. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageSample.MeterId"> <summary> Optional. Unique ID for the resource that was consumed (aka ResourceID). </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageSample.MeterName"> <summary> Optional. Friendly name of the resource being consumed. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageSample.MeterRegion"> <summary> Optional. Region of the meterId used for billing purposes </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageSample.MeterSubCategory"> <summary> Optional. Sub-category of the consumed resource. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageSample.Quantity"> <summary> Optional. The amount of the resource consumption that occurred in this time frame. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageSample.Unit"> <summary> Optional. The unit in which the usage for this resource is being counted, e.g. Hours, GB. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageSample.UsageEndTime"> <summary> Optional. UTC end time for the usage bucket to which this usage aggregate belongs. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.Models.UsageSample.UsageStartTime"> <summary> Optional. UTC start time for the usage bucket to which this usage aggregate belongs. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.IUsageAggregationManagementClient.ApiVersion"> <summary> Gets the API version. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.IUsageAggregationManagementClient.BaseUri"> <summary> Gets the URI used as the base for all cloud service requests. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.IUsageAggregationManagementClient.Credentials"> <summary> Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.IUsageAggregationManagementClient.LongRunningOperationInitialTimeout"> <summary> Gets or sets the initial timeout for Long Running Operations. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.IUsageAggregationManagementClient.LongRunningOperationRetryTimeout"> <summary> Gets or sets the retry timeout for Long Running Operations. </summary> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationManagementClient.#ctor"> <summary> Initializes a new instance of the UsageAggregationManagementClient class. </summary> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationManagementClient.#ctor(Microsoft.Azure.SubscriptionCloudCredentials,System.Uri)"> <summary> Initializes a new instance of the UsageAggregationManagementClient class. </summary> <param name='credentials'> Required. Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. </param> <param name='baseUri'> Optional. Gets the URI used as the base for all cloud service requests. </param> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationManagementClient.#ctor(Microsoft.Azure.SubscriptionCloudCredentials)"> <summary> Initializes a new instance of the UsageAggregationManagementClient class. </summary> <param name='credentials'> Required. Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. </param> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationManagementClient.#ctor(System.Net.Http.HttpClient)"> <summary> Initializes a new instance of the UsageAggregationManagementClient class. </summary> <param name='httpClient'> The Http client </param> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationManagementClient.#ctor(Microsoft.Azure.SubscriptionCloudCredentials,System.Uri,System.Net.Http.HttpClient)"> <summary> Initializes a new instance of the UsageAggregationManagementClient class. </summary> <param name='credentials'> Required. Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. </param> <param name='baseUri'> Optional. Gets the URI used as the base for all cloud service requests. </param> <param name='httpClient'> The Http client </param> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationManagementClient.#ctor(Microsoft.Azure.SubscriptionCloudCredentials,System.Net.Http.HttpClient)"> <summary> Initializes a new instance of the UsageAggregationManagementClient class. </summary> <param name='credentials'> Required. Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. </param> <param name='httpClient'> The Http client </param> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationManagementClient.Clone(Hyak.Common.ServiceClient{Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationManagementClient})"> <summary> Clones properties from current instance to another UsageAggregationManagementClient instance </summary> <param name='client'> Instance of UsageAggregationManagementClient to clone to </param> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationManagementClient.ParseAggregationGranularity(System.String)"> <summary> Parse enum values for type AggregationGranularity. </summary> <param name='value'> The value to parse. </param> <returns> The enum value. </returns> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationManagementClient.AggregationGranularityToString(Microsoft.Azure.Commerce.UsageAggregates.Models.AggregationGranularity)"> <summary> Convert an enum of type AggregationGranularity to a string. </summary> <param name='value'> The value to convert to a string. </param> <returns> The enum value as a string. </returns> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationManagementClient.ApiVersion"> <summary> Gets the API version. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationManagementClient.BaseUri"> <summary> Gets the URI used as the base for all cloud service requests. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationManagementClient.Credentials"> <summary> Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationManagementClient.LongRunningOperationInitialTimeout"> <summary> Gets or sets the initial timeout for Long Running Operations. </summary> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationManagementClient.LongRunningOperationRetryTimeout"> <summary> Gets or sets the retry timeout for Long Running Operations. </summary> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationOperationsExtensions.Get(Microsoft.Azure.Commerce.UsageAggregates.IUsageAggregationOperations,System.DateTime,System.DateTime,Microsoft.Azure.Commerce.UsageAggregates.Models.AggregationGranularity,System.Boolean,System.String)"> <summary> Query aggregated Azure subscription consumption data for a date range. (see https://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c for more information) </summary> <param name='operations'> Reference to the Microsoft.Azure.Commerce.UsageAggregates.IUsageAggregationOperations. </param> <param name='reportedStartTime'> Required. The start of the time range to retrieve data for. </param> <param name='reportedEndTime'> Required. The end of the time range to retrieve data for. </param> <param name='aggregationGranularity'> Required. Value is either daily (default) or hourly to tell the API how to return the results grouped by day or hour. </param> <param name='showDetails'> Required. When set to true (default), the aggregates are broken down into the instance metadata which is more granular. </param> <param name='continuationToken'> Optional. Retrieved from previous calls, this is the bookmark used for progress when the responses are paged. </param> <returns> The Get UsageAggregates operation response. </returns> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationOperationsExtensions.GetAsync(Microsoft.Azure.Commerce.UsageAggregates.IUsageAggregationOperations,System.DateTime,System.DateTime,Microsoft.Azure.Commerce.UsageAggregates.Models.AggregationGranularity,System.Boolean,System.String)"> <summary> Query aggregated Azure subscription consumption data for a date range. (see https://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c for more information) </summary> <param name='operations'> Reference to the Microsoft.Azure.Commerce.UsageAggregates.IUsageAggregationOperations. </param> <param name='reportedStartTime'> Required. The start of the time range to retrieve data for. </param> <param name='reportedEndTime'> Required. The end of the time range to retrieve data for. </param> <param name='aggregationGranularity'> Required. Value is either daily (default) or hourly to tell the API how to return the results grouped by day or hour. </param> <param name='showDetails'> Required. When set to true (default), the aggregates are broken down into the instance metadata which is more granular. </param> <param name='continuationToken'> Optional. Retrieved from previous calls, this is the bookmark used for progress when the responses are paged. </param> <returns> The Get UsageAggregates operation response. </returns> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.IUsageAggregationOperations.GetAsync(System.DateTime,System.DateTime,Microsoft.Azure.Commerce.UsageAggregates.Models.AggregationGranularity,System.Boolean,System.String,System.Threading.CancellationToken)"> <summary> Query aggregated Azure subscription consumption data for a date range. (see https://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c for more information) </summary> <param name='reportedStartTime'> The start of the time range to retrieve data for. </param> <param name='reportedEndTime'> The end of the time range to retrieve data for. </param> <param name='aggregationGranularity'> Value is either daily (default) or hourly to tell the API how to return the results grouped by day or hour. </param> <param name='showDetails'> When set to true (default), the aggregates are broken down into the instance metadata which is more granular. </param> <param name='continuationToken'> Retrieved from previous calls, this is the bookmark used for progress when the responses are paged. </param> <param name='cancellationToken'> Cancellation token. </param> <returns> The Get UsageAggregates operation response. </returns> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationOperations.#ctor(Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationManagementClient)"> <summary> Initializes a new instance of the UsageAggregationOperations class. </summary> <param name='client'> Reference to the service client. </param> </member> <member name="M:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationOperations.GetAsync(System.DateTime,System.DateTime,Microsoft.Azure.Commerce.UsageAggregates.Models.AggregationGranularity,System.Boolean,System.String,System.Threading.CancellationToken)"> <summary> Query aggregated Azure subscription consumption data for a date range. (see https://msdn.microsoft.com/library/azure/1ea5b323-54bb-423d-916f-190de96c6a3c for more information) </summary> <param name='reportedStartTime'> Required. The start of the time range to retrieve data for. </param> <param name='reportedEndTime'> Required. The end of the time range to retrieve data for. </param> <param name='aggregationGranularity'> Required. Value is either daily (default) or hourly to tell the API how to return the results grouped by day or hour. </param> <param name='showDetails'> Required. When set to true (default), the aggregates are broken down into the instance metadata which is more granular. </param> <param name='continuationToken'> Optional. Retrieved from previous calls, this is the bookmark used for progress when the responses are paged. </param> <param name='cancellationToken'> Cancellation token. </param> <returns> The Get UsageAggregates operation response. </returns> </member> <member name="P:Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationOperations.Client"> <summary> Gets a reference to the Microsoft.Azure.Commerce.UsageAggregates.UsageAggregationManagementClient. </summary> </member> </members> </doc> |