xml/Azure.Developer.DevCenter/DeploymentEnvironmentsClient.xml (3,537 lines of code) (raw):
<Type Name="DeploymentEnvironmentsClient" FullName="Azure.Developer.DevCenter.DeploymentEnvironmentsClient">
<TypeSignature Language="C#" Value="public class DeploymentEnvironmentsClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DeploymentEnvironmentsClient extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.Developer.DevCenter.DeploymentEnvironmentsClient" />
<TypeSignature Language="VB.NET" Value="Public Class DeploymentEnvironmentsClient" />
<TypeSignature Language="F#" Value="type DeploymentEnvironmentsClient = class" />
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary> The DeploymentEnvironments service client. </summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DeploymentEnvironmentsClient ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary> Initializes a new instance of DeploymentEnvironmentsClient for mocking. </summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DeploymentEnvironmentsClient (Uri endpoint, Azure.Core.TokenCredential credential);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.#ctor(System.Uri,Azure.Core.TokenCredential)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential)" />
<MemberSignature Language="F#" Value="new Azure.Developer.DevCenter.DeploymentEnvironmentsClient : Uri * Azure.Core.TokenCredential -> Azure.Developer.DevCenter.DeploymentEnvironmentsClient" Usage="new Azure.Developer.DevCenter.DeploymentEnvironmentsClient (endpoint, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
</Parameters>
<Docs>
<param name="endpoint"> The DevCenter-specific URI to operate on. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<summary> Initializes a new instance of DeploymentEnvironmentsClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DeploymentEnvironmentsClient (Uri endpoint, Azure.Core.TokenCredential credential, Azure.Developer.DevCenter.AzureDeveloperDevCenterClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential, class Azure.Developer.DevCenter.AzureDeveloperDevCenterClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.#ctor(System.Uri,Azure.Core.TokenCredential,Azure.Developer.DevCenter.AzureDeveloperDevCenterClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential, options As AzureDeveloperDevCenterClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.Developer.DevCenter.DeploymentEnvironmentsClient : Uri * Azure.Core.TokenCredential * Azure.Developer.DevCenter.AzureDeveloperDevCenterClientOptions -> Azure.Developer.DevCenter.DeploymentEnvironmentsClient" Usage="new Azure.Developer.DevCenter.DeploymentEnvironmentsClient (endpoint, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="options" Type="Azure.Developer.DevCenter.AzureDeveloperDevCenterClientOptions" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="endpoint"> The DevCenter-specific URI to operate on. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<param name="options"> The options for configuring the client. </param>
<summary> Initializes a new instance of DeploymentEnvironmentsClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DeploymentEnvironmentsClient (Uri endpoint, Azure.Core.TokenCredential credential, Azure.Developer.DevCenter.DevCenterClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential, class Azure.Developer.DevCenter.DevCenterClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.#ctor(System.Uri,Azure.Core.TokenCredential,Azure.Developer.DevCenter.DevCenterClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential, options As DevCenterClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.Developer.DevCenter.DeploymentEnvironmentsClient : Uri * Azure.Core.TokenCredential * Azure.Developer.DevCenter.DevCenterClientOptions -> Azure.Developer.DevCenter.DeploymentEnvironmentsClient" Usage="new Azure.Developer.DevCenter.DeploymentEnvironmentsClient (endpoint, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="options" Type="Azure.Developer.DevCenter.DevCenterClientOptions" Index="2" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="endpoint"> The DevCenter-specific URI to operate on. </param>
<param name="credential"> A credential used to authenticate to an Azure Service. </param>
<param name="options"> The options for configuring the client. </param>
<summary> Initializes a new instance of DeploymentEnvironmentsClient. </summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="endpoint" /> or <paramref name="credential" /> is null. </exception>
</Docs>
</Member>
<Member MemberName="CreateOrUpdateEnvironment">
<MemberSignature Language="C#" Value="public virtual Azure.Operation<Azure.Developer.DevCenter.Models.DevCenterEnvironment> CreateOrUpdateEnvironment (Azure.WaitUntil waitUntil, string projectName, string userId, Azure.Developer.DevCenter.Models.DevCenterEnvironment environment, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class Azure.Developer.DevCenter.Models.DevCenterEnvironment> CreateOrUpdateEnvironment(valuetype Azure.WaitUntil waitUntil, string projectName, string userId, class Azure.Developer.DevCenter.Models.DevCenterEnvironment environment, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.CreateOrUpdateEnvironment(Azure.WaitUntil,System.String,System.String,Azure.Developer.DevCenter.Models.DevCenterEnvironment,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrUpdateEnvironment (waitUntil As WaitUntil, projectName As String, userId As String, environment As DevCenterEnvironment, Optional cancellationToken As CancellationToken = Nothing) As Operation(Of DevCenterEnvironment)" />
<MemberSignature Language="F#" Value="abstract member CreateOrUpdateEnvironment : Azure.WaitUntil * string * string * Azure.Developer.DevCenter.Models.DevCenterEnvironment * System.Threading.CancellationToken -> Azure.Operation<Azure.Developer.DevCenter.Models.DevCenterEnvironment>
override this.CreateOrUpdateEnvironment : Azure.WaitUntil * string * string * Azure.Developer.DevCenter.Models.DevCenterEnvironment * System.Threading.CancellationToken -> Azure.Operation<Azure.Developer.DevCenter.Models.DevCenterEnvironment>" Usage="deploymentEnvironmentsClient.CreateOrUpdateEnvironment (waitUntil, projectName, userId, environment, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation<Azure.Developer.DevCenter.Models.DevCenterEnvironment></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="projectName" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="userId" Type="System.String" Index="2" FrameworkAlternate="azure-dotnet" />
<Parameter Name="environment" Type="Azure.Developer.DevCenter.Models.DevCenterEnvironment" Index="3" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="4" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="waitUntil">
<see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="userId"> The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. </param>
<param name="environment"> Represents an environment. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Creates or updates an environment. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" />, <paramref name="userId" /> or <paramref name="environment" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="userId" /> is an empty string, and was expected to be non-empty. </exception>
<!-- No matching elements were found for the following include tag -->
<include file="Docs/DeploymentEnvironmentsClient.xml" path="doc/members/member[@name='CreateOrUpdateEnvironment(WaitUntil,string,string,DevCenterEnvironment,CancellationToken)']/*" />
</Docs>
</Member>
<Member MemberName="CreateOrUpdateEnvironment">
<MemberSignature Language="C#" Value="public virtual Azure.Operation<BinaryData> CreateOrUpdateEnvironment (Azure.WaitUntil waitUntil, string projectName, string userId, string environmentName, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation`1<class System.BinaryData> CreateOrUpdateEnvironment(valuetype Azure.WaitUntil waitUntil, string projectName, string userId, string environmentName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.CreateOrUpdateEnvironment(Azure.WaitUntil,System.String,System.String,System.String,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrUpdateEnvironment (waitUntil As WaitUntil, projectName As String, userId As String, environmentName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Operation(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member CreateOrUpdateEnvironment : Azure.WaitUntil * string * string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>
override this.CreateOrUpdateEnvironment : Azure.WaitUntil * string * string * string * Azure.Core.RequestContent * Azure.RequestContext -> Azure.Operation<BinaryData>" Usage="deploymentEnvironmentsClient.CreateOrUpdateEnvironment (waitUntil, projectName, userId, environmentName, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="projectName" Type="System.String" />
<Parameter Name="userId" Type="System.String" />
<Parameter Name="environmentName" Type="System.String" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="waitUntil">
<see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="userId"> The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. </param>
<param name="environmentName"> The name of the environment. </param>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Creates or updates an environment.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Operation" /> representing an asynchronous operation on the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" />, <paramref name="userId" />, <paramref name="environmentName" /> or <paramref name="content" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" />, <paramref name="userId" /> or <paramref name="environmentName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call CreateOrUpdateEnvironment and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
environmentType = "<environmentType>",
catalogName = "<catalogName>",
environmentDefinitionName = "<environmentDefinitionName>",
});
Operation<BinaryData> operation = client.CreateOrUpdateEnvironment(WaitUntil.Completed, "<projectName>", "<userId>", "<environmentName>", content);
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
]]></code>
This sample shows how to call CreateOrUpdateEnvironment with all parameters and request content and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
parameters = new
{
key = new object(),
},
environmentType = "<environmentType>",
catalogName = "<catalogName>",
environmentDefinitionName = "<environmentDefinitionName>",
});
Operation<BinaryData> operation = client.CreateOrUpdateEnvironment(WaitUntil.Completed, "<projectName>", "<userId>", "<environmentName>", content);
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("parameters").GetProperty("<key>").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("user").ToString());
Console.WriteLine(result.GetProperty("provisioningState").ToString());
Console.WriteLine(result.GetProperty("resourceGroupId").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="CreateOrUpdateEnvironmentAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<Azure.Developer.DevCenter.Models.DevCenterEnvironment>> CreateOrUpdateEnvironmentAsync (Azure.WaitUntil waitUntil, string projectName, string userId, Azure.Developer.DevCenter.Models.DevCenterEnvironment environment, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation`1<class Azure.Developer.DevCenter.Models.DevCenterEnvironment>> CreateOrUpdateEnvironmentAsync(valuetype Azure.WaitUntil waitUntil, string projectName, string userId, class Azure.Developer.DevCenter.Models.DevCenterEnvironment environment, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.CreateOrUpdateEnvironmentAsync(Azure.WaitUntil,System.String,System.String,Azure.Developer.DevCenter.Models.DevCenterEnvironment,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrUpdateEnvironmentAsync (waitUntil As WaitUntil, projectName As String, userId As String, environment As DevCenterEnvironment, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation(Of DevCenterEnvironment))" />
<MemberSignature Language="F#" Value="abstract member CreateOrUpdateEnvironmentAsync : Azure.WaitUntil * string * string * Azure.Developer.DevCenter.Models.DevCenterEnvironment * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.Developer.DevCenter.Models.DevCenterEnvironment>>
override this.CreateOrUpdateEnvironmentAsync : Azure.WaitUntil * string * string * Azure.Developer.DevCenter.Models.DevCenterEnvironment * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation<Azure.Developer.DevCenter.Models.DevCenterEnvironment>>" Usage="deploymentEnvironmentsClient.CreateOrUpdateEnvironmentAsync (waitUntil, projectName, userId, environment, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation<Azure.Developer.DevCenter.Models.DevCenterEnvironment>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="projectName" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="userId" Type="System.String" Index="2" FrameworkAlternate="azure-dotnet" />
<Parameter Name="environment" Type="Azure.Developer.DevCenter.Models.DevCenterEnvironment" Index="3" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="4" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="waitUntil">
<see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="userId"> The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. </param>
<param name="environment"> Represents an environment. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Creates or updates an environment. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" />, <paramref name="userId" /> or <paramref name="environment" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="userId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call CreateOrUpdateEnvironmentAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
DevCenterEnvironment environment = new DevCenterEnvironment("<environmentName>", "<environmentType>", "<catalogName>", "<environmentDefinitionName>");
Operation<DevCenterEnvironment> operation = await client.CreateOrUpdateEnvironmentAsync(WaitUntil.Completed, "<projectName>", "<userId>", environment);
DevCenterEnvironment responseData = operation.Value;
]]></code>
This sample shows how to call CreateOrUpdateEnvironmentAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
DevCenterEnvironment environment = new DevCenterEnvironment("<environmentName>", "<environmentType>", "<catalogName>", "<environmentDefinitionName>")
{
Parameters =
{
["key"] = BinaryData.FromObjectAsJson(new object())
},
};
Operation<DevCenterEnvironment> operation = await client.CreateOrUpdateEnvironmentAsync(WaitUntil.Completed, "<projectName>", "<userId>", environment);
DevCenterEnvironment responseData = operation.Value;
]]></code></example>
</Docs>
</Member>
<Member MemberName="CreateOrUpdateEnvironmentAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation<BinaryData>> CreateOrUpdateEnvironmentAsync (Azure.WaitUntil waitUntil, string projectName, string userId, string environmentName, Azure.Core.RequestContent content, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation`1<class System.BinaryData>> CreateOrUpdateEnvironmentAsync(valuetype Azure.WaitUntil waitUntil, string projectName, string userId, string environmentName, class Azure.Core.RequestContent content, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.CreateOrUpdateEnvironmentAsync(Azure.WaitUntil,System.String,System.String,System.String,Azure.Core.RequestContent,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function CreateOrUpdateEnvironmentAsync (waitUntil As WaitUntil, projectName As String, userId As String, environmentName As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Operation(Of BinaryData))" />
<MemberSignature Language="F#" Value="abstract member CreateOrUpdateEnvironmentAsync : Azure.WaitUntil * string * string * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>
override this.CreateOrUpdateEnvironmentAsync : Azure.WaitUntil * string * string * string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation<BinaryData>>" Usage="deploymentEnvironmentsClient.CreateOrUpdateEnvironmentAsync (waitUntil, projectName, userId, environmentName, content, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation<System.BinaryData>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="projectName" Type="System.String" />
<Parameter Name="userId" Type="System.String" />
<Parameter Name="environmentName" Type="System.String" />
<Parameter Name="content" Type="Azure.Core.RequestContent" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="waitUntil">
<see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="userId"> The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. </param>
<param name="environmentName"> The name of the environment. </param>
<param name="content"> The content to send as the body of the request. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Creates or updates an environment.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Operation" /> representing an asynchronous operation on the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" />, <paramref name="userId" />, <paramref name="environmentName" /> or <paramref name="content" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" />, <paramref name="userId" /> or <paramref name="environmentName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call CreateOrUpdateEnvironmentAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
environmentType = "<environmentType>",
catalogName = "<catalogName>",
environmentDefinitionName = "<environmentDefinitionName>",
});
Operation<BinaryData> operation = await client.CreateOrUpdateEnvironmentAsync(WaitUntil.Completed, "<projectName>", "<userId>", "<environmentName>", content);
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
]]></code>
This sample shows how to call CreateOrUpdateEnvironmentAsync with all parameters and request content and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
using RequestContent content = RequestContent.Create(new
{
parameters = new
{
key = new object(),
},
environmentType = "<environmentType>",
catalogName = "<catalogName>",
environmentDefinitionName = "<environmentDefinitionName>",
});
Operation<BinaryData> operation = await client.CreateOrUpdateEnvironmentAsync(WaitUntil.Completed, "<projectName>", "<userId>", "<environmentName>", content);
BinaryData responseData = operation.Value;
JsonElement result = JsonDocument.Parse(responseData.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("parameters").GetProperty("<key>").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("user").ToString());
Console.WriteLine(result.GetProperty("provisioningState").ToString());
Console.WriteLine(result.GetProperty("resourceGroupId").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="DeleteEnvironment">
<MemberSignature Language="C#" Value="public virtual Azure.Operation DeleteEnvironment (Azure.WaitUntil waitUntil, string projectName, string userId, string environmentName, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Operation DeleteEnvironment(valuetype Azure.WaitUntil waitUntil, string projectName, string userId, string environmentName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.DeleteEnvironment(Azure.WaitUntil,System.String,System.String,System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteEnvironment (waitUntil As WaitUntil, projectName As String, userId As String, environmentName As String, Optional context As RequestContext = Nothing) As Operation" />
<MemberSignature Language="F#" Value="abstract member DeleteEnvironment : Azure.WaitUntil * string * string * string * Azure.RequestContext -> Azure.Operation
override this.DeleteEnvironment : Azure.WaitUntil * string * string * string * Azure.RequestContext -> Azure.Operation" Usage="deploymentEnvironmentsClient.DeleteEnvironment (waitUntil, projectName, userId, environmentName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Operation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="projectName" Type="System.String" />
<Parameter Name="userId" Type="System.String" />
<Parameter Name="environmentName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="waitUntil">
<see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="userId"> The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. </param>
<param name="environmentName"> The name of the environment. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Deletes an environment and all its associated resources
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Operation" /> representing an asynchronous operation on the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" />, <paramref name="userId" /> or <paramref name="environmentName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" />, <paramref name="userId" /> or <paramref name="environmentName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call DeleteEnvironment.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Operation operation = client.DeleteEnvironment(WaitUntil.Completed, "<projectName>", "<userId>", "<environmentName>");
]]></code>
This sample shows how to call DeleteEnvironment with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Operation operation = client.DeleteEnvironment(WaitUntil.Completed, "<projectName>", "<userId>", "<environmentName>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="DeleteEnvironmentAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Operation> DeleteEnvironmentAsync (Azure.WaitUntil waitUntil, string projectName, string userId, string environmentName, Azure.RequestContext context = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Operation> DeleteEnvironmentAsync(valuetype Azure.WaitUntil waitUntil, string projectName, string userId, string environmentName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.DeleteEnvironmentAsync(Azure.WaitUntil,System.String,System.String,System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function DeleteEnvironmentAsync (waitUntil As WaitUntil, projectName As String, userId As String, environmentName As String, Optional context As RequestContext = Nothing) As Task(Of Operation)" />
<MemberSignature Language="F#" Value="abstract member DeleteEnvironmentAsync : Azure.WaitUntil * string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>
override this.DeleteEnvironmentAsync : Azure.WaitUntil * string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>" Usage="deploymentEnvironmentsClient.DeleteEnvironmentAsync (waitUntil, projectName, userId, environmentName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Operation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="projectName" Type="System.String" />
<Parameter Name="userId" Type="System.String" />
<Parameter Name="environmentName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="waitUntil">
<see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service; <see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation. For more information on long-running operations, please see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/LongRunningOperations.md"> Azure.Core Long-Running Operation samples</see>. </param>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="userId"> The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. </param>
<param name="environmentName"> The name of the environment. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Deletes an environment and all its associated resources
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Operation" /> representing an asynchronous operation on the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" />, <paramref name="userId" /> or <paramref name="environmentName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" />, <paramref name="userId" /> or <paramref name="environmentName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call DeleteEnvironmentAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Operation operation = await client.DeleteEnvironmentAsync(WaitUntil.Completed, "<projectName>", "<userId>", "<environmentName>");
]]></code>
This sample shows how to call DeleteEnvironmentAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Operation operation = await client.DeleteEnvironmentAsync(WaitUntil.Completed, "<projectName>", "<userId>", "<environmentName>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAllEnvironments">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetAllEnvironments (string projectName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetAllEnvironments(string projectName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetAllEnvironments(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAllEnvironments (projectName As String, context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetAllEnvironments : string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetAllEnvironments : string * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetAllEnvironments (projectName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="context" Type="Azure.RequestContext" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists the environments for a project.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetAllEnvironments(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetAllEnvironments and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetAllEnvironments("<projectName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
}
]]></code>
This sample shows how to call GetAllEnvironments with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetAllEnvironments("<projectName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("parameters").GetProperty("<key>").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("user").ToString());
Console.WriteLine(result.GetProperty("provisioningState").ToString());
Console.WriteLine(result.GetProperty("resourceGroupId").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAllEnvironments">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.Developer.DevCenter.Models.DevCenterEnvironment> GetAllEnvironments (string projectName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.Developer.DevCenter.Models.DevCenterEnvironment> GetAllEnvironments(string projectName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetAllEnvironments(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAllEnvironments (projectName As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of DevCenterEnvironment)" />
<MemberSignature Language="F#" Value="abstract member GetAllEnvironments : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Developer.DevCenter.Models.DevCenterEnvironment>
override this.GetAllEnvironments : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Developer.DevCenter.Models.DevCenterEnvironment>" Usage="deploymentEnvironmentsClient.GetAllEnvironments (projectName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.Developer.DevCenter.Models.DevCenterEnvironment></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Lists the environments for a project. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetAllEnvironments.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (DevCenterEnvironment item in client.GetAllEnvironments("<projectName>"))
{
}
]]></code>
This sample shows how to call GetAllEnvironments with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (DevCenterEnvironment item in client.GetAllEnvironments("<projectName>"))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAllEnvironments">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetAllEnvironments (string projectName, int? maxCount, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetAllEnvironments(string projectName, valuetype System.Nullable`1<int32> maxCount, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetAllEnvironments(System.String,System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAllEnvironments (projectName As String, maxCount As Nullable(Of Integer), context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetAllEnvironments : string * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetAllEnvironments : string * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetAllEnvironments (projectName, maxCount, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxCount" Type="System.Nullable<System.Int32>" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="maxCount"> The maximum number of resources to return from the operation. Example: 'top=10'. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists the environments for a project.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetAllEnvironments and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetAllEnvironments("<projectName>", null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
}
]]></code>
This sample shows how to call GetAllEnvironments with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetAllEnvironments("<projectName>", 1234, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("parameters").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("user").ToString());
Console.WriteLine(result.GetProperty("provisioningState").ToString());
Console.WriteLine(result.GetProperty("resourceGroupId").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAllEnvironmentsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetAllEnvironmentsAsync (string projectName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetAllEnvironmentsAsync(string projectName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetAllEnvironmentsAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAllEnvironmentsAsync (projectName As String, context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetAllEnvironmentsAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetAllEnvironmentsAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetAllEnvironmentsAsync (projectName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="context" Type="Azure.RequestContext" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists the environments for a project.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetAllEnvironmentsAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetAllEnvironmentsAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetAllEnvironmentsAsync("<projectName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
}
]]></code>
This sample shows how to call GetAllEnvironmentsAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetAllEnvironmentsAsync("<projectName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("parameters").GetProperty("<key>").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("user").ToString());
Console.WriteLine(result.GetProperty("provisioningState").ToString());
Console.WriteLine(result.GetProperty("resourceGroupId").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAllEnvironmentsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevCenterEnvironment> GetAllEnvironmentsAsync (string projectName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.Developer.DevCenter.Models.DevCenterEnvironment> GetAllEnvironmentsAsync(string projectName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetAllEnvironmentsAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAllEnvironmentsAsync (projectName As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of DevCenterEnvironment)" />
<MemberSignature Language="F#" Value="abstract member GetAllEnvironmentsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevCenterEnvironment>
override this.GetAllEnvironmentsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevCenterEnvironment>" Usage="deploymentEnvironmentsClient.GetAllEnvironmentsAsync (projectName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevCenterEnvironment></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Lists the environments for a project. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetAllEnvironmentsAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (DevCenterEnvironment item in client.GetAllEnvironmentsAsync("<projectName>"))
{
}
]]></code>
This sample shows how to call GetAllEnvironmentsAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (DevCenterEnvironment item in client.GetAllEnvironmentsAsync("<projectName>"))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetAllEnvironmentsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetAllEnvironmentsAsync (string projectName, int? maxCount, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetAllEnvironmentsAsync(string projectName, valuetype System.Nullable`1<int32> maxCount, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetAllEnvironmentsAsync(System.String,System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetAllEnvironmentsAsync (projectName As String, maxCount As Nullable(Of Integer), context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetAllEnvironmentsAsync : string * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetAllEnvironmentsAsync : string * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetAllEnvironmentsAsync (projectName, maxCount, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxCount" Type="System.Nullable<System.Int32>" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="maxCount"> The maximum number of resources to return from the operation. Example: 'top=10'. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists the environments for a project.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetAllEnvironmentsAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetAllEnvironmentsAsync("<projectName>", null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
}
]]></code>
This sample shows how to call GetAllEnvironmentsAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetAllEnvironmentsAsync("<projectName>", 1234, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("parameters").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("user").ToString());
Console.WriteLine(result.GetProperty("provisioningState").ToString());
Console.WriteLine(result.GetProperty("resourceGroupId").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetCatalog">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetCatalog (string projectName, string catalogName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetCatalog(string projectName, string catalogName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetCatalog(System.String,System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetCatalog (projectName As String, catalogName As String, context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member GetCatalog : string * string * Azure.RequestContext -> Azure.Response
override this.GetCatalog : string * string * Azure.RequestContext -> Azure.Response" Usage="deploymentEnvironmentsClient.GetCatalog (projectName, catalogName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" />
<Parameter Name="catalogName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="projectName"> Name of the project. </param>
<param name="catalogName"> Name of the catalog. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Gets the specified catalog within the project
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetCatalog(System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetCatalog and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response response = client.GetCatalog("<projectName>", "<catalogName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
]]></code>
This sample shows how to call GetCatalog with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response response = client.GetCatalog("<projectName>", "<catalogName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetCatalog">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Developer.DevCenter.Models.DevCenterCatalog> GetCatalog (string projectName, string catalogName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Developer.DevCenter.Models.DevCenterCatalog> GetCatalog(string projectName, string catalogName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetCatalog(System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetCatalog (projectName As String, catalogName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DevCenterCatalog)" />
<MemberSignature Language="F#" Value="abstract member GetCatalog : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Developer.DevCenter.Models.DevCenterCatalog>
override this.GetCatalog : string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Developer.DevCenter.Models.DevCenterCatalog>" Usage="deploymentEnvironmentsClient.GetCatalog (projectName, catalogName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Developer.DevCenter.Models.DevCenterCatalog></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="catalogName" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> Name of the project. </param>
<param name="catalogName"> Name of the catalog. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Gets the specified catalog within the project. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetCatalog.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response<DevCenterCatalog> response = client.GetCatalog("<projectName>", "<catalogName>");
]]></code>
This sample shows how to call GetCatalog with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response<DevCenterCatalog> response = client.GetCatalog("<projectName>", "<catalogName>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetCatalogAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetCatalogAsync (string projectName, string catalogName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetCatalogAsync(string projectName, string catalogName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetCatalogAsync(System.String,System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetCatalogAsync (projectName As String, catalogName As String, context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetCatalogAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetCatalogAsync : string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="deploymentEnvironmentsClient.GetCatalogAsync (projectName, catalogName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" />
<Parameter Name="catalogName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="projectName"> Name of the project. </param>
<param name="catalogName"> Name of the catalog. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Gets the specified catalog within the project
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetCatalogAsync(System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetCatalogAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response response = await client.GetCatalogAsync("<projectName>", "<catalogName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
]]></code>
This sample shows how to call GetCatalogAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response response = await client.GetCatalogAsync("<projectName>", "<catalogName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetCatalogAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Developer.DevCenter.Models.DevCenterCatalog>> GetCatalogAsync (string projectName, string catalogName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Developer.DevCenter.Models.DevCenterCatalog>> GetCatalogAsync(string projectName, string catalogName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetCatalogAsync(System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetCatalogAsync (projectName As String, catalogName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DevCenterCatalog))" />
<MemberSignature Language="F#" Value="abstract member GetCatalogAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Developer.DevCenter.Models.DevCenterCatalog>>
override this.GetCatalogAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Developer.DevCenter.Models.DevCenterCatalog>>" Usage="deploymentEnvironmentsClient.GetCatalogAsync (projectName, catalogName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Developer.DevCenter.Models.DevCenterCatalog>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="catalogName" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> Name of the project. </param>
<param name="catalogName"> Name of the catalog. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Gets the specified catalog within the project. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetCatalogAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response<DevCenterCatalog> response = await client.GetCatalogAsync("<projectName>", "<catalogName>");
]]></code>
This sample shows how to call GetCatalogAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response<DevCenterCatalog> response = await client.GetCatalogAsync("<projectName>", "<catalogName>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetCatalogs">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetCatalogs (string projectName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetCatalogs(string projectName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetCatalogs(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetCatalogs (projectName As String, context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetCatalogs : string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetCatalogs : string * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetCatalogs (projectName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="context" Type="Azure.RequestContext" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> Name of the project. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists all of the catalogs available for a project.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetCatalogs(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetCatalogs and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetCatalogs("<projectName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
}
]]></code>
This sample shows how to call GetCatalogs with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetCatalogs("<projectName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetCatalogs">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.Developer.DevCenter.Models.DevCenterCatalog> GetCatalogs (string projectName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.Developer.DevCenter.Models.DevCenterCatalog> GetCatalogs(string projectName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetCatalogs(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetCatalogs (projectName As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of DevCenterCatalog)" />
<MemberSignature Language="F#" Value="abstract member GetCatalogs : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Developer.DevCenter.Models.DevCenterCatalog>
override this.GetCatalogs : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Developer.DevCenter.Models.DevCenterCatalog>" Usage="deploymentEnvironmentsClient.GetCatalogs (projectName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.Developer.DevCenter.Models.DevCenterCatalog></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> Name of the project. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Lists all of the catalogs available for a project. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetCatalogs.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (DevCenterCatalog item in client.GetCatalogs("<projectName>"))
{
}
]]></code>
This sample shows how to call GetCatalogs with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (DevCenterCatalog item in client.GetCatalogs("<projectName>"))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetCatalogs">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetCatalogs (string projectName, int? maxCount, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetCatalogs(string projectName, valuetype System.Nullable`1<int32> maxCount, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetCatalogs(System.String,System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetCatalogs (projectName As String, maxCount As Nullable(Of Integer), context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetCatalogs : string * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetCatalogs : string * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetCatalogs (projectName, maxCount, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxCount" Type="System.Nullable<System.Int32>" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="maxCount"> The maximum number of resources to return from the operation. Example: 'top=10'. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists all of the catalogs available for a project.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetCatalogs and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetCatalogs("<projectName>", null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
}
]]></code>
This sample shows how to call GetCatalogs with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetCatalogs("<projectName>", 1234, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetCatalogsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetCatalogsAsync (string projectName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetCatalogsAsync(string projectName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetCatalogsAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetCatalogsAsync (projectName As String, context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetCatalogsAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetCatalogsAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetCatalogsAsync (projectName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="context" Type="Azure.RequestContext" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> Name of the project. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists all of the catalogs available for a project.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetCatalogsAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetCatalogsAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetCatalogsAsync("<projectName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
}
]]></code>
This sample shows how to call GetCatalogsAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetCatalogsAsync("<projectName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetCatalogsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevCenterCatalog> GetCatalogsAsync (string projectName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.Developer.DevCenter.Models.DevCenterCatalog> GetCatalogsAsync(string projectName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetCatalogsAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetCatalogsAsync (projectName As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of DevCenterCatalog)" />
<MemberSignature Language="F#" Value="abstract member GetCatalogsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevCenterCatalog>
override this.GetCatalogsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevCenterCatalog>" Usage="deploymentEnvironmentsClient.GetCatalogsAsync (projectName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevCenterCatalog></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> Name of the project. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Lists all of the catalogs available for a project. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetCatalogsAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (DevCenterCatalog item in client.GetCatalogsAsync("<projectName>"))
{
}
]]></code>
This sample shows how to call GetCatalogsAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (DevCenterCatalog item in client.GetCatalogsAsync("<projectName>"))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetCatalogsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetCatalogsAsync (string projectName, int? maxCount, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetCatalogsAsync(string projectName, valuetype System.Nullable`1<int32> maxCount, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetCatalogsAsync(System.String,System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetCatalogsAsync (projectName As String, maxCount As Nullable(Of Integer), context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetCatalogsAsync : string * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetCatalogsAsync : string * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetCatalogsAsync (projectName, maxCount, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxCount" Type="System.Nullable<System.Int32>" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="maxCount"> The maximum number of resources to return from the operation. Example: 'top=10'. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists all of the catalogs available for a project.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetCatalogsAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetCatalogsAsync("<projectName>", null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
}
]]></code>
This sample shows how to call GetCatalogsAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetCatalogsAsync("<projectName>", 1234, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironment">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetEnvironment (string projectName, string userId, string environmentName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetEnvironment(string projectName, string userId, string environmentName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironment(System.String,System.String,System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironment (projectName As String, userId As String, environmentName As String, context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member GetEnvironment : string * string * string * Azure.RequestContext -> Azure.Response
override this.GetEnvironment : string * string * string * Azure.RequestContext -> Azure.Response" Usage="deploymentEnvironmentsClient.GetEnvironment (projectName, userId, environmentName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" />
<Parameter Name="userId" Type="System.String" />
<Parameter Name="environmentName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="projectName"> Name of the project. </param>
<param name="userId"> The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. </param>
<param name="environmentName"> Environment name. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Gets an environment
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironment(System.String,System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" />, <paramref name="userId" /> or <paramref name="environmentName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" />, <paramref name="userId" /> or <paramref name="environmentName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironment and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response response = client.GetEnvironment("<projectName>", "<userId>", "<environmentName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
]]></code>
This sample shows how to call GetEnvironment with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response response = client.GetEnvironment("<projectName>", "<userId>", "<environmentName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("parameters").GetProperty("<key>").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("user").ToString());
Console.WriteLine(result.GetProperty("provisioningState").ToString());
Console.WriteLine(result.GetProperty("resourceGroupId").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironment">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Developer.DevCenter.Models.DevCenterEnvironment> GetEnvironment (string projectName, string userId, string environmentName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Developer.DevCenter.Models.DevCenterEnvironment> GetEnvironment(string projectName, string userId, string environmentName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironment(System.String,System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironment (projectName As String, userId As String, environmentName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of DevCenterEnvironment)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironment : string * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Developer.DevCenter.Models.DevCenterEnvironment>
override this.GetEnvironment : string * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Developer.DevCenter.Models.DevCenterEnvironment>" Usage="deploymentEnvironmentsClient.GetEnvironment (projectName, userId, environmentName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Developer.DevCenter.Models.DevCenterEnvironment></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="userId" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="environmentName" Type="System.String" Index="2" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> Name of the project. </param>
<param name="userId"> The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. </param>
<param name="environmentName"> Environment name. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Gets an environment. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" />, <paramref name="userId" /> or <paramref name="environmentName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" />, <paramref name="userId" /> or <paramref name="environmentName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetEnvironment.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response<DevCenterEnvironment> response = client.GetEnvironment("<projectName>", "<userId>", "<environmentName>");
]]></code>
This sample shows how to call GetEnvironment with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response<DevCenterEnvironment> response = client.GetEnvironment("<projectName>", "<userId>", "<environmentName>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetEnvironmentAsync (string projectName, string userId, string environmentName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetEnvironmentAsync(string projectName, string userId, string environmentName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentAsync(System.String,System.String,System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentAsync (projectName As String, userId As String, environmentName As String, context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentAsync : string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetEnvironmentAsync : string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="deploymentEnvironmentsClient.GetEnvironmentAsync (projectName, userId, environmentName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" />
<Parameter Name="userId" Type="System.String" />
<Parameter Name="environmentName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="projectName"> Name of the project. </param>
<param name="userId"> The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. </param>
<param name="environmentName"> Environment name. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Gets an environment
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentAsync(System.String,System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" />, <paramref name="userId" /> or <paramref name="environmentName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" />, <paramref name="userId" /> or <paramref name="environmentName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironmentAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response response = await client.GetEnvironmentAsync("<projectName>", "<userId>", "<environmentName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
]]></code>
This sample shows how to call GetEnvironmentAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response response = await client.GetEnvironmentAsync("<projectName>", "<userId>", "<environmentName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("parameters").GetProperty("<key>").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("user").ToString());
Console.WriteLine(result.GetProperty("provisioningState").ToString());
Console.WriteLine(result.GetProperty("resourceGroupId").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Developer.DevCenter.Models.DevCenterEnvironment>> GetEnvironmentAsync (string projectName, string userId, string environmentName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Developer.DevCenter.Models.DevCenterEnvironment>> GetEnvironmentAsync(string projectName, string userId, string environmentName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentAsync(System.String,System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentAsync (projectName As String, userId As String, environmentName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of DevCenterEnvironment))" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentAsync : string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Developer.DevCenter.Models.DevCenterEnvironment>>
override this.GetEnvironmentAsync : string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Developer.DevCenter.Models.DevCenterEnvironment>>" Usage="deploymentEnvironmentsClient.GetEnvironmentAsync (projectName, userId, environmentName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Developer.DevCenter.Models.DevCenterEnvironment>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="userId" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="environmentName" Type="System.String" Index="2" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> Name of the project. </param>
<param name="userId"> The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. </param>
<param name="environmentName"> Environment name. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Gets an environment. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" />, <paramref name="userId" /> or <paramref name="environmentName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" />, <paramref name="userId" /> or <paramref name="environmentName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetEnvironmentAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response<DevCenterEnvironment> response = await client.GetEnvironmentAsync("<projectName>", "<userId>", "<environmentName>");
]]></code>
This sample shows how to call GetEnvironmentAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response<DevCenterEnvironment> response = await client.GetEnvironmentAsync("<projectName>", "<userId>", "<environmentName>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentDefinition">
<MemberSignature Language="C#" Value="public virtual Azure.Response GetEnvironmentDefinition (string projectName, string catalogName, string definitionName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response GetEnvironmentDefinition(string projectName, string catalogName, string definitionName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinition(System.String,System.String,System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentDefinition (projectName As String, catalogName As String, definitionName As String, context As RequestContext) As Response" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentDefinition : string * string * string * Azure.RequestContext -> Azure.Response
override this.GetEnvironmentDefinition : string * string * string * Azure.RequestContext -> Azure.Response" Usage="deploymentEnvironmentsClient.GetEnvironmentDefinition (projectName, catalogName, definitionName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" />
<Parameter Name="catalogName" Type="System.String" />
<Parameter Name="definitionName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="projectName"> Name of the project. </param>
<param name="catalogName"> Name of the catalog. </param>
<param name="definitionName"> Name of the environment definition. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Get an environment definition from a catalog.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinition(System.String,System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" />, <paramref name="catalogName" /> or <paramref name="definitionName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" />, <paramref name="catalogName" /> or <paramref name="definitionName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironmentDefinition and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response response = client.GetEnvironmentDefinition("<projectName>", "<catalogName>", "<definitionName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
]]></code>
This sample shows how to call GetEnvironmentDefinition with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response response = client.GetEnvironmentDefinition("<projectName>", "<catalogName>", "<definitionName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("default").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("type").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("readOnly").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("required").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("allowed")[0].ToString());
Console.WriteLine(result.GetProperty("parametersSchema").ToString());
Console.WriteLine(result.GetProperty("templatePath").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentDefinition">
<MemberSignature Language="C#" Value="public virtual Azure.Response<Azure.Developer.DevCenter.Models.EnvironmentDefinition> GetEnvironmentDefinition (string projectName, string catalogName, string definitionName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Response`1<class Azure.Developer.DevCenter.Models.EnvironmentDefinition> GetEnvironmentDefinition(string projectName, string catalogName, string definitionName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinition(System.String,System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentDefinition (projectName As String, catalogName As String, definitionName As String, Optional cancellationToken As CancellationToken = Nothing) As Response(Of EnvironmentDefinition)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentDefinition : string * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Developer.DevCenter.Models.EnvironmentDefinition>
override this.GetEnvironmentDefinition : string * string * string * System.Threading.CancellationToken -> Azure.Response<Azure.Developer.DevCenter.Models.EnvironmentDefinition>" Usage="deploymentEnvironmentsClient.GetEnvironmentDefinition (projectName, catalogName, definitionName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response<Azure.Developer.DevCenter.Models.EnvironmentDefinition></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="catalogName" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="definitionName" Type="System.String" Index="2" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> Name of the project. </param>
<param name="catalogName"> Name of the catalog. </param>
<param name="definitionName"> Name of the environment definition. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Get an environment definition from a catalog. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" />, <paramref name="catalogName" /> or <paramref name="definitionName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" />, <paramref name="catalogName" /> or <paramref name="definitionName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetEnvironmentDefinition.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response<EnvironmentDefinition> response = client.GetEnvironmentDefinition("<projectName>", "<catalogName>", "<definitionName>");
]]></code>
This sample shows how to call GetEnvironmentDefinition with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response<EnvironmentDefinition> response = client.GetEnvironmentDefinition("<projectName>", "<catalogName>", "<definitionName>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentDefinitionAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response> GetEnvironmentDefinitionAsync (string projectName, string catalogName, string definitionName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response> GetEnvironmentDefinitionAsync(string projectName, string catalogName, string definitionName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitionAsync(System.String,System.String,System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentDefinitionAsync (projectName As String, catalogName As String, definitionName As String, context As RequestContext) As Task(Of Response)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentDefinitionAsync : string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.GetEnvironmentDefinitionAsync : string * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>" Usage="deploymentEnvironmentsClient.GetEnvironmentDefinitionAsync (projectName, catalogName, definitionName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" />
<Parameter Name="catalogName" Type="System.String" />
<Parameter Name="definitionName" Type="System.String" />
<Parameter Name="context" Type="Azure.RequestContext" />
</Parameters>
<Docs>
<param name="projectName"> Name of the project. </param>
<param name="catalogName"> Name of the catalog. </param>
<param name="definitionName"> Name of the environment definition. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Get an environment definition from a catalog.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitionAsync(System.String,System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The response returned from the service. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" />, <paramref name="catalogName" /> or <paramref name="definitionName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" />, <paramref name="catalogName" /> or <paramref name="definitionName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironmentDefinitionAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response response = await client.GetEnvironmentDefinitionAsync("<projectName>", "<catalogName>", "<definitionName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
]]></code>
This sample shows how to call GetEnvironmentDefinitionAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response response = await client.GetEnvironmentDefinitionAsync("<projectName>", "<catalogName>", "<definitionName>", null);
JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("default").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("type").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("readOnly").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("required").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("allowed")[0].ToString());
Console.WriteLine(result.GetProperty("parametersSchema").ToString());
Console.WriteLine(result.GetProperty("templatePath").ToString());
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentDefinitionAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Developer.DevCenter.Models.EnvironmentDefinition>> GetEnvironmentDefinitionAsync (string projectName, string catalogName, string definitionName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.Response`1<class Azure.Developer.DevCenter.Models.EnvironmentDefinition>> GetEnvironmentDefinitionAsync(string projectName, string catalogName, string definitionName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitionAsync(System.String,System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentDefinitionAsync (projectName As String, catalogName As String, definitionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of EnvironmentDefinition))" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentDefinitionAsync : string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Developer.DevCenter.Models.EnvironmentDefinition>>
override this.GetEnvironmentDefinitionAsync : string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Developer.DevCenter.Models.EnvironmentDefinition>>" Usage="deploymentEnvironmentsClient.GetEnvironmentDefinitionAsync (projectName, catalogName, definitionName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.Response<Azure.Developer.DevCenter.Models.EnvironmentDefinition>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="catalogName" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="definitionName" Type="System.String" Index="2" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="3" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> Name of the project. </param>
<param name="catalogName"> Name of the catalog. </param>
<param name="definitionName"> Name of the environment definition. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Get an environment definition from a catalog. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" />, <paramref name="catalogName" /> or <paramref name="definitionName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" />, <paramref name="catalogName" /> or <paramref name="definitionName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetEnvironmentDefinitionAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response<EnvironmentDefinition> response = await client.GetEnvironmentDefinitionAsync("<projectName>", "<catalogName>", "<definitionName>");
]]></code>
This sample shows how to call GetEnvironmentDefinitionAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
Response<EnvironmentDefinition> response = await client.GetEnvironmentDefinitionAsync("<projectName>", "<catalogName>", "<definitionName>");
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentDefinitions">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetEnvironmentDefinitions (string projectName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetEnvironmentDefinitions(string projectName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitions(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentDefinitions (projectName As String, context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentDefinitions : string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetEnvironmentDefinitions : string * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetEnvironmentDefinitions (projectName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="context" Type="Azure.RequestContext" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists all environment definitions available for a project.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitions(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironmentDefinitions and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetEnvironmentDefinitions("<projectName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
}
]]></code>
This sample shows how to call GetEnvironmentDefinitions with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetEnvironmentDefinitions("<projectName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("default").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("type").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("readOnly").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("required").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("allowed")[0].ToString());
Console.WriteLine(result.GetProperty("parametersSchema").ToString());
Console.WriteLine(result.GetProperty("templatePath").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentDefinitions">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.Developer.DevCenter.Models.EnvironmentDefinition> GetEnvironmentDefinitions (string projectName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.Developer.DevCenter.Models.EnvironmentDefinition> GetEnvironmentDefinitions(string projectName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitions(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentDefinitions (projectName As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of EnvironmentDefinition)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentDefinitions : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Developer.DevCenter.Models.EnvironmentDefinition>
override this.GetEnvironmentDefinitions : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Developer.DevCenter.Models.EnvironmentDefinition>" Usage="deploymentEnvironmentsClient.GetEnvironmentDefinitions (projectName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.Developer.DevCenter.Models.EnvironmentDefinition></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Lists all environment definitions available for a project. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetEnvironmentDefinitions.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (EnvironmentDefinition item in client.GetEnvironmentDefinitions("<projectName>"))
{
}
]]></code>
This sample shows how to call GetEnvironmentDefinitions with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (EnvironmentDefinition item in client.GetEnvironmentDefinitions("<projectName>"))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentDefinitions">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetEnvironmentDefinitions (string projectName, int? maxCount, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetEnvironmentDefinitions(string projectName, valuetype System.Nullable`1<int32> maxCount, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitions(System.String,System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentDefinitions (projectName As String, maxCount As Nullable(Of Integer), context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentDefinitions : string * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetEnvironmentDefinitions : string * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetEnvironmentDefinitions (projectName, maxCount, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxCount" Type="System.Nullable<System.Int32>" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="maxCount"> The maximum number of resources to return from the operation. Example: 'top=10'. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists all environment definitions available for a project.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironmentDefinitions and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetEnvironmentDefinitions("<projectName>", null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
}
]]></code>
This sample shows how to call GetEnvironmentDefinitions with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetEnvironmentDefinitions("<projectName>", 1234, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("default").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("type").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("readOnly").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("required").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("allowed")[0].ToString());
Console.WriteLine(result.GetProperty("parametersSchema").ToString());
Console.WriteLine(result.GetProperty("templatePath").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentDefinitionsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetEnvironmentDefinitionsAsync (string projectName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetEnvironmentDefinitionsAsync(string projectName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitionsAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentDefinitionsAsync (projectName As String, context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentDefinitionsAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetEnvironmentDefinitionsAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetEnvironmentDefinitionsAsync (projectName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="context" Type="Azure.RequestContext" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists all environment definitions available for a project.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitionsAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironmentDefinitionsAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetEnvironmentDefinitionsAsync("<projectName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
}
]]></code>
This sample shows how to call GetEnvironmentDefinitionsAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetEnvironmentDefinitionsAsync("<projectName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("default").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("type").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("readOnly").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("required").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("allowed")[0].ToString());
Console.WriteLine(result.GetProperty("parametersSchema").ToString());
Console.WriteLine(result.GetProperty("templatePath").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentDefinitionsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.Developer.DevCenter.Models.EnvironmentDefinition> GetEnvironmentDefinitionsAsync (string projectName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.Developer.DevCenter.Models.EnvironmentDefinition> GetEnvironmentDefinitionsAsync(string projectName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitionsAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentDefinitionsAsync (projectName As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of EnvironmentDefinition)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentDefinitionsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Developer.DevCenter.Models.EnvironmentDefinition>
override this.GetEnvironmentDefinitionsAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Developer.DevCenter.Models.EnvironmentDefinition>" Usage="deploymentEnvironmentsClient.GetEnvironmentDefinitionsAsync (projectName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.Developer.DevCenter.Models.EnvironmentDefinition></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Lists all environment definitions available for a project. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetEnvironmentDefinitionsAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (EnvironmentDefinition item in client.GetEnvironmentDefinitionsAsync("<projectName>"))
{
}
]]></code>
This sample shows how to call GetEnvironmentDefinitionsAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (EnvironmentDefinition item in client.GetEnvironmentDefinitionsAsync("<projectName>"))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentDefinitionsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetEnvironmentDefinitionsAsync (string projectName, int? maxCount, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetEnvironmentDefinitionsAsync(string projectName, valuetype System.Nullable`1<int32> maxCount, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitionsAsync(System.String,System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentDefinitionsAsync (projectName As String, maxCount As Nullable(Of Integer), context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentDefinitionsAsync : string * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetEnvironmentDefinitionsAsync : string * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetEnvironmentDefinitionsAsync (projectName, maxCount, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxCount" Type="System.Nullable<System.Int32>" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="maxCount"> The maximum number of resources to return from the operation. Example: 'top=10'. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists all environment definitions available for a project.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironmentDefinitionsAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetEnvironmentDefinitionsAsync("<projectName>", null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
}
]]></code>
This sample shows how to call GetEnvironmentDefinitionsAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetEnvironmentDefinitionsAsync("<projectName>", 1234, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("default").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("type").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("readOnly").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("required").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("allowed")[0].ToString());
Console.WriteLine(result.GetProperty("parametersSchema").ToString());
Console.WriteLine(result.GetProperty("templatePath").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentDefinitionsByCatalog">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetEnvironmentDefinitionsByCatalog (string projectName, string catalogName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetEnvironmentDefinitionsByCatalog(string projectName, string catalogName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitionsByCatalog(System.String,System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentDefinitionsByCatalog (projectName As String, catalogName As String, context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentDefinitionsByCatalog : string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetEnvironmentDefinitionsByCatalog : string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetEnvironmentDefinitionsByCatalog (projectName, catalogName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="catalogName" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="catalogName"> The name of the catalog. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists all environment definitions available within a catalog.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitionsByCatalog(System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironmentDefinitionsByCatalog and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetEnvironmentDefinitionsByCatalog("<projectName>", "<catalogName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
}
]]></code>
This sample shows how to call GetEnvironmentDefinitionsByCatalog with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetEnvironmentDefinitionsByCatalog("<projectName>", "<catalogName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("default").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("type").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("readOnly").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("required").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("allowed")[0].ToString());
Console.WriteLine(result.GetProperty("parametersSchema").ToString());
Console.WriteLine(result.GetProperty("templatePath").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentDefinitionsByCatalog">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.Developer.DevCenter.Models.EnvironmentDefinition> GetEnvironmentDefinitionsByCatalog (string projectName, string catalogName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.Developer.DevCenter.Models.EnvironmentDefinition> GetEnvironmentDefinitionsByCatalog(string projectName, string catalogName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitionsByCatalog(System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentDefinitionsByCatalog (projectName As String, catalogName As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of EnvironmentDefinition)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentDefinitionsByCatalog : string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Developer.DevCenter.Models.EnvironmentDefinition>
override this.GetEnvironmentDefinitionsByCatalog : string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Developer.DevCenter.Models.EnvironmentDefinition>" Usage="deploymentEnvironmentsClient.GetEnvironmentDefinitionsByCatalog (projectName, catalogName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.Developer.DevCenter.Models.EnvironmentDefinition></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="catalogName" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="catalogName"> The name of the catalog. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Lists all environment definitions available within a catalog. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetEnvironmentDefinitionsByCatalog.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (EnvironmentDefinition item in client.GetEnvironmentDefinitionsByCatalog("<projectName>", "<catalogName>"))
{
}
]]></code>
This sample shows how to call GetEnvironmentDefinitionsByCatalog with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (EnvironmentDefinition item in client.GetEnvironmentDefinitionsByCatalog("<projectName>", "<catalogName>"))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentDefinitionsByCatalog">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetEnvironmentDefinitionsByCatalog (string projectName, string catalogName, int? maxCount, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetEnvironmentDefinitionsByCatalog(string projectName, string catalogName, valuetype System.Nullable`1<int32> maxCount, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitionsByCatalog(System.String,System.String,System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentDefinitionsByCatalog (projectName As String, catalogName As String, maxCount As Nullable(Of Integer), context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentDefinitionsByCatalog : string * string * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetEnvironmentDefinitionsByCatalog : string * string * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetEnvironmentDefinitionsByCatalog (projectName, catalogName, maxCount, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="catalogName" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxCount" Type="System.Nullable<System.Int32>" Index="2" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="3" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="catalogName"> The name of the catalog. </param>
<param name="maxCount"> The maximum number of resources to return from the operation. Example: 'top=10'. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists all environment definitions available within a catalog.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironmentDefinitionsByCatalog and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetEnvironmentDefinitionsByCatalog("<projectName>", "<catalogName>", null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
}
]]></code>
This sample shows how to call GetEnvironmentDefinitionsByCatalog with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetEnvironmentDefinitionsByCatalog("<projectName>", "<catalogName>", 1234, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("default").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("type").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("readOnly").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("required").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("allowed")[0].ToString());
Console.WriteLine(result.GetProperty("parametersSchema").ToString());
Console.WriteLine(result.GetProperty("templatePath").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentDefinitionsByCatalogAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetEnvironmentDefinitionsByCatalogAsync (string projectName, string catalogName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetEnvironmentDefinitionsByCatalogAsync(string projectName, string catalogName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitionsByCatalogAsync(System.String,System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentDefinitionsByCatalogAsync (projectName As String, catalogName As String, context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentDefinitionsByCatalogAsync : string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetEnvironmentDefinitionsByCatalogAsync : string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetEnvironmentDefinitionsByCatalogAsync (projectName, catalogName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="catalogName" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="catalogName"> The name of the catalog. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists all environment definitions available within a catalog.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitionsByCatalogAsync(System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironmentDefinitionsByCatalogAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetEnvironmentDefinitionsByCatalogAsync("<projectName>", "<catalogName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
}
]]></code>
This sample shows how to call GetEnvironmentDefinitionsByCatalogAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetEnvironmentDefinitionsByCatalogAsync("<projectName>", "<catalogName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("default").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("type").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("readOnly").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("required").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("allowed")[0].ToString());
Console.WriteLine(result.GetProperty("parametersSchema").ToString());
Console.WriteLine(result.GetProperty("templatePath").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentDefinitionsByCatalogAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.Developer.DevCenter.Models.EnvironmentDefinition> GetEnvironmentDefinitionsByCatalogAsync (string projectName, string catalogName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.Developer.DevCenter.Models.EnvironmentDefinition> GetEnvironmentDefinitionsByCatalogAsync(string projectName, string catalogName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitionsByCatalogAsync(System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentDefinitionsByCatalogAsync (projectName As String, catalogName As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of EnvironmentDefinition)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentDefinitionsByCatalogAsync : string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Developer.DevCenter.Models.EnvironmentDefinition>
override this.GetEnvironmentDefinitionsByCatalogAsync : string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Developer.DevCenter.Models.EnvironmentDefinition>" Usage="deploymentEnvironmentsClient.GetEnvironmentDefinitionsByCatalogAsync (projectName, catalogName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.Developer.DevCenter.Models.EnvironmentDefinition></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="catalogName" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="catalogName"> The name of the catalog. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Lists all environment definitions available within a catalog. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetEnvironmentDefinitionsByCatalogAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (EnvironmentDefinition item in client.GetEnvironmentDefinitionsByCatalogAsync("<projectName>", "<catalogName>"))
{
}
]]></code>
This sample shows how to call GetEnvironmentDefinitionsByCatalogAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (EnvironmentDefinition item in client.GetEnvironmentDefinitionsByCatalogAsync("<projectName>", "<catalogName>"))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentDefinitionsByCatalogAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetEnvironmentDefinitionsByCatalogAsync (string projectName, string catalogName, int? maxCount, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetEnvironmentDefinitionsByCatalogAsync(string projectName, string catalogName, valuetype System.Nullable`1<int32> maxCount, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentDefinitionsByCatalogAsync(System.String,System.String,System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentDefinitionsByCatalogAsync (projectName As String, catalogName As String, maxCount As Nullable(Of Integer), context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentDefinitionsByCatalogAsync : string * string * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetEnvironmentDefinitionsByCatalogAsync : string * string * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetEnvironmentDefinitionsByCatalogAsync (projectName, catalogName, maxCount, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="catalogName" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxCount" Type="System.Nullable<System.Int32>" Index="2" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="3" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="catalogName"> The name of the catalog. </param>
<param name="maxCount"> The maximum number of resources to return from the operation. Example: 'top=10'. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists all environment definitions available within a catalog.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="catalogName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironmentDefinitionsByCatalogAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetEnvironmentDefinitionsByCatalogAsync("<projectName>", "<catalogName>", null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
}
]]></code>
This sample shows how to call GetEnvironmentDefinitionsByCatalogAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetEnvironmentDefinitionsByCatalogAsync("<projectName>", "<catalogName>", 1234, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("id").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("description").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("default").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("type").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("readOnly").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("required").ToString());
Console.WriteLine(result.GetProperty("parameters")[0].GetProperty("allowed")[0].ToString());
Console.WriteLine(result.GetProperty("parametersSchema").ToString());
Console.WriteLine(result.GetProperty("templatePath").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironments">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetEnvironments (string projectName, string userId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetEnvironments(string projectName, string userId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironments(System.String,System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironments (projectName As String, userId As String, context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironments : string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetEnvironments : string * string * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetEnvironments (projectName, userId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="userId" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="userId"> The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists the environments for a project and user.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironments(System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> or <paramref name="userId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="userId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironments and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetEnvironments("<projectName>", "<userId>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
}
]]></code>
This sample shows how to call GetEnvironments with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetEnvironments("<projectName>", "<userId>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("parameters").GetProperty("<key>").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("user").ToString());
Console.WriteLine(result.GetProperty("provisioningState").ToString());
Console.WriteLine(result.GetProperty("resourceGroupId").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironments">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.Developer.DevCenter.Models.DevCenterEnvironment> GetEnvironments (string projectName, string userId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.Developer.DevCenter.Models.DevCenterEnvironment> GetEnvironments(string projectName, string userId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironments(System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironments (projectName As String, userId As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of DevCenterEnvironment)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironments : string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Developer.DevCenter.Models.DevCenterEnvironment>
override this.GetEnvironments : string * string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Developer.DevCenter.Models.DevCenterEnvironment>" Usage="deploymentEnvironmentsClient.GetEnvironments (projectName, userId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.Developer.DevCenter.Models.DevCenterEnvironment></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="userId" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="userId"> The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Lists the environments for a project and user. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> or <paramref name="userId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="userId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetEnvironments.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (DevCenterEnvironment item in client.GetEnvironments("<projectName>", "<userId>"))
{
}
]]></code>
This sample shows how to call GetEnvironments with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (DevCenterEnvironment item in client.GetEnvironments("<projectName>", "<userId>"))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironments">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetEnvironments (string projectName, string userId, int? maxCount, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetEnvironments(string projectName, string userId, valuetype System.Nullable`1<int32> maxCount, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironments(System.String,System.String,System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironments (projectName As String, userId As String, maxCount As Nullable(Of Integer), context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironments : string * string * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetEnvironments : string * string * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetEnvironments (projectName, userId, maxCount, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="userId" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxCount" Type="System.Nullable<System.Int32>" Index="2" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="3" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="userId"> The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. </param>
<param name="maxCount"> The maximum number of resources to return from the operation. Example: 'top=10'. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists the environments for a project and user.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> or <paramref name="userId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="userId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironments and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetEnvironments("<projectName>", "<userId>", null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
}
]]></code>
This sample shows how to call GetEnvironments with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetEnvironments("<projectName>", "<userId>", 1234, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("parameters").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("user").ToString());
Console.WriteLine(result.GetProperty("provisioningState").ToString());
Console.WriteLine(result.GetProperty("resourceGroupId").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetEnvironmentsAsync (string projectName, string userId, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetEnvironmentsAsync(string projectName, string userId, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentsAsync(System.String,System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentsAsync (projectName As String, userId As String, context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentsAsync : string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetEnvironmentsAsync : string * string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetEnvironmentsAsync (projectName, userId, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="userId" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="userId"> The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists the environments for a project and user.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentsAsync(System.String,System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> or <paramref name="userId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="userId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironmentsAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetEnvironmentsAsync("<projectName>", "<userId>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
}
]]></code>
This sample shows how to call GetEnvironmentsAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetEnvironmentsAsync("<projectName>", "<userId>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("parameters").GetProperty("<key>").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("user").ToString());
Console.WriteLine(result.GetProperty("provisioningState").ToString());
Console.WriteLine(result.GetProperty("resourceGroupId").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevCenterEnvironment> GetEnvironmentsAsync (string projectName, string userId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.Developer.DevCenter.Models.DevCenterEnvironment> GetEnvironmentsAsync(string projectName, string userId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentsAsync(System.String,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentsAsync (projectName As String, userId As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of DevCenterEnvironment)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentsAsync : string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevCenterEnvironment>
override this.GetEnvironmentsAsync : string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevCenterEnvironment>" Usage="deploymentEnvironmentsClient.GetEnvironmentsAsync (projectName, userId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevCenterEnvironment></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="userId" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="2" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="userId"> The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Lists the environments for a project and user. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> or <paramref name="userId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="userId" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetEnvironmentsAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (DevCenterEnvironment item in client.GetEnvironmentsAsync("<projectName>", "<userId>"))
{
}
]]></code>
This sample shows how to call GetEnvironmentsAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (DevCenterEnvironment item in client.GetEnvironmentsAsync("<projectName>", "<userId>"))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentsAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetEnvironmentsAsync (string projectName, string userId, int? maxCount, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetEnvironmentsAsync(string projectName, string userId, valuetype System.Nullable`1<int32> maxCount, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentsAsync(System.String,System.String,System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentsAsync (projectName As String, userId As String, maxCount As Nullable(Of Integer), context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentsAsync : string * string * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetEnvironmentsAsync : string * string * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetEnvironmentsAsync (projectName, userId, maxCount, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="userId" Type="System.String" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxCount" Type="System.Nullable<System.Int32>" Index="2" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="3" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="userId"> The AAD object id of the user. If value is 'me', the identity is taken from the authentication context. </param>
<param name="maxCount"> The maximum number of resources to return from the operation. Example: 'top=10'. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists the environments for a project and user.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> or <paramref name="userId" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> or <paramref name="userId" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironmentsAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetEnvironmentsAsync("<projectName>", "<userId>", null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
}
]]></code>
This sample shows how to call GetEnvironmentsAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetEnvironmentsAsync("<projectName>", "<userId>", 1234, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("parameters").ToString());
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("environmentType").ToString());
Console.WriteLine(result.GetProperty("user").ToString());
Console.WriteLine(result.GetProperty("provisioningState").ToString());
Console.WriteLine(result.GetProperty("resourceGroupId").ToString());
Console.WriteLine(result.GetProperty("catalogName").ToString());
Console.WriteLine(result.GetProperty("environmentDefinitionName").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("code").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("message").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("target").ToString());
Console.WriteLine(result.GetProperty("error").GetProperty("innererror").GetProperty("code").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentTypes">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetEnvironmentTypes (string projectName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetEnvironmentTypes(string projectName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentTypes(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentTypes (projectName As String, context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentTypes : string * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetEnvironmentTypes : string * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetEnvironmentTypes (projectName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="context" Type="Azure.RequestContext" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists all environment types configured for a project.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentTypes(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironmentTypes and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetEnvironmentTypes("<projectName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("deploymentTargetId").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
}
]]></code>
This sample shows how to call GetEnvironmentTypes with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetEnvironmentTypes("<projectName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("deploymentTargetId").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentTypes">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<Azure.Developer.DevCenter.Models.DevCenterEnvironmentType> GetEnvironmentTypes (string projectName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class Azure.Developer.DevCenter.Models.DevCenterEnvironmentType> GetEnvironmentTypes(string projectName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentTypes(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentTypes (projectName As String, Optional cancellationToken As CancellationToken = Nothing) As Pageable(Of DevCenterEnvironmentType)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentTypes : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Developer.DevCenter.Models.DevCenterEnvironmentType>
override this.GetEnvironmentTypes : string * System.Threading.CancellationToken -> Azure.Pageable<Azure.Developer.DevCenter.Models.DevCenterEnvironmentType>" Usage="deploymentEnvironmentsClient.GetEnvironmentTypes (projectName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<Azure.Developer.DevCenter.Models.DevCenterEnvironmentType></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Lists all environment types configured for a project. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetEnvironmentTypes.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (DevCenterEnvironmentType item in client.GetEnvironmentTypes("<projectName>"))
{
}
]]></code>
This sample shows how to call GetEnvironmentTypes with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (DevCenterEnvironmentType item in client.GetEnvironmentTypes("<projectName>"))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentTypes">
<MemberSignature Language="C#" Value="public virtual Azure.Pageable<BinaryData> GetEnvironmentTypes (string projectName, int? maxCount, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.Pageable`1<class System.BinaryData> GetEnvironmentTypes(string projectName, valuetype System.Nullable`1<int32> maxCount, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentTypes(System.String,System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentTypes (projectName As String, maxCount As Nullable(Of Integer), context As RequestContext) As Pageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentTypes : string * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>
override this.GetEnvironmentTypes : string * Nullable<int> * Azure.RequestContext -> Azure.Pageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetEnvironmentTypes (projectName, maxCount, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Pageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxCount" Type="System.Nullable<System.Int32>" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="maxCount"> The maximum number of resources to return from the operation. Example: 'top=10'. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists all environment types configured for a project.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.Pageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironmentTypes and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetEnvironmentTypes("<projectName>", null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("deploymentTargetId").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
}
]]></code>
This sample shows how to call GetEnvironmentTypes with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
foreach (BinaryData item in client.GetEnvironmentTypes("<projectName>", 1234, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("deploymentTargetId").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentTypesAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetEnvironmentTypesAsync (string projectName, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetEnvironmentTypesAsync(string projectName, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentTypesAsync(System.String,Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentTypesAsync (projectName As String, context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentTypesAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetEnvironmentTypesAsync : string * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetEnvironmentTypesAsync (projectName, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="context" Type="Azure.RequestContext" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists all environment types configured for a project.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item><item><description>
Please try the simpler <see cref="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentTypesAsync(System.String,System.Threading.CancellationToken)" /> convenience overload with strongly typed models first.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironmentTypesAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetEnvironmentTypesAsync("<projectName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("deploymentTargetId").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
}
]]></code>
This sample shows how to call GetEnvironmentTypesAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetEnvironmentTypesAsync("<projectName>", null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("deploymentTargetId").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentTypesAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevCenterEnvironmentType> GetEnvironmentTypesAsync (string projectName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class Azure.Developer.DevCenter.Models.DevCenterEnvironmentType> GetEnvironmentTypesAsync(string projectName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentTypesAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentTypesAsync (projectName As String, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of DevCenterEnvironmentType)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentTypesAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevCenterEnvironmentType>
override this.GetEnvironmentTypesAsync : string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevCenterEnvironmentType>" Usage="deploymentEnvironmentsClient.GetEnvironmentTypesAsync (projectName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<Azure.Developer.DevCenter.Models.DevCenterEnvironmentType></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="1" FrameworkAlternate="azure-dotnet" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="cancellationToken"> The cancellation token to use. </param>
<summary> Lists all environment types configured for a project. </summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<example>
This sample shows how to call GetEnvironmentTypesAsync.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (DevCenterEnvironmentType item in client.GetEnvironmentTypesAsync("<projectName>"))
{
}
]]></code>
This sample shows how to call GetEnvironmentTypesAsync with all parameters.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (DevCenterEnvironmentType item in client.GetEnvironmentTypesAsync("<projectName>"))
{
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="GetEnvironmentTypesAsync">
<MemberSignature Language="C#" Value="public virtual Azure.AsyncPageable<BinaryData> GetEnvironmentTypesAsync (string projectName, int? maxCount, Azure.RequestContext context);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AsyncPageable`1<class System.BinaryData> GetEnvironmentTypesAsync(string projectName, valuetype System.Nullable`1<int32> maxCount, class Azure.RequestContext context) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.GetEnvironmentTypesAsync(System.String,System.Nullable{System.Int32},Azure.RequestContext)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetEnvironmentTypesAsync (projectName As String, maxCount As Nullable(Of Integer), context As RequestContext) As AsyncPageable(Of BinaryData)" />
<MemberSignature Language="F#" Value="abstract member GetEnvironmentTypesAsync : string * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>
override this.GetEnvironmentTypesAsync : string * Nullable<int> * Azure.RequestContext -> Azure.AsyncPageable<BinaryData>" Usage="deploymentEnvironmentsClient.GetEnvironmentTypesAsync (projectName, maxCount, context)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AsyncPageable<System.BinaryData></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="projectName" Type="System.String" Index="0" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="maxCount" Type="System.Nullable<System.Int32>" Index="1" FrameworkAlternate="azure-dotnet-preview" />
<Parameter Name="context" Type="Azure.RequestContext" Index="2" FrameworkAlternate="azure-dotnet-preview" />
</Parameters>
<Docs>
<param name="projectName"> The DevCenter Project upon which to execute operations. </param>
<param name="maxCount"> The maximum number of resources to return from the operation. Example: 'top=10'. </param>
<param name="context"> The request context, which can override default behaviors of the client pipeline on a per-call basis. </param>
<summary>
[Protocol Method] Lists all environment types configured for a project.
<list type="bullet"><item><description>
This <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/ProtocolMethods.md">protocol method</see> allows explicit creation of the request and processing of the response for advanced scenarios.
</description></item></list></summary>
<returns> The <see cref="T:Azure.AsyncPageable`1" /> from the service containing a list of <see cref="T:System.BinaryData" /> objects. Details of the body schema for each item in the collection are in the Remarks section below. </returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="projectName" /> is null. </exception>
<exception cref="T:System.ArgumentException">
<paramref name="projectName" /> is an empty string, and was expected to be non-empty. </exception>
<exception cref="T:Azure.RequestFailedException"> Service returned a non-success status code. </exception>
<example>
This sample shows how to call GetEnvironmentTypesAsync and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetEnvironmentTypesAsync("<projectName>", null, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("deploymentTargetId").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
}
]]></code>
This sample shows how to call GetEnvironmentTypesAsync with all parameters and parse the result.
<code><![CDATA[
Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
DeploymentEnvironmentsClient client = new DeploymentEnvironmentsClient(endpoint, credential);
await foreach (BinaryData item in client.GetEnvironmentTypesAsync("<projectName>", 1234, null))
{
JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement;
Console.WriteLine(result.GetProperty("name").ToString());
Console.WriteLine(result.GetProperty("deploymentTargetId").ToString());
Console.WriteLine(result.GetProperty("status").ToString());
}
]]></code></example>
</Docs>
</Member>
<Member MemberName="Pipeline">
<MemberSignature Language="C#" Value="public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.Core.Pipeline.HttpPipeline Pipeline" />
<MemberSignature Language="DocId" Value="P:Azure.Developer.DevCenter.DeploymentEnvironmentsClient.Pipeline" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property Pipeline As HttpPipeline" />
<MemberSignature Language="F#" Value="member this.Pipeline : Azure.Core.Pipeline.HttpPipeline" Usage="Azure.Developer.DevCenter.DeploymentEnvironmentsClient.Pipeline" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Developer.DevCenter</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Core.Pipeline.HttpPipeline</ReturnType>
</ReturnValue>
<Docs>
<summary> The HTTP pipeline for sending and receiving REST requests and responses. </summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>