Microsoft.Azure.Management.Consumption.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.Azure.Management.Consumption</name> </assembly> <members> <member name="T:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient"> <summary> Consumption management client provides access to consumption resources for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.BaseUri"> <summary> The base URI of the service. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.SerializationSettings"> <summary> Gets or sets json serialization settings. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.DeserializationSettings"> <summary> Gets or sets json deserialization settings. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.Credentials"> <summary> Credentials needed for the client to connect to Azure. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.ApiVersion"> <summary> Version of the API to be used with the client request. The current version is 2017-02-27-preview. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.SubscriptionId"> <summary> Azure Subscription ID. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.AcceptLanguage"> <summary> Gets or sets the preferred language for the response. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.LongRunningOperationRetryTimeout"> <summary> Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.GenerateClientRequestId"> <summary> When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.UsageDetails"> <summary> Gets the IUsageDetailsOperations. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.Operations"> <summary> Gets the IOperations. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.#ctor(System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the ConsumptionManagementClient class. </summary> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> </member> <member name="M:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.#ctor(System.Net.Http.HttpClientHandler,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the ConsumptionManagementClient class. </summary> <param name='rootHandler'> Optional. The http client handler used to handle http transport. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> </member> <member name="M:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.#ctor(System.Uri,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the ConsumptionManagementClient class. </summary> <param name='baseUri'> Optional. The base URI of the service. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.#ctor(System.Uri,System.Net.Http.HttpClientHandler,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the ConsumptionManagementClient class. </summary> <param name='baseUri'> Optional. The base URI of the service. </param> <param name='rootHandler'> Optional. The http client handler used to handle http transport. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.#ctor(Microsoft.Rest.ServiceClientCredentials,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the ConsumptionManagementClient class. </summary> <param name='credentials'> Required. Credentials needed for the client to connect to Azure. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.#ctor(Microsoft.Rest.ServiceClientCredentials,System.Net.Http.HttpClientHandler,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the ConsumptionManagementClient class. </summary> <param name='credentials'> Required. Credentials needed for the client to connect to Azure. </param> <param name='rootHandler'> Optional. The http client handler used to handle http transport. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.#ctor(System.Uri,Microsoft.Rest.ServiceClientCredentials,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the ConsumptionManagementClient class. </summary> <param name='baseUri'> Optional. The base URI of the service. </param> <param name='credentials'> Required. Credentials needed for the client to connect to Azure. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.#ctor(System.Uri,Microsoft.Rest.ServiceClientCredentials,System.Net.Http.HttpClientHandler,System.Net.Http.DelegatingHandler[])"> <summary> Initializes a new instance of the ConsumptionManagementClient class. </summary> <param name='baseUri'> Optional. The base URI of the service. </param> <param name='credentials'> Required. Credentials needed for the client to connect to Azure. </param> <param name='rootHandler'> Optional. The http client handler used to handle http transport. </param> <param name='handlers'> Optional. The delegating handlers to add to the http client pipeline. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Management.Consumption.ConsumptionManagementClient.Initialize"> <summary> Initializes client properties. </summary> </member> <member name="T:Microsoft.Azure.Management.Consumption.IConsumptionManagementClient"> <summary> Consumption management client provides access to consumption resources for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.IConsumptionManagementClient.BaseUri"> <summary> The base URI of the service. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.IConsumptionManagementClient.SerializationSettings"> <summary> Gets or sets json serialization settings. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.IConsumptionManagementClient.DeserializationSettings"> <summary> Gets or sets json deserialization settings. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.IConsumptionManagementClient.Credentials"> <summary> Credentials needed for the client to connect to Azure. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.IConsumptionManagementClient.ApiVersion"> <summary> Version of the API to be used with the client request. The current version is 2017-02-27-preview. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.IConsumptionManagementClient.SubscriptionId"> <summary> Azure Subscription ID. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.IConsumptionManagementClient.AcceptLanguage"> <summary> Gets or sets the preferred language for the response. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.IConsumptionManagementClient.LongRunningOperationRetryTimeout"> <summary> Gets or sets the retry timeout in seconds for Long Running Operations. Default value is 30. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.IConsumptionManagementClient.GenerateClientRequestId"> <summary> When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.IConsumptionManagementClient.UsageDetails"> <summary> Gets the IUsageDetailsOperations. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.IConsumptionManagementClient.Operations"> <summary> Gets the IOperations. </summary> </member> <member name="T:Microsoft.Azure.Management.Consumption.IOperations"> <summary> Operations operations. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.IOperations.ListWithHttpMessagesAsync(System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Lists all of the available consumption REST API operations. </summary> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Azure.Management.Consumption.Models.ErrorResponseException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Management.Consumption.IOperations.ListNextWithHttpMessagesAsync(System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Lists all of the available consumption REST API operations. </summary> <param name='nextPageLink'> The NextLink from the previous successful call to List operation. </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Azure.Management.Consumption.Models.ErrorResponseException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="T:Microsoft.Azure.Management.Consumption.IUsageDetailsOperations"> <summary> UsageDetailsOperations operations. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.IUsageDetailsOperations.ListWithHttpMessagesAsync(System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Lists the usage details for a scope in reverse chronological order by billing period. Usage details are available via this API only for January 1, 2017 or later. <see href="https://go.microsoft.com/fwlink/?linkid=845275" /> </summary> <param name='scope'> The scope of the usage details. The scope can be '/subscriptions/{subscriptionId}/' for a subscription, or '/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/{invoiceName}' for an invoice or '/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}' for a billing perdiod. </param> <param name='expand'> May be used to expand the additionalProperties or meterDetails property within a list of usage details. By default, these fields are not included when listing usage details. </param> <param name='filter'> May be used to filter usageDetails by usageEnd (Utc time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. </param> <param name='skiptoken'> Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. </param> <param name='top'> May be used to limit the number of results to the most recent N usageDetails. </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Azure.Management.Consumption.Models.ErrorResponseException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="M:Microsoft.Azure.Management.Consumption.IUsageDetailsOperations.ListNextWithHttpMessagesAsync(System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Lists the usage details for a scope in reverse chronological order by billing period. Usage details are available via this API only for January 1, 2017 or later. <see href="https://go.microsoft.com/fwlink/?linkid=845275" /> </summary> <param name='nextPageLink'> The NextLink from the previous successful call to List operation. </param> <param name='customHeaders'> The headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Azure.Management.Consumption.Models.ErrorResponseException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> </member> <member name="T:Microsoft.Azure.Management.Consumption.Models.ErrorDetails"> <summary> The details of the error. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.ErrorDetails.#ctor"> <summary> Initializes a new instance of the ErrorDetails class. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.ErrorDetails.#ctor(System.String,System.String,System.String)"> <summary> Initializes a new instance of the ErrorDetails class. </summary> <param name="code">Error code.</param> <param name="message">Error message indicating why the operation failed.</param> <param name="target">The target of the particular error.</param> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.ErrorDetails.Code"> <summary> Gets error code. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.ErrorDetails.Message"> <summary> Gets error message indicating why the operation failed. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.ErrorDetails.Target"> <summary> Gets the target of the particular error. </summary> </member> <member name="T:Microsoft.Azure.Management.Consumption.Models.ErrorResponse"> <summary> Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.ErrorResponse.#ctor"> <summary> Initializes a new instance of the ErrorResponse class. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.ErrorResponse.#ctor(Microsoft.Azure.Management.Consumption.Models.ErrorDetails)"> <summary> Initializes a new instance of the ErrorResponse class. </summary> <param name="error">The details of the error.</param> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.ErrorResponse.Error"> <summary> Gets or sets the details of the error. </summary> </member> <member name="T:Microsoft.Azure.Management.Consumption.Models.ErrorResponseException"> <summary> Exception thrown for an invalid response with ErrorResponse information. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.ErrorResponseException.Request"> <summary> Gets information about the associated HTTP request. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.ErrorResponseException.Response"> <summary> Gets information about the associated HTTP response. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.ErrorResponseException.Body"> <summary> Gets or sets the body object. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.ErrorResponseException.#ctor"> <summary> Initializes a new instance of the ErrorResponseException class. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.ErrorResponseException.#ctor(System.String)"> <summary> Initializes a new instance of the ErrorResponseException class. </summary> <param name="message">The exception message.</param> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.ErrorResponseException.#ctor(System.String,System.Exception)"> <summary> Initializes a new instance of the ErrorResponseException class. </summary> <param name="message">The exception message.</param> <param name="innerException">Inner exception.</param> </member> <member name="T:Microsoft.Azure.Management.Consumption.Models.MeterDetails"> <summary> The properties of the meter detail. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.MeterDetails.#ctor"> <summary> Initializes a new instance of the MeterDetails class. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.MeterDetails.#ctor(System.String,System.String,System.String,System.String,System.String,System.Nullable{System.Decimal},System.Nullable{System.Decimal})"> <summary> Initializes a new instance of the MeterDetails class. </summary> <param name="meterName">The name of the meter, within the given meter category</param> <param name="meterCategory">The category of the meter, for example, 'Cloud services', 'Networking', etc..</param> <param name="meterSubCategory">The subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc..</param> <param name="unit">The unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc.</param> <param name="meterLocation">The location in which the Azure service is available.</param> <param name="totalIncludedQuantity">The total included quantity associated with the offer.</param> <param name="pretaxStandardRate">The pretax listing price.</param> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.MeterDetails.MeterName"> <summary> Gets the name of the meter, within the given meter category </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.MeterDetails.MeterCategory"> <summary> Gets the category of the meter, for example, 'Cloud services', 'Networking', etc.. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.MeterDetails.MeterSubCategory"> <summary> Gets the subcategory of the meter, for example, 'A6 Cloud services', 'ExpressRoute (IXP)', etc.. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.MeterDetails.Unit"> <summary> Gets the unit in which the meter consumption is charged, for example, 'Hours', 'GB', etc. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.MeterDetails.MeterLocation"> <summary> Gets the location in which the Azure service is available. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.MeterDetails.TotalIncludedQuantity"> <summary> Gets the total included quantity associated with the offer. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.MeterDetails.PretaxStandardRate"> <summary> Gets the pretax listing price. </summary> </member> <member name="T:Microsoft.Azure.Management.Consumption.Models.Operation"> <summary> A Consumption REST API operation. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.Operation.#ctor"> <summary> Initializes a new instance of the Operation class. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.Operation.#ctor(System.String,Microsoft.Azure.Management.Consumption.Models.OperationDisplay)"> <summary> Initializes a new instance of the Operation class. </summary> <param name="name">Operation name: {provider}/{resource}/{operation}.</param> <param name="display">The object that represents the operation.</param> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.Operation.Name"> <summary> Gets operation name: {provider}/{resource}/{operation}. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.Operation.Display"> <summary> Gets or sets the object that represents the operation. </summary> </member> <member name="T:Microsoft.Azure.Management.Consumption.Models.OperationDisplay"> <summary> The object that represents the operation. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.OperationDisplay.#ctor"> <summary> Initializes a new instance of the OperationDisplay class. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.OperationDisplay.#ctor(System.String,System.String,System.String)"> <summary> Initializes a new instance of the OperationDisplay class. </summary> <param name="provider">Service provider: Microsoft.Consumption.</param> <param name="resource">Resource on which the operation is performed: UsageDetail, etc.</param> <param name="operation">Operation type: Read, write, delete, etc.</param> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.OperationDisplay.Provider"> <summary> Gets service provider: Microsoft.Consumption. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.OperationDisplay.Resource"> <summary> Gets resource on which the operation is performed: UsageDetail, etc. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.OperationDisplay.Operation"> <summary> Gets operation type: Read, write, delete, etc. </summary> </member> <member name="T:Microsoft.Azure.Management.Consumption.Models.Page`1"> <summary> Defines a page in Azure responses. </summary> <typeparam name="T">Type of the page content items</typeparam> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.Page`1.NextPageLink"> <summary> Gets the link to the next page. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.Page`1.GetEnumerator"> <summary> Returns an enumerator that iterates through the collection. </summary> <returns>A an enumerator that can be used to iterate through the collection.</returns> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.Page`1.System#Collections#IEnumerable#GetEnumerator"> <summary> Returns an enumerator that iterates through the collection. </summary> <returns>A an enumerator that can be used to iterate through the collection.</returns> </member> <member name="T:Microsoft.Azure.Management.Consumption.Models.Resource"> <summary> The Resource model definition. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.Resource.#ctor"> <summary> Initializes a new instance of the Resource class. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.Resource.#ctor(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String})"> <summary> Initializes a new instance of the Resource class. </summary> <param name="id">Resource Id.</param> <param name="name">Resource name.</param> <param name="type">Resource type.</param> <param name="tags">Resource tags.</param> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.Resource.Id"> <summary> Gets resource Id. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.Resource.Name"> <summary> Gets resource name. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.Resource.Type"> <summary> Gets resource type. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.Resource.Tags"> <summary> Gets resource tags. </summary> </member> <member name="T:Microsoft.Azure.Management.Consumption.Models.UsageDetail"> <summary> An usage detail resource. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.UsageDetail.#ctor"> <summary> Initializes a new instance of the UsageDetail class. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Models.UsageDetail.#ctor(System.String,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.String,System.String,System.Nullable{System.DateTime},System.Nullable{System.DateTime},System.String,System.String,System.String,System.String,System.Nullable{System.Decimal},System.Nullable{System.Decimal},System.Nullable{System.Decimal},System.Nullable{System.Boolean},System.String,Microsoft.Azure.Management.Consumption.Models.MeterDetails,System.Collections.Generic.IDictionary{System.String,System.String})"> <summary> Initializes a new instance of the UsageDetail class. </summary> <param name="id">Resource Id.</param> <param name="name">Resource name.</param> <param name="type">Resource type.</param> <param name="tags">Resource tags.</param> <param name="billingPeriodId">The id of the billing period resource that the usage belongs to.</param> <param name="invoiceId">The id of the invoice resource that the usage belongs to.</param> <param name="usageStart">The start of the date time range covered by the usage detail.</param> <param name="usageEnd">The end of the date time range covered by the usage detail.</param> <param name="instanceName">The name of the resource instance that the usage is about.</param> <param name="instanceId">The uri of the resource instance that the usage is about.</param> <param name="instanceLocation">The location of the resource instance that the usage is about.</param> <param name="currency">The ISO currency in which the meter is charged, for example, USD.</param> <param name="usageQuantity">The quantity of usage.</param> <param name="billableQuantity">The billable usage quantity.</param> <param name="pretaxCost">The amount of cost before tax.</param> <param name="isEstimated">The estimated usage is subject to change.</param> <param name="meterId">The meter id.</param> <param name="meterDetails">The details about the meter. By default this is not populated, unless it's specified in $expand.</param> <param name="additionalProperties">The list of key/value pairs for the additional properties, in the format 'key':'value' where key = the field name, and value = the field value. By default this is not populated, unless it's specified in $expand.</param> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.UsageDetail.BillingPeriodId"> <summary> Gets the id of the billing period resource that the usage belongs to. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.UsageDetail.InvoiceId"> <summary> Gets the id of the invoice resource that the usage belongs to. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.UsageDetail.UsageStart"> <summary> Gets the start of the date time range covered by the usage detail. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.UsageDetail.UsageEnd"> <summary> Gets the end of the date time range covered by the usage detail. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.UsageDetail.InstanceName"> <summary> Gets the name of the resource instance that the usage is about. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.UsageDetail.InstanceId"> <summary> Gets the uri of the resource instance that the usage is about. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.UsageDetail.InstanceLocation"> <summary> Gets the location of the resource instance that the usage is about. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.UsageDetail.Currency"> <summary> Gets the ISO currency in which the meter is charged, for example, USD. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.UsageDetail.UsageQuantity"> <summary> Gets the quantity of usage. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.UsageDetail.BillableQuantity"> <summary> Gets the billable usage quantity. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.UsageDetail.PretaxCost"> <summary> Gets the amount of cost before tax. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.UsageDetail.IsEstimated"> <summary> Gets the estimated usage is subject to change. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.UsageDetail.MeterId"> <summary> Gets the meter id. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.UsageDetail.MeterDetails"> <summary> Gets the details about the meter. By default this is not populated, unless it's specified in $expand. </summary> </member> <member name="P:Microsoft.Azure.Management.Consumption.Models.UsageDetail.AdditionalProperties"> <summary> Gets the list of key/value pairs for the additional properties, in the format 'key':'value' where key = the field name, and value = the field value. By default this is not populated, unless it's specified in $expand. </summary> </member> <member name="T:Microsoft.Azure.Management.Consumption.Operations"> <summary> Operations operations. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Operations.#ctor(Microsoft.Azure.Management.Consumption.ConsumptionManagementClient)"> <summary> Initializes a new instance of the Operations class. </summary> <param name='client'> Reference to the service client. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="P:Microsoft.Azure.Management.Consumption.Operations.Client"> <summary> Gets a reference to the ConsumptionManagementClient </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.Operations.ListWithHttpMessagesAsync(System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Lists all of the available consumption REST API operations. </summary> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Azure.Management.Consumption.Models.ErrorResponseException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Management.Consumption.Operations.ListNextWithHttpMessagesAsync(System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Lists all of the available consumption REST API operations. </summary> <param name='nextPageLink'> The NextLink from the previous successful call to List operation. </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Azure.Management.Consumption.Models.ErrorResponseException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="T:Microsoft.Azure.Management.Consumption.OperationsExtensions"> <summary> Extension methods for Operations. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.OperationsExtensions.List(Microsoft.Azure.Management.Consumption.IOperations)"> <summary> Lists all of the available consumption REST API operations. </summary> <param name='operations'> The operations group for this extension method. </param> </member> <member name="M:Microsoft.Azure.Management.Consumption.OperationsExtensions.ListAsync(Microsoft.Azure.Management.Consumption.IOperations,System.Threading.CancellationToken)"> <summary> Lists all of the available consumption REST API operations. </summary> <param name='operations'> The operations group for this extension method. </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Management.Consumption.OperationsExtensions.ListNext(Microsoft.Azure.Management.Consumption.IOperations,System.String)"> <summary> Lists all of the available consumption REST API operations. </summary> <param name='operations'> The operations group for this extension method. </param> <param name='nextPageLink'> The NextLink from the previous successful call to List operation. </param> </member> <member name="M:Microsoft.Azure.Management.Consumption.OperationsExtensions.ListNextAsync(Microsoft.Azure.Management.Consumption.IOperations,System.String,System.Threading.CancellationToken)"> <summary> Lists all of the available consumption REST API operations. </summary> <param name='operations'> The operations group for this extension method. </param> <param name='nextPageLink'> The NextLink from the previous successful call to List operation. </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="T:Microsoft.Azure.Management.Consumption.UsageDetailsOperations"> <summary> UsageDetailsOperations operations. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.UsageDetailsOperations.#ctor(Microsoft.Azure.Management.Consumption.ConsumptionManagementClient)"> <summary> Initializes a new instance of the UsageDetailsOperations class. </summary> <param name='client'> Reference to the service client. </param> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> </member> <member name="P:Microsoft.Azure.Management.Consumption.UsageDetailsOperations.Client"> <summary> Gets a reference to the ConsumptionManagementClient </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.UsageDetailsOperations.ListWithHttpMessagesAsync(System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Lists the usage details for a scope in reverse chronological order by billing period. Usage details are available via this API only for January 1, 2017 or later. <see href="https://go.microsoft.com/fwlink/?linkid=845275" /> </summary> <param name='scope'> The scope of the usage details. The scope can be '/subscriptions/{subscriptionId}/' for a subscription, or '/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/{invoiceName}' for an invoice or '/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}' for a billing perdiod. </param> <param name='expand'> May be used to expand the additionalProperties or meterDetails property within a list of usage details. By default, these fields are not included when listing usage details. </param> <param name='filter'> May be used to filter usageDetails by usageEnd (Utc time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. </param> <param name='skiptoken'> Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. </param> <param name='top'> May be used to limit the number of results to the most recent N usageDetails. </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Azure.Management.Consumption.Models.ErrorResponseException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="M:Microsoft.Azure.Management.Consumption.UsageDetailsOperations.ListNextWithHttpMessagesAsync(System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{System.String}},System.Threading.CancellationToken)"> <summary> Lists the usage details for a scope in reverse chronological order by billing period. Usage details are available via this API only for January 1, 2017 or later. <see href="https://go.microsoft.com/fwlink/?linkid=845275" /> </summary> <param name='nextPageLink'> The NextLink from the previous successful call to List operation. </param> <param name='customHeaders'> Headers that will be added to request. </param> <param name='cancellationToken'> The cancellation token. </param> <exception cref="T:Microsoft.Azure.Management.Consumption.Models.ErrorResponseException"> Thrown when the operation returned an invalid status code </exception> <exception cref="T:Microsoft.Rest.SerializationException"> Thrown when unable to deserialize the response </exception> <exception cref="T:Microsoft.Rest.ValidationException"> Thrown when a required parameter is null </exception> <exception cref="T:System.ArgumentNullException"> Thrown when a required parameter is null </exception> <return> A response object containing the response body and response headers. </return> </member> <member name="T:Microsoft.Azure.Management.Consumption.UsageDetailsOperationsExtensions"> <summary> Extension methods for UsageDetailsOperations. </summary> </member> <member name="M:Microsoft.Azure.Management.Consumption.UsageDetailsOperationsExtensions.List(Microsoft.Azure.Management.Consumption.IUsageDetailsOperations,System.String,System.String,System.String,System.String,System.Nullable{System.Int32})"> <summary> Lists the usage details for a scope in reverse chronological order by billing period. Usage details are available via this API only for January 1, 2017 or later. <see href="https://go.microsoft.com/fwlink/?linkid=845275" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='scope'> The scope of the usage details. The scope can be '/subscriptions/{subscriptionId}/' for a subscription, or '/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/{invoiceName}' for an invoice or '/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}' for a billing perdiod. </param> <param name='expand'> May be used to expand the additionalProperties or meterDetails property within a list of usage details. By default, these fields are not included when listing usage details. </param> <param name='filter'> May be used to filter usageDetails by usageEnd (Utc time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. </param> <param name='skiptoken'> Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. </param> <param name='top'> May be used to limit the number of results to the most recent N usageDetails. </param> </member> <member name="M:Microsoft.Azure.Management.Consumption.UsageDetailsOperationsExtensions.ListAsync(Microsoft.Azure.Management.Consumption.IUsageDetailsOperations,System.String,System.String,System.String,System.String,System.Nullable{System.Int32},System.Threading.CancellationToken)"> <summary> Lists the usage details for a scope in reverse chronological order by billing period. Usage details are available via this API only for January 1, 2017 or later. <see href="https://go.microsoft.com/fwlink/?linkid=845275" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='scope'> The scope of the usage details. The scope can be '/subscriptions/{subscriptionId}/' for a subscription, or '/subscriptions/{subscriptionId}/providers/Microsoft.Billing/invoices/{invoiceName}' for an invoice or '/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}' for a billing perdiod. </param> <param name='expand'> May be used to expand the additionalProperties or meterDetails property within a list of usage details. By default, these fields are not included when listing usage details. </param> <param name='filter'> May be used to filter usageDetails by usageEnd (Utc time). The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. </param> <param name='skiptoken'> Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. </param> <param name='top'> May be used to limit the number of results to the most recent N usageDetails. </param> <param name='cancellationToken'> The cancellation token. </param> </member> <member name="M:Microsoft.Azure.Management.Consumption.UsageDetailsOperationsExtensions.ListNext(Microsoft.Azure.Management.Consumption.IUsageDetailsOperations,System.String)"> <summary> Lists the usage details for a scope in reverse chronological order by billing period. Usage details are available via this API only for January 1, 2017 or later. <see href="https://go.microsoft.com/fwlink/?linkid=845275" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='nextPageLink'> The NextLink from the previous successful call to List operation. </param> </member> <member name="M:Microsoft.Azure.Management.Consumption.UsageDetailsOperationsExtensions.ListNextAsync(Microsoft.Azure.Management.Consumption.IUsageDetailsOperations,System.String,System.Threading.CancellationToken)"> <summary> Lists the usage details for a scope in reverse chronological order by billing period. Usage details are available via this API only for January 1, 2017 or later. <see href="https://go.microsoft.com/fwlink/?linkid=845275" /> </summary> <param name='operations'> The operations group for this extension method. </param> <param name='nextPageLink'> The NextLink from the previous successful call to List operation. </param> <param name='cancellationToken'> The cancellation token. </param> </member> </members> </doc> |