Repository for documentation on the Azure .NET SDK.
Home Page: https://docs.microsoft.com/dotnet/api/?view=azure-dotnet
License: Creative Commons Attribution 4.0 International
This repository houses raw content for the Azure .NET SDK API documentation, hosted on docs.microsoft.com. Content provided here is generated from various NuGet packages that provide tooling to interact and manage Azure services.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.
Can you specify what the result value represents?
This does not give us much information "A Task object that represents the asynchronous operation."
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
Breaking changes abound. how about a clarification of these terms. If you don't get this right, nobody is connecting to cosmosdb. kinda urgent.
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
In the description of TokenCache property, it says "To turn OFF token caching, set TokenCache to null." https://docs.microsoft.com/en-us/dotnet/api/microsoft.identitymodel.clients.activedirectory.authenticationcontext.tokencache?view=azure-dotnet
But there is no setter for the property, or setTokenCache method in Authenticationcontext class. How to set it?
Because provisioning state is a string which is ambiguous, it would be important to list the possible values, or provide an enumeration for this field. At the very least, possible values for deployment states should be listed.
"Provisioning State (Get) - Gets the state of provisioning" is not proper documentation IMO. Typically when writing documentation it is bad practice to simply add spaces to the name of the item being described with small changes in word order. Some elaboration here would be beneficial. I assume this documentation is auto generated and simply needs to be filled in.
Reasoning:
There are many times when in an application you may want to make decisions based on the state of a deployment. Having a list of know values would be helpful for this, since it is difficult/impossible to know what will come from Azure in this case.
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
I'm not sure how one is supposed to figure out how to use these classes, since the documentation provides basically zero info on usage.
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
I'm trying to follow the MongoDb docs. https://docs.microsoft.com/en-us/dotnet/api/overview/azure/cosmosdb?view=azure-dotnet Seems like there's an extra closing parens in the last line.
Copied this:
`/* Include this "using" directive...
using Microsoft.Azure.Documents.Client;
*/
DocumentClient client = new DocumentClient(endpointUri, authKeyString);
Uri documentUri = UriFactory.CreateDocumentUri("MyDatabaseName", "MyCollectionName", "DocumentId");
SomeClass myObject = client.ReadDocumentAsync(documentUri).ToString()).Result;`
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
Hi,
I have run into some issues with creating CloudJobs and CloudTasks from C#. I got errors such as:
System.InvalidOperationException: The property JobPreparationTask cannot be modified while the object is in the Bound state.
at Microsoft.Azure.Batch.PropertyAccessor`1.SetValue(T value, Boolean overrideReadOnly, Boolean overrideAccessControl)
System.InvalidOperationException: The property State cannot be read while the object is in the Unbound state.
at Microsoft.Azure.Batch.PropertyAccessController.ReadProperty[T](Func`1 propertyReadAction, BindingAccess allowedAccess, String propertyName)
at Microsoft.Azure.Batch.CloudJob.get_State()
System.InvalidOperationException: This object is in an invalid state. Write access is not allowed.
at Microsoft.Azure.Batch.PropertyAccessor`1.<>c__DisplayClass19_0.<SetValue>b__0()
at Microsoft.Azure.Batch.PropertyAccessor`1.SetValue(T value, Boolean overrideReadOnly, Boolean overrideAccessControl)
I'm confused when and when not I can read/write properties in relation to calls to:
JobOperations.ListJobs()JobOperations.GetJob()JobOperations.CreateJob()Cloud.Job.Commit()Cloud.Job.CommitChanges()Cloud.Job.Refresh()The errors thrown are not very helpful, nor is the documentation. Could you please clarify this subject a bit?
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
Hi,
I feel that the DocumentClient class documentation isn't very clear about the lifetime that the DocumentClient instance should have.
The first paragraph under the Remarks chapter hints to a reuse of the instance for the lifetime of the application, that I would translate by making this instance a Singleton. But the following chapter explains that since it's implementing IDisposable, it should be disposed right after it has been used and hints at doing it through a using.
The confusion is even aggravated by the fact that I have found two diametrically opposed example. The CosmosDB tutorial on the web app sample uses a Singleton, going as far as making all the Repository static. Another example, this time on MSDN which shows a sample using ASP.Net Core creates the DocumentClient instance just for the query, inside of a using which means that it's disposed right away.
Also found this article, again on CosmosDB's documentation that says that the Cosmos DB client should be a singleton...
So... where's the truth? This looks a lot like the HttpClient which, since it implements IDisposable everyone was putting in a using which is a bad idea.
I think the title says it all :-)
Transaction is the unit of concurrency: Users can have multiple transactions in-flight at any given point of time but for a given transaction each API must be called one at a time.
So all Reliable Collection APIs that take in a transaction and return a Task, must be awaited one at a time.
I don't see the causality here. The first sentence states that if we inspect each transaction individually (regardless of the other txs), we call the APIs sequentially.
The second sentence states that for all the APIs that are ITransaction -> Task, they should be awaited sequentially.
If we wait for tasks from different txs concurrently, rule 1 holds but rule 2 doesn't. This means rule 2 is not an implication of rule 1.
Can someone elaborate on this? We should either remove So, or remove rule 2 altogether.
error on api description
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
There is a nuance to this method that I did not catch Some remarks should help.
The delegate set with OnMessageAsync needs to be quick at going to a awaited state, or quick to complete. If the method has a of synchronous stuff it does before it goes to a awaited state, the subsequent messages are not picked up from servicebus until the thread really goes to the awaited state. Hence, in the worst case, serializing the handling of the messages to one at a time.
I'm trying to understand what's the behavior of this method if the container doesn't exist, but it's not readily available in the docs.
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
please find the error message while we call this function
Microsoft.Azure.Batch.Common.BatchException: Operation returned an invalid status code 'Conflict' ---> Microsoft.Azure.Batch.Protocol.Models.BatchErrorException: Operation returned an invalid status code 'Conflict'
at Microsoft.Azure.Batch.Protocol.ComputeNodeOperations.d__14.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
at Microsoft.Azure.Batch.Protocol.BatchRequestBase2.<ExecuteRequestWithCancellationAsync>d__43.MoveNext() --- End of stack trace from previous location where exception was thrown --- at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw() at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task) at Microsoft.Azure.Batch.Protocol.BatchRequestBase2.d__40.MoveNext()
--- End of inner exception stack trace ---
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at Microsoft.Azure.Batch.Protocol.BatchRequestBase2.<ExecuteRequestAsync>d__40.MoveNext() --- End of stack trace from previous location where exception was thrown --- at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw() at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task) at Microsoft.Azure.Batch.ProtocolLayer.<ProcessAndExecuteBatchRequest>d__841.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
at Microsoft.Azure.Batch.ProtocolLayer.d__55.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
at System.Runtime.ExceptionServices.ExceptionDispatchInfo.Throw()
at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
at System.Runtime.CompilerServices.TaskAwaiter.GetResult()
at Microsoft.Azure.BatchExplorer.Models.ComputeNodeModel.d__38.MoveNext() in E:\Work\delete\azure-batch-samples-master\CSharp\BatchExplorer\Models\ComputeNodeModel.cs:line 318
Request Information
ClientRequestId:
RequestId:8c07a8b6-c8de-48e2-a83a-cd97e49618c6
HttpStatusCode:Conflict
StatusMessage:The specified operation is not valid on the node.
The REST API doc doesn't mention Update at all. What's the difference?
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
What happens if the table is not found? Does it throw an error? Are there distinct errors for issues of connectivity vs table affirmatively not existing? What value is returned if it does not throw an error ?
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
It is very cool but Microsoft.PowerBI.Api still don't support Net Standard. And I think it should be mentioned.
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
Please add sample return values, such as ones for actual storage and emulated storage. We need to know if the URI contains port, path, the scheme, etc.
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
The property says it is a string, but it is not clear what the valid values for it are? What do you set it do? How do you use the property?
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
The biggest constructor is mentioned with having two 'dependencyName', which isn't correct. Also it would be very helpful to know how 'data', 'target' and 'DependancyTypeName' will show up in our AI dashboard.
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
On the old documentation site classes had a section about thread safety. This site does not seem to have the standard section. That aside, is this thread safe?
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
1.xml](https://github.com/Azure/azure-docs-sdk-dotnet/blob/master/xml/Microsoft.ServiceFabric.Services.Communication.Client/ServicePartitionClient1.xml)What happens if the record set doesn't exist? What kind of exceptions can be thrown?
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
Hi - the 'code' text in the 'Remarks' section on this page which begins: "When your app uses DocumentClient, you should call its IDisposable.Dispose implementation when you are finished using it...." - this is incorrect / misleading information. This is actually contradicted by the (correct) information directly above it in the 'Remarks' section - that users should be creating a DocumentClient and caching it for future use as it is threadsafe. To have the correct information followed by an incorrect code sample is very confusing - can you update the sample to show a static DocumentClient being created, with the 'using' approach as an alternative fallback? Thanks
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
hello,
after
while(results.Read())
{
Console.WriteLine("Column 0: {0} Column 1: {1}", results[0], results[1]);
}
You must close the connection.
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
The doc states:
This value can range from 10 seconds, to 5 hours (or 18,000 seconds)
This doesn't appear to be the case. Any value under 10 minutes (600 seconds) is rejected with a 400 error (with a very uninformative message: "One of the specified inputs is invalid")
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
Des display error
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
This could do with some examples. I'm working with a QueueClient and we are using brokered messages and looping repeatedly on the queue recalling _queueClient.Receive in the event of an exception on send; transient or not. The message will stay in the parent queue so what is the point of the RetryPolicy when passing messages like this?
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
Code snippets for "The example below creates a new document, and then creates a new attachment for that document" has been duplicated in this article. A little confusing.
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
When CreateDocumentAsync() is called on a collection with a unique key constraint, and the caller is trying to insert a document with a duplicate key, there appears to be no NUMERIC error code or status returned that would indicate a unique key constraint violation! -- Did I miss something in the documentation (or is the documentation missing something). Below is the simplified code / exception I received while testing such a case:
// Attempt to create a document with unique key violation ...
try
{
response = await m_doc_client.CreateDocumentAsync( my_collection_uri, my_doc, request_opts );
}
catch ( Exception )
{
// Unique key violation exception is thrown here ...
// But what (or where) is the status code?
}
The above, when executed results in the following Exception:
[01-May-18 10:58:22 PM] Microsoft.Azure.Documents.Client: Message: {"Errors":["Unique index constraint violation."]}
[01-May-18 10:58:22 PM] ActivityId: 36ff0cc8-ff3e-484d-aa08-1732d99307af, Request URI: /apps/DocDbApp/services/DocDbServer79/partitions/a4cb499b-38c8-11e6-8106-8cdcd42c33be/replicas/1p/, RequestStats: , SDK: documentdb-dotnet-sdk/1.21.1 Host/32-bit MicrosoftWindowsNT/6.2.9200.0.
[01-May-18 10:58:22 PM] Error creating document in [redacted] collection
[01-May-18 10:58:22 PM] Microsoft.Azure.Documents.Client: Message: {"Errors":["Unique index constraint violation."]}
[01-May-18 10:58:22 PM] ActivityId: 36ff0cc8-ff3e-484d-aa08-1732d99307af, Request URI: /apps/DocDbApp/services/DocDbServer79/partitions/a4cb499b-38c8-11e6-8106-8cdcd42c33be/replicas/1p/, RequestStats: , SDK: documentdb-dotnet-sdk/1.21.1 Host/32-bit MicrosoftWindowsNT/6.2.9200.0.
However, one would think that a NUMERIC status code of some kind would be returned when a unique key violation occurs so that the caller would then be able to act on the error -- currently, the only way I see of doing so is to compare the exception message returned to: "Unique index constraint violation." -- not a very friendly ( or culture-neutral ) way of dealing with API errors !!
Again, if I missed something, I apologize in advance, but if a code sample, or section on unique key violations / exception handling could be supplied in the documentation, it would be appreciated.
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
Documentation states: "You have reached your quota of user objects for this database"
WHAT is the quota value? 10, 100, 1000?
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
I thought MSFT moved away from that old auto-created documentation style of MSDN that always showed up in the first 10 google results and every developer had to skip past to get to actual examples of working code. This seems like a huge step back. I'm doing the same thing again and skipping these sites.
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
The max number of messages to request from a queue is 32, according to the REST API documentation. This number (32) is not documented in the .NET SDK.
E.g.
PeekMessages
GetMessages
can you please confirm the latest api-version 2018-03-31 returns the value in the UsageDetail.BillableQuantity property for https://management.azure.com//subscriptions/{subscriptionid}/providers/Microsoft.Consumption/usageDetails endpoint output JSON?
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
Many class definitions do not include thread safety information. For example for https://github.com/Azure/azure-docs-sdk-dotnet/blob/b39513f/xml/Microsoft.Azure.DataLake.Store/AdlsClient.xml does not mention anywhere if the class's methods are safe to use from multiple threads (like WebClient is) or if we need a instance per thread.
I have Azure Data Factory pipeline activity as below JSON, but when using code to get StoreProcedureName, it always return null.
JSON:
{ "type": "SqlServerStoredProcedure", "typeProperties": { "storedProcedureName": "[DataLoad].[uspSwitchPartition]", "storedProcedureParameters": { "tableName": "Core.CustomerDevelopments", "MonthId": "$$Text.Format('{0:yyyyMM}', WindowEnd)" } }, "inputs": [ { "name": "ASQL-outCoreCustomerDevelopments-AfterDataLoad" } ], "outputs": [ { "name": "ASQL-outCoreCustomerDevelopments-AfterPartitionSwitch" } ], "policy": { "timeout": "24.00:00:00", "concurrency": 4, "retry": 3, "longRetry": 3, "longRetryInterval": "01:00:00" }, "scheduler": { "frequency": "Month", "interval": 1 }, "name": "SwitchPartition" }
C# Code in Function APP:
System.Runtime.Serialization.Json.DataContractJsonSerializer serializer = new System.Runtime.Serialization.Json.DataContractJsonSerializer(activity.GetType(),new Type[] { typeof(Microsoft.Azure.Management.DataFactories.Models.SqlServerStoredProcedureActivity) }); MemoryStream ms = new MemoryStream(); serializer.WriteObject(ms, activity ); string json = Encoding.Default.GetString(ms.ToArray()); log.Info(json);
Return:
2017-12-27T01:48:09.309 {"TypeProperties":{"__type":"SqlServerStoredProcedureActivity:#Microsoft.Azure.Management.DataFactories.Models","StoredProcedureName":null,"StoredProcedureParameters":null},"Description":null,"Inputs":[{"EndTime":null,"Length":null,"Name":"ASQL-outCoreCustomerDevelopments-AfterDataLoad","StartTime":null}],"LinkedServiceName":null,"Name":"SwitchPartition","Outputs":[{"Name":"ASQL-outCoreCustomerDevelopments-AfterPartitionSwitch"}],"Policy":null,"Scheduler":{"AnchorDateTime":null,"Frequency":"Month","Interval":1,"Offset":null,"Style":null}}
When using Microsoft.Azure.Management.DataFactory operations extensions functions from TriggersOperationsExtensions, PipelinesOperationsExtensions, DatasetsOperationsExtensions or LinkedServicesOperationsExtensions to respectively delete elements of an ADF (using the Delete function), if there is a failure of any kind then the function throws:
Microsoft.Azure.Management.DataFactory.Models.ErrorResponseException: Operation returned an invalid status code 'BadRequest'
It would be very helpful if the exceptions thrown by these functions were more descriptive of the underlying problem (for example, "attempt to delete LinkedService <Lname> which Dataset <Dname> depends on"), and if the following pages would describe the possible failure scenarios:
TriggersOperationsExtensions
PipelinesOperationsExtensions
DatasetsOperationsExtensions
LinkedServicesOperationsExtensions
I believe the recommended package for Service bus is https://www.nuget.org/packages/Microsoft.Azure.ServiceBus/, no? the link at the Client Library section points to https://www.nuget.org/packages/WindowsAzure.ServiceBus.
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
Please provide proper documentation for the Application Insights API.
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
The link in Remarks is missing a slash after the .com:
http://azure.microsoft.comdocumentation/articles/documentdb-performance-levels/
Several methods in this document are only available in 4.2.x-Preview, but the documentation does not show this at all. The documentation needs to specify the version if it is not the latest stable.
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
Issues:
Previously in msdn there was list of methods at the top(not individual overloads) and user was able to see individual overloads on separate page when method was selected. The current list of overloads for all methods is huge and hard to read/search
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
How does one interpret the value here? Is zero success? One? Its an Int64 so there is a huge range of values, but what do any of them mean?
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
Func<T1, T2, T3, TResult> is documented at https://docs.microsoft.com/en-us/dotnet/api/system.func-4?view=netstandard-1.6, but the link goes back to MSDN.
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
Links to the Microsoft.ServiceFabric.Data.Collections namespace documentation are broken
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
Please provide the following methods in IMessageReceiver:
bool TryReceive(out Message msg, TimeSpan timeout)
Task<bool> TryReceiveAsync(out Message msg, TimeSpan timeout)
So that we can use these like:
if (TryReceive(out Message msg, TimeSpan.FromSeconds(30))
{
...
}
else
{
...
}
Change powershell example to use SecureString
The documentation page for RequestOptions.SessionToken has broken formatting - several of the paragraphs are rendered in code blocks, and the examples that show up in the github page seem to be missing (or I can't figure out how to get them to show up)
Can you add documentation on the exceptions thrown by extension methods. This is present for the normal methods of the KeyVaultClient but not the extensions.
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
Followed the steps under the "management libs for .Net authentication" but my app is met with:
Microsoft.Rest.Azure.CloudException: 'The client '<clientid>' with object id '<objid>' does not have authorization to perform action 'Microsoft.Compute/virtualMachines/read' over scope '/subscriptions/<subid>/resourceGroups/<rgname>/providers/Microsoft.Compute/virtualMachines/<vmname>'.'
So we must be missing a step in the docs here to make this effective.
⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.