@azure-typespec/http-client-csharp-mgmt 1.0.0-alpha.20250409.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/emitter/emitter.d.ts +4 -0
- package/dist/emitter/emitter.d.ts.map +1 -0
- package/dist/emitter/emitter.js +77 -0
- package/dist/emitter/emitter.js.map +1 -0
- package/dist/emitter/index.d.ts +2 -0
- package/dist/emitter/index.d.ts.map +1 -0
- package/dist/emitter/index.js +4 -0
- package/dist/emitter/index.js.map +1 -0
- package/dist/emitter/resource-type.d.ts +2 -0
- package/dist/emitter/resource-type.d.ts.map +1 -0
- package/dist/emitter/resource-type.js +31 -0
- package/dist/emitter/resource-type.js.map +1 -0
- package/dist/emitter/sdk-context-options.d.ts +3 -0
- package/dist/emitter/sdk-context-options.d.ts.map +1 -0
- package/dist/emitter/sdk-context-options.js +23 -0
- package/dist/emitter/sdk-context-options.js.map +1 -0
- package/dist/generator/Azure.Core.dll +0 -0
- package/dist/generator/Azure.Generator.Mgmt.deps.json +998 -0
- package/dist/generator/Azure.Generator.Mgmt.dll +0 -0
- package/dist/generator/Azure.Generator.Mgmt.pdb +0 -0
- package/dist/generator/Azure.Generator.Mgmt.xml +818 -0
- package/dist/generator/Azure.Generator.dll +0 -0
- package/dist/generator/Azure.Generator.pdb +0 -0
- package/dist/generator/Azure.Generator.xml +163 -0
- package/dist/generator/Azure.ResourceManager.dll +0 -0
- package/dist/generator/CommandLine.dll +0 -0
- package/dist/generator/Humanizer.dll +0 -0
- package/dist/generator/Microsoft.Bcl.AsyncInterfaces.dll +0 -0
- package/dist/generator/Microsoft.Build.Framework.dll +0 -0
- package/dist/generator/Microsoft.Build.dll +0 -0
- package/dist/generator/Microsoft.CodeAnalysis.CSharp.Workspaces.dll +0 -0
- package/dist/generator/Microsoft.CodeAnalysis.CSharp.dll +0 -0
- package/dist/generator/Microsoft.CodeAnalysis.Workspaces.dll +0 -0
- package/dist/generator/Microsoft.CodeAnalysis.dll +0 -0
- package/dist/generator/Microsoft.Extensions.Logging.Abstractions.dll +0 -0
- package/dist/generator/Microsoft.NET.StringTools.dll +0 -0
- package/dist/generator/Microsoft.TypeSpec.Generator.ClientModel.dll +0 -0
- package/dist/generator/Microsoft.TypeSpec.Generator.Input.dll +0 -0
- package/dist/generator/Microsoft.TypeSpec.Generator.dll +0 -0
- package/dist/generator/Microsoft.TypeSpec.Generator.runtimeconfig.json +12 -0
- package/dist/generator/NuGet.Common.dll +0 -0
- package/dist/generator/NuGet.Configuration.dll +0 -0
- package/dist/generator/NuGet.Frameworks.dll +0 -0
- package/dist/generator/Shared/Core/AppContextSwitchHelper.cs +42 -0
- package/dist/generator/Shared/Core/AsyncLockWithValue.cs +260 -0
- package/dist/generator/Shared/Core/AzureKeyCredentialPolicy.cs +50 -0
- package/dist/generator/Shared/Core/ClientDiagnostics.cs +73 -0
- package/dist/generator/Shared/Core/DiagnosticScope.cs +473 -0
- package/dist/generator/Shared/Core/DiagnosticScopeFactory.cs +104 -0
- package/dist/generator/Shared/Core/FixedDelayWithNoJitterStrategy.cs +26 -0
- package/dist/generator/Shared/Core/HttpMessageSanitizer.cs +198 -0
- package/dist/generator/Shared/Core/IOperationSource.cs +14 -0
- package/dist/generator/Shared/Core/NextLinkOperationImplementation.cs +690 -0
- package/dist/generator/Shared/Core/OperationFinalStateVia.cs +16 -0
- package/dist/generator/Shared/Core/OperationInternal.cs +256 -0
- package/dist/generator/Shared/Core/OperationInternalBase.cs +234 -0
- package/dist/generator/Shared/Core/OperationInternalOfT.cs +422 -0
- package/dist/generator/Shared/Core/OperationPoller.cs +114 -0
- package/dist/generator/Shared/Core/RawRequestUriBuilder.cs +192 -0
- package/dist/generator/Shared/Core/SequentialDelayStrategy.cs +38 -0
- package/dist/generator/Shared/Core/TaskExtensions.cs +313 -0
- package/dist/generator/Shared/Core/VoidValue.cs +10 -0
- package/dist/generator/System.ClientModel.dll +0 -0
- package/dist/generator/System.ComponentModel.Composition.dll +0 -0
- package/dist/generator/System.Composition.AttributedModel.dll +0 -0
- package/dist/generator/System.Composition.Convention.dll +0 -0
- package/dist/generator/System.Composition.Hosting.dll +0 -0
- package/dist/generator/System.Composition.Runtime.dll +0 -0
- package/dist/generator/System.Composition.TypedParts.dll +0 -0
- package/dist/generator/System.Configuration.ConfigurationManager.dll +0 -0
- package/dist/generator/System.Diagnostics.EventLog.dll +0 -0
- package/dist/generator/System.IO.Pipelines.dll +0 -0
- package/dist/generator/System.Memory.Data.dll +0 -0
- package/dist/generator/System.Reflection.MetadataLoadContext.dll +0 -0
- package/dist/generator/System.Security.Cryptography.ProtectedData.dll +0 -0
- package/dist/generator/cs/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/cs/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/cs/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/cs/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/de/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/de/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/de/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/de/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/es/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/es/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/es/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/es/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/fr/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/fr/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/fr/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/fr/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/it/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/it/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/it/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/it/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/ja/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/ja/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/ja/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/ja/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/ko/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/ko/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/ko/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/ko/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/net8.0/Azure.Core.dll +0 -0
- package/dist/generator/net8.0/Azure.Generator.Mgmt.deps.json +998 -0
- package/dist/generator/net8.0/Azure.Generator.Mgmt.dll +0 -0
- package/dist/generator/net8.0/Azure.Generator.Mgmt.pdb +0 -0
- package/dist/generator/net8.0/Azure.Generator.Mgmt.xml +818 -0
- package/dist/generator/net8.0/Azure.Generator.dll +0 -0
- package/dist/generator/net8.0/Azure.Generator.pdb +0 -0
- package/dist/generator/net8.0/Azure.Generator.xml +163 -0
- package/dist/generator/net8.0/Azure.ResourceManager.dll +0 -0
- package/dist/generator/net8.0/CommandLine.dll +0 -0
- package/dist/generator/net8.0/Humanizer.dll +0 -0
- package/dist/generator/net8.0/Microsoft.Bcl.AsyncInterfaces.dll +0 -0
- package/dist/generator/net8.0/Microsoft.Build.Framework.dll +0 -0
- package/dist/generator/net8.0/Microsoft.Build.dll +0 -0
- package/dist/generator/net8.0/Microsoft.CodeAnalysis.CSharp.Workspaces.dll +0 -0
- package/dist/generator/net8.0/Microsoft.CodeAnalysis.CSharp.dll +0 -0
- package/dist/generator/net8.0/Microsoft.CodeAnalysis.Workspaces.dll +0 -0
- package/dist/generator/net8.0/Microsoft.CodeAnalysis.dll +0 -0
- package/dist/generator/net8.0/Microsoft.Extensions.Logging.Abstractions.dll +0 -0
- package/dist/generator/net8.0/Microsoft.NET.StringTools.dll +0 -0
- package/dist/generator/net8.0/Microsoft.TypeSpec.Generator.ClientModel.dll +0 -0
- package/dist/generator/net8.0/Microsoft.TypeSpec.Generator.Input.dll +0 -0
- package/dist/generator/net8.0/Microsoft.TypeSpec.Generator.dll +0 -0
- package/dist/generator/net8.0/NuGet.Common.dll +0 -0
- package/dist/generator/net8.0/NuGet.Configuration.dll +0 -0
- package/dist/generator/net8.0/NuGet.Frameworks.dll +0 -0
- package/dist/generator/net8.0/Shared/Core/AppContextSwitchHelper.cs +42 -0
- package/dist/generator/net8.0/Shared/Core/AsyncLockWithValue.cs +260 -0
- package/dist/generator/net8.0/Shared/Core/AzureKeyCredentialPolicy.cs +50 -0
- package/dist/generator/net8.0/Shared/Core/ClientDiagnostics.cs +73 -0
- package/dist/generator/net8.0/Shared/Core/DiagnosticScope.cs +473 -0
- package/dist/generator/net8.0/Shared/Core/DiagnosticScopeFactory.cs +104 -0
- package/dist/generator/net8.0/Shared/Core/FixedDelayWithNoJitterStrategy.cs +26 -0
- package/dist/generator/net8.0/Shared/Core/HttpMessageSanitizer.cs +198 -0
- package/dist/generator/net8.0/Shared/Core/IOperationSource.cs +14 -0
- package/dist/generator/net8.0/Shared/Core/NextLinkOperationImplementation.cs +690 -0
- package/dist/generator/net8.0/Shared/Core/OperationFinalStateVia.cs +16 -0
- package/dist/generator/net8.0/Shared/Core/OperationInternal.cs +256 -0
- package/dist/generator/net8.0/Shared/Core/OperationInternalBase.cs +234 -0
- package/dist/generator/net8.0/Shared/Core/OperationInternalOfT.cs +422 -0
- package/dist/generator/net8.0/Shared/Core/OperationPoller.cs +114 -0
- package/dist/generator/net8.0/Shared/Core/RawRequestUriBuilder.cs +192 -0
- package/dist/generator/net8.0/Shared/Core/SequentialDelayStrategy.cs +38 -0
- package/dist/generator/net8.0/Shared/Core/TaskExtensions.cs +313 -0
- package/dist/generator/net8.0/Shared/Core/VoidValue.cs +10 -0
- package/dist/generator/net8.0/System.ClientModel.dll +0 -0
- package/dist/generator/net8.0/System.ComponentModel.Composition.dll +0 -0
- package/dist/generator/net8.0/System.Composition.AttributedModel.dll +0 -0
- package/dist/generator/net8.0/System.Composition.Convention.dll +0 -0
- package/dist/generator/net8.0/System.Composition.Hosting.dll +0 -0
- package/dist/generator/net8.0/System.Composition.Runtime.dll +0 -0
- package/dist/generator/net8.0/System.Composition.TypedParts.dll +0 -0
- package/dist/generator/net8.0/System.Configuration.ConfigurationManager.dll +0 -0
- package/dist/generator/net8.0/System.Diagnostics.EventLog.dll +0 -0
- package/dist/generator/net8.0/System.IO.Pipelines.dll +0 -0
- package/dist/generator/net8.0/System.Memory.Data.dll +0 -0
- package/dist/generator/net8.0/System.Reflection.MetadataLoadContext.dll +0 -0
- package/dist/generator/net8.0/System.Security.Cryptography.ProtectedData.dll +0 -0
- package/dist/generator/net8.0/cs/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/cs/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/net8.0/cs/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/cs/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/net8.0/de/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/de/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/net8.0/de/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/de/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/net8.0/es/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/es/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/net8.0/es/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/es/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/net8.0/fr/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/fr/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/net8.0/fr/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/fr/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/net8.0/it/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/it/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/net8.0/it/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/it/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/net8.0/ja/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/ja/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/net8.0/ja/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/ja/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/net8.0/ko/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/ko/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/net8.0/ko/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/ko/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/net8.0/pl/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/pl/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/net8.0/pl/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/pl/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/net8.0/pt-BR/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/pt-BR/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/net8.0/pt-BR/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/pt-BR/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/net8.0/ru/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/ru/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/net8.0/ru/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/ru/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/net8.0/runtimes/win/lib/net8.0/System.Diagnostics.EventLog.Messages.dll +0 -0
- package/dist/generator/net8.0/runtimes/win/lib/net8.0/System.Diagnostics.EventLog.dll +0 -0
- package/dist/generator/net8.0/tr/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/tr/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/net8.0/tr/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/tr/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/net8.0/zh-Hans/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/zh-Hans/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/net8.0/zh-Hans/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/zh-Hans/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/net8.0/zh-Hant/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/zh-Hant/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/net8.0/zh-Hant/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/net8.0/zh-Hant/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/pl/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/pl/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/pl/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/pl/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/pt-BR/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/pt-BR/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/pt-BR/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/pt-BR/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/ru/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/ru/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/ru/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/ru/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/runtimes/win/lib/net8.0/System.Diagnostics.EventLog.Messages.dll +0 -0
- package/dist/generator/runtimes/win/lib/net8.0/System.Diagnostics.EventLog.dll +0 -0
- package/dist/generator/tr/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/tr/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/tr/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/tr/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/zh-Hans/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/zh-Hans/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/zh-Hans/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/zh-Hans/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/dist/generator/zh-Hant/Microsoft.CodeAnalysis.CSharp.Workspaces.resources.dll +0 -0
- package/dist/generator/zh-Hant/Microsoft.CodeAnalysis.CSharp.resources.dll +0 -0
- package/dist/generator/zh-Hant/Microsoft.CodeAnalysis.Workspaces.resources.dll +0 -0
- package/dist/generator/zh-Hant/Microsoft.CodeAnalysis.resources.dll +0 -0
- package/package.json +67 -0
|
@@ -0,0 +1,818 @@
|
|
|
1
|
+
<?xml version="1.0"?>
|
|
2
|
+
<doc>
|
|
3
|
+
<assembly>
|
|
4
|
+
<name>Azure.Generator.Mgmt</name>
|
|
5
|
+
</assembly>
|
|
6
|
+
<members>
|
|
7
|
+
<member name="T:Azure.Generator.Management.ManagementClientGenerator">
|
|
8
|
+
<summary>
|
|
9
|
+
The Azure management client generator to generate the Azure management client SDK.
|
|
10
|
+
</summary>
|
|
11
|
+
</member>
|
|
12
|
+
<member name="M:Azure.Generator.Management.ManagementClientGenerator.#ctor(Microsoft.TypeSpec.Generator.GeneratorContext)">
|
|
13
|
+
<summary>
|
|
14
|
+
The Azure management client generator to generate the Azure management client SDK.
|
|
15
|
+
</summary>
|
|
16
|
+
<param name="context"></param>
|
|
17
|
+
</member>
|
|
18
|
+
<member name="P:Azure.Generator.Management.ManagementClientGenerator.InputLibrary">
|
|
19
|
+
<inheritdoc/>
|
|
20
|
+
</member>
|
|
21
|
+
<member name="P:Azure.Generator.Management.ManagementClientGenerator.OutputLibrary">
|
|
22
|
+
<inheritdoc/>
|
|
23
|
+
</member>
|
|
24
|
+
<member name="P:Azure.Generator.Management.ManagementClientGenerator.TypeFactory">
|
|
25
|
+
<inheritdoc/>
|
|
26
|
+
</member>
|
|
27
|
+
<member name="M:Azure.Generator.Management.ManagementClientGenerator.Configure">
|
|
28
|
+
<summary>
|
|
29
|
+
Customize the generation output for Azure client SDK.
|
|
30
|
+
</summary>
|
|
31
|
+
</member>
|
|
32
|
+
<member name="T:Azure.Generator.Management.ManagementInputLibrary">
|
|
33
|
+
<inheritdoc/>
|
|
34
|
+
</member>
|
|
35
|
+
<member name="M:Azure.Generator.Management.ManagementInputLibrary.#ctor(System.String)">
|
|
36
|
+
<inheritdoc/>
|
|
37
|
+
</member>
|
|
38
|
+
<member name="T:Azure.Generator.Management.ManagementOutputLibrary">
|
|
39
|
+
<inheritdoc/>
|
|
40
|
+
</member>
|
|
41
|
+
<member name="M:Azure.Generator.Management.ManagementOutputLibrary.BuildTypeProviders">
|
|
42
|
+
<inheritdoc/>
|
|
43
|
+
</member>
|
|
44
|
+
<member name="T:Azure.Generator.Management.ManagementTypeFactory">
|
|
45
|
+
<inheritdoc/>
|
|
46
|
+
</member>
|
|
47
|
+
<member name="P:Azure.Generator.Management.ManagementTypeFactory.ClientPipelineApi">
|
|
48
|
+
<inheritdoc/>
|
|
49
|
+
</member>
|
|
50
|
+
<member name="P:Azure.Generator.Management.ManagementTypeFactory.AzureDependencyPackages">
|
|
51
|
+
<inheritdoc/>
|
|
52
|
+
</member>
|
|
53
|
+
<member name="M:Azure.Generator.Management.ManagementTypeFactory.CreateClientCore(Microsoft.TypeSpec.Generator.Input.InputClient)">
|
|
54
|
+
<inheritdoc/>
|
|
55
|
+
</member>
|
|
56
|
+
<member name="M:Azure.Generator.Management.Models.RequestPath.IsAncestorOf(Azure.Generator.Management.Models.RequestPath)">
|
|
57
|
+
<summary>
|
|
58
|
+
Check if this <see cref="T:Azure.Generator.Management.Models.RequestPath"/> is a prefix path of the other request path.
|
|
59
|
+
Note that this.IsAncestorOf(this) will return false which indicates that this method is testing the "proper ancestor" like a proper subset.
|
|
60
|
+
</summary>
|
|
61
|
+
<param name="other"></param>
|
|
62
|
+
<returns></returns>
|
|
63
|
+
</member>
|
|
64
|
+
<member name="M:Azure.Generator.Management.Models.RequestPath.TrimAncestorFrom(Azure.Generator.Management.Models.RequestPath)">
|
|
65
|
+
<summary>
|
|
66
|
+
Trim this from the other and return the <see cref="T:Azure.Generator.Management.Models.RequestPath"/>that remain.
|
|
67
|
+
The result is "other - this" by removing this as a prefix of other.
|
|
68
|
+
If this == other, return empty request path
|
|
69
|
+
</summary>
|
|
70
|
+
<param name="other"></param>
|
|
71
|
+
<returns></returns>
|
|
72
|
+
<exception cref="T:System.InvalidOperationException">if this.IsAncestorOf(other) is false</exception>
|
|
73
|
+
</member>
|
|
74
|
+
<member name="M:Azure.Generator.Management.Providers.Abstraction.MgmtHttpPipelineProvider.FromExpression(Microsoft.TypeSpec.Generator.Expressions.ValueExpression)">
|
|
75
|
+
<inheritdoc/>
|
|
76
|
+
</member>
|
|
77
|
+
<member name="T:Azure.Generator.Management.Providers.ResourceClientProvider">
|
|
78
|
+
<summary>
|
|
79
|
+
Provides a resource client type.
|
|
80
|
+
</summary>
|
|
81
|
+
</member>
|
|
82
|
+
<member name="M:Azure.Generator.Management.RestClientVisitor.VisitType(Microsoft.TypeSpec.Generator.Providers.TypeProvider)">
|
|
83
|
+
<inheritdoc/>
|
|
84
|
+
</member>
|
|
85
|
+
<member name="M:Azure.Generator.Management.Utilities.ConstructorProviderHelper.BuildMockingConstructor(Microsoft.TypeSpec.Generator.Providers.TypeProvider)">
|
|
86
|
+
<summary>
|
|
87
|
+
Builds a constructor for the enclosing type for mocking purposes.
|
|
88
|
+
</summary>
|
|
89
|
+
<param name="enclosingType">The type provider to build the constructor for.</param>
|
|
90
|
+
</member>
|
|
91
|
+
<member name="M:Azure.Core.AzureKeyCredentialPolicy.#ctor(Azure.AzureKeyCredential,System.String,System.String)">
|
|
92
|
+
<summary>
|
|
93
|
+
Initializes a new instance of the <see cref="T:Azure.Core.AzureKeyCredentialPolicy"/> class.
|
|
94
|
+
</summary>
|
|
95
|
+
<param name="credential">The <see cref="T:Azure.AzureKeyCredential"/> used to authenticate requests.</param>
|
|
96
|
+
<param name="name">The name of the key header used for the credential.</param>
|
|
97
|
+
<param name="prefix">The prefix to apply before the credential key. For example, a prefix of "SharedAccessKey" would result in
|
|
98
|
+
a value of "SharedAccessKey {credential.Key}" being stamped on the request header with header key of <paramref name="name"/>.</param>
|
|
99
|
+
</member>
|
|
100
|
+
<member name="M:Azure.Core.AzureKeyCredentialPolicy.OnSendingRequest(Azure.Core.HttpMessage)">
|
|
101
|
+
<inheritdoc/>
|
|
102
|
+
</member>
|
|
103
|
+
<member name="T:Azure.Core.OperationInternal">
|
|
104
|
+
<summary>
|
|
105
|
+
A helper class used to build long-running operation instances. In order to use this helper:
|
|
106
|
+
<list type="number">
|
|
107
|
+
<item>Make sure your LRO implements the <see cref="T:Azure.Core.IOperation"/> interface.</item>
|
|
108
|
+
<item>Add a private <see cref="T:Azure.Core.OperationInternal"/> field to your LRO, and instantiate it during construction.</item>
|
|
109
|
+
<item>Delegate method calls to the <see cref="T:Azure.Core.OperationInternal"/> implementations.</item>
|
|
110
|
+
</list>
|
|
111
|
+
Supported members:
|
|
112
|
+
<list type="bullet">
|
|
113
|
+
<item>
|
|
114
|
+
<description><see cref="P:Azure.Core.OperationInternalBase.HasCompleted"/></description>
|
|
115
|
+
</item>
|
|
116
|
+
<item>
|
|
117
|
+
<description><see cref="P:Azure.Core.OperationInternalBase.RawResponse"/>, used for <see cref="M:Azure.Operation.GetRawResponse"/></description>
|
|
118
|
+
</item>
|
|
119
|
+
<item>
|
|
120
|
+
<description><see cref="M:Azure.Core.OperationInternalBase.UpdateStatus(System.Threading.CancellationToken)"/></description>
|
|
121
|
+
</item>
|
|
122
|
+
<item>
|
|
123
|
+
<description><see cref="M:Azure.Core.OperationInternalBase.UpdateStatusAsync(System.Threading.CancellationToken)"/></description>
|
|
124
|
+
</item>
|
|
125
|
+
<item>
|
|
126
|
+
<description><see cref="M:Azure.Core.OperationInternalBase.WaitForCompletionResponseAsync(System.Threading.CancellationToken)"/></description>
|
|
127
|
+
</item>
|
|
128
|
+
<item>
|
|
129
|
+
<description><see cref="M:Azure.Core.OperationInternalBase.WaitForCompletionResponseAsync(System.TimeSpan,System.Threading.CancellationToken)"/></description>
|
|
130
|
+
</item>
|
|
131
|
+
</list>
|
|
132
|
+
</summary>
|
|
133
|
+
</member>
|
|
134
|
+
<member name="M:Azure.Core.OperationInternal.Succeeded(Azure.Response)">
|
|
135
|
+
<summary>
|
|
136
|
+
Initializes a new instance of the <see cref="T:Azure.Core.OperationInternal"/> class in a final successful state.
|
|
137
|
+
</summary>
|
|
138
|
+
<param name="rawResponse">The final value of <see cref="P:Azure.Core.OperationInternalBase.RawResponse"/>.</param>
|
|
139
|
+
</member>
|
|
140
|
+
<member name="M:Azure.Core.OperationInternal.Failed(Azure.Response,Azure.RequestFailedException)">
|
|
141
|
+
<summary>
|
|
142
|
+
Initializes a new instance of the <see cref="T:Azure.Core.OperationInternal"/> class in a final failed state.
|
|
143
|
+
</summary>
|
|
144
|
+
<param name="rawResponse">The final value of <see cref="P:Azure.Core.OperationInternalBase.RawResponse"/>.</param>
|
|
145
|
+
<param name="operationFailedException">The exception that will be thrown by <c>UpdateStatusAsync</c>.</param>
|
|
146
|
+
</member>
|
|
147
|
+
<member name="M:Azure.Core.OperationInternal.#ctor(Azure.Core.IOperation,Azure.Core.Pipeline.ClientDiagnostics,Azure.Response,System.String,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}},Azure.Core.DelayStrategy)">
|
|
148
|
+
<summary>
|
|
149
|
+
Initializes a new instance of the <see cref="T:Azure.Core.OperationInternal"/> class.
|
|
150
|
+
</summary>
|
|
151
|
+
<param name="operation">The long-running operation making use of this class. Passing "<c>this</c>" is expected.</param>
|
|
152
|
+
<param name="clientDiagnostics">Used for diagnostic scope and exception creation. This is expected to be the instance created during the construction of your main client.</param>
|
|
153
|
+
<param name="rawResponse">
|
|
154
|
+
The initial value of <see cref="P:Azure.Core.OperationInternalBase.RawResponse"/>. Usually, long-running operation objects can be instantiated in two ways:
|
|
155
|
+
<list type="bullet">
|
|
156
|
+
<item>
|
|
157
|
+
When calling a client's "<c>Start<OperationName></c>" method, a service call is made to start the operation, and an <see cref="T:Azure.Operation"/> instance is returned.
|
|
158
|
+
In this case, the response received from this service call can be passed here.
|
|
159
|
+
</item>
|
|
160
|
+
<item>
|
|
161
|
+
When a user instantiates an <see cref="T:Azure.Operation"/> directly using a public constructor, there's no previous service call. In this case, passing <c>null</c> is expected.
|
|
162
|
+
</item>
|
|
163
|
+
</list>
|
|
164
|
+
</param>
|
|
165
|
+
<param name="operationTypeName">
|
|
166
|
+
The type name of the long-running operation making use of this class. Used when creating diagnostic scopes. If left <c>null</c>, the type name will be inferred based on the
|
|
167
|
+
parameter <paramref name="operation"/>.
|
|
168
|
+
</param>
|
|
169
|
+
<param name="scopeAttributes">The attributes to use during diagnostic scope creation.</param>
|
|
170
|
+
<param name="fallbackStrategy"> The delay strategy to use. Default is <see cref="T:Azure.Core.FixedDelayWithNoJitterStrategy"/>.</param>
|
|
171
|
+
</member>
|
|
172
|
+
<member name="T:Azure.Core.IOperation">
|
|
173
|
+
<summary>
|
|
174
|
+
An interface used by <see cref="T:Azure.Core.OperationInternal"/> for making service calls and updating state. It's expected that
|
|
175
|
+
your long-running operation classes implement this interface.
|
|
176
|
+
</summary>
|
|
177
|
+
</member>
|
|
178
|
+
<member name="M:Azure.Core.IOperation.UpdateStateAsync(System.Boolean,System.Threading.CancellationToken)">
|
|
179
|
+
<summary>
|
|
180
|
+
Calls the service and updates the state of the long-running operation. Properties directly handled by the
|
|
181
|
+
<see cref="T:Azure.Core.OperationInternal"/> class, such as <see cref="P:Azure.Core.OperationInternalBase.RawResponse"/>
|
|
182
|
+
don't need to be updated. Operation-specific properties, such as "<c>CreateOn</c>" or "<c>LastModified</c>",
|
|
183
|
+
must be manually updated by the operation implementing this method.
|
|
184
|
+
<example>Usage example:
|
|
185
|
+
<code>
|
|
186
|
+
async ValueTask<OperationState> IOperation.UpdateStateAsync(bool async, CancellationToken cancellationToken)<br/>
|
|
187
|
+
{<br/>
|
|
188
|
+
Response<R> response = async ? <async service call> : <sync service call>;<br/>
|
|
189
|
+
if (<operation succeeded>) return OperationState.Success(response.GetRawResponse(), <parse response>);<br/>
|
|
190
|
+
if (<operation failed>) return OperationState.Failure(response.GetRawResponse());<br/>
|
|
191
|
+
return OperationState.Pending(response.GetRawResponse());<br/>
|
|
192
|
+
}
|
|
193
|
+
</code>
|
|
194
|
+
</example>
|
|
195
|
+
</summary>
|
|
196
|
+
<param name="async"><c>true</c> if the call should be executed asynchronously. Otherwise, <c>false</c>.</param>
|
|
197
|
+
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> controlling the request lifetime.</param>
|
|
198
|
+
<returns>
|
|
199
|
+
A structure indicating the current operation state. The <see cref="T:Azure.Core.OperationState"/> structure must be instantiated by one of
|
|
200
|
+
its static methods:
|
|
201
|
+
<list type="bullet">
|
|
202
|
+
<item>Use <see cref="M:Azure.Core.OperationState.Success(Azure.Response)"/> when the operation has completed successfully.</item>
|
|
203
|
+
<item>Use <see cref="M:Azure.Core.OperationState.Failure(Azure.Response,Azure.RequestFailedException)"/> when the operation has completed with failures.</item>
|
|
204
|
+
<item>Use <see cref="M:Azure.Core.OperationState.Pending(Azure.Response)"/> when the operation has not completed yet.</item>
|
|
205
|
+
</list>
|
|
206
|
+
</returns>
|
|
207
|
+
</member>
|
|
208
|
+
<member name="T:Azure.Core.OperationState">
|
|
209
|
+
<summary>
|
|
210
|
+
A helper structure passed to <see cref="T:Azure.Core.OperationInternal"/> to indicate the current operation state. This structure must be
|
|
211
|
+
instantiated by one of its static methods, depending on the operation state:
|
|
212
|
+
<list type="bullet">
|
|
213
|
+
<item>Use <see cref="M:Azure.Core.OperationState.Success(Azure.Response)"/> when the operation has completed successfully.</item>
|
|
214
|
+
<item>Use <see cref="M:Azure.Core.OperationState.Failure(Azure.Response,Azure.RequestFailedException)"/> when the operation has completed with failures.</item>
|
|
215
|
+
<item>Use <see cref="M:Azure.Core.OperationState.Pending(Azure.Response)"/> when the operation has not completed yet.</item>
|
|
216
|
+
</list>
|
|
217
|
+
</summary>
|
|
218
|
+
</member>
|
|
219
|
+
<member name="M:Azure.Core.OperationState.Success(Azure.Response)">
|
|
220
|
+
<summary>
|
|
221
|
+
Instantiates an <see cref="T:Azure.Core.OperationState"/> indicating the operation has completed successfully.
|
|
222
|
+
</summary>
|
|
223
|
+
<param name="rawResponse">The HTTP response obtained during the status update.</param>
|
|
224
|
+
<returns>A new <see cref="T:Azure.Core.OperationState"/> instance.</returns>
|
|
225
|
+
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="rawResponse"/> is <c>null</c>.</exception>
|
|
226
|
+
</member>
|
|
227
|
+
<member name="M:Azure.Core.OperationState.Failure(Azure.Response,Azure.RequestFailedException)">
|
|
228
|
+
<summary>
|
|
229
|
+
Instantiates an <see cref="T:Azure.Core.OperationState"/> indicating the operation has completed with failures.
|
|
230
|
+
</summary>
|
|
231
|
+
<param name="rawResponse">The HTTP response obtained during the status update.</param>
|
|
232
|
+
<param name="operationFailedException">
|
|
233
|
+
The exception to throw from <c>UpdateStatus</c> because of the operation failure. If left <c>null</c>,
|
|
234
|
+
a default exception is created based on the <paramref name="rawResponse"/> parameter.
|
|
235
|
+
</param>
|
|
236
|
+
<returns>A new <see cref="T:Azure.Core.OperationState"/> instance.</returns>
|
|
237
|
+
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="rawResponse"/> is <c>null</c>.</exception>
|
|
238
|
+
</member>
|
|
239
|
+
<member name="M:Azure.Core.OperationState.Pending(Azure.Response)">
|
|
240
|
+
<summary>
|
|
241
|
+
Instantiates an <see cref="T:Azure.Core.OperationState"/> indicating the operation has not completed yet.
|
|
242
|
+
</summary>
|
|
243
|
+
<param name="rawResponse">The HTTP response obtained during the status update.</param>
|
|
244
|
+
<returns>A new <see cref="T:Azure.Core.OperationState"/> instance.</returns>
|
|
245
|
+
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="rawResponse"/> is <c>null</c>.</exception>
|
|
246
|
+
</member>
|
|
247
|
+
<member name="M:Azure.Core.NextLinkOperationImplementation.GetFinalUri(System.String)">
|
|
248
|
+
<summary>
|
|
249
|
+
This function is used to get the final request uri after the lro has completed.
|
|
250
|
+
</summary>
|
|
251
|
+
</member>
|
|
252
|
+
<member name="T:Azure.Core.NextLinkOperationImplementation.EmptyResponse">
|
|
253
|
+
<summary>
|
|
254
|
+
This is only used for final get of the delete LRO, we just want to return an empty response with 204 to the user for this case.
|
|
255
|
+
</summary>
|
|
256
|
+
</member>
|
|
257
|
+
<member name="M:Azure.Core.NextLinkOperationImplementation.EmptyResponse.ContainsHeader(System.String)">
|
|
258
|
+
<inheritdoc />
|
|
259
|
+
</member>
|
|
260
|
+
<member name="M:Azure.Core.NextLinkOperationImplementation.EmptyResponse.EnumerateHeaders">
|
|
261
|
+
<inheritdoc />
|
|
262
|
+
</member>
|
|
263
|
+
<member name="M:Azure.Core.NextLinkOperationImplementation.EmptyResponse.TryGetHeader(System.String,System.String@)">
|
|
264
|
+
<inheritdoc />
|
|
265
|
+
</member>
|
|
266
|
+
<member name="M:Azure.Core.NextLinkOperationImplementation.EmptyResponse.TryGetHeaderValues(System.String,System.Collections.Generic.IEnumerable{System.String}@)">
|
|
267
|
+
<inheritdoc />
|
|
268
|
+
</member>
|
|
269
|
+
<member name="M:Azure.Core.Pipeline.ClientDiagnostics.#ctor(Azure.Core.ClientOptions,System.Nullable{System.Boolean})">
|
|
270
|
+
<summary>
|
|
271
|
+
Initializes a new instance of the <see cref="T:Azure.Core.Pipeline.ClientDiagnostics"/> class.
|
|
272
|
+
</summary>
|
|
273
|
+
<param name="options">The customer provided client options object.</param>
|
|
274
|
+
<param name="suppressNestedClientActivities">Flag controlling if <see cref="T:System.Diagnostics.Activity"/>
|
|
275
|
+
created by this <see cref="T:Azure.Core.Pipeline.ClientDiagnostics"/> for client method calls should be suppressed when called
|
|
276
|
+
by other Azure SDK client methods. It's recommended to set it to true for new clients; use default (null)
|
|
277
|
+
for backward compatibility reasons, or set it to false to explicitly disable suppression for specific cases.
|
|
278
|
+
The default value could change in the future, the flag should be only set to false if suppression for the client
|
|
279
|
+
should never be enabled.</param>
|
|
280
|
+
</member>
|
|
281
|
+
<member name="M:Azure.Core.Pipeline.ClientDiagnostics.#ctor(System.String,System.String,Azure.Core.DiagnosticsOptions,System.Nullable{System.Boolean})">
|
|
282
|
+
<summary>
|
|
283
|
+
Initializes a new instance of the <see cref="T:Azure.Core.Pipeline.ClientDiagnostics"/> class.
|
|
284
|
+
</summary>
|
|
285
|
+
<param name="optionsNamespace">Namespace of the client class, such as Azure.Storage or Azure.AppConfiguration.</param>
|
|
286
|
+
<param name="providerNamespace">Azure Resource Provider namespace of the Azure service SDK is primarily used for.</param>
|
|
287
|
+
<param name="diagnosticsOptions">The customer provided client diagnostics options.</param>
|
|
288
|
+
<param name="suppressNestedClientActivities">Flag controlling if <see cref="T:System.Diagnostics.Activity"/>
|
|
289
|
+
created by this <see cref="T:Azure.Core.Pipeline.ClientDiagnostics"/> for client method calls should be suppressed when called
|
|
290
|
+
by other Azure SDK client methods. It's recommended to set it to true for new clients, use default (null) for old clients
|
|
291
|
+
for backward compatibility reasons, or set it to false to explicitly disable suppression for specific cases.
|
|
292
|
+
The default value could change in the future, the flag should be only set to false if suppression for the client
|
|
293
|
+
should never be enabled.</param>
|
|
294
|
+
</member>
|
|
295
|
+
<member name="M:Azure.Core.Pipeline.DiagnosticScopeFactory.#ctor(System.String,System.String,System.Boolean,System.Boolean,System.Boolean)">
|
|
296
|
+
<summary>
|
|
297
|
+
Creates diagnostic scope factory.
|
|
298
|
+
</summary>
|
|
299
|
+
<param name="clientNamespace">The namespace which is used as a prefix for all ActivitySources created by the factory and the name of DiagnosticSource (when used).</param>
|
|
300
|
+
<param name="resourceProviderNamespace">Azure resource provider namespace.</param>
|
|
301
|
+
<param name="isActivityEnabled">Flag indicating if distributed tracing is enabled.</param>
|
|
302
|
+
<param name="suppressNestedClientActivities">Flag indicating if nested Azure SDK activities describing public API calls should be suppressed.</param>
|
|
303
|
+
<param name="isStable">Whether instrumentation is considered stable. When false, experimental feature flag controls if tracing is enabled.</param>
|
|
304
|
+
</member>
|
|
305
|
+
<member name="M:Azure.Core.Pipeline.DiagnosticScopeFactory.GetActivitySource(System.String,System.String)">
|
|
306
|
+
<summary>
|
|
307
|
+
This method combines client namespace and operation name into an ActivitySource name and creates the activity source.
|
|
308
|
+
For example:
|
|
309
|
+
ns: Azure.Storage.Blobs
|
|
310
|
+
name: BlobClient.DownloadTo
|
|
311
|
+
result Azure.Storage.Blobs.BlobClient
|
|
312
|
+
</summary>
|
|
313
|
+
</member>
|
|
314
|
+
<member name="M:Azure.Core.Pipeline.DiagnosticScope.AddLink(System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
|
|
315
|
+
<summary>
|
|
316
|
+
Adds a link to the scope. This must be called before <see cref="M:Azure.Core.Pipeline.DiagnosticScope.Start"/> has been called for the DiagnosticScope.
|
|
317
|
+
</summary>
|
|
318
|
+
<param name="traceparent">The traceparent for the link.</param>
|
|
319
|
+
<param name="tracestate">The tracestate for the link.</param>
|
|
320
|
+
<param name="attributes">Optional attributes to associate with the link.</param>
|
|
321
|
+
</member>
|
|
322
|
+
<member name="M:Azure.Core.Pipeline.DiagnosticScope.SetTraceContext(System.String,System.String)">
|
|
323
|
+
<summary>
|
|
324
|
+
Sets the trace context for the current scope.
|
|
325
|
+
</summary>
|
|
326
|
+
<param name="traceparent">The trace parent to set for the current scope.</param>
|
|
327
|
+
<param name="tracestate">The trace state to set for the current scope.</param>
|
|
328
|
+
</member>
|
|
329
|
+
<member name="M:Azure.Core.Pipeline.DiagnosticScope.Failed(System.Exception)">
|
|
330
|
+
<summary>
|
|
331
|
+
Marks the scope as failed.
|
|
332
|
+
</summary>
|
|
333
|
+
<param name="exception">The exception to associate with the failed scope.</param>
|
|
334
|
+
</member>
|
|
335
|
+
<member name="M:Azure.Core.Pipeline.DiagnosticScope.Failed(System.String)">
|
|
336
|
+
<summary>
|
|
337
|
+
Marks the scope as failed with low-cardinality error.type attribute.
|
|
338
|
+
</summary>
|
|
339
|
+
<param name="errorCode">Error code to associate with the failed scope.</param>
|
|
340
|
+
</member>
|
|
341
|
+
<member name="T:Azure.Core.Pipeline.ActivityExtensions">
|
|
342
|
+
<summary>
|
|
343
|
+
Until Activity Source is no longer considered experimental.
|
|
344
|
+
</summary>
|
|
345
|
+
</member>
|
|
346
|
+
<member name="T:Azure.Core.Pipeline.TaskExtensions.Enumerable`1">
|
|
347
|
+
<summary>
|
|
348
|
+
Both <see cref="T:Azure.Core.Pipeline.TaskExtensions.Enumerable`1"/> and <see cref="T:Azure.Core.Pipeline.TaskExtensions.Enumerator`1"/> are defined as public structs so that foreach can use duck typing
|
|
349
|
+
to call <see cref="M:Azure.Core.Pipeline.TaskExtensions.Enumerable`1.GetEnumerator"/> and avoid heap memory allocation.
|
|
350
|
+
Please don't delete this method and don't make these types private.
|
|
351
|
+
</summary>
|
|
352
|
+
<typeparam name="T"></typeparam>
|
|
353
|
+
</member>
|
|
354
|
+
<member name="T:Azure.Core.AppContextSwitchHelper">
|
|
355
|
+
<summary>
|
|
356
|
+
Helper for interacting with AppConfig settings and their related Environment variable settings.
|
|
357
|
+
</summary>
|
|
358
|
+
</member>
|
|
359
|
+
<member name="M:Azure.Core.AppContextSwitchHelper.GetConfigValue(System.String,System.String)">
|
|
360
|
+
<summary>
|
|
361
|
+
Determines if either an AppContext switch or its corresponding Environment Variable is set
|
|
362
|
+
</summary>
|
|
363
|
+
<param name="appContexSwitchName">Name of the AppContext switch.</param>
|
|
364
|
+
<param name="environmentVariableName">Name of the Environment variable.</param>
|
|
365
|
+
<returns>If the AppContext switch has been set, returns the value of the switch.
|
|
366
|
+
If the AppContext switch has not been set, returns the value of the environment variable.
|
|
367
|
+
False if neither is set.
|
|
368
|
+
</returns>
|
|
369
|
+
</member>
|
|
370
|
+
<member name="T:Azure.Core.SequentialDelayStrategy">
|
|
371
|
+
<summary>
|
|
372
|
+
A delay strategy that uses a fixed sequence of delays with no jitter applied. This is used by management LROs.
|
|
373
|
+
</summary>
|
|
374
|
+
</member>
|
|
375
|
+
<member name="T:Azure.Core.OperationInternal`1">
|
|
376
|
+
<summary>
|
|
377
|
+
A helper class used to build long-running operation instances. In order to use this helper:
|
|
378
|
+
<list type="number">
|
|
379
|
+
<item>Make sure your LRO implements the <see cref="T:Azure.Core.IOperation`1"/> interface.</item>
|
|
380
|
+
<item>Add a private <see cref="T:Azure.Core.OperationInternal`1"/> field to your LRO, and instantiate it during construction.</item>
|
|
381
|
+
<item>Delegate method calls to the <see cref="T:Azure.Core.OperationInternal`1"/> implementations.</item>
|
|
382
|
+
</list>
|
|
383
|
+
Supported members:
|
|
384
|
+
<list type="bullet">
|
|
385
|
+
<item>
|
|
386
|
+
<description><see cref="P:Azure.Core.OperationInternal`1.HasValue"/></description>
|
|
387
|
+
</item>
|
|
388
|
+
<item>
|
|
389
|
+
<description><see cref="P:Azure.Core.OperationInternalBase.HasCompleted"/></description>
|
|
390
|
+
</item>
|
|
391
|
+
<item>
|
|
392
|
+
<description><see cref="P:Azure.Core.OperationInternal`1.Value"/></description>
|
|
393
|
+
</item>
|
|
394
|
+
<item>
|
|
395
|
+
<description><see cref="P:Azure.Core.OperationInternalBase.RawResponse"/>, used for <see cref="M:Azure.Operation.GetRawResponse"/></description>
|
|
396
|
+
</item>
|
|
397
|
+
<item>
|
|
398
|
+
<description><see cref="M:Azure.Core.OperationInternalBase.UpdateStatus(System.Threading.CancellationToken)"/></description>
|
|
399
|
+
</item>
|
|
400
|
+
<item>
|
|
401
|
+
<description><see cref="M:Azure.Core.OperationInternalBase.UpdateStatusAsync(System.Threading.CancellationToken)"/></description>
|
|
402
|
+
</item>
|
|
403
|
+
<item>
|
|
404
|
+
<description><see cref="M:Azure.Core.OperationInternal`1.WaitForCompletionAsync(System.Threading.CancellationToken)"/></description>
|
|
405
|
+
</item>
|
|
406
|
+
<item>
|
|
407
|
+
<description><see cref="M:Azure.Core.OperationInternal`1.WaitForCompletionAsync(System.TimeSpan,System.Threading.CancellationToken)"/></description>
|
|
408
|
+
</item>
|
|
409
|
+
</list>
|
|
410
|
+
</summary>
|
|
411
|
+
<typeparam name="T">The final result of the long-running operation. Must match the type used in <see cref="T:Azure.Operation`1"/>.</typeparam>
|
|
412
|
+
</member>
|
|
413
|
+
<member name="M:Azure.Core.OperationInternal`1.Succeeded(Azure.Response,`0)">
|
|
414
|
+
<summary>
|
|
415
|
+
Initializes a new instance of the <see cref="T:Azure.Core.OperationInternal"/> class in a final successful state.
|
|
416
|
+
</summary>
|
|
417
|
+
<param name="rawResponse">The final value of <see cref="P:Azure.Core.OperationInternalBase.RawResponse"/>.</param>
|
|
418
|
+
<param name="value">The final result of the long-running operation.</param>
|
|
419
|
+
</member>
|
|
420
|
+
<member name="M:Azure.Core.OperationInternal`1.Failed(Azure.Response,Azure.RequestFailedException)">
|
|
421
|
+
<summary>
|
|
422
|
+
Initializes a new instance of the <see cref="T:Azure.Core.OperationInternal"/> class in a final failed state.
|
|
423
|
+
</summary>
|
|
424
|
+
<param name="rawResponse">The final value of <see cref="P:Azure.Core.OperationInternalBase.RawResponse"/>.</param>
|
|
425
|
+
<param name="operationFailedException">The exception that will be thrown by <c>UpdateStatusAsync</c>.</param>
|
|
426
|
+
</member>
|
|
427
|
+
<member name="M:Azure.Core.OperationInternal`1.#ctor(Azure.Core.IOperation{`0},Azure.Core.Pipeline.ClientDiagnostics,Azure.Response,System.String,System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}},Azure.Core.DelayStrategy)">
|
|
428
|
+
<summary>
|
|
429
|
+
Initializes a new instance of the <see cref="T:Azure.Core.OperationInternal`1"/> class.
|
|
430
|
+
</summary>
|
|
431
|
+
<param name="operation">The long-running operation making use of this class. Passing "<c>this</c>" is expected.</param>
|
|
432
|
+
<param name="clientDiagnostics">Used for diagnostic scope and exception creation. This is expected to be the instance created during the construction of your main client.</param>
|
|
433
|
+
<param name="rawResponse">
|
|
434
|
+
The initial value of <see cref="P:Azure.Core.OperationInternalBase.RawResponse"/>. Usually, long-running operation objects can be instantiated in two ways:
|
|
435
|
+
<list type="bullet">
|
|
436
|
+
<item>
|
|
437
|
+
When calling a client's "<c>Start<OperationName></c>" method, a service call is made to start the operation, and an <see cref="T:Azure.Operation`1"/> instance is returned.
|
|
438
|
+
In this case, the response received from this service call can be passed here.
|
|
439
|
+
</item>
|
|
440
|
+
<item>
|
|
441
|
+
When a user instantiates an <see cref="T:Azure.Operation`1"/> directly using a public constructor, there's no previous service call. In this case, passing <c>null</c> is expected.
|
|
442
|
+
</item>
|
|
443
|
+
</list>
|
|
444
|
+
</param>
|
|
445
|
+
<param name="operationTypeName">
|
|
446
|
+
The type name of the long-running operation making use of this class. Used when creating diagnostic scopes. If left <c>null</c>, the type name will be inferred based on the
|
|
447
|
+
parameter <paramref name="operation"/>.
|
|
448
|
+
</param>
|
|
449
|
+
<param name="scopeAttributes">The attributes to use during diagnostic scope creation.</param>
|
|
450
|
+
<param name="fallbackStrategy">The delay strategy when Retry-After header is not present. When it is present, the longer of the two delays will be used.
|
|
451
|
+
Default is <see cref="T:Azure.Core.FixedDelayWithNoJitterStrategy"/>.</param>
|
|
452
|
+
</member>
|
|
453
|
+
<member name="P:Azure.Core.OperationInternal`1.HasValue">
|
|
454
|
+
<summary>
|
|
455
|
+
Returns <c>true</c> if the long-running operation completed successfully and has produced a final result.
|
|
456
|
+
<example>Usage example:
|
|
457
|
+
<code>
|
|
458
|
+
public bool HasValue => _operationInternal.HasValue;
|
|
459
|
+
</code>
|
|
460
|
+
</example>
|
|
461
|
+
</summary>
|
|
462
|
+
</member>
|
|
463
|
+
<member name="P:Azure.Core.OperationInternal`1.Value">
|
|
464
|
+
<summary>
|
|
465
|
+
The final result of the long-running operation.
|
|
466
|
+
<example>Usage example:
|
|
467
|
+
<code>
|
|
468
|
+
public T Value => _operationInternal.Value;
|
|
469
|
+
</code>
|
|
470
|
+
</example>
|
|
471
|
+
</summary>
|
|
472
|
+
<exception cref="T:System.InvalidOperationException">Thrown when the operation has not completed yet.</exception>
|
|
473
|
+
<exception cref="T:Azure.RequestFailedException">Thrown when the operation has completed with failures.</exception>
|
|
474
|
+
</member>
|
|
475
|
+
<member name="M:Azure.Core.OperationInternal`1.WaitForCompletionAsync(System.Threading.CancellationToken)">
|
|
476
|
+
<summary>
|
|
477
|
+
Periodically calls <see cref="M:Azure.Core.OperationInternalBase.UpdateStatusAsync(System.Threading.CancellationToken)"/> until the long-running operation completes.
|
|
478
|
+
After each service call, a retry-after header may be returned to communicate that there is no reason to poll
|
|
479
|
+
for status change until the specified time has passed.
|
|
480
|
+
Headers supported are: "Retry-After", "retry-after-ms", and "x-ms-retry-after-ms",
|
|
481
|
+
<example>Usage example:
|
|
482
|
+
<code>
|
|
483
|
+
public async ValueTask<Response<T>> WaitForCompletionAsync(CancellationToken cancellationToken) =>
|
|
484
|
+
await _operationInternal.WaitForCompletionAsync(cancellationToken).ConfigureAwait(false);
|
|
485
|
+
</code>
|
|
486
|
+
</example>
|
|
487
|
+
</summary>
|
|
488
|
+
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> controlling the request lifetime.</param>
|
|
489
|
+
<returns>The last HTTP response received from the server, including the final result of the long-running operation.</returns>
|
|
490
|
+
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
491
|
+
</member>
|
|
492
|
+
<member name="M:Azure.Core.OperationInternal`1.WaitForCompletionAsync(System.TimeSpan,System.Threading.CancellationToken)">
|
|
493
|
+
<summary>
|
|
494
|
+
Periodically calls <see cref="M:Azure.Core.OperationInternalBase.UpdateStatusAsync(System.Threading.CancellationToken)"/> until the long-running operation completes. The interval
|
|
495
|
+
between calls is defined by the parameter <paramref name="pollingInterval"/>, but it can change based on information returned
|
|
496
|
+
from the server. After each service call, a retry-after header may be returned to communicate that there is no reason to poll
|
|
497
|
+
for status change until the specified time has passed. In this case, the maximum value between the <paramref name="pollingInterval"/>
|
|
498
|
+
parameter and the retry-after header is chosen as the wait interval. Headers supported are: "Retry-After", "retry-after-ms",
|
|
499
|
+
and "x-ms-retry-after-ms".
|
|
500
|
+
<example>Usage example:
|
|
501
|
+
<code>
|
|
502
|
+
public async ValueTask<Response<T>> WaitForCompletionAsync(TimeSpan pollingInterval, CancellationToken cancellationToken) =>
|
|
503
|
+
await _operationInternal.WaitForCompletionAsync(pollingInterval, cancellationToken).ConfigureAwait(false);
|
|
504
|
+
</code>
|
|
505
|
+
</example>
|
|
506
|
+
</summary>
|
|
507
|
+
<param name="pollingInterval">The interval between status requests to the server.</param>
|
|
508
|
+
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> controlling the request lifetime.</param>
|
|
509
|
+
<returns>The last HTTP response received from the server, including the final result of the long-running operation.</returns>
|
|
510
|
+
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
511
|
+
</member>
|
|
512
|
+
<member name="M:Azure.Core.OperationInternal`1.WaitForCompletion(System.Threading.CancellationToken)">
|
|
513
|
+
<summary>
|
|
514
|
+
Periodically calls <see cref="M:Azure.Core.OperationInternalBase.UpdateStatus(System.Threading.CancellationToken)"/> until the long-running operation completes.
|
|
515
|
+
After each service call, a retry-after header may be returned to communicate that there is no reason to poll
|
|
516
|
+
for status change until the specified time has passed.
|
|
517
|
+
Headers supported are: "Retry-After", "retry-after-ms", and "x-ms-retry-after-ms",
|
|
518
|
+
<example>Usage example:
|
|
519
|
+
<code>
|
|
520
|
+
public async ValueTask<Response<T>> WaitForCompletionAsync(CancellationToken cancellationToken) =>
|
|
521
|
+
await _operationInternal.WaitForCompletionAsync(cancellationToken).ConfigureAwait(false);
|
|
522
|
+
</code>
|
|
523
|
+
</example>
|
|
524
|
+
</summary>
|
|
525
|
+
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> controlling the request lifetime.</param>
|
|
526
|
+
<returns>The last HTTP response received from the server, including the final result of the long-running operation.</returns>
|
|
527
|
+
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
528
|
+
</member>
|
|
529
|
+
<member name="M:Azure.Core.OperationInternal`1.WaitForCompletion(System.TimeSpan,System.Threading.CancellationToken)">
|
|
530
|
+
<summary>
|
|
531
|
+
Periodically calls <see cref="M:Azure.Core.OperationInternalBase.UpdateStatus(System.Threading.CancellationToken)"/> until the long-running operation completes. The interval
|
|
532
|
+
between calls is defined by the <see cref="T:Azure.Core.FixedDelayWithNoJitterStrategy"/>, which takes into account any retry-after header that is returned
|
|
533
|
+
from the server.
|
|
534
|
+
<example>Usage example:
|
|
535
|
+
<code>
|
|
536
|
+
public async ValueTask<Response<T>> WaitForCompletionAsync(CancellationToken cancellationToken) =>
|
|
537
|
+
await _operationInternal.WaitForCompletionAsync(cancellationToken).ConfigureAwait(false);
|
|
538
|
+
</code>
|
|
539
|
+
</example>
|
|
540
|
+
</summary>
|
|
541
|
+
<param name="pollingInterval">The interval between status requests to the server.</param>
|
|
542
|
+
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> controlling the request lifetime.</param>
|
|
543
|
+
<returns>The last HTTP response received from the server, including the final result of the long-running operation.</returns>
|
|
544
|
+
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
545
|
+
</member>
|
|
546
|
+
<member name="T:Azure.Core.IOperation`1">
|
|
547
|
+
<summary>
|
|
548
|
+
An interface used by <see cref="T:Azure.Core.OperationInternal`1"/> for making service calls and updating state. It's expected that
|
|
549
|
+
your long-running operation classes implement this interface.
|
|
550
|
+
</summary>
|
|
551
|
+
<typeparam name="T">The final result of the long-running operation. Must match the type used in <see cref="T:Azure.Operation`1"/>.</typeparam>
|
|
552
|
+
</member>
|
|
553
|
+
<member name="M:Azure.Core.IOperation`1.UpdateStateAsync(System.Boolean,System.Threading.CancellationToken)">
|
|
554
|
+
<summary>
|
|
555
|
+
Calls the service and updates the state of the long-running operation. Properties directly handled by the
|
|
556
|
+
<see cref="T:Azure.Core.OperationInternal`1"/> class, such as <see cref="P:Azure.Core.OperationInternalBase.RawResponse"/> or
|
|
557
|
+
<see cref="P:Azure.Core.OperationInternal`1.Value"/>, don't need to be updated. Operation-specific properties, such
|
|
558
|
+
as "<c>CreateOn</c>" or "<c>LastModified</c>", must be manually updated by the operation implementing this
|
|
559
|
+
method.
|
|
560
|
+
<example>Usage example:
|
|
561
|
+
<code>
|
|
562
|
+
async ValueTask<OperationState<T>> IOperation<T>.UpdateStateAsync(bool async, CancellationToken cancellationToken)<br/>
|
|
563
|
+
{<br/>
|
|
564
|
+
Response<R> response = async ? <async service call> : <sync service call>;<br/>
|
|
565
|
+
if (<operation succeeded>) return OperationState<T>.Success(response.GetRawResponse(), <parse response>);<br/>
|
|
566
|
+
if (<operation failed>) return OperationState<T>.Failure(response.GetRawResponse());<br/>
|
|
567
|
+
return OperationState<T>.Pending(response.GetRawResponse());<br/>
|
|
568
|
+
}
|
|
569
|
+
</code>
|
|
570
|
+
</example>
|
|
571
|
+
</summary>
|
|
572
|
+
<param name="async"><c>true</c> if the call should be executed asynchronously. Otherwise, <c>false</c>.</param>
|
|
573
|
+
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> controlling the request lifetime.</param>
|
|
574
|
+
<returns>
|
|
575
|
+
A structure indicating the current operation state. The <see cref="T:Azure.Core.OperationState`1"/> structure must be instantiated by one of
|
|
576
|
+
its static methods:
|
|
577
|
+
<list type="bullet">
|
|
578
|
+
<item>Use <see cref="M:Azure.Core.OperationState`1.Success(Azure.Response,`0)"/> when the operation has completed successfully.</item>
|
|
579
|
+
<item>Use <see cref="M:Azure.Core.OperationState`1.Failure(Azure.Response,Azure.RequestFailedException)"/> when the operation has completed with failures.</item>
|
|
580
|
+
<item>Use <see cref="M:Azure.Core.OperationState`1.Pending(Azure.Response)"/> when the operation has not completed yet.</item>
|
|
581
|
+
</list>
|
|
582
|
+
</returns>
|
|
583
|
+
</member>
|
|
584
|
+
<member name="T:Azure.Core.OperationState`1">
|
|
585
|
+
<summary>
|
|
586
|
+
A helper structure passed to <see cref="T:Azure.Core.OperationInternal`1"/> to indicate the current operation state. This structure must be
|
|
587
|
+
instantiated by one of its static methods, depending on the operation state:
|
|
588
|
+
<list type="bullet">
|
|
589
|
+
<item>Use <see cref="M:Azure.Core.OperationState`1.Success(Azure.Response,`0)"/> when the operation has completed successfully.</item>
|
|
590
|
+
<item>Use <see cref="M:Azure.Core.OperationState`1.Failure(Azure.Response,Azure.RequestFailedException)"/> when the operation has completed with failures.</item>
|
|
591
|
+
<item>Use <see cref="M:Azure.Core.OperationState`1.Pending(Azure.Response)"/> when the operation has not completed yet.</item>
|
|
592
|
+
</list>
|
|
593
|
+
</summary>
|
|
594
|
+
<typeparam name="T">The final result of the long-running operation. Must match the type used in <see cref="T:Azure.Operation`1"/>.</typeparam>
|
|
595
|
+
</member>
|
|
596
|
+
<member name="M:Azure.Core.OperationState`1.Success(Azure.Response,`0)">
|
|
597
|
+
<summary>
|
|
598
|
+
Instantiates an <see cref="T:Azure.Core.OperationState`1"/> indicating the operation has completed successfully.
|
|
599
|
+
</summary>
|
|
600
|
+
<param name="rawResponse">The HTTP response obtained during the status update.</param>
|
|
601
|
+
<param name="value">The final result of the long-running operation.</param>
|
|
602
|
+
<returns>A new <see cref="T:Azure.Core.OperationState`1"/> instance.</returns>
|
|
603
|
+
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="rawResponse"/> or <paramref name="value"/> is <c>null</c>.</exception>
|
|
604
|
+
</member>
|
|
605
|
+
<member name="M:Azure.Core.OperationState`1.Failure(Azure.Response,Azure.RequestFailedException)">
|
|
606
|
+
<summary>
|
|
607
|
+
Instantiates an <see cref="T:Azure.Core.OperationState`1"/> indicating the operation has completed with failures.
|
|
608
|
+
</summary>
|
|
609
|
+
<param name="rawResponse">The HTTP response obtained during the status update.</param>
|
|
610
|
+
<param name="operationFailedException">
|
|
611
|
+
The exception to throw from <c>UpdateStatus</c> because of the operation failure. The same exception will be thrown when
|
|
612
|
+
<see cref="P:Azure.Core.OperationInternal`1.Value"/> is called. If left <c>null</c>, a default exception is created based on the
|
|
613
|
+
<paramref name="rawResponse"/> parameter.
|
|
614
|
+
</param>
|
|
615
|
+
<returns>A new <see cref="T:Azure.Core.OperationState`1"/> instance.</returns>
|
|
616
|
+
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="rawResponse"/> is <c>null</c>.</exception>
|
|
617
|
+
</member>
|
|
618
|
+
<member name="M:Azure.Core.OperationState`1.Pending(Azure.Response)">
|
|
619
|
+
<summary>
|
|
620
|
+
Instantiates an <see cref="T:Azure.Core.OperationState`1"/> indicating the operation has not completed yet.
|
|
621
|
+
</summary>
|
|
622
|
+
<param name="rawResponse">The HTTP response obtained during the status update.</param>
|
|
623
|
+
<returns>A new <see cref="T:Azure.Core.OperationState`1"/> instance.</returns>
|
|
624
|
+
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="rawResponse"/> is <c>null</c>.</exception>
|
|
625
|
+
</member>
|
|
626
|
+
<member name="P:Azure.Core.OperationInternalBase.RawResponse">
|
|
627
|
+
<summary>
|
|
628
|
+
The last HTTP response received from the server. Its update already handled in calls to "<c>UpdateStatus</c>" and
|
|
629
|
+
"<c>WaitForCompletionAsync</c>", but custom methods not supported by this class, such as "<c>CancelOperation</c>",
|
|
630
|
+
must update it as well.
|
|
631
|
+
<example>Usage example:
|
|
632
|
+
<code>
|
|
633
|
+
public Response GetRawResponse() => _operationInternal.RawResponse;
|
|
634
|
+
</code>
|
|
635
|
+
</example>
|
|
636
|
+
</summary>
|
|
637
|
+
</member>
|
|
638
|
+
<member name="P:Azure.Core.OperationInternalBase.HasCompleted">
|
|
639
|
+
<summary>
|
|
640
|
+
Returns <c>true</c> if the long-running operation has completed.
|
|
641
|
+
<example>Usage example:
|
|
642
|
+
<code>
|
|
643
|
+
public bool HasCompleted => _operationInternal.HasCompleted;
|
|
644
|
+
</code>
|
|
645
|
+
</example>
|
|
646
|
+
</summary>
|
|
647
|
+
</member>
|
|
648
|
+
<member name="M:Azure.Core.OperationInternalBase.UpdateStatusAsync(System.Threading.CancellationToken)">
|
|
649
|
+
<summary>
|
|
650
|
+
Calls the server to get the latest status of the long-running operation, handling diagnostic scope creation for distributed
|
|
651
|
+
tracing. The default scope name can be changed with the "<c>operationTypeName</c>" parameter passed to the constructor.
|
|
652
|
+
<example>Usage example:
|
|
653
|
+
<code>
|
|
654
|
+
public async ValueTask<Response> UpdateStatusAsync(CancellationToken cancellationToken) =>
|
|
655
|
+
await _operationInternal.UpdateStatusAsync(cancellationToken).ConfigureAwait(false);
|
|
656
|
+
</code>
|
|
657
|
+
</example>
|
|
658
|
+
</summary>
|
|
659
|
+
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> controlling the request lifetime.</param>
|
|
660
|
+
<returns>The HTTP response received from the server.</returns>
|
|
661
|
+
<remarks>
|
|
662
|
+
After a successful run, this method will update <see cref="P:Azure.Core.OperationInternalBase.RawResponse"/> and might update <see cref="P:Azure.Core.OperationInternalBase.HasCompleted"/>.
|
|
663
|
+
</remarks>
|
|
664
|
+
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
665
|
+
</member>
|
|
666
|
+
<member name="M:Azure.Core.OperationInternalBase.UpdateStatus(System.Threading.CancellationToken)">
|
|
667
|
+
<summary>
|
|
668
|
+
Calls the server to get the latest status of the long-running operation, handling diagnostic scope creation for distributed
|
|
669
|
+
tracing. The default scope name can be changed with the "<c>operationTypeName</c>" parameter passed to the constructor.
|
|
670
|
+
<example>Usage example:
|
|
671
|
+
<code>
|
|
672
|
+
public Response UpdateStatus(CancellationToken cancellationToken) => _operationInternal.UpdateStatus(cancellationToken);
|
|
673
|
+
</code>
|
|
674
|
+
</example>
|
|
675
|
+
</summary>
|
|
676
|
+
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> controlling the request lifetime.</param>
|
|
677
|
+
<returns>The HTTP response received from the server.</returns>
|
|
678
|
+
<remarks>
|
|
679
|
+
After a successful run, this method will update <see cref="P:Azure.Core.OperationInternalBase.RawResponse"/> and might update <see cref="P:Azure.Core.OperationInternalBase.HasCompleted"/>.
|
|
680
|
+
</remarks>
|
|
681
|
+
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
682
|
+
</member>
|
|
683
|
+
<member name="M:Azure.Core.OperationInternalBase.WaitForCompletionResponseAsync(System.Threading.CancellationToken)">
|
|
684
|
+
<summary>
|
|
685
|
+
Periodically calls <see cref="M:Azure.Core.OperationInternalBase.UpdateStatusAsync(System.Threading.CancellationToken)"/> until the long-running operation completes.
|
|
686
|
+
After each service call, a retry-after header may be returned to communicate that there is no reason to poll
|
|
687
|
+
for status change until the specified time has passed. The maximum of the retry after value and the fallback strategy
|
|
688
|
+
is then used as the wait interval.
|
|
689
|
+
Headers supported are: "Retry-After", "retry-after-ms", and "x-ms-retry-after-ms",
|
|
690
|
+
<example>Usage example:
|
|
691
|
+
<code>
|
|
692
|
+
public async ValueTask<Response<T>> WaitForCompletionAsync(CancellationToken cancellationToken) =>
|
|
693
|
+
await _operationInternal.WaitForCompletionAsync(cancellationToken).ConfigureAwait(false);
|
|
694
|
+
</code>
|
|
695
|
+
</example>
|
|
696
|
+
</summary>
|
|
697
|
+
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> controlling the request lifetime.</param>
|
|
698
|
+
<returns>The last HTTP response received from the server, including the final result of the long-running operation.</returns>
|
|
699
|
+
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
700
|
+
</member>
|
|
701
|
+
<member name="M:Azure.Core.OperationInternalBase.WaitForCompletionResponseAsync(System.TimeSpan,System.Threading.CancellationToken)">
|
|
702
|
+
<summary>
|
|
703
|
+
Periodically calls <see cref="M:Azure.Core.OperationInternalBase.UpdateStatusAsync(System.Threading.CancellationToken)"/> until the long-running operation completes. The interval
|
|
704
|
+
between calls is defined by the parameter <paramref name="pollingInterval"/>, but it can change based on information returned
|
|
705
|
+
from the server. After each service call, a retry-after header may be returned to communicate that there is no reason to poll
|
|
706
|
+
for status change until the specified time has passed. In this case, the maximum value between the <paramref name="pollingInterval"/>
|
|
707
|
+
parameter and the retry-after header is chosen as the wait interval. Headers supported are: "Retry-After", "retry-after-ms",
|
|
708
|
+
and "x-ms-retry-after-ms".
|
|
709
|
+
<example>Usage example:
|
|
710
|
+
<code>
|
|
711
|
+
public async ValueTask<Response<T>> WaitForCompletionAsync(TimeSpan pollingInterval, CancellationToken cancellationToken) =>
|
|
712
|
+
await _operationInternal.WaitForCompletionAsync(pollingInterval, cancellationToken).ConfigureAwait(false);
|
|
713
|
+
</code>
|
|
714
|
+
</example>
|
|
715
|
+
</summary>
|
|
716
|
+
<param name="pollingInterval">The interval between status requests to the server. <strong></strong></param>
|
|
717
|
+
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> controlling the request lifetime.</param>
|
|
718
|
+
<returns>The last HTTP response received from the server, including the final result of the long-running operation.</returns>
|
|
719
|
+
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
720
|
+
</member>
|
|
721
|
+
<member name="M:Azure.Core.OperationInternalBase.WaitForCompletionResponse(System.Threading.CancellationToken)">
|
|
722
|
+
<summary>
|
|
723
|
+
Periodically calls <see cref="M:Azure.Core.OperationInternalBase.UpdateStatus(System.Threading.CancellationToken)"/> until the long-running operation completes.
|
|
724
|
+
After each service call, a retry-after header may be returned to communicate that there is no reason to poll
|
|
725
|
+
for status change until the specified time has passed. The maximum of the retry after value and the fallback strategy
|
|
726
|
+
is then used as the wait interval.
|
|
727
|
+
Headers supported are: "Retry-After", "retry-after-ms", and "x-ms-retry-after-ms",
|
|
728
|
+
and "x-ms-retry-after-ms".
|
|
729
|
+
<example>Usage example:
|
|
730
|
+
<code>
|
|
731
|
+
public async ValueTask<Response<T>> WaitForCompletionAsync(TimeSpan pollingInterval, CancellationToken cancellationToken) =>
|
|
732
|
+
await _operationInternal.WaitForCompletionAsync(pollingInterval, cancellationToken).ConfigureAwait(false);
|
|
733
|
+
</code>
|
|
734
|
+
</example>
|
|
735
|
+
</summary>
|
|
736
|
+
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> controlling the request lifetime.</param>
|
|
737
|
+
<returns>The last HTTP response received from the server, including the final result of the long-running operation.</returns>
|
|
738
|
+
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
739
|
+
</member>
|
|
740
|
+
<member name="M:Azure.Core.OperationInternalBase.WaitForCompletionResponse(System.TimeSpan,System.Threading.CancellationToken)">
|
|
741
|
+
<summary>
|
|
742
|
+
Periodically calls <see cref="M:Azure.Core.OperationInternalBase.UpdateStatus(System.Threading.CancellationToken)"/> until the long-running operation completes. The interval
|
|
743
|
+
between calls is defined by the parameter <paramref name="pollingInterval"/>, but it can change based on information returned
|
|
744
|
+
from the server. After each service call, a retry-after header may be returned to communicate that there is no reason to poll
|
|
745
|
+
for status change until the specified time has passed. In this case, the maximum value between the <paramref name="pollingInterval"/>
|
|
746
|
+
parameter and the retry-after header is chosen as the wait interval. Headers supported are: "Retry-After", "retry-after-ms",
|
|
747
|
+
and "x-ms-retry-after-ms".
|
|
748
|
+
<example>Usage example:
|
|
749
|
+
<code>
|
|
750
|
+
public async ValueTask<Response<T>> WaitForCompletionAsync(TimeSpan pollingInterval, CancellationToken cancellationToken) =>
|
|
751
|
+
await _operationInternal.WaitForCompletionAsync(pollingInterval, cancellationToken).ConfigureAwait(false);
|
|
752
|
+
</code>
|
|
753
|
+
</example>
|
|
754
|
+
</summary>
|
|
755
|
+
<param name="pollingInterval">The interval between status requests to the server.</param>
|
|
756
|
+
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> controlling the request lifetime.</param>
|
|
757
|
+
<returns>The last HTTP response received from the server, including the final result of the long-running operation.</returns>
|
|
758
|
+
<exception cref="T:Azure.RequestFailedException">Thrown if there's been any issues during the connection, or if the operation has completed with failures.</exception>
|
|
759
|
+
</member>
|
|
760
|
+
<member name="T:Azure.Core.AsyncLockWithValue`1">
|
|
761
|
+
<summary>
|
|
762
|
+
Primitive that combines async lock and value cache
|
|
763
|
+
</summary>
|
|
764
|
+
<typeparam name="T"></typeparam>
|
|
765
|
+
</member>
|
|
766
|
+
<member name="M:Azure.Core.AsyncLockWithValue`1.GetLockOrValueAsync(System.Boolean,System.Threading.CancellationToken)">
|
|
767
|
+
<summary>
|
|
768
|
+
Method that either returns cached value or acquire a lock.
|
|
769
|
+
If one caller has acquired a lock, other callers will be waiting for the lock to be released.
|
|
770
|
+
If value is set, lock is released and all waiters get that value.
|
|
771
|
+
If value isn't set, the next waiter in the queue will get the lock.
|
|
772
|
+
</summary>
|
|
773
|
+
<param name="async"></param>
|
|
774
|
+
<param name="cancellationToken"></param>
|
|
775
|
+
<returns></returns>
|
|
776
|
+
</member>
|
|
777
|
+
<member name="M:Azure.Core.AsyncLockWithValue`1.SetValue(`0,System.Int64@)">
|
|
778
|
+
<summary>
|
|
779
|
+
Set value to the cache and to all the waiters
|
|
780
|
+
</summary>
|
|
781
|
+
<param name="value"></param>
|
|
782
|
+
<param name="lockIndex"></param>
|
|
783
|
+
</member>
|
|
784
|
+
<member name="M:Azure.Core.AsyncLockWithValue`1.Reset(System.Int64@)">
|
|
785
|
+
<summary>
|
|
786
|
+
Release the lock and allow next waiter acquire it
|
|
787
|
+
</summary>
|
|
788
|
+
</member>
|
|
789
|
+
<member name="P:Azure.Core.AsyncLockWithValue`1.LockOrValue.HasValue">
|
|
790
|
+
<summary>
|
|
791
|
+
Returns true if lock contains the cached value. Otherwise false.
|
|
792
|
+
</summary>
|
|
793
|
+
</member>
|
|
794
|
+
<member name="P:Azure.Core.AsyncLockWithValue`1.LockOrValue.Value">
|
|
795
|
+
<summary>
|
|
796
|
+
Returns cached value if it was set when lock has been created. Throws exception otherwise.
|
|
797
|
+
</summary>
|
|
798
|
+
<exception cref="T:System.InvalidOperationException">Value isn't set.</exception>
|
|
799
|
+
</member>
|
|
800
|
+
<member name="M:Azure.Core.AsyncLockWithValue`1.LockOrValue.SetValue(`0)">
|
|
801
|
+
<summary>
|
|
802
|
+
Set value to the cache and to all the waiters.
|
|
803
|
+
</summary>
|
|
804
|
+
<param name="value"></param>
|
|
805
|
+
<exception cref="T:System.InvalidOperationException">Value is set already.</exception>
|
|
806
|
+
</member>
|
|
807
|
+
<member name="T:Azure.Core.OperationPoller">
|
|
808
|
+
<summary>
|
|
809
|
+
Implementation of LRO polling logic.
|
|
810
|
+
</summary>
|
|
811
|
+
</member>
|
|
812
|
+
<member name="T:Azure.Core.FixedDelayWithNoJitterStrategy">
|
|
813
|
+
<summary>
|
|
814
|
+
A delay strategy that uses a fixed delay with no jitter applied. This is used by data plane LROs.
|
|
815
|
+
</summary>
|
|
816
|
+
</member>
|
|
817
|
+
</members>
|
|
818
|
+
</doc>
|